Overriding configuration variables from cypress.env.json

Question

TL;DR:

I am trying to override the baseUrl value from cypress.json using my cypress.env.json file, but I can't seem to figure out how. Is there a way to do this?

Background

Setting environment variables in the cypress.json file and later overriding them in cypress.env.json is as easy as pie. In cypress.json:

{
  "env": {
    "someVariable": "originalValue"
  }
}

... and in cypress.env.json:

{
  "someVariable": "newValue"
}

Regarding configuration variables, the documentation states:

If your environment variables match a standard configuration key, then instead of setting an environment variable they will instead override the configuration value.

However, if I try setting baseUrl from cypress.json...

{
  "baseUrl": "http://example.com/setFromCypress.json",
  "env": {
    "someVariable": "originalValue"
  }
}

... and overriding it in cypress.env.json ...

{
  "baseUrl": "http://example.com/setFromCypress.env.json",
  "someVariable": "newValue"
}

... then someVariable is overriden, but the existing baseUrl remains unchanged (and a baseUrl appears inside the object placed at the env key):

I have no problem when setting baseUrl in cypress.json and later overriding it in the command line using CYPRESS_BASE_URL:

$ export CYPRESS_BASE_URL=http://example.com/setFromCommandLine

Then, the original baseUrl is overriden:

To summarize: Am I missing something in the documentation, or is something missing in the documentation?

I think it's a bug.. would create an [issue](https://github.com/cypress-io/cypress/issues/new) — dwelle, Nov 13 '17 at 13:45
I think you can add that as an answer, @DanSwain. Just do so, and I'll give you the checkmark. ;) — vages, Nov 16 '17 at 11:38

score 11 · Answer 1 · answered Dec 12 '19 at 14:44

11

A simple workaround: in plugins/index.js do

module.exports = (on, config) => {
  if(config.hasOwnProperty('env') &&  config.env.hasOwnProperty('baseUrl')){
      config.baseUrl = config.env.baseUrl;
  }
  return config
}

answered Dec 12 '19 at 14:44

Wesol

168
1
9

that's an excellent workaround to a widely encountered problem, thanks a lot! – damusnet Jul 29 '20 at 20:13
I just spent hours trying to find/create something like this. Thanks so much! – bildungsroman Oct 08 '20 at 00:25

score 5 · Accepted Answer · edited Oct 04 '20 at 07:28

After the above post, it was explained in the related github issue that this is not considered a bug. Variables from cypress.env.json are loaded into the environmentVariables variable within the overall config (despite what the current documentation would lead you to believe). The overall config file is cypress.json. In the github issue, I've provided backup concerning why the current explanation is confusing.

Overriding configuration variables from cypress.env.json

TL;DR:

Background

2 Answers2