feat: remove testFiles reference (#20565)

* feat: remove testFiles reference * feat: remove testFiles reference * Fix test/TS
cypress-io · Mar 11, 2022 · 5670344 · 5670344 · cypress-bot · Mar 11, 2022
1 parent 31ed4dd
commit 5670344
Show file tree

Hide file tree

Showing 21 changed files with 139 additions and 35 deletions.
diff --git a/cli/schema/cypress.schema.json b/cli/schema/cypress.schema.json
@@ -50,14 +50,6 @@
           "default": 10000,
           "description": "Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts"
         },
-        "testFiles": {
-          "type": [
-            "string",
-            "array"
-          ],
-          "default": "**/*.*",
-          "description": "A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global"
-        },
         "watchForFileChanges": {
           "type": "boolean",
           "default": true,

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -2622,12 +2622,6 @@ declare namespace Cypress {
      * @default {}
      */
     env: { [key: string]: any }
-    /**
-     * A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match.
-     * @default "*.hot-update.js"
-     * @deprecated use `excludeSpecPattern` instead
-     */
-    ignoreTestFiles: string | string[]
     /**
      * A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match.
      * @default "*.hot-update.js"
@@ -2866,12 +2860,6 @@ declare namespace Cypress {
      * Glob pattern to determine what test files to load.
      */
     specPattern: string | string[]
-    /**
-     * Glob pattern to determine what test files to load.
-     *
-     * @deprecated Use `specPattern` under `component` or `e2e`
-     */
-    testFiles: string | string[]
     /**
      * The user agent the browser sends in all request headers.
      */

diff --git a/npm/angular/README.md b/npm/angular/README.md
@@ -28,7 +28,7 @@ Enable component testing in `cypress.config.js`.
 module.exports = {
   "component": {
     "componentFolder": "src/app",
-    "testFiles": "**/*cy-spec.ts"
+    "specPattern": "**/*cy-spec.ts"
   }
 }
 ```

diff --git a/npm/create-cypress-tests/__snapshots__/init-component-testing.test.ts.js b/npm/create-cypress-tests/__snapshots__/init-component-testing.test.ts.js
@@ -1,7 +1,7 @@
 exports['injects guessed next.js template cypress.config.ts'] = `
 export default {
   componentFolder: "src",
-  testFiles: "**/*.spec.{js,ts,jsx,tsx}"
+  specPattern: "**/*.spec.{js,ts,jsx,tsx}"
 };
 
 `
@@ -22,7 +22,7 @@ module.exports = (on, config) => {
 exports['Injected overridden webpack template cypress.config.ts'] = `
 export default {
   componentFolder: "cypress/component",
-  testFiles: "**/*.spec.{js,ts,jsx,tsx}"
+  specPattern: "**/*.spec.{js,ts,jsx,tsx}"
 };
 
 `

diff --git a/npm/create-cypress-tests/src/component-testing/init-component-testing.test.ts b/npm/create-cypress-tests/src/component-testing/init-component-testing.test.ts
@@ -275,7 +275,7 @@ describe('init component tests script', () => {
     expect(JSON.stringify(injectedCode.default, null, 2)).to.equal(JSON.stringify(
       {
         componentFolder: 'cypress/component',
-        testFiles: '**/*.spec.{js,ts,jsx,tsx}',
+        specPattern: '**/*.spec.{js,ts,jsx,tsx}',
       },
       null,
       2,

diff --git a/npm/create-cypress-tests/src/component-testing/init-component-testing.ts b/npm/create-cypress-tests/src/component-testing/init-component-testing.ts
@@ -58,7 +58,7 @@ async function injectAndShowCypressConfig (
 ) {
   const configToInject = {
     componentFolder,
-    testFiles: '**/*.spec.{js,ts,jsx,tsx}',
+    specPattern: '**/*.spec.{js,ts,jsx,tsx}',
   }
 
   await injectOrShowConfigCode(() => insertValuesInConfigFile(cypressJsonPath, configToInject), {

diff --git a/npm/react/examples/find-webpack/README.md b/npm/react/examples/find-webpack/README.md
@@ -27,13 +27,13 @@ Next, create a `cypress.json` with some basic configuration:
 ```json
 {
   "component": {
-    "testFiles": "**/*.test.{js,ts,jsx,tsx}",
+    "specPattern": "**/*.test.{js,ts,jsx,tsx}",
     "componentFolder": "src"
   }
 }
 ```
 
-Here we are adding some Component Testing specific options, hence the `"component"` key. `"componentFolder"` is where all the components and tests are located, and `"testFiles"` is the pattern to search for test files.
+Here we are adding some Component Testing specific options, hence the `"component"` key. `"componentFolder"` is where all the components and tests are located, and `"specPattern"` is the pattern to search for test files.
 
 The last thing we need to is tell Cypress to use `@cypress/webpack-dev-server` for component tests. Plugins are explained in detail in the [Cypress documentation](https://on.cypress.io/installing-plugins). By default plugins are loaded from `cypress/plugins/index.js`. Create that file and add:
 

diff --git a/npm/vite-dev-server/cypress/new-signature/plugins.js b/npm/vite-dev-server/cypress/new-signature/plugins.js
@@ -17,7 +17,7 @@ module.exports = (on, config) => {
     )
   })
 
-  config.testFiles = '**/smoke.spec.ts'
+  config.component.specPattern = '**/smoke.spec.ts'
 
   return config
 }
diff --git a/packages/config/__snapshots__/index_spec.js b/packages/config/__snapshots__/index_spec.js
@@ -7,7 +7,8 @@ exports['src/index .getBreakingKeys returns list of breaking config keys 1'] = [
   "experimentalShadowDomSupport",
   "firefoxGcInterval",
   "nodeVersion",
-  "nodeVersion"
+  "nodeVersion",
+  "testFiles"
 ]
 
 exports['src/index .getDefaultValues returns list of public config keys 1'] = {

diff --git a/packages/config/lib/options.ts b/packages/config/lib/options.ts
@@ -533,6 +533,11 @@ export const breakingOptions: Array<BreakingOption> = [
     errorKey: 'NODE_VERSION_DEPRECATION_BUNDLED',
     isWarning: true,
   },
+  {
+    name: 'testFiles',
+    errorKey: 'TEST_FILES_DEPRECATION',
+    isWarning: false,
+  },
 ]
 
 export const breakingRootOptions: Array<BreakingOption> = [

diff --git a/packages/data-context/src/sources/migration/codegen.ts b/packages/data-context/src/sources/migration/codegen.ts
@@ -21,6 +21,11 @@ type ConfigOptions = {
   component: Record<string, unknown>
 }
 
+type ResolvedConfigOptions = Cypress.ResolvedConfigOptions & {
+  testFiles: string | string[]
+  ignoreTestFiles: string | string[]
+}
+
 /**
  * config format pre-10.0
  */
@@ -361,7 +366,7 @@ export function reduceConfig (cfg: OldCypressConfig): ConfigOptions {
     }
 
     if (key === 'e2e' || key === 'component') {
-      const value = val as Cypress.ResolvedConfigOptions
+      const value = val as ResolvedConfigOptions
 
       if (!value) {
         return acc

diff --git a/packages/errors/__snapshot-html__/TEST_FILES_DEPRECATION.html b/packages/errors/__snapshot-html__/TEST_FILES_DEPRECATION.html
diff --git a/packages/errors/src/errors.ts b/packages/errors/src/errors.ts
@@ -1321,6 +1321,27 @@ export const AllCypressErrors = {
     `
   },
 
+  TEST_FILES_DEPRECATION: (errShape: BreakingErrResult) => {
+    const code = errPartial`
+    {
+      e2e: {
+        specPattern: '...',
+      },
+      component: {
+        specPattern: '...',
+      },
+    }`
+
+    return errTemplate`\
+     The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
+
+      It is now renamed to ${fmt.highlight('specPattern')} and configured separately as a testing type property: ${fmt.highlightSecondary('e2e.specPattern')} and ${fmt.highlightSecondary('component.specPattern')}
+
+      ${fmt.code(code)}
+
+      https://on.cypress.io/migration-guide`
+  },
+
 } as const
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars

