Issue 1042 (#1057)

* server: remove unused file

* server: WIP, start implementing accepting plugin returning promise and yielding config overrides [skip ci]

* server: cleanup the env + environentVariables disaster. simplify and only use 'env'

* server, desktop-gum: rename 'env' to 'cypressEnv' to avoid conflicts, fix failing tests

* server: modify plugins error content to be clearer

* runner, driver: more environmentVariables -> env cleanup

* fixes #509 return the complete configuration object to Cypress.config()

* fixes #1042 enable plugins to return a promise and modify config

* desktop-gui: add 'plugin' override to configuration display

* server: bug fix when plugin cause a project not to open

* desktop-gui: fix for failing e2e test

* server: make errors clearer when plugins crash

* server: fix bug with PLUGINS_FUNCTION_ERROR not sending right arguments

- fix failing tests
- improve plugin error content

* server: fix failing snapshots, preprocessor is invoked for support + spec files

* server: fix tests, don't watch the support file initially

- this was causing a problem where unhandled preprocessor errors were
causing the entire process to hang.
- this was happening because we weren’t properly running support files
through a custom preprocessor initially

* fixes failing tests

Author: brian-mann

.eslintrc

@@ -3,6 +3,7 @@
     "plugin:cypress-dev/general"
   ],
   "env": {
+    "es6": true,
     "node": true
   }
 }

packages/desktop-gui/cypress/fixtures/config.json

@@ -27,9 +27,9 @@
   "clientUrlDisplay": "http://localhost:2020",
   "commandTimeout": 4000,
   "cypressHostUrl": "http://localhost:2020",
-  "env": "development",
-  "environmentVariables": {
-    
+  "cypressEnv": "development",
+  "env": {
+
   },
   "execTimeout": 60000,
   "fileServerFolder": "/Users/jennifer/Dev/Projects/cypress-example-kitchensink",
@@ -40,7 +40,7 @@
   "isHeadless": false,
   "isNewProject": false,
   "javascripts": [
-    
+
   ],
   "morgan": true,
   "namespace": "__cypress",
@@ -108,7 +108,7 @@
       "from": "default",
       "value": 4000
     },
