Skip to content

Commit

Permalink
chore: Address skipped specs in server package (#22356)
Browse files Browse the repository at this point in the history 
* chore: Un-skip some tests

* chore: Unskip more tests

* chore: Use exec rather than spawn

* chore: Fix test

* chore: Remove events_spec tests

* chore: Add defaultValue for specPattern option

* chore: Remove default value

* chore: Use os to determine system arch and platform during testing

* chore: Add comment for specPattern defaultValue

* chore: Remove comment
  • Loading branch information
@astone123
astone123 authored Jun 27, 2022
1 parent 3ee77a8 commit 22d2c31
Show file tree
Hide file tree
Showing 13 changed files with 55 additions and 322 deletions.
1 change: 1 addition & 0 deletions packages/config/__snapshots__/index.spec.ts.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ exports['config/src/index .getPublicConfigKeys returns list of public config key
"viewportWidth",
"waitForAnimations",
"watchForFileChanges",
"specPattern",
"browsers",
"hosts",
"isInteractive",
Expand Down
6 changes: 6 additions & 0 deletions packages/config/src/options.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,12 @@ const resolvedOptions: Array<ResolvedConfigOption> = [
canUpdateDuringTestTime: false,
requireRestartOnChange: 'server',
},
// Possibly add a defaultValue for specPattern https://github.com/cypress-io/cypress/issues/22507
{
name: 'specPattern',
validation: validate.isStringOrArrayOfStrings,
canUpdateDuringTestTime: false,
},
]

const runtimeOptions: Array<RuntimeConfigOption> = [
Expand Down
4 changes: 2 additions & 2 deletions packages/server/test/integration/cli_spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ describe('CLI Interface', () => {
})
})

