Cypress.env() supporting objects

[blasvicco]

Current behavior:

If we try to set an object as env variable we get an error.

Desired behavior:

It will be great if we can set objects in the env variables.

Versions

Beta 3.0.3

[funnylookinhat]

As an example - we have an environment-specific options object that we frequently want to pass to cy.visit that include HTTP Auth, etc.; it'd simplify things greatly if we could just: cy.visit('/foobar', Cypress.env('visitOptions'));

[jennifer-shehane]

@blasvicco Could you explain how you are trying to set your env variable? There are 5 ways they can be set - so we want to make sure to address your issue appropriately. https://on.cypress.io/environment-variables#Setting

@funnylookinhat Cypress.env() should accept an object, as is described in the docs. Make sure you are passing the object literal and not the string 'visitOptions'.

[blasvicco]

@jennifer-shehane Following this
We have in our plugin js index file the next lines:

module.exports = (on, config) => {
  config.env.visit_options = {
      auth: {
        password: 'test',
        username: 'test_something',
      },
  };
  console.log(config);
  return config;
};

When we run cypress we are able to see that the config has the env.visit_options set properly but in the cypress window we are getting this error:

[jennifer-shehane]

Yes, this does throw this error. Console.log of env options in config:

{ 
  env: { visit_options: { auth: [Object] } }
 }

[jennifer-shehane]

Now that I see your use case, there is an open issue for this here: #1736

Going to close as duplicate.