-    "environmentVariables": {
+    "env": {
       "fileServerFolder": {
         "from": "default",
         "value": ""

packages/desktop-gui/cypress/integration/settings_spec.coffee

@@ -65,7 +65,7 @@ describe "Settings", ->
         cy.contains("Your project's configuration is displayed")
 
       it "displays legend in table", ->
-        cy.get("table>tbody>tr").should("have.length", 5)
+        cy.get("table>tbody>tr").should("have.length", 6)
 
       it "wraps config line in proper classes", ->
         cy

packages/desktop-gui/src/app/app.jsx

@@ -20,7 +20,7 @@ class App extends Component {
     appApi.listenForMenuClicks()
 
     ipc.getOptions().then((options = {}) => {
-      appStore.set(_.pick(options, 'env', 'os', 'projectPath', 'version'))
+      appStore.set(_.pick(options, 'cypressEnv', 'os', 'projectPath', 'version'))
       viewStore.showApp()
     })
 

packages/desktop-gui/src/lib/app-store.js

@@ -2,7 +2,7 @@ import { action, computed, observable } from 'mobx'
 import localData from '../lib/local-data'
 
 class AppStore {
-  @observable env
+  @observable cypressEnv
   @observable os
   @observable projectPath = null
   @observable newVersion
@@ -15,7 +15,7 @@ class AppStore {
   }
 
   @computed get isDev () {
-    return this.env === 'development'
+    return this.cypressEnv === 'development'
   }
 
   @computed get isGlobalMode () {
@@ -27,7 +27,7 @@ class AppStore {
   }
 
   @action set (props) {
-    if (props.env != null) this.env = props.env
+    if (props.cypressEnv != null) this.cypressEnv = props.cypressEnv
     if (props.os != null) this.os = props.os
     if (props.projectPath != null) this.projectPath = props.projectPath
     if (props.version != null) this.version = this.newVersion = props.version

packages/desktop-gui/src/settings/configuration.jsx

@@ -102,6 +102,10 @@ const Configuration = observer(({ project }) => (
           <td><span className='cli'>CLI</span></td>
           <td>set from CLI arguments</td>
         </tr>
+        <tr className='config-keys'>
+          <td><span className='plugin'>plugin</span></td>
+          <td>set from plugin file</td>
+        </tr>
       </tbody>
     </table>
     <pre className='config-vars'>

packages/desktop-gui/src/settings/settings.scss

@@ -53,7 +53,7 @@
     padding: 10px;
     font-family: $font-mono;
 
-    .envFile:hover, .env:hover, .config:hover, .cli:hover, .default:hover {
+    .envFile:hover, .env:hover, .config:hover, .cli:hover, .plugin:hover, .default:hover {
       border-bottom: 1px dotted #777;
     }
 
@@ -83,7 +83,7 @@
     }
   }
 
-  .envFile, .env, .config, .cli, .default {
+  .envFile, .env, .config, .cli, .plugin, .default {
     font-family: $font-mono;
 
     padding: 2px;
@@ -109,6 +109,11 @@
     color: #A21313;
   }
 
+  .plugin {
+    background-color: #f0e7fc;
+    color: #134aa2;
+  }
+
 }
 
 .settings-wrapper {

packages/driver/src/cypress.coffee

@@ -119,13 +119,13 @@ class $Cypress
       longStackTraces: config.isInteractive
     })
 
-    {environmentVariables, remote} = config
+    {env, remote} = config
 
-    config = _.omit(config, "environmentVariables", "remote")
+    config = _.omit(config, "env", "remote", "resolved", "scaffoldedFiles", "javascripts", "state")
 
     @state = $SetterGetter.create({})
     @config = $SetterGetter.create(config)
-    @env = $SetterGetter.create(environmentVariables)
+    @env = $SetterGetter.create(env)
 
     @Cookies = $Cookies.create(config.namespace, d)
 

packages/driver/src/cypress/error_messages.coffee

@@ -204,9 +204,6 @@ module.exports = {
     invalid_argument: "#{cmd('each')} must be passed a callback function."
     non_array: "#{cmd('each')} can only operate on an array like subject. Your subject was: '{{subject}}'"
 
-  env:
-    variables_missing: "Cypress.environmentVariables is not defined. Open an issue if you see this message."
-
   exec:
     failed: """#{cmd('exec', '\'{{cmd}}\'')} failed with the following error:
 

packages/driver/test/unit/cypress_spec.coffee

@@ -78,7 +78,7 @@ describe "src/cypress", ->
   describe "#env", ->
     beforeEach ->
       @Cypress.setConfig({
-        environmentVariables: {foo: "bar"}
+        env: {foo: "bar"}
       })
 
     it "acts as getter", ->
@@ -108,9 +108,9 @@ describe "src/cypress", ->
     it "instantiates Cookies", ->
       expect(@Cypress.Cookies).to.be.an("object")
 
-    it "passes config.environmentVariables", ->
+    it "passes config.env", ->
       @Cypress.setConfig({
-        environmentVariables: {foo: "bar"}
+        env: {foo: "bar"}
       })
 
       expect(@Cypress.env()).to.deep.eq({foo: "bar"})

packages/runner/src/app/app.jsx

@@ -121,7 +121,7 @@ App.propTypes = {
       majorVersion: PropTypes.string.isRequired,
       version: PropTypes.string.isRequired,
     })).isRequired,
-    env: PropTypes.string.isRequired,
+    cypressEnv: PropTypes.string.isRequired,
     integrationFolder: PropTypes.string.isRequired,
     numTestsKeptInMemory: PropTypes.number.isRequired,
     projectName: PropTypes.string.isRequired,

packages/runner/src/app/app.spec.jsx

@@ -13,7 +13,7 @@ import App from './app'
 const createProps = () => ({
   config: {
     browsers: [],
-    env: 'tst',
+    cypressEnv: 'tst',
     integrationFolder: '',
     numTestsKeptInMemory: 1,
     projectName: '',

packages/runner/src/app/container.spec.jsx

@@ -14,7 +14,7 @@ import Container, { automationElementId } from './container'
 const createProps = () => ({
   config: {
     browsers: [],
-    env: 'test',
+    cypressEnv: 'test',
     integrationFolder: '',
     numTestsKeptInMemory: 1,
     projectName: '',

packages/runner/src/lib/event-manager.js

@@ -62,7 +62,7 @@ const eventManager = {
     })
 
     _.each(socketRerunEvents, (event) => {
-      channel.on(event,  this._reRun.bind(this))
+      channel.on(event, this._reRun.bind(this))
     })
 
     reporterBus.on('runner:console:error', (testId) => {
@@ -165,31 +165,7 @@ const eventManager = {
   },
 
   setup (config, specPath) {
-    Cypress = $Cypress.create(
-      _.pick(config,
-        'isTextTerminal',
-        'numTestsKeptInMemory',
-        'waitForAnimations',
-        'animationDistanceThreshold',
-        'defaultCommandTimeout',
-        'pageLoadTimeout',
-        'requestTimeout',
-        'responseTimeout',
-        'environmentVariables',
-        'xhrUrl',
-        'baseUrl',
-        'viewportWidth',
-        'viewportHeight',
-        'execTimeout',
-        'screenshotOnHeadlessFailure',
-        'namespace',
-        'remote',
-        'version',
-        'fixturesFolder',
-        'platform',
-        'arch'
-      )
-    )
+    Cypress = $Cypress.create(config)
 
     // expose Cypress globally
     window.Cypress = Cypress

packages/server/__snapshots__/plugins_spec.coffee

@@ -3,7 +3,7 @@ Started video recording: /foo/bar/.projects/plugins-async-error/cypress/videos/a
 
   (Tests Starting)
 
-Error: The following error was thrown by a plugin. We've stopped running your tests because this likely interrupts behavior critical to them.
+Error: The following error was thrown by a plugin. We've stopped running your tests because a plugin crashed.
 
 Error: Async error from plugins file
     at stack trace line
@@ -50,15 +50,16 @@ Started video recording: /foo/bar/.projects/working-preprocessor/cypress/videos/
   (Tests Starting)
 
 
+  ✓ is another spec
   ✓ is another spec
 
-  1 passing
+  2 passing
 
 
   (Tests Finished)
 
-  - Tests:           1
-  - Passes:          1
+  - Tests:           2
+  - Passes:          2
   - Failures:        0
   - Pending:         0
   - Duration:        10 seconds
@@ -73,6 +74,40 @@ Started video recording: /foo/bar/.projects/working-preprocessor/cypress/videos/
   - Finished processing:  /foo/bar/.projects/working-preprocessor/cypress/videos/abc123.mp4 (0 seconds)
 
 
+  (All Done)
+
+`
+
+exports['e2e plugins can modify config from plugins 1'] = `
+Started video recording: /foo/bar/.projects/plugin-config/cypress/videos/abc123.mp4
+
+  (Tests Starting)
+
+
+  ✓ overrides config
+  ✓ overrides env
+
+  2 passing
+
+
+  (Tests Finished)
+
+  - Tests:           2
+  - Passes:          2
+  - Failures:        0
+  - Pending:         0
+  - Duration:        10 seconds
+  - Screenshots:     0
+  - Video Recorded:  true
+  - Cypress Version: 1.2.3
+
+
+  (Video)
+
+  - Started processing:   Compressing to 20 CRF
+  - Finished processing:  /foo/bar/.projects/plugin-config/cypress/videos/abc123.mp4 (0 seconds)
+
+
   (All Done)
 
 `