// TODO:(tgriesser) originally skipped this, not sure why
it.skip('writes out package.json and exits', (done) => {
// This fails on MacOS due to an apparent limit on the buffer size of stdout
it('writes out package.json and exits', (done) => {
return cp.exec('npm run dev -- --return-pkg', { env }, (err, stdout, stderr) => {
if (err) {
done(err)
Expand Down
90 changes: 3 additions & 87 deletions packages/server/test/integration/cypress_spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -473,33 +473,6 @@ describe('lib/cypress', () => {
})
})

// NOTE: Removal of fixtures is not supported in new flow
it.skip('removes fixtures when they exist and fixturesFolder is false', function (done) {
ctx.actions.project.setCurrentProjectAndTestingTypeForTestSetup(this.idsPath)

ctx.lifecycleManager.getFullInitialConfig()
.then((cfg) => {
this.cfg = cfg

return fs.statAsync(this.cfg.fixturesFolder)
}).then(() => {
return settings.read(this.idsPath)
}).then((json) => {
json.fixturesFolder = false

return settings.writeForTesting(this.idsPath, json)
}).then(() => {
return cypress.start([`--run-project=${this.idsPath}`])
}).then(() => {
return fs.statAsync(this.cfg.fixturesFolder)
.then(() => {
throw new Error('fixturesFolder should not exist!')
}).catch(() => {
return done()
})
})
})

it('runs project headlessly and displays gui', function () {
return cypress.start([`--run-project=${this.todosPath}`, '--headed'])
.then(() => {
Expand Down Expand Up @@ -727,13 +700,12 @@ describe('lib/cypress', () => {
})
})

// TODO: test this
it.skip('logs error and exits when project has cypress.config.js syntax error', function () {
it('logs error and exits when project has cypress.config.js syntax error', function () {
return fs.writeFileAsync(`${this.todosPath}/cypress.config.js`, `module.exports = {`)
.then(() => {
return cypress.start([`--run-project=${this.todosPath}`])
}).then(() => {
this.expectExitWithErr('ERROR_READING_FILE', this.todosPath)
this.expectExitWithErr('CONFIG_FILE_REQUIRE_ERROR', this.todosPath)
})
})

Expand Down Expand Up @@ -1143,8 +1115,7 @@ describe('lib/cypress', () => {
})

describe('--config-file', () => {
// TODO: fix
it.skip(`with a custom config file fails when it doesn't exist`, function () {
it(`with a custom config file fails when it doesn't exist`, function () {
this.filename = 'abcdefgh.test.js'

return fs.statAsync(path.join(this.todosPath, this.filename))
Expand Down Expand Up @@ -1729,61 +1700,6 @@ describe('lib/cypress', () => {
})
})
})

// NOTE: skipped because we want to ensure this is captured in v10
it.skip('sends warning when baseUrl cannot be verified', function () {
const bus = new EE()
const event = { sender: { send: sinon.stub() } }
const warning = { message: 'Blah blah baseUrl blah blah' }

sinon.stub(ServerE2E.prototype, 'open').resolves([2121, warning])

return cypress.start(['--port=2121', '--config', 'pageLoadTimeout=1000', '--foo=bar', '--env=baz=baz'])
.then(() => {
const options = Events.start.firstCall.args[0]

Events.handleEvent(options, bus, event, 123, 'on:project:warning')

return Events.handleEvent(options, bus, event, 123, 'open:project', this.todosPath)
}).then(() => {
expect(event.sender.send.withArgs('response').firstCall.args[1].data).to.eql(warning)
})
})

describe('--config-file', () => {
beforeEach(function () {
this.filename = 'foo.bar.baz.asdf.quux.json'
this.open = sinon.stub(ServerE2E.prototype, 'open').resolves([])
})

// TODO: (tgriesser) needs a system test, the mocking here no longer is correct
it.skip('reads config from a custom config file', function () {
const bus = new EE()

return fs.writeJson(path.join(this.pristinePath, this.filename), {
env: { foo: 'bar' },
port: 2020,
}).then(() => {
return cypress.start([
`--config-file=${this.filename}`,
])
.then(() => {
const options = Events.start.firstCall.args[0]

return Events.handleEvent(options, bus, {}, 123, 'open:project', this.pristinePath)
})
.then(() => {
expect(this.open).to.be.called

const cfg = this.open.getCall(0).args[0]

expect(cfg.env.foo).to.equal('bar')

expect(cfg.port).to.equal(2020)
})
})
})
})
})

context('--cwd', () => {
Expand Down
7 changes: 0 additions & 7 deletions packages/server/test/unit/browsers/firefox_spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,13 +279,6 @@ describe('lib/browsers/firefox', () => {
})
})

// TODO: pick open port for debugger
it.skip('finds remote port for firefox debugger', function () {
return firefox.open(this.browser, 'http://', this.options, this.automation).then(() => {
// expect(firefoxUtil.findRemotePort).to.be.called
})
})

it('sets proxy-related preferences if specified', function () {
this.options.proxyServer = 'http://proxy-server:1234'

Expand Down
44 changes: 15 additions & 29 deletions packages/server/test/unit/config_spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ const config = require(`../../lib/config`)
const errors = require(`../../lib/errors`)
const configUtil = require(`../../lib/util/config`)

const os = require('node:os')

describe('lib/config', () => {
before(function () {
this.env = process.env
Expand Down Expand Up @@ -157,18 +159,10 @@ describe('lib/config', () => {
return this.expectValidationPasses()
})

// NOTE: Validated in real use
it.skip('validates cypress.config.js', function () {
it('validates cypress.config.js', function () {
this.setup({ reporter: 5 })

return this.expectValidationFails('cypress.config.{js,ts,mjs,cjs}')
})

// NOTE: Validated in real use
it.skip('validates cypress.env.json', function () {
this.setup({}, { reporter: 5 })

return this.expectValidationFails('cypress.env.json')
return this.expectValidationFails('Expected reporter to be a string')
})

it('only validates known values', function () {
Expand Down Expand Up @@ -577,28 +571,27 @@ describe('lib/config', () => {
})
})

// TODO:(lachlan): after mega PR
context.skip('specPattern', () => {
context('specPattern', () => {
it('passes if a string', function () {
this.setup({ e2e: { specPattern: '**/*.coffee' } })
this.setup({ e2e: { supportFile: false, specPattern: '**/*.coffee' } })

return this.expectValidationPasses()
})

it('passes if an array of strings', function () {
this.setup({ e2e: { specPattern: ['**/*.coffee'] } })
this.setup({ e2e: { supportFile: false, specPattern: ['**/*.coffee'] } })

return this.expectValidationPasses()
})

it('fails if not a string or array', function () {
this.setup({ e2e: { specPattern: 42 } })
this.setup({ e2e: { supportFile: false, specPattern: 42 } })

return this.expectValidationFails('be a string or an array of strings')
})

it('fails if not an array of strings', function () {
this.setup({ e2e: { specPattern: [5] } })
this.setup({ e2e: { supportFile: false, specPattern: [5] } })

return this.expectValidationFails('be a string or an array of strings')
.then(() => {
Expand Down Expand Up @@ -1466,8 +1459,7 @@ describe('lib/config', () => {
expect(warning).to.be.calledWith('FIREFOX_GC_INTERVAL_REMOVED')
})

// TODO:(lachlan) after mega PR
describe.skip('.resolved', () => {
describe('.resolved', () => {
it('sets reporter and port to cli', () => {
const obj = {
projectRoot: '/foo/bar',
Expand All @@ -1483,22 +1475,20 @@ describe('lib/config', () => {
.then((cfg) => {
expect(cfg.resolved).to.deep.eq({
animationDistanceThreshold: { value: 5, from: 'default' },
arch: { value: os.arch(), from: 'default' },
baseUrl: { value: null, from: 'default' },
blockHosts: { value: null, from: 'default' },
browsers: { value: [], from: 'default' },
chromeWebSecurity: { value: true, from: 'default' },
clientCertificates: { value: [], from: 'default' },
component: { from: 'default', value: {} },
defaultCommandTimeout: { value: 4000, from: 'default' },
downloadsFolder: { value: 'cypress/downloads', from: 'default' },
e2e: { from: 'default', value: {} },
env: {},
execTimeout: { value: 60000, from: 'default' },
experimentalFetchPolyfill: { value: false, from: 'default' },
experimentalInteractiveRunEvents: { value: false, from: 'default' },
experimentalSessionAndOrigin: { value: false, from: 'default' },
experimentalSourceRewriting: { value: false, from: 'default' },
experimentalStudio: { value: false, from: 'default' },
fileServerFolder: { value: '', from: 'default' },
fixturesFolder: { value: 'cypress/fixtures', from: 'default' },
hosts: { value: null, from: 'default' },
Expand All @@ -1509,6 +1499,7 @@ describe('lib/config', () => {
modifyObstructiveCode: { value: true, from: 'default' },
numTestsKeptInMemory: { value: 50, from: 'default' },
pageLoadTimeout: { value: 60000, from: 'default' },
platform: { value: os.platform(), from: 'default' },
port: { value: 1234, from: 'cli' },
projectId: { value: null, from: 'default' },
redirectionLimit: { value: 20, from: 'default' },
Expand All @@ -1525,7 +1516,6 @@ describe('lib/config', () => {
supportFile: { value: false, from: 'config' },
supportFolder: { value: false, from: 'default' },
taskTimeout: { value: 60000, from: 'default' },
specPattern: { value: '**/*.*', from: 'default' },
trashAssetsBeforeRuns: { value: true, from: 'default' },
userAgent: { value: null, from: 'default' },
video: { value: true, from: 'default' },
Expand Down Expand Up @@ -1570,22 +1560,20 @@ describe('lib/config', () => {
return config.mergeDefaults(obj, options)
.then((cfg) => {
expect(cfg.resolved).to.deep.eq({
arch: { value: os.arch(), from: 'default' },
animationDistanceThreshold: { value: 5, from: 'default' },
baseUrl: { value: 'http://localhost:8080', from: 'config' },
blockHosts: { value: null, from: 'default' },
browsers: { value: [], from: 'default' },
chromeWebSecurity: { value: true, from: 'default' },
component: { from: 'default', value: {} },
clientCertificates: { value: [], from: 'default' },
defaultCommandTimeout: { value: 4000, from: 'default' },
downloadsFolder: { value: 'cypress/downloads', from: 'default' },
e2e: { from: 'default', value: {} },
execTimeout: { value: 60000, from: 'default' },
experimentalFetchPolyfill: { value: false, from: 'default' },
experimentalInteractiveRunEvents: { value: false, from: 'default' },
experimentalSessionAndOrigin: { value: false, from: 'default' },
experimentalSourceRewriting: { value: false, from: 'default' },
experimentalStudio: { value: false, from: 'default' },
env: {
foo: {
value: 'foo',
Expand Down Expand Up @@ -1618,6 +1606,7 @@ describe('lib/config', () => {
modifyObstructiveCode: { value: true, from: 'default' },
numTestsKeptInMemory: { value: 50, from: 'default' },
pageLoadTimeout: { value: 60000, from: 'default' },
platform: { value: os.platform(), from: 'default' },
port: { value: 2020, from: 'config' },
projectId: { value: 'projectId123', from: 'env' },
redirectionLimit: { value: 20, from: 'default' },
Expand All @@ -1634,7 +1623,6 @@ describe('lib/config', () => {
supportFile: { value: false, from: 'config' },
supportFolder: { value: false, from: 'default' },
taskTimeout: { value: 60000, from: 'default' },
specPattern: { value: '**/*.*', from: 'default' },
trashAssetsBeforeRuns: { value: true, from: 'default' },
userAgent: { value: null, from: 'default' },
video: { value: true, from: 'default' },
Expand Down Expand Up @@ -1861,9 +1849,7 @@ describe('lib/config', () => {
})
})

// TODO: Figure out the behavior on updateWithPluginValues, should we check
// the config from cfg, or get it from the data-context?
it.skip('catches browsers=null returned from plugins', () => {
it('catches browsers=null returned from plugins', () => {
const browser = {
name: 'fake browser name',
family: 'chromium',
Expand Down
Loading

5 comments on commit 22d2c31

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 22d2c31 Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the linux x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/10.3.0/linux-x64/develop-22d2c31d856203b5110a1ed3270d0c93467e13fe/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 22d2c31 Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the linux arm64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/10.3.0/linux-arm64/develop-22d2c31d856203b5110a1ed3270d0c93467e13fe/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 22d2c31 Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the darwin arm64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/10.3.0/darwin-arm64/develop-22d2c31d856203b5110a1ed3270d0c93467e13fe/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 22d2c31 Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the darwin x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/10.3.0/darwin-x64/develop-22d2c31d856203b5110a1ed3270d0c93467e13fe/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 22d2c31 Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the win32 x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/10.3.0/win32-x64/develop-22d2c31d856203b5110a1ed3270d0c93467e13fe/cypress.tgz

Please sign in to comment.