This Node.js version is used to:
+ {isFileJSON(project.configFile)
+ ? undefined
+ : - Execute code in the {configFileFormatted(project.configFile)}.
}
- Build files in the {formatIntegrationFolder()} folder.
- Build files in the
cypress/support folder.
- Execute code in the {formatPluginsFile() ? formatPluginsFile() : 'plugins'} file.
diff --git a/packages/desktop-gui/src/settings/project-id.jsx b/packages/desktop-gui/src/settings/project-id.jsx
index 3efa639d1229..18593a8e77cf 100644
--- a/packages/desktop-gui/src/settings/project-id.jsx
+++ b/packages/desktop-gui/src/settings/project-id.jsx
@@ -3,6 +3,7 @@ import React from 'react'
import Tooltip from '@cypress/react-tooltip'
import ipc from '../lib/ipc'
+import { isFileJSON } from '../lib/utils'
import { configFileFormatted } from '../lib/config-file-formatted'
const openProjectIdHelp = (e) => {
@@ -19,10 +20,6 @@ const openProjectIdHelp = (e) => {
const ProjectId = observer(({ project }) => {
if (!project.id) return null
- const projectIdJsonConfig = {
- projectId: project.id,
- }
-
return (
)
diff --git a/packages/desktop-gui/src/settings/project-id_spec.jsx b/packages/desktop-gui/src/settings/project-id_spec.jsx
index 2bbd1204f57b..c97571a32832 100644
--- a/packages/desktop-gui/src/settings/project-id_spec.jsx
+++ b/packages/desktop-gui/src/settings/project-id_spec.jsx
@@ -44,4 +44,14 @@ describe('ProjectId', () => {
cy.get('@externalOpen').should('have.been.called')
})
+
+ it('shows a different output when configFile is js', () => {
+ mount(, {
+ stylesheets: '/__root/dist/app.css',
+ })
+
+ cy.get('[data-cy=project-id] pre').then(($pre) => {
+ expect($pre.text()).to.contain('module.exports = ')
+ })
+ })
})
diff --git a/packages/server/lib/config.ts b/packages/server/lib/config.ts
index 37afe5e10e60..17aad0a1a06c 100644
--- a/packages/server/lib/config.ts
+++ b/packages/server/lib/config.ts
@@ -9,7 +9,7 @@ import scaffold from './scaffold'
import { fs } from './util/fs'
import keys from './util/keys'
import origin from './util/origin'
-import settings from './util/settings'
+import * as settings from './util/settings'
import Debug from 'debug'
import pathHelpers from './util/path_helpers'
import findSystemNode from './util/find_system_node'
diff --git a/packages/server/lib/configFiles.ts b/packages/server/lib/configFiles.ts
new file mode 100644
index 000000000000..938003e636ec
--- /dev/null
+++ b/packages/server/lib/configFiles.ts
@@ -0,0 +1,2 @@
+// the first file is the default created file
+export const CYPRESS_CONFIG_FILES = ['cypress.json', 'cypress.config.js']
diff --git a/packages/server/lib/errors.js b/packages/server/lib/errors.js
index e33a20dab4c1..8574c0bd1984 100644
--- a/packages/server/lib/errors.js
+++ b/packages/server/lib/errors.js
@@ -694,6 +694,20 @@ const getMsgByType = function (type, arg1 = {}, arg2, arg3) {
${chalk.yellow(arg1.error)}
Learn more at https://on.cypress.io/reporters`
+ // TODO: update with vetted cypress language
+ case 'NO_DEFAULT_CONFIG_FILE_FOUND':
+ return stripIndent`\
+ Could not find a Cypress configuration file, exiting.
+
+ We looked but did not find a default config file in this folder: ${chalk.blue(arg1)}`
+ // TODO: update with vetted cypress language
+ case 'CONFIG_FILES_LANGUAGE_CONFLICT':
+ return stripIndent`
+ There is both a \`${arg2}\` and a \`${arg3}\` at the location below:
+ ${arg1}
+
+ Cypress does not know which one to read for config. Please remove one of the two and try again.
+ `
case 'CONFIG_FILE_NOT_FOUND':
return stripIndent`\
Could not find a Cypress configuration file, exiting.
diff --git a/packages/server/lib/gui/events.js b/packages/server/lib/gui/events.js
index 25d006069129..3508c3ff1156 100644
--- a/packages/server/lib/gui/events.js
+++ b/packages/server/lib/gui/events.js
@@ -1,5 +1,6 @@
/* eslint-disable no-case-declarations */
const _ = require('lodash')
+const path = require('path')
const ipc = require('electron').ipcMain
const { clipboard } = require('electron')
const debug = require('debug')('cypress:server:events')
@@ -323,6 +324,20 @@ const handleEvent = function (options, bus, event, id, type, arg) {
onWarning,
})
}).call('getConfig')
+ .then((config) => {
+ if (config.configFile && path.isAbsolute(config.configFile)) {
+ config.configFile = path.relative(arg, config.configFile)
+ }
+
+ // those two values make no sense to display in
+ // the GUI
+ if (config.resolved) {
+ config.resolved.configFile = undefined
+ config.resolved.testingType = undefined
+ }
+
+ return config
+ })
.then(send)
.catch(sendErr)
diff --git a/packages/server/lib/modes/run.js b/packages/server/lib/modes/run.js
index 61c1b892afe3..145847dffd99 100644
--- a/packages/server/lib/modes/run.js
+++ b/packages/server/lib/modes/run.js
@@ -11,7 +11,6 @@ const logSymbols = require('log-symbols')
const recordMode = require('./record')
const errors = require('../errors')
-const ProjectStatic = require('../project_static')
const Reporter = require('../reporter')
const browserUtils = require('../browsers')
const { openProject } = require('../open_project')
@@ -609,22 +608,21 @@ const openProjectCreate = (projectRoot, socketId, args) => {
return openProject.create(projectRoot, args, options)
}
-const createAndOpenProject = function (socketId, options) {
+const createAndOpenProject = async function (socketId, options) {
const { projectRoot, projectId } = options
- return ProjectStatic.ensureExists(projectRoot, options)
- .then(() => {
- // open this project without
- // adding it to the global cache
- return openProjectCreate(projectRoot, socketId, options)
- })
- .call('getProject')
+ return openProjectCreate(projectRoot, socketId, options)
+ .then((open_project) => open_project.getProject())
.then((project) => {
- return Promise.props({
+ return Promise.all([
project,
- config: project.getConfig(),
- projectId: getProjectId(project, projectId),
- })
+ project.getConfig(),
+ getProjectId(project, projectId),
+ ]).then(([project, config, projectId]) => ({
+ project,
+ config,
+ projectId,
+ }))
})
}
diff --git a/packages/server/lib/open_project.ts b/packages/server/lib/open_project.ts
index 57836a37ad0d..1a4189fb473a 100644
--- a/packages/server/lib/open_project.ts
+++ b/packages/server/lib/open_project.ts
@@ -37,7 +37,7 @@ export interface LaunchArgs {
_: [string] // Cypress App binary location
config: Record
cwd: string
- browser: Browser
+ browser?: Browser['name']
configFile?: string
project: string // projectRoot
projectRoot: string // same as above
@@ -46,6 +46,12 @@ export interface LaunchArgs {
os: PlatformName
onFocusTests?: () => any
+ /**
+ * in run mode, the path of the project run
+ * path is relative if specified with --project,
+ * absolute if implied by current working directory
+ */
+ runProject?: string
}
// @see https://github.com/cypress-io/cypress/issues/18094
@@ -456,7 +462,7 @@ export class OpenProject {
try {
await this.openProject.initializeConfig()
await this.openProject.open()
- } catch (err) {
+ } catch (err: any) {
if (err.isCypressErr && err.portInUse) {
errors.throw(err.type, err.port)
} else {
diff --git a/packages/server/lib/project-base.ts b/packages/server/lib/project-base.ts
index 3bb01fa130e0..7ccf66ded546 100644
--- a/packages/server/lib/project-base.ts
+++ b/packages/server/lib/project-base.ts
@@ -23,14 +23,14 @@ import system from './util/system'
import user from './user'
import { ensureProp } from './util/class-helpers'
import { fs } from './util/fs'
-import settings from './util/settings'
+import * as settings from './util/settings'
import plugins from './plugins'
import specsUtil from './util/specs'
import Watchers from './watchers'
import devServer from './plugins/dev-server'
import preprocessor from './plugins/preprocessor'
import { SpecsStore } from './specs-store'
-import { checkSupportFile } from './project_utils'
+import { checkSupportFile, getDefaultConfigFilePath } from './project_utils'
import type { LaunchArgs } from './open_project'
// Cannot just use RuntimeConfigOptions as is because some types are not complete.
@@ -54,7 +54,7 @@ type WebSocketOptionsCallback = (...args: any[]) => any
export interface OpenProjectLaunchOptions {
args?: LaunchArgs
- configFile?: string | boolean
+ configFile?: string | false
browsers?: Cypress.Browser[]
// Callback to reload the Desktop GUI when cypress.json is changed.
@@ -516,7 +516,7 @@ export class ProjectBase extends EE {
projectRoot,
}: {
projectRoot: string
- configFile?: string | boolean
+ configFile?: string | false
onSettingsChanged?: false | (() => void)
}) {
// bail if we havent been told to
@@ -690,6 +690,12 @@ export class ProjectBase extends EE {
}
async initializeConfig (): Promise {
+ // set default for "configFile" if undefined
+ if (this.options.configFile === undefined
+ || this.options.configFile === null) {
+ this.options.configFile = await getDefaultConfigFilePath(this.projectRoot, !this.options.args?.runProject)
+ }
+
let theCfg: Cfg = await config.get(this.projectRoot, this.options)
if (theCfg.browsers) {
diff --git a/packages/server/lib/project_static.ts b/packages/server/lib/project_static.ts
index c27b89c8cb86..b216451b2662 100644
--- a/packages/server/lib/project_static.ts
+++ b/packages/server/lib/project_static.ts
@@ -7,8 +7,9 @@ import api from './api'
import cache from './cache'
import user from './user'
import keys from './util/keys'
-import settings from './util/settings'
+import * as settings from './util/settings'
import { ProjectBase } from './project-base'
+import { getDefaultConfigFilePath } from './project_utils'
const debug = Debug('cypress:server:project_static')
@@ -60,7 +61,7 @@ export async function _getProject (clientProject, authToken) {
debug('got project from api')
return _mergeDetails(clientProject, project)
- } catch (err) {
+ } catch (err: any) {
debug('failed to get project from api', err.statusCode)
switch (err.statusCode) {
case 404:
@@ -153,13 +154,10 @@ export async function add (path, options) {
}
}
-export function getId (path) {
- return new ProjectBase({ projectRoot: path, testingType: 'e2e', options: {} }).getProjectId()
-}
+export async function getId (path) {
+ const configFile = await getDefaultConfigFilePath(path)
-export function ensureExists (path, options) {
- // is there a configFile? is the root writable?
- return settings.exists(path, options)
+ return new ProjectBase({ projectRoot: path, testingType: 'e2e', options: { configFile } }).getProjectId()
}
interface ProjectIdOptions{
diff --git a/packages/server/lib/project_utils.ts b/packages/server/lib/project_utils.ts
index c48979e8a377..54c3cab34559 100644
--- a/packages/server/lib/project_utils.ts
+++ b/packages/server/lib/project_utils.ts
@@ -1,10 +1,11 @@
import Debug from 'debug'
import path from 'path'
-import settings from './util/settings'
+import * as settings from './util/settings'
import errors from './errors'
import { fs } from './util/fs'
import { escapeFilenameInUrl } from './util/escape_filename'
+import { CYPRESS_CONFIG_FILES } from './configFiles'
const debug = Debug('cypress:server:project_utils')
@@ -119,7 +120,7 @@ export const checkSupportFile = async ({
configFile,
}: {
supportFile?: string | boolean
- configFile?: string | boolean
+ configFile?: string | false
}) => {
if (supportFile && typeof supportFile === 'string') {
const found = await fs.pathExists(supportFile)
@@ -131,3 +132,26 @@ export const checkSupportFile = async ({
return
}
+
+export async function getDefaultConfigFilePath (projectRoot: string, returnDefaultValueIfNotFound: boolean = true): Promise {
+ const filesInProjectDir = await fs.readdir(projectRoot)
+
+ const foundConfigFiles = CYPRESS_CONFIG_FILES.filter((file) => filesInProjectDir.includes(file))
+
+ // if we only found one default file, it is the one
+ if (foundConfigFiles.length === 1) {
+ return foundConfigFiles[0]
+ }
+
+ // if we found more than one, throw a language conflict
+ if (foundConfigFiles.length > 1) {
+ throw errors.throw('CONFIG_FILES_LANGUAGE_CONFLICT', projectRoot, ...foundConfigFiles)
+ }
+
+ if (returnDefaultValueIfNotFound) {
+ // Default is to create a new `cypress.json` file if one does not exist.
+ return CYPRESS_CONFIG_FILES[0]
+ }
+
+ throw errors.get('NO_DEFAULT_CONFIG_FILE_FOUND', projectRoot)
+}
diff --git a/packages/server/lib/util/require_async.ts b/packages/server/lib/util/require_async.ts
index dc11b7c86c4b..6f7d077cd192 100644
--- a/packages/server/lib/util/require_async.ts
+++ b/packages/server/lib/util/require_async.ts
@@ -14,10 +14,6 @@ let requireProcess: cp.ChildProcess | null
interface RequireAsyncOptions{
projectRoot: string
loadErrorCode: string
- /**
- * members of the object returned that are functions and will need to be wrapped
- */
- functionNames: string[]
}
interface ChildOptions{
diff --git a/packages/server/lib/util/settings.js b/packages/server/lib/util/settings.js
deleted file mode 100644
index d1e13a14c667..000000000000
--- a/packages/server/lib/util/settings.js
+++ /dev/null
@@ -1,265 +0,0 @@
-const _ = require('lodash')
-const Promise = require('bluebird')
-const path = require('path')
-const errors = require('../errors')
-const log = require('../log')
-const { fs } = require('../util/fs')
-const { requireAsync } = require('./require_async')
-const debug = require('debug')('cypress:server:settings')
-
-function jsCode (obj) {
- const objJSON = obj && !_.isEmpty(obj)
- ? JSON.stringify(_.omit(obj, 'configFile'), null, 2)
- : `{
-
-}`
-
- return `module.exports = ${objJSON}
-`
-}
-
-// TODO:
-// think about adding another PSemaphore
-// here since we can read + write the
-// settings at the same time something else
-// is potentially reading it
-
-const flattenCypress = (obj) => {
- return obj.cypress ? obj.cypress : undefined
-}
-
-const maybeVerifyConfigFile = Promise.method((configFile) => {
- if (configFile === false) {
- return
- }
-
- return fs.statAsync(configFile)
-})
-
-const renameVisitToPageLoad = (obj) => {
- const v = obj.visitTimeout
-
- if (v) {
- obj = _.omit(obj, 'visitTimeout')
- obj.pageLoadTimeout = v
-
- return obj
- }
-}
-
-const renameCommandTimeout = (obj) => {
- const c = obj.commandTimeout
-
- if (c) {
- obj = _.omit(obj, 'commandTimeout')
- obj.defaultCommandTimeout = c
-
- return obj
- }
-}
-
-const renameSupportFolder = (obj) => {
- const sf = obj.supportFolder
-
- if (sf) {
- obj = _.omit(obj, 'supportFolder')
- obj.supportFile = sf
-
- return obj
- }
-}
-
-module.exports = {
- _pathToFile (projectRoot, file) {
- return path.isAbsolute(file) ? file : path.join(projectRoot, file)
- },
-
- _err (type, file, err) {
- const e = errors.get(type, file, err)
-
- e.code = err.code
- e.errno = err.errno
- throw e
- },
-
- _logReadErr (file, err) {
- errors.throw('ERROR_READING_FILE', file, err)
- },
-
- _logWriteErr (file, err) {
- return this._err('ERROR_WRITING_FILE', file, err)
- },
-
- _write (file, obj = {}) {
- if (/\.json$/.test(file)) {
- debug('writing json file')
-
- return fs.outputJsonAsync(file, obj, { spaces: 2 })
- .return(obj)
- .catch((err) => {
- return this._logWriteErr(file, err)
- })
- }
-
- debug('writing javascript file')
-
- return fs.writeFileAsync(file, jsCode(obj))
- .return(obj)
- .catch((err) => {
- return this._logWriteErr(file, err)
- })
- },
-
- _applyRewriteRules (obj = {}) {
- return _.reduce([flattenCypress, renameVisitToPageLoad, renameCommandTimeout, renameSupportFolder], (memo, fn) => {
- const ret = fn(memo)
-
- return ret ? ret : memo
- }, _.cloneDeep(obj))
- },
-
- isComponentTesting (options = {}) {
- return options.testingType === 'component'
- },
-
- configFile (options = {}) {
- return options.configFile === false ? false : (options.configFile || 'cypress.json')
- },
-
- id (projectRoot, options = {}) {
- const file = this.pathToConfigFile(projectRoot, options)
-
- return fs.readJsonAsync(file)
- .get('projectId')
- .catch(() => {
- return null
- })
- },
- /**
- * Ensures the project at this root has a config file
- * that is readable and writable by the node process
- * @param {string} projectRoot root of the project
- * @param {object} options
- * @returns
- */
- exists (projectRoot, options = {}) {
- const file = this.pathToConfigFile(projectRoot, options)
-
- // first check if cypress.json exists
- return maybeVerifyConfigFile(file)
- .then(() => {
- // if it does also check that the projectRoot
- // directory is writable
- return fs.accessAsync(projectRoot, fs.W_OK)
- }).catch({ code: 'ENOENT' }, () => {
- // cypress.json does not exist, completely new project
- log('cannot find file %s', file)
-
- return this._err('CONFIG_FILE_NOT_FOUND', this.configFile(options), projectRoot)
- }).catch({ code: 'EACCES' }, { code: 'EPERM' }, () => {
- // we cannot write due to folder permissions
- return errors.warning('FOLDER_NOT_WRITABLE', projectRoot)
- }).catch((err) => {
- if (errors.isCypressErr(err)) {
- throw err
- }
-
- return this._logReadErr(file, err)
- })
- },
-
- read (projectRoot, options = {}) {
- if (options.configFile === false) {
- return Promise.resolve({})
- }
-
- const file = this.pathToConfigFile(projectRoot, options)
-
- return requireAsync(file,
- {
- projectRoot,
- loadErrorCode: 'CONFIG_FILE_ERROR',
- })
- .catch((err) => {
- if (err.type === 'MODULE_NOT_FOUND' || err.code === 'ENOENT') {
- debug('file not found', file)
-
- return this._write(file, {})
- }
-
- return Promise.reject(err)
- })
- .then((configObject = {}) => {
- if (this.isComponentTesting(options) && 'component' in configObject) {
- configObject = { ...configObject, ...configObject.component }
- }
-
- if (!this.isComponentTesting(options) && 'e2e' in configObject) {
- configObject = { ...configObject, ...configObject.e2e }
- }
-
- debug('resolved configObject', configObject)
- const changed = this._applyRewriteRules(configObject)
-
- // if our object is unchanged
- // then just return it
- if (_.isEqual(configObject, changed)) {
- return configObject
- }
-
- // else write the new reduced obj
- return this._write(file, changed)
- .then((config) => {
- return config
- })
- }).catch((err) => {
- debug('an error occured when reading config', err)
- if (errors.isCypressErr(err)) {
- throw err
- }
-
- return this._logReadErr(file, err)
- })
- },
-
- readEnv (projectRoot) {
- const file = this.pathToCypressEnvJson(projectRoot)
-
- return fs.readJsonAsync(file)
- .catch({ code: 'ENOENT' }, () => {
- return {}
- })
- .catch((err) => {
- if (errors.isCypressErr(err)) {
- throw err
- }
-
- return this._logReadErr(file, err)
- })
- },
-
- write (projectRoot, obj = {}, options = {}) {
- if (options.configFile === false) {
- return Promise.resolve({})
- }
-
- return this.read(projectRoot, options)
- .then((settings) => {
- _.extend(settings, obj)
-
- const file = this.pathToConfigFile(projectRoot, options)
-
- return this._write(file, settings)
- })
- },
-
- pathToConfigFile (projectRoot, options = {}) {
- const configFile = this.configFile(options)
-
- return configFile && this._pathToFile(projectRoot, configFile)
- },
-
- pathToCypressEnvJson (projectRoot) {
- return this._pathToFile(projectRoot, 'cypress.env.json')
- },
-}
diff --git a/packages/server/lib/util/settings.ts b/packages/server/lib/util/settings.ts
new file mode 100644
index 000000000000..1cd3591504a4
--- /dev/null
+++ b/packages/server/lib/util/settings.ts
@@ -0,0 +1,238 @@
+import _ from 'lodash'
+import Promise from 'bluebird'
+import path from 'path'
+import errors from '../errors'
+import { fs } from '../util/fs'
+import { requireAsync } from './require_async'
+import Debug from 'debug'
+
+const debug = Debug('cypress:server:settings')
+
+interface SettingsOptions {
+ testingType?: 'component' |'e2e'
+ configFile?: string | false
+ args?: {
+ runProject?: string
+ }
+}
+
+function jsCode (obj) {
+ const objJSON = obj && !_.isEmpty(obj)
+ ? JSON.stringify(_.omit(obj, 'configFile'), null, 2)
+ : `{
+
+}`
+
+ return `module.exports = ${objJSON}
+`
+}
+
+// TODO:
+// think about adding another PSemaphore
+// here since we can read + write the
+// settings at the same time something else
+// is potentially reading it
+
+const flattenCypress = (obj) => {
+ return obj.cypress ? obj.cypress : undefined
+}
+
+const renameVisitToPageLoad = (obj) => {
+ const v = obj.visitTimeout
+
+ if (v) {
+ obj = _.omit(obj, 'visitTimeout')
+ obj.pageLoadTimeout = v
+
+ return obj
+ }
+}
+
+const renameCommandTimeout = (obj) => {
+ const c = obj.commandTimeout
+
+ if (c) {
+ obj = _.omit(obj, 'commandTimeout')
+ obj.defaultCommandTimeout = c
+
+ return obj
+ }
+}
+
+const renameSupportFolder = (obj) => {
+ const sf = obj.supportFolder
+
+ if (sf) {
+ obj = _.omit(obj, 'supportFolder')
+ obj.supportFile = sf
+
+ return obj
+ }
+}
+
+function _pathToFile (projectRoot, file) {
+ return path.isAbsolute(file) ? file : path.join(projectRoot, file)
+}
+
+function _err (type, file, err) {
+ const e = errors.get(type, file, err)
+
+ e.code = err.code
+ e.errno = err.errno
+ throw e
+}
+
+function _logReadErr (file, err) {
+ errors.throw('ERROR_READING_FILE', file, err)
+}
+
+function _logWriteErr (file, err) {
+ return _err('ERROR_WRITING_FILE', file, err)
+}
+
+function _write (file, obj = {}) {
+ if (/\.json$/.test(file)) {
+ debug('writing json file')
+
+ return fs.outputJson(file, obj, { spaces: 2 })
+ .then(() => obj)
+ .catch((err) => {
+ return _logWriteErr(file, err)
+ })
+ }
+
+ debug('writing javascript file')
+
+ return fs.writeFileAsync(file, jsCode(obj))
+ .return(obj)
+ .catch((err) => {
+ return _logWriteErr(file, err)
+ })
+}
+
+function _applyRewriteRules (obj = {}) {
+ return _.reduce([flattenCypress, renameVisitToPageLoad, renameCommandTimeout, renameSupportFolder], (memo, fn) => {
+ const ret = fn(memo)
+
+ return ret ? ret : memo
+ }, _.cloneDeep(obj))
+}
+
+export function isComponentTesting (options: SettingsOptions = {}) {
+ return options.testingType === 'component'
+}
+
+export function configFile (options: SettingsOptions = {}) {
+ // default is only used in tests.
+ // This prevents a the change from becoming bigger than it should
+ // FIXME: remove the default
+ return options.configFile === false ? false : (options.configFile || 'cypress.json')
+}
+
+export function id (projectRoot, options = {}) {
+ const file = pathToConfigFile(projectRoot, options)
+
+ return fs.readJson(file)
+ .then((config) => config.projectId)
+ .catch(() => {
+ return null
+ })
+}
+
+export function read (projectRoot, options: SettingsOptions = {}) {
+ if (options.configFile === false) {
+ return Promise.resolve({})
+ }
+
+ const file = pathToConfigFile(projectRoot, options)
+
+ return requireAsync(file,
+ {
+ projectRoot,
+ loadErrorCode: 'CONFIG_FILE_ERROR',
+ })
+ .catch((err) => {
+ if (err.type === 'MODULE_NOT_FOUND' || err.code === 'ENOENT') {
+ if (options.args?.runProject) {
+ return Promise.reject(errors.get('CONFIG_FILE_NOT_FOUND', options.configFile, projectRoot))
+ }
+
+ return _write(file, {})
+ }
+
+ return Promise.reject(err)
+ })
+ .then((configObject = {}) => {
+ if (isComponentTesting(options) && 'component' in configObject) {
+ configObject = { ...configObject, ...configObject.component }
+ }
+
+ if (!isComponentTesting(options) && 'e2e' in configObject) {
+ configObject = { ...configObject, ...configObject.e2e }
+ }
+
+ debug('resolved configObject', configObject)
+ const changed = _applyRewriteRules(configObject)
+
+ // if our object is unchanged
+ // then just return it
+ if (_.isEqual(configObject, changed)) {
+ return configObject
+ }
+
+ // else write the new reduced obj
+ return _write(file, changed)
+ .then((config) => {
+ return config
+ })
+ }).catch((err) => {
+ debug('an error occured when reading config', err)
+ if (errors.isCypressErr(err)) {
+ throw err
+ }
+
+ return _logReadErr(file, err)
+ })
+}
+
+export function readEnv (projectRoot) {
+ const file = pathToCypressEnvJson(projectRoot)
+
+ return fs.readJson(file)
+ .catch((err) => {
+ if (err.code === 'ENOENT') {
+ return {}
+ }
+
+ if (errors.isCypressErr(err)) {
+ throw err
+ }
+
+ return _logReadErr(file, err)
+ })
+}
+
+export function write (projectRoot, obj = {}, options: SettingsOptions = {}) {
+ if (options.configFile === false) {
+ return Promise.resolve({})
+ }
+
+ return read(projectRoot, options)
+ .then((settings) => {
+ _.extend(settings, obj)
+
+ const file = pathToConfigFile(projectRoot, options)
+
+ return _write(file, settings)
+ })
+}
+
+export function pathToConfigFile (projectRoot, options: SettingsOptions = {}) {
+ const file = configFile(options)
+
+ return file && _pathToFile(projectRoot, file)
+}
+
+export function pathToCypressEnvJson (projectRoot) {
+ return _pathToFile(projectRoot, 'cypress.env.json')
+}
diff --git a/packages/server/test/e2e/3_config_spec.js b/packages/server/test/e2e/3_config_spec.js
index e0f89be3de6a..183a8734fb5a 100644
--- a/packages/server/test/e2e/3_config_spec.js
+++ b/packages/server/test/e2e/3_config_spec.js
@@ -54,4 +54,10 @@ describe('e2e config', () => {
configFile: 'cypress.config.custom.js',
})
})
+
+ it('supports custom configFile in a default JavaScript file', function () {
+ return e2e.exec(this, {
+ project: Fixtures.projectPath('config-with-js'),
+ })
+ })
})
diff --git a/packages/server/test/integration/cypress_spec.js b/packages/server/test/integration/cypress_spec.js
index 969258aa9652..0fdb877aa463 100644
--- a/packages/server/test/integration/cypress_spec.js
+++ b/packages/server/test/integration/cypress_spec.js
@@ -499,7 +499,7 @@ describe('lib/cypress', () => {
])
}).each(ensureDoesNotExist)
.then(() => {
- this.expectExitWithErr('CONFIG_FILE_NOT_FOUND', this.pristinePath)
+ this.expectExitWithErr('NO_DEFAULT_CONFIG_FILE_FOUND', this.pristinePath)
})
})
diff --git a/packages/server/test/support/fixtures/projects/config-with-js/cypress.config.js b/packages/server/test/support/fixtures/projects/config-with-js/cypress.config.js
new file mode 100644
index 000000000000..d95722d5dddc
--- /dev/null
+++ b/packages/server/test/support/fixtures/projects/config-with-js/cypress.config.js
@@ -0,0 +1,7 @@
+module.exports = {
+ pageLoadTimeout: 10000,
+ e2e: {
+ defaultCommandTimeout: 500,
+ videoCompression: 20,
+ },
+}
diff --git a/packages/server/test/support/fixtures/projects/config-with-js/cypress/integration/app_spec.js b/packages/server/test/support/fixtures/projects/config-with-js/cypress/integration/app_spec.js
new file mode 100644
index 000000000000..011ffed68906
--- /dev/null
+++ b/packages/server/test/support/fixtures/projects/config-with-js/cypress/integration/app_spec.js
@@ -0,0 +1,8 @@
+it('overrides config', () => {
+ // overrides come from plugins
+ expect(Cypress.config('defaultCommandTimeout')).to.eq(500)
+ expect(Cypress.config('videoCompression')).to.eq(20)
+
+ // overrides come from CLI
+ expect(Cypress.config('pageLoadTimeout')).to.eq(10000)
+})
diff --git a/packages/server/test/unit/gui/files_spec.ts b/packages/server/test/unit/gui/files_spec.ts
index 57b6793e9aea..2f6d17f90c84 100644
--- a/packages/server/test/unit/gui/files_spec.ts
+++ b/packages/server/test/unit/gui/files_spec.ts
@@ -32,11 +32,12 @@ describe('gui/files', () => {
this.err = new Error('foo')
+ sinon.stub(ProjectBase.prototype, 'initializeConfig').resolves()
sinon.stub(ProjectBase.prototype, 'open').resolves()
sinon.stub(ProjectBase.prototype, 'getConfig').returns(this.config)
this.showSaveDialog = sinon.stub(dialog, 'showSaveDialog').resolves(this.selectedPath)
- this.createFile = sinon.stub(specWriter, 'createFile').resolves({})
+ this.createFile = sinon.stub(specWriter, 'createFile').resolves()
this.getSpecs = sinon.stub(openProject, 'getSpecs').resolves(this.specs)
return openProject.create('/_test-output/path/to/project-e2e', {
diff --git a/packages/server/test/unit/modes/run_spec.js b/packages/server/test/unit/modes/run_spec.js
index 73fb1d52cc6b..1821baa7b33b 100644
--- a/packages/server/test/unit/modes/run_spec.js
+++ b/packages/server/test/unit/modes/run_spec.js
@@ -20,7 +20,6 @@ const random = require(`${root}../lib/util/random`)
const system = require(`${root}../lib/util/system`)
const specsUtil = require(`${root}../lib/util/specs`)
const { experimental } = require(`${root}../lib/experiments`)
-const ProjectStatic = require(`${root}../lib/project_static`)
describe('lib/modes/run', () => {
beforeEach(function () {
@@ -660,7 +659,6 @@ describe('lib/modes/run', () => {
sinon.stub(electron.app, 'on').withArgs('ready').yieldsAsync()
sinon.stub(user, 'ensureAuthToken')
- sinon.stub(ProjectStatic, 'ensureExists').resolves()
sinon.stub(random, 'id').returns(1234)
sinon.stub(openProject, 'create').resolves(openProject)
sinon.stub(runMode, 'waitForSocketConnection').resolves()
@@ -738,7 +736,6 @@ describe('lib/modes/run', () => {
sinon.stub(electron.app, 'on').withArgs('ready').yieldsAsync()
sinon.stub(user, 'ensureAuthToken')
- sinon.stub(ProjectStatic, 'ensureExists').resolves()
sinon.stub(random, 'id').returns(1234)
sinon.stub(openProject, 'create').resolves(openProject)
sinon.stub(system, 'info').resolves({ osName: 'osFoo', osVersion: 'fooVersion' })
diff --git a/packages/server/test/unit/project_spec.js b/packages/server/test/unit/project_spec.js
index 1f350b601297..d05e445fe43c 100644
--- a/packages/server/test/unit/project_spec.js
+++ b/packages/server/test/unit/project_spec.js
@@ -87,15 +87,15 @@ describe('lib/project-base', () => {
expect(p.projectRoot).to.eq(path.resolve('../foo/bar'))
})
- it('handles CT specific behaviors', async function () {
+ it('sets CT specific defaults and calls CT function', async function () {
sinon.stub(ServerE2E.prototype, 'open').resolves([])
sinon.stub(ProjectBase.prototype, 'startCtDevServer').resolves({ port: 9999 })
- const projectCt = new ProjectBase({ projectRoot: '../foo/bar', testingType: 'component' })
+ const projectCt = new ProjectBase({ projectRoot: this.pristinePath, testingType: 'component' })
await projectCt.initializeConfig()
- return projectCt.open({}).then((project) => {
+ return projectCt.open({}).then(() => {
expect(projectCt._cfg.viewportHeight).to.eq(500)
expect(projectCt._cfg.viewportWidth).to.eq(500)
expect(projectCt._cfg.baseUrl).to.eq('http://localhost:9999')
@@ -149,7 +149,8 @@ describe('lib/project-base', () => {
const integrationFolder = 'foo/bar/baz'
beforeEach(function () {
- sinon.stub(config, 'get').withArgs(this.todosPath, { foo: 'bar' }).resolves({ baz: 'quux', integrationFolder, browsers: [] })
+ sinon.stub(config, 'get').withArgs(this.todosPath, { foo: 'bar', configFile: 'cypress.json' })
+ .resolves({ baz: 'quux', integrationFolder, browsers: [] })
})
it('calls config.get with projectRoot + options + saved state', function () {
diff --git a/packages/server/test/unit/project_utils_spec.ts b/packages/server/test/unit/project_utils_spec.ts
index 009b92e93588..dbf69ea14fd7 100644
--- a/packages/server/test/unit/project_utils_spec.ts
+++ b/packages/server/test/unit/project_utils_spec.ts
@@ -1,7 +1,9 @@
import Chai from 'chai'
-import { getSpecUrl, checkSupportFile } from '../../lib/project_utils'
-import Fixtures from '../support/helpers/fixtures'
import path from 'path'
+import sinon from 'sinon'
+import { fs } from '../../lib/util/fs'
+import { getSpecUrl, checkSupportFile, getDefaultConfigFilePath } from '../../lib/project_utils'
+import Fixtures from '../support/helpers/fixtures'
const todosPath = Fixtures.projectPath('todos')
@@ -117,4 +119,58 @@ describe('lib/project_utils', () => {
}
})
})
+
+ describe('getDefaultConfigFilePath', () => {
+ let readdirStub
+ const projectRoot = '/a/project/root'
+
+ beforeEach(() => {
+ readdirStub = sinon.stub(fs, 'readdir')
+ })
+
+ afterEach(() => {
+ readdirStub.restore()
+ })
+
+ it('finds cypress.json when present', async () => {
+ readdirStub.withArgs(projectRoot).resolves(['cypress.json'])
+ const ret = await getDefaultConfigFilePath(projectRoot)
+
+ expect(ret).to.equal('cypress.json')
+ })
+
+ it('defaults to cypress.config.js when present', async () => {
+ readdirStub.withArgs(projectRoot).resolves(['cypress.config.js'])
+ const ret = await getDefaultConfigFilePath(projectRoot)
+
+ expect(ret).to.equal('cypress.config.js')
+ })
+
+ it('defaults to cypress.json when no file is returned', async () => {
+ readdirStub.withArgs(projectRoot).resolves([])
+ const ret = await getDefaultConfigFilePath(projectRoot)
+
+ expect(ret).to.equal('cypress.json')
+ })
+
+ it('errors if two default files are present', async () => {
+ readdirStub.withArgs(projectRoot).resolves(['cypress.config.js', 'cypress.json'])
+ try {
+ await getDefaultConfigFilePath(projectRoot)
+ throw Error('should have failed')
+ } catch (err) {
+ expect(err).to.have.property('type', 'CONFIG_FILES_LANGUAGE_CONFLICT')
+ }
+ })
+
+ it('errors if no file is present and we asked not to create any', async () => {
+ readdirStub.withArgs(projectRoot).resolves([])
+ try {
+ await getDefaultConfigFilePath(projectRoot, false)
+ throw Error('should have failed')
+ } catch (err) {
+ expect(err).to.have.property('type', 'NO_DEFAULT_CONFIG_FILE_FOUND')
+ }
+ })
+ })
})
diff --git a/packages/server/test/unit/settings_spec.js b/packages/server/test/unit/settings_spec.js
deleted file mode 100644
index ca1e4cef8622..000000000000
--- a/packages/server/test/unit/settings_spec.js
+++ /dev/null
@@ -1,272 +0,0 @@
-require('../spec_helper')
-
-const path = require('path')
-const { fs } = require(`${root}lib/util/fs`)
-const settings = require(`${root}lib/util/settings`)
-
-const projectRoot = process.cwd()
-
-describe('lib/settings', () => {
- context('with no configFile option', () => {
- beforeEach(function () {
- this.setup = (obj = {}) => {
- return fs.writeJsonAsync('cypress.json', obj)
- }
- })
-
- afterEach(() => {
- return fs.removeAsync('cypress.json')
- })
-
- context('nested cypress object', () => {
- it('flattens object on read', function () {
- return this.setup({ cypress: { foo: 'bar' } })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ foo: 'bar' })
-
- return fs.readJsonAsync('cypress.json')
- }).then((obj) => {
- expect(obj).to.deep.eq({ foo: 'bar' })
- })
- })
- })
-
- context('.readEnv', () => {
- afterEach(() => {
- return fs.removeAsync('cypress.env.json')
- })
-
- it('parses json', () => {
- const json = { foo: 'bar', baz: 'quux' }
-
- fs.writeJsonSync('cypress.env.json', json)
-
- return settings.readEnv(projectRoot)
- .then((obj) => {
- expect(obj).to.deep.eq(json)
- })
- })
-
- it('throws when invalid json', () => {
- fs.writeFileSync('cypress.env.json', '{\'foo;: \'bar}')
-
- return settings.readEnv(projectRoot)
- .catch((err) => {
- expect(err.type).to.eq('ERROR_READING_FILE')
- expect(err.message).to.include('SyntaxError')
-
- expect(err.message).to.include(projectRoot)
- })
- })
-
- it('does not write initial file', () => {
- return settings.readEnv(projectRoot)
- .then((obj) => {
- expect(obj).to.deep.eq({})
- }).then(() => {
- return fs.pathExists('cypress.env.json')
- }).then((found) => {
- expect(found).to.be.false
- })
- })
- })
-
- context('.id', () => {
- beforeEach(function () {
- this.projectRoot = path.join(projectRoot, '_test-output/path/to/project/')
-
- return fs.ensureDirAsync(this.projectRoot)
- })
-
- afterEach(function () {
- return fs.removeAsync(`${this.projectRoot}cypress.json`)
- })
-
- it('returns project id for project', function () {
- return fs.writeJsonAsync(`${this.projectRoot}cypress.json`, {
- projectId: 'id-123',
- })
- .then(() => {
- return settings.id(this.projectRoot)
- }).then((id) => {
- expect(id).to.equal('id-123')
- })
- })
- })
-
- context('.read', () => {
- it('promises cypress.json', function () {
- return this.setup({ foo: 'bar' })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ foo: 'bar' })
- })
- })
-
- it('promises cypress.json and merges CT specific properties for via testingType: component', function () {
- return this.setup({ a: 'b', component: { a: 'c' } })
- .then(() => {
- return settings.read(projectRoot, { testingType: 'component' })
- }).then((obj) => {
- expect(obj).to.deep.eq({ a: 'c', component: { a: 'c' } })
- })
- })
-
- it('promises cypress.json and merges e2e specific properties', function () {
- return this.setup({ a: 'b', e2e: { a: 'c' } })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ a: 'c', e2e: { a: 'c' } })
- })
- })
-
- it('renames commandTimeout -> defaultCommandTimeout', function () {
- return this.setup({ commandTimeout: 30000, foo: 'bar' })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ defaultCommandTimeout: 30000, foo: 'bar' })
- })
- })
-
- it('renames supportFolder -> supportFile', function () {
- return this.setup({ supportFolder: 'foo', foo: 'bar' })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ supportFile: 'foo', foo: 'bar' })
- })
- })
-
- it('renames visitTimeout -> pageLoadTimeout', function () {
- return this.setup({ visitTimeout: 30000, foo: 'bar' })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ pageLoadTimeout: 30000, foo: 'bar' })
- })
- })
-
- it('renames visitTimeout -> pageLoadTimeout on nested cypress obj', function () {
- return this.setup({ cypress: { visitTimeout: 30000, foo: 'bar' } })
- .then(() => {
- return settings.read(projectRoot)
- }).then((obj) => {
- expect(obj).to.deep.eq({ pageLoadTimeout: 30000, foo: 'bar' })
- })
- })
- })
-
- context('.write', () => {
- it('promises cypress.json updates', function () {
- return this.setup().then(() => {
- return settings.write(projectRoot, { foo: 'bar' })
- }).then((obj) => {
- expect(obj).to.deep.eq({ foo: 'bar' })
- })
- })
-
- it('only writes over conflicting keys', function () {
- return this.setup({ projectId: '12345', autoOpen: true })
- .then(() => {
- return settings.write(projectRoot, { projectId: 'abc123' })
- }).then((obj) => {
- expect(obj).to.deep.eq({ projectId: 'abc123', autoOpen: true })
- })
- })
- })
- })
-
- context('with configFile: false', () => {
- beforeEach(function () {
- this.projectRoot = path.join(projectRoot, '_test-output/path/to/project/')
-
- this.options = {
- configFile: false,
- }
- })
-
- it('.exists passes', function () {
- return settings.exists(this.projectRoot, this.options)
- .then((exists) => {
- expect(exists).to.equal(undefined)
- })
- })
-
- it('.write does not create a file', function () {
- return settings.write(this.projectRoot, {}, this.options)
- .then(() => {
- return fs.exists(path.join(this.projectRoot, 'cypress.json'))
- .then((exists) => {
- expect(exists).to.equal(false)
- })
- })
- })
-
- it('.read returns empty object', function () {
- return settings.read(this.projectRoot, this.options)
- .then((settings) => {
- expect(settings).to.deep.equal({})
- })
- })
- })
-
- context('with a configFile set', () => {
- beforeEach(function () {
- this.projectRoot = path.join(projectRoot, '_test-output/path/to/project/')
-
- this.options = {
- configFile: 'my-test-config-file.json',
- }
-
- this.optionsJs = {
- configFile: 'my-test-config-file.js',
- }
- })
-
- afterEach(function () {
- return fs.removeAsync(`${this.projectRoot}${this.options.configFile}`)
- })
-
- it('.exists fails when configFile doesn\'t exist', function () {
- return settings.exists(this.projectRoot, this.options)
- .catch((error) => {
- expect(error.type).to.equal('CONFIG_FILE_NOT_FOUND')
- })
- })
-
- it('.write creates configFile', function () {
- return settings.write(this.projectRoot, { foo: 'bar' }, this.options)
- .then(() => {
- return fs.readJsonAsync(path.join(this.projectRoot, this.options.configFile))
- .then((json) => {
- expect(json).to.deep.equal({ foo: 'bar' })
- })
- })
- })
-
- it('.read returns from configFile', function () {
- return fs.writeJsonAsync(path.join(this.projectRoot, this.options.configFile), { foo: 'bar' })
- .then(() => {
- return settings.read(this.projectRoot, this.options)
- .then((settings) => {
- expect(settings).to.deep.equal({ foo: 'bar' })
- })
- })
- })
-
- it('.read returns from configFile when its a JavaScript file', function () {
- return fs.writeFile(path.join(this.projectRoot, this.optionsJs.configFile), `module.exports = { baz: 'lurman' }`)
- .then(() => {
- return settings.read(this.projectRoot, this.optionsJs)
- .then((settings) => {
- expect(settings).to.deep.equal({ baz: 'lurman' })
- })
- })
- })
- })
-})
diff --git a/packages/server/test/unit/util/settings_spec.js b/packages/server/test/unit/util/settings_spec.js
index e306accaf242..a7c4f2c2aaeb 100644
--- a/packages/server/test/unit/util/settings_spec.js
+++ b/packages/server/test/unit/util/settings_spec.js
@@ -1,10 +1,253 @@
+const path = require('path')
+
require('../../spec_helper')
-const setting = require(`../../../lib/util/settings`)
+const { fs } = require('../../../lib/util/fs')
+const settings = require(`../../../lib/util/settings`)
+
+const projectRoot = process.cwd()
+const defaultOptions = {
+ configFile: 'cypress.json',
+}
describe('lib/util/settings', () => {
- describe('pathToConfigFile', () => {
+ context('with default configFile option', () => {
+ beforeEach(function () {
+ this.setup = (obj = {}) => {
+ return fs.writeJsonAsync('cypress.json', obj)
+ }
+ })
+
+ afterEach(() => {
+ return fs.removeAsync('cypress.json')
+ })
+
+ context('nested cypress object', () => {
+ it('flattens object on read', function () {
+ return this.setup({ cypress: { foo: 'bar' } })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ foo: 'bar' })
+
+ return fs.readJsonAsync('cypress.json')
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ foo: 'bar' })
+ })
+ })
+ })
+
+ context('.readEnv', () => {
+ afterEach(() => {
+ return fs.removeAsync('cypress.env.json')
+ })
+
+ it('parses json', () => {
+ const json = { foo: 'bar', baz: 'quux' }
+
+ fs.writeJsonSync('cypress.env.json', json)
+
+ return settings.readEnv(projectRoot)
+ .then((obj) => {
+ expect(obj).to.deep.eq(json)
+ })
+ })
+
+ it('throws when invalid json', () => {
+ fs.writeFileSync('cypress.env.json', '{\'foo;: \'bar}')
+
+ return settings.readEnv(projectRoot)
+ .catch((err) => {
+ expect(err.type).to.eq('ERROR_READING_FILE')
+ expect(err.message).to.include('SyntaxError')
+
+ expect(err.message).to.include(projectRoot)
+ })
+ })
+
+ it('does not write initial file', () => {
+ return settings.readEnv(projectRoot)
+ .then((obj) => {
+ expect(obj).to.deep.eq({})
+ }).then(() => {
+ return fs.pathExists('cypress.env.json')
+ }).then((found) => {
+ expect(found).to.be.false
+ })
+ })
+ })
+
+ context('.id', () => {
+ beforeEach(function () {
+ this.projectRoot = path.join(projectRoot, '_test-output/path/to/project/')
+
+ return fs.ensureDirAsync(this.projectRoot)
+ })
+
+ afterEach(function () {
+ return fs.removeAsync(`${this.projectRoot}cypress.json`)
+ })
+
+ it('returns project id for project', function () {
+ return fs.writeJsonAsync(`${this.projectRoot}cypress.json`, {
+ projectId: 'id-123',
+ })
+ .then(() => {
+ return settings.id(this.projectRoot, defaultOptions)
+ }).then((id) => {
+ expect(id).to.equal('id-123')
+ })
+ })
+ })
+
+ context('.read', () => {
+ it('promises cypress.json', function () {
+ return this.setup({ foo: 'bar' })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ foo: 'bar' })
+ })
+ })
+
+ it('promises cypress.json and merges CT specific properties for via testingType: component', function () {
+ return this.setup({ a: 'b', component: { a: 'c' } })
+ .then(() => {
+ return settings.read(projectRoot, { ...defaultOptions, testingType: 'component' })
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ a: 'c', component: { a: 'c' } })
+ })
+ })
+
+ it('promises cypress.json and merges e2e specific properties', function () {
+ return this.setup({ a: 'b', e2e: { a: 'c' } })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ a: 'c', e2e: { a: 'c' } })
+ })
+ })
+
+ it('renames commandTimeout -> defaultCommandTimeout', function () {
+ return this.setup({ commandTimeout: 30000, foo: 'bar' })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ defaultCommandTimeout: 30000, foo: 'bar' })
+ })
+ })
+
+ it('renames supportFolder -> supportFile', function () {
+ return this.setup({ supportFolder: 'foo', foo: 'bar' })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ supportFile: 'foo', foo: 'bar' })
+ })
+ })
+
+ it('renames visitTimeout -> pageLoadTimeout', function () {
+ return this.setup({ visitTimeout: 30000, foo: 'bar' })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ pageLoadTimeout: 30000, foo: 'bar' })
+ })
+ })
+
+ it('renames visitTimeout -> pageLoadTimeout on nested cypress obj', function () {
+ return this.setup({ cypress: { visitTimeout: 30000, foo: 'bar' } })
+ .then(() => {
+ return settings.read(projectRoot, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ pageLoadTimeout: 30000, foo: 'bar' })
+ })
+ })
+
+ it('errors if in run mode and can\'t find file', function () {
+ return settings.read(projectRoot, { ...defaultOptions, args: { runProject: 'path' } })
+ .then(() => {
+ throw Error('read should have failed with no config file in run mode')
+ }).catch((err) => {
+ expect(err.type).to.equal('CONFIG_FILE_NOT_FOUND')
+
+ return fs.access(path.join(projectRoot, 'cypress.json'))
+ .then(() => {
+ throw Error('file should not have been created here')
+ }).catch((err) => {
+ expect(err.code).to.equal('ENOENT')
+ })
+ })
+ })
+ })
+
+ context('.write', () => {
+ it('promises cypress.json updates', function () {
+ return this.setup().then(() => {
+ return settings.write(projectRoot, { foo: 'bar' }, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ foo: 'bar' })
+ })
+ })
+
+ it('only writes over conflicting keys', function () {
+ return this.setup({ projectId: '12345', autoOpen: true })
+ .then(() => {
+ return settings.write(projectRoot, { projectId: 'abc123' }, defaultOptions)
+ }).then((obj) => {
+ expect(obj).to.deep.eq({ projectId: 'abc123', autoOpen: true })
+ })
+ })
+ })
+ })
+
+ context('with configFile: false', () => {
+ beforeEach(function () {
+ this.projectRoot = path.join(projectRoot, '_test-output/path/to/project/')
+
+ this.options = {
+ configFile: false,
+ }
+ })
+
+ it('.write does not create a file', function () {
+ return settings.write(this.projectRoot, {}, this.options)
+ .then(() => {
+ return fs.access(path.join(this.projectRoot, 'cypress.json'))
+ .then(() => {
+ throw Error('file shuold not have been created here')
+ }).catch((err) => {
+ expect(err.code).to.equal('ENOENT')
+ })
+ })
+ })
+
+ it('.read returns empty object', function () {
+ return settings.read(this.projectRoot, this.options)
+ .then((settings) => {
+ expect(settings).to.deep.equal({})
+ })
+ })
+ })
+
+ context('with js files', () => {
+ it('.read returns from configFile when its a JavaScript file', function () {
+ this.projectRoot = path.join(projectRoot, '_test-output/path/to/project/')
+
+ return fs.writeFile(path.join(this.projectRoot, 'cypress.custom.js'), `module.exports = { baz: 'lurman' }`)
+ .then(() => {
+ return settings.read(this.projectRoot, { configFile: 'cypress.custom.js' })
+ .then((settings) => {
+ expect(settings).to.deep.equal({ baz: 'lurman' })
+ }).then(() => {
+ return fs.remove(path.join(this.projectRoot, 'cypress.custom.js'))
+ })
+ })
+ })
+ })
+
+ describe('.pathToConfigFile', () => {
it('supports relative path', () => {
- const path = setting.pathToConfigFile('/users/tony/cypress', {
+ const path = settings.pathToConfigFile('/users/tony/cypress', {
configFile: 'e2e/config.json',
})
@@ -12,7 +255,7 @@ describe('lib/util/settings', () => {
})
it('supports absolute path', () => {
- const path = setting.pathToConfigFile('/users/tony/cypress', {
+ const path = settings.pathToConfigFile('/users/tony/cypress', {
configFile: '/users/pepper/cypress/e2e/cypress.config.json',
})