diff --git a/packages/errors/test/unit/visualSnapshotErrors_spec.ts b/packages/errors/test/unit/visualSnapshotErrors_spec.ts
@@ -1101,5 +1101,10 @@ describe('visual error templates', () => {
         default: ['custom.config.js', 'custom.json'],
       }
     },
+    TEST_FILES_DEPRECATION: () => {
+      return {
+        default: [{ name: 'testFiles', configFile: '/path/to/cypress.config.js.ts' }],
+      }
+    },
   })
 })
diff --git a/packages/server/test/integration/cypress_spec.js b/packages/server/test/integration/cypress_spec.js
@@ -411,15 +411,15 @@ describe('lib/cypress', () => {
       })
     })
 
-    it('runs project by limiting spec files via config.testFiles string glob pattern', function () {
+    it('runs project by limiting spec files via config.e2e.specPattern string glob pattern', function () {
       return cypress.start([`--run-project=${this.todosPath}`, `--config={"e2e":{"specPattern":"${this.todosPath}/tests/test2.coffee"}}`])
       .then(() => {
         expect(browsers.open).to.be.calledWithMatch(ELECTRON_BROWSER, { url: 'http://localhost:8888/__/#/specs/runner?file=tests/test2.coffee' })
         this.expectExitWith(0)
       })
     })
 
-    it('runs project by limiting spec files via config.testFiles as a JSON array of string glob patterns', function () {
+    it('runs project by limiting spec files via config.e2e.specPattern as a JSON array of string glob patterns', function () {
       return cypress.start([`--run-project=${this.todosPath}`, '--config={"e2e":{"specPattern":["**/test2.coffee","**/test1.js"]}}'])
       .then(() => {
         expect(browsers.open).to.be.calledWithMatch(ELECTRON_BROWSER, { url: 'http://localhost:8888/__/#/specs/runner?file=tests/test2.coffee' })

diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts
@@ -29,7 +29,7 @@ export interface FullConfig extends Partial<Cypress.RuntimeConfigOptions & Cypre
 // and are required when creating a project.
 export type ReceivedCypressOptions =
   Pick<Cypress.RuntimeConfigOptions, 'hosts' | 'projectName' | 'clientRoute' | 'devServerPublicPathRoute' | 'namespace' | 'report' | 'socketIoCookie' | 'configFile' | 'isTextTerminal' | 'isNewProject' | 'proxyUrl' | 'browsers' | 'browserUrl' | 'socketIoRoute' | 'arch' | 'platform' | 'spec' | 'specs' | 'browser' | 'version' | 'remote'>
-  & Pick<Cypress.ResolvedConfigOptions, 'chromeWebSecurity' | 'supportFolder' | 'experimentalSourceRewriting' | 'fixturesFolder' | 'reporter' | 'reporterOptions' | 'screenshotsFolder' | 'pluginsFile' | 'supportFile' | 'baseUrl' | 'viewportHeight' | 'viewportWidth' | 'port' | 'experimentalInteractiveRunEvents' | 'userAgent' | 'downloadsFolder' | 'env' | 'testFiles' | 'excludeSpecPattern' | 'specPattern'> // TODO: Figure out how to type this better.
+  & Pick<Cypress.ResolvedConfigOptions, 'chromeWebSecurity' | 'supportFolder' | 'experimentalSourceRewriting' | 'fixturesFolder' | 'reporter' | 'reporterOptions' | 'screenshotsFolder' | 'pluginsFile' | 'supportFile' | 'baseUrl' | 'viewportHeight' | 'viewportWidth' | 'port' | 'experimentalInteractiveRunEvents' | 'userAgent' | 'downloadsFolder' | 'env' | 'excludeSpecPattern' | 'specPattern'> // TODO: Figure out how to type this better.
 
 export interface SampleConfigFile{
   status: 'changes' | 'valid' | 'skipped' | 'error'

diff --git a/system-tests/__snapshots__/config_spec.js b/system-tests/__snapshots__/config_spec.js
@@ -281,3 +281,23 @@ Please remove this option or add this as an e2e testing type property: e2e.baseU
 https://on.cypress.io/migration-guide
 
 `
+
+exports['e2e config throws an error if testFiles is set on the config file 1'] = `
+The testFiles configuration option is now invalid when set on the config object in Cypress version 10.0.0.
+
+ It is now renamed to specPattern and configured separately as a testing type property: e2e.specPattern and component.specPattern
+
+ 
+
+{
+  e2e: {
+    specPattern: '...',
+  },
+  component: {
+    specPattern: '...',
+  },
+}
+
+ https://on.cypress.io/migration-guide
+
+`
diff --git a/system-tests/projects/invalid-root-level-config/invalid-testFiles-config.js b/system-tests/projects/invalid-root-level-config/invalid-testFiles-config.js
@@ -0,0 +1,4 @@
+module.exports = {
+  testFiles: 'cypress/support/e2e.js',
+  e2e: {},
+}
diff --git a/system-tests/projects/same-fixtures-integration-folders/cypress.config.js b/system-tests/projects/same-fixtures-integration-folders/cypress.config.js
@@ -1,7 +1,6 @@
 module.exports = {
   'pluginsFile': false,
   'fixturesFolder': 'cypress/e2e',
-  'testFiles': '**/*spec.js',
   'e2e': {
     'supportFile': false,
   },

diff --git a/system-tests/projects/unify-onboarding-with-config/cypress.config.js b/system-tests/projects/unify-onboarding-with-config/cypress.config.js
@@ -3,7 +3,7 @@ const { devServer } = require('@cypress/webpack-dev-server')
 module.exports = {
   component: {
     supportFile: false,
-    testFiles: '**/*cy-spec.{js,jsx,ts,tsx}',
+    specPattern: '**/*cy-spec.{js,jsx,ts,tsx}',
     componentFolder: 'src',
     devServer,
     devServerConfig: {

diff --git a/system-tests/test/config_spec.js b/system-tests/test/config_spec.js
@@ -169,4 +169,15 @@ describe('e2e config', () => {
       snapshot: true,
     })
   })
+
+  it('throws an error if testFiles is set on the config file', async function () {
+    await Fixtures.scaffoldProject('invalid-root-level-config')
+
+    return systemTests.exec(this, {
+      project: 'invalid-root-level-config',
+      configFile: 'invalid-testFiles-config.js',
+      expectedExitCode: 1,
+      snapshot: true,
+    })
+  })
 })