add unit test for xvfb options -screen

cypress-io · Jan 22, 2020 · 9ac5fe3 · 9ac5fe3 · cypress-bot · Jan 22, 2020
1 parent ee0d6fa
commit 9ac5fe3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/cli/lib/exec/xvfb.js b/cli/lib/exec/xvfb.js
@@ -7,21 +7,27 @@ const debugXvfb = require('debug')('cypress:xvfb')
 const { throwFormErrorText, errors } = require('../errors')
 const util = require('../util')
 
-const xvfb = Promise.promisifyAll(new Xvfb({
+const xvfbOptions = {
   timeout: 30000, // milliseconds
-  xvfb_args: ['-screen', '0', '1280x1024x24'], // need to explicitly define screen otherwise electron will crash
+  // need to explicitly define screen otherwise electron will crash
+  // https://github.com/cypress-io/cypress/issues/6184
+  xvfb_args: ['-screen', '0', '1280x1024x24'],
   onStderrData (data) {
     if (debugXvfb.enabled) {
       debugXvfb(data.toString())
     }
   },
-}))
+}
+
+const xvfb = Promise.promisifyAll(new Xvfb(xvfbOptions))
 
 module.exports = {
   _debugXvfb: debugXvfb, // expose for testing
 
   _xvfb: xvfb, // expose for testing
 
+  _xvfbOptions: xvfbOptions, // expose for testing
+
   start () {
     debug('Starting Xvfb')
 

diff --git a/cli/test/lib/exec/xvfb_spec.js b/cli/test/lib/exec/xvfb_spec.js
@@ -30,6 +30,12 @@ describe('lib/exec/xvfb', function () {
     })
   })
 
+  context('xvfbOptions', function () {
+    it('sets explicit screen', () => {
+      expect(xvfb._xvfbOptions).to.have.property('xvfb_args').that.includes('-screen')
+    })
+  })
+
   context('#start', function () {
     it('passes', function () {
       sinon.stub(xvfb._xvfb, 'startAsync').resolves()