feat: show better error message if testing type is not configured (#2…

…2000)

* feat: show better error message if testing type is not configured

* Add tests

* Update tests

* Fix some tests

* Fix some tests

* Fix test

* Fix tests

* Update packages/errors/src/errors.ts

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* Update with code review

* Fix test

* Add on link

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

circle.yml

@@ -835,7 +835,7 @@ commands:
           command: |
             if [[ -f cypress.json ]]; then
               rm -rf cypress.json
-              echo 'module.exports = {}' > cypress.config.js
+              echo 'module.exports = { e2e: {} }' > cypress.config.js
             fi
       - run:
           name: Rename support file
@@ -2211,7 +2211,7 @@ jobs:
             CYPRESS_INTERNAL_FORCE_SCAFFOLD: "1"
           command: |
             rm -rf cypress.json
-            echo 'module.exports = {}' > cypress.config.js
+            echo 'module.exports = { e2e: {} }' > cypress.config.js
       - run:
           name: Rename support file
           working_directory: test-binary

packages/data-context/src/data/ProjectLifecycleManager.ts

@@ -542,6 +542,10 @@ export class ProjectLifecycleManager {
       return
     }
 
+    if (this.ctx.isRunMode && this.loadedConfigFile && !this.isTestingTypeConfigured(testingType)) {
+      return this.ctx.onError(getError('TESTING_TYPE_NOT_CONFIGURED', testingType))
+    }
+
     if (this.ctx.isRunMode || (this.isTestingTypeConfigured(testingType) && !(this.ctx.coreData.forceReconfigureProject && this.ctx.coreData.forceReconfigureProject[testingType]))) {
       this._configManager.loadTestingType()
     }

packages/errors/src/errors.ts

@@ -1551,6 +1551,16 @@ export const AllCypressErrors = {
       the devServer config as a ${fmt.highlight(devServerConfigFile)} option.
     `
   },
+
+  TESTING_TYPE_NOT_CONFIGURED: (testingType: TestingType) => {
+    return errTemplate`
+      The testing type selected (${fmt.highlight(testingType)}) is not configured in your config file.
+
+      Please run ‘cypress open’ and choose your testing type to automatically update your configuration file.
+
+      https://on.cypress.io/configuration
+    `
+  },
 } as const
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars

packages/errors/test/unit/visualSnapshotErrors_spec.ts

@@ -1167,5 +1167,10 @@ describe('visual error templates', () => {
         default: ['vite', '/dev/project', ['vite.config.js', 'vite.config.ts']],
       }
     },
+    TESTING_TYPE_NOT_CONFIGURED: () => {
+      return {
+        default: ['component'],
+      }
+    },
   })
 })

packages/graphql/schemas/schema.graphql

@@ -618,6 +618,7 @@ enum ErrorTypeEnum {
   SETUP_NODE_EVENTS_INVALID_EVENT_NAME_ERROR
   SETUP_NODE_EVENTS_IS_NOT_FUNCTION
   SUPPORT_FILE_NOT_FOUND
+  TESTING_TYPE_NOT_CONFIGURED
   TESTS_DID_NOT_START_FAILED
   TESTS_DID_NOT_START_RETRYING
   TEST_FILES_RENAMED

system-tests/__snapshots__/testing_type_not_configured_error_spec.ts.js

@@ -0,0 +1,19 @@
+exports['testing type not configured error on run mode / reports correct exit code when failing attempting to run e2e'] = `
+The testing type selected (e2e) is not configured in your config file.
+
+Please run ‘cypress open’ and choose your testing type to automatically update your configuration file.
+
+https://on.cypress.io/configuration
+
+
+`
+
+exports['testing type not configured error on run mode / reports correct exit code when failing attempting to run component'] = `
+The testing type selected (component) is not configured in your config file.
+
+Please run ‘cypress open’ and choose your testing type to automatically update your configuration file.
+
+https://on.cypress.io/configuration
+
+
+`

system-tests/projects/busted-support-file/cypress.config.js

@@ -1 +1,3 @@
-module.exports = {}
+module.exports = {
+  e2e: {},
+}

system-tests/projects/invalid-root-level-config/invalid-component-baseUrl-config.js

@@ -1,5 +1,9 @@
 module.exports = {
   component: {
     baseUrl: 'https://foo.com',
+    devServer: {
+      framework: 'create-react-app',
+      bundler: 'webpack',
+    },
   },
 }

system-tests/projects/invalid-root-level-config/invalid-component-experimentalSessionAndOrigin-config.js

@@ -1,5 +1,9 @@
 module.exports = {
   component: {
     experimentalSessionAndOrigin: true,
+    devServer: {
+      framework: 'create-react-app',
+      bundler: 'webpack',
+    },
   },
 }

system-tests/projects/multiple-support-files/cypress.config.js

@@ -1 +1,3 @@
-module.exports = {}
+module.exports = {
+  e2e: {},
+}

system-tests/projects/ts-proj-4-5/cypress.config.ts

@@ -1,3 +1,5 @@
 import { defineConfig } from 'cypress'
 
-export default defineConfig({})
+export default defineConfig({
+  e2e: {},
+})

system-tests/projects/ts-proj/cypress.config.ts

@@ -1 +1,3 @@
-module.exports = {}
+module.exports = {
+  e2e: {},
+}

system-tests/projects/uncaught-support-file/cypress.config.js

@@ -1 +1,3 @@
-module.exports = {}
+module.exports = {
+  e2e: {},
+}

system-tests/test/cookies_spec.ts

@@ -183,6 +183,7 @@ describe('e2e cookies', () => {
       https: true,
     }],
     settings: {
+      e2e: {},
       hosts: {
         '*.foo.com': '127.0.0.1',
         '*.bar.net': '127.0.0.1',
@@ -339,6 +340,7 @@ describe('cross-origin cookies, set:cookies', () => {
         '*.bar.net': '127.0.0.1',
         '*.cypress.test': '127.0.0.1',
       },
+      e2e: {},
     },
 
   })

system-tests/test/cy_origin_error_spec.ts

@@ -20,6 +20,7 @@ describe('e2e cy.origin errors', () => {
       onServer,
     }],
     settings: {
+      e2e: {},
       hosts: {
         '*.foobar.com': '127.0.0.1',
       },

system-tests/test/cy_origin_retries_spec.ts

@@ -21,6 +21,7 @@ describe('e2e cy.origin retries', () => {
       hosts: {
         '*.foobar.com': '127.0.0.1',
       },
+      e2e: {},
     },
   })
 

system-tests/test/form_submissions_spec.js

@@ -108,6 +108,7 @@ describe('e2e forms', () => {
   context('<form> submissions', () => {
     systemTests.setup({
       settings: {
+        e2e: {},
         env: {
           PATH_TO_LARGE_IMAGE: pathToLargeImage,
         },
@@ -149,6 +150,7 @@ describe('e2e forms', () => {
     systemTests.it('passes with http on localhost', {
       config: {
         baseUrl: `http://localhost:${HTTP_PORT}`,
+        e2e: {},
       },
       spec: 'form_submission_multipart.cy.js',
       snapshot: true,

