feat: add CYPRESS_SKIP_VERIFY option to suppress verification (#29836)

* misc: add `CYPRESS_SKIP_VERIFY` option to suppress verification * Update CHANGELOG.md * Move changelog entry to feature * Whoops - features * Update CHANGELOG.md * Update cli/lib/tasks/verify.js Co-authored-by: Bill Glesias <[email protected]> * Update cli/lib/tasks/verify.js Co-authored-by: Bill Glesias <[email protected]> * Update cli/lib/tasks/verify.js Co-authored-by: Bill Glesias <[email protected]> * Appease the linter --------- Co-authored-by: Jennifer Shehane <[email protected]> Co-authored-by: Bill Glesias <[email protected]>
cypress-io · Aug 16, 2024 · 482358b · 482358b · cypress-bot · Aug 16, 2024
1 parent 8b54d3e
commit 482358b
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -1,12 +1,16 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
-## 13.13.4
+## 13.14.0
 
 _Released 8/27/2024 (PENDING)_
 
 **Performance:**
 
 - Fixed a potential memory leak in the Cypress server when re-connecting to an unintentionally disconnected CDP connection. Fixes [#29744](https://github.com/cypress-io/cypress/issues/29744). Addressed in [#29988](https://github.com/cypress-io/cypress/pull/29988)
 
+**Features:**
+
+- Added a `CYPRESS_SKIP_VERIFY` flag to enable suppressing Cypress verification checks. Addresses [#22243](https://github.com/cypress-io/cypress/issues/22243).
+
 **Dependency Updates:**
 
 - Updated `detect-port` from `1.3.0` to `1.6.1`. Addressed in [#30038](https://github.com/cypress-io/cypress/pull/30038).

diff --git a/cli/lib/tasks/verify.js b/cli/lib/tasks/verify.js
@@ -258,8 +258,15 @@ const start = (options = {}) => {
     force: false,
     welcomeMessage: true,
     smokeTestTimeout: VERIFY_TEST_RUNNER_TIMEOUT_MS,
+    skipVerify: util.getEnv('CYPRESS_SKIP_VERIFY') === 'true',
   })
 
+  if (options.skipVerify) {
+    debug('skipping verification of the Cypress app')
+
+    return Promise.resolve()
+  }
+
   if (options.dev) {
     return runSmokeTest('', options)
   }

diff --git a/cli/test/lib/tasks/verify_spec.js b/cli/test/lib/tasks/verify_spec.js
@@ -97,6 +97,16 @@ context('lib/tasks/verify', () => {
     expect(newVerifyInstance.VERIFY_TEST_RUNNER_TIMEOUT_MS).to.eql(DEFAULT_VERIFY_TIMEOUT)
   })
 
+  it('returns early when `CYPRESS_SKIP_VERIFY` is set to true', () => {
+    process.env.CYPRESS_SKIP_VERIFY = 'true'
+    delete require.cache[require.resolve(`${lib}/tasks/verify`)]
+    const newVerifyInstance = require(`${lib}/tasks/verify`)
+
+    return newVerifyInstance.start().then((result) => {
+      expect(result).to.eq(undefined)
+    })
+  })
+
   it('logs error and exits when no version of Cypress is installed', () => {
     return verify
     .start()