feat: Add configuration option for disabling screenshots (#8083)

Co-authored-by: Jennifer Shehane <[email protected]>
cypress-io · Jul 28, 2020 · fbce860 · fbce860 · cypress-bot · Jul 28, 2020
1 parent dbe88da
commit fbce860
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 1 deletion.
diff --git a/cli/schema/cypress.schema.json b/cli/schema/cypress.schema.json
@@ -124,6 +124,11 @@
       "default": "cypress/plugins/index.js",
       "description": "Path to plugins file. (Pass false to disable)"
     },
+    "screenshotOnRunFailure": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether Cypress will take a screenshot when a test fails during cypress run"
+    },
     "screenshotsFolder": {
       "type": "string",
       "default": "cypress/screenshots",

diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -2421,6 +2421,11 @@ declare namespace Cypress {
      * @example 1.2.3
      */
     resolvedNodeVersion: string
+    /**
+     * Whether Cypress will take a screenshot when a test fails during cypress run.
+     * @default true
+     */
+    screenshotOnRunFailure: boolean
     /**
      * Path to folder where screenshots will be saved from [cy.screenshot()](https://on.cypress.io/screenshot) command or after a headless or CI run’s test failure
      * @default "cypress/screenshots"

diff --git a/packages/driver/cypress/integration/commands/screenshot_spec.js b/packages/driver/cypress/integration/commands/screenshot_spec.js
@@ -94,6 +94,25 @@ describe('src/cy/commands/screenshot', () => {
       })
     })
 
+    it('is noop when screenshotOnRunFailure is false', () => {
+      Cypress.config('isInteractive', false)
+      Cypress.config('screenshotOnRunFailure', false)
+
+      cy.spy(Cypress, 'action').log(false)
+
+      const test = {
+        err: new Error,
+      }
+
+      const runnable = cy.state('runnable')
+
+      Cypress.action('runner:runnable:after:run:async', test, runnable)
+      .then(() => {
+        expect(Cypress.action).not.to.be.calledWith('cy:test:set:state')
+        expect(Cypress.automation).not.to.be.called
+      })
+    })
+
     it('sends before/after events', function () {
       Cypress.config('isInteractive', false)
       this.screenshotConfig.scale = false

diff --git a/packages/driver/src/cy/commands/screenshot.js b/packages/driver/src/cy/commands/screenshot.js
@@ -388,7 +388,7 @@ module.exports = function (Commands, Cypress, cy, state, config) {
   Cypress.on('runnable:after:run:async', (test, runnable) => {
     const screenshotConfig = $Screenshot.getConfig()
 
-    if (!test.err || !screenshotConfig.screenshotOnRunFailure || config('isInteractive') || test.err.isPending) {
+    if (!test.err || !screenshotConfig.screenshotOnRunFailure || config('isInteractive') || test.err.isPending || !config('screenshotOnRunFailure')) {
       return
     }
 

diff --git a/packages/server/lib/config.js b/packages/server/lib/config.js
@@ -76,6 +76,7 @@ viewportHeight                  responseTimeout
 video                           taskTimeout
 videoCompression
 videoUploadOnPasses
+screenshotOnRunFailure
 watchForFileChanges
 waitForAnimations               resolvedNodeVersion
 nodeVersion                     resolvedNodePath
@@ -142,6 +143,7 @@ const CONFIG_DEFAULTS = {
   video: true,
   videoCompression: 32,
   videoUploadOnPasses: true,
+  screenshotOnRunFailure: true,
   modifyObstructiveCode: true,
   chromeWebSecurity: true,
   waitForAnimations: true,
@@ -212,6 +214,7 @@ const validationRules = {
   videoCompression: v.isNumberOrFalse,
   videosFolder: v.isString,
   videoUploadOnPasses: v.isBoolean,
+  screenshotOnRunFailure: v.isBoolean,
   viewportHeight: v.isNumber,
   viewportWidth: v.isNumber,
   waitForAnimations: v.isBoolean,

diff --git a/packages/server/test/unit/config_spec.js b/packages/server/test/unit/config_spec.js
@@ -593,6 +593,20 @@ describe('lib/config', () => {
         })
       })
 
+      context('screenshotOnRunFailure', () => {
+        it('passes if a boolean', function () {
+          this.setup({ screenshotOnRunFailure: false })
+
+          return this.expectValidationPasses()
+        })
+
+        it('fails if not a boolean', function () {
+          this.setup({ screenshotOnRunFailure: 42 })
+
+          return this.expectValidationFails('be a boolean')
+        })
+      })
+
       context('viewportHeight', () => {
         it('passes if a number', function () {
           this.setup({ viewportHeight: 10 })
@@ -1125,6 +1139,7 @@ describe('lib/config', () => {
             video: { value: true, from: 'default' },
             videoCompression: { value: 32, from: 'default' },
             videoUploadOnPasses: { value: true, from: 'default' },
+            screenshotOnRunFailure: { value: true, from: 'default' },
             videosFolder: { value: 'cypress/videos', from: 'default' },
             supportFile: { value: 'cypress/support', from: 'default' },
             pluginsFile: { value: 'cypress/plugins', from: 'default' },
@@ -1201,6 +1216,7 @@ describe('lib/config', () => {
             video: { value: true, from: 'default' },
             videoCompression: { value: 32, from: 'default' },
             videoUploadOnPasses: { value: true, from: 'default' },
+            screenshotOnRunFailure: { value: true, from: 'default' },
             videosFolder: { value: 'cypress/videos', from: 'default' },
             supportFile: { value: 'cypress/support', from: 'default' },
             pluginsFile: { value: 'cypress/plugins', from: 'default' },