system-tests/test/session_spec.ts

@@ -126,6 +126,7 @@ describe('e2e sessions', () => {
       hosts: {
         '*.foo.com': '127.0.0.1',
       },
+      e2e: {},
     },
   })
 

system-tests/test/stdout_spec.js

@@ -17,6 +17,7 @@ describe('e2e stdout', () => {
         'www.apple.com': '127.0.0.1',
         '*.cypress.io': '127.0.0.1',
       },
+      e2e: {},
     },
   })
 

system-tests/test/testing_type_not_configured_error_spec.ts

@@ -0,0 +1,19 @@
+const systemTests = require('../lib/system-tests').default
+
+describe('testing type not configured error on run mode', () => {
+  systemTests.setup()
+
+  systemTests.it('reports correct exit code when failing attempting to run e2e', {
+    project: 'simple-ct',
+    testingType: 'e2e',
+    snapshot: true,
+    expectedExitCode: 1,
+  })
+
+  systemTests.it('reports correct exit code when failing attempting to run component', {
+    project: 'e2e',
+    testingType: 'component',
+    snapshot: true,
+    expectedExitCode: 1,
+  })
+})

system-tests/test/viewport_spec.js

@@ -5,6 +5,7 @@ describe('e2e viewport', () => {
     settings: {
       viewportWidth: 800,
       viewportHeight: 600,
+      e2e: {},
     },
   })
 

system-tests/test/visit_spec.js

@@ -121,6 +121,7 @@ describe('e2e visit', () => {
       settings: {
         responseTimeout: 500,
         pageLoadTimeout: 1000,
+        e2e: {},
       },
       servers: {
         port: 3434,
@@ -194,6 +195,7 @@ describe('e2e visit', () => {
     systemTests.setup({
       settings: {
         responseTimeout: 2000,
+        e2e: {},
       },
       servers: {
         port: 3434,
@@ -213,6 +215,7 @@ describe('e2e visit', () => {
     systemTests.setup({
       settings: {
         pageLoadTimeout: 1000,
+        e2e: {},
       },
       servers: {
         port: 3434,

system-tests/test/web_security_spec.js

@@ -66,6 +66,7 @@ describe('e2e web security', () => {
         '*.bar.com': '127.0.0.1',
         '*.foobar.com': '127.0.0.1',
       },
+      e2e: {},
     },
   })