cypress/packages/server/test/unit/append_electron_switches_spec.ts at 57583f2e47c89ffabc32d01452e6275c2ce60e5a · cypress-io/cypress · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
import os from 'os'
import sinon from 'sinon'
import mockedEnv from 'mocked-env'
import { appendElectronSwitches } from '../../lib/append_electron_switches'

describe('lib/append_electron_switches', () => {
  beforeEach(() => {
    sinon.stub(os, 'platform').returns('linux')
  })

  afterEach(() => {
    sinon.restore()
  })

  // @see https://github.com/electron/electron/issues/46538
  // @see https://github.com/cypress-io/cypress/issues/32361
  context('sets gtk-version=3 in Electron >= 36', () => {
    it('sets launch args', async () => {
      const mockApp = {
        commandLine: {
          appendSwitch: sinon.stub(),
        },
      } as unknown as Electron.App

      appendElectronSwitches(mockApp)
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--gtk-version', '3')
    })
  })

  context('disables hardware acceleration on Linux', () => {
    it('disables hardware acceleration', async () => {
      const mockApp = {
        disableHardwareAcceleration: sinon.stub(),
        commandLine: {
          appendSwitch: sinon.stub(),
        },
      } as unknown as Electron.App

      appendElectronSwitches(mockApp)
      expect(mockApp.disableHardwareAcceleration).to.have.been.called
    })
  })

  context('parses ELECTRON_EXTRA_LAUNCH_ARGS', () => {
    let restore = null

    afterEach(() => {
      if (restore) {
        return restore()
      }
    })

    it('sets launch args', async () => {
      restore = mockedEnv({
        ELECTRON_EXTRA_LAUNCH_ARGS: '--foo --bar=baz --quux=true',
      })

      const mockApp = {
        disableHardwareAcceleration: sinon.stub(),
        commandLine: {
          appendSwitch: sinon.stub(),
        },
      } as unknown as Electron.App

      appendElectronSwitches(mockApp)
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--foo')
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--bar', 'baz')

      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--quux', 'true')
    })

    it('sets launch args with zero', async () => {
      restore = mockedEnv({
        ELECTRON_EXTRA_LAUNCH_ARGS: '--foo --bar=baz --quux=0',
      })

      const mockApp = {
        disableHardwareAcceleration: sinon.stub(),
        commandLine: {
          appendSwitch: sinon.stub(),
        },
      } as unknown as Electron.App

      appendElectronSwitches(mockApp)
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--foo')
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--bar', 'baz')

      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--quux', '0')
    })

    it('sets launch args with false', async () => {
      restore = mockedEnv({
        ELECTRON_EXTRA_LAUNCH_ARGS: '--foo --bar=baz --quux=false',
      })

      const mockApp = {
        disableHardwareAcceleration: sinon.stub(),
        commandLine: {
          appendSwitch: sinon.stub(),
        },
      } as unknown as Electron.App

      appendElectronSwitches(mockApp)

      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--foo')
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--bar', 'baz')

      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--quux', 'false')
    })

    it('sets launch args with multiple values inside quotes', async () => {
      restore = mockedEnv({
        ELECTRON_EXTRA_LAUNCH_ARGS: `--foo --ipsum=0 --bar=--baz=quux --lorem='--ipsum=dolor --sit=amet'`,
      })

      const mockApp = {
        disableHardwareAcceleration: sinon.stub(),
        commandLine: {
          appendSwitch: sinon.stub(),
        },
      } as unknown as Electron.App

      appendElectronSwitches(mockApp)
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--foo')
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--ipsum', '0')
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--bar', '--baz=quux')
      expect(mockApp.commandLine.appendSwitch).to.have.been.calledWith('--lorem', '--ipsum=dolor --sit=amet')
    })
  })
})