Before Spec API
The before:spec event fires before a spec file is run. When running cypress
via cypress open, the event will fire when the browser launches.
Syntax
⚠️ This code is part of the
setupNodeEvents function and
thus executes in the Node environment. You cannot call Cypress or cy
commands in this function, but you do have the direct access to the file system
and the rest of the operating system.
⚠️ When running via cypress open, the before:spec event only fires if the
experimentalInteractiveRunEvents flag
is enabled.
const { defineConfig } = require('cypress')
module.exports = defineConfig({
// setupNodeEvents can be defined in either
// the e2e or component configuration
e2e: {
setupNodeEvents(on, config) {
on('before:spec', (spec) => {
/* ... */
})
}
}
})
import { defineConfig } from 'cypress'
export default defineConfig({
// setupNodeEvents can be defined in either
// the e2e or component configuration
e2e: {
setupNodeEvents(on, config) {
on('before:spec', (spec) => {
/* ... */
})
}
}
})
Deprecated
The plugins file is deprecated as of Cypress CFG_VERSION. We recommend that you update your configuration. Please see the plugins guide and the migration guide for more information.
// cypress/plugins/index.js
module.exports = (on, config) => {
on('before:spec', (spec) => {
/* ... */
})
}
spec (Object)
Details of the spec file, including the following properties:
| Property | Description |
|---|---|
name | The base name of the spec file (e.g. login_spec.js) |
relative | The path to the spec file, relative to the project root (e.g. cypress/integration/login_spec.js) |
absolute | The absolute path to the spec file (e.g. /Users/janelane/my-app/cypress/integration/login_spec.js) |
Usage
You can return a promise from the before:spec event handler and it will be
awaited before Cypress proceeds running the spec.
Log the relative spec path to stdout before the spec is run
module.exports = (on, config) => {
on('before:spec', (spec) => {
// spec will look something like this:
// {
// name: 'login_spec.js',
// relative: 'cypress/integration/login_spec.js',
// absolute: '/Users/janelane/app/cypress/integration/login_spec.js',
// }
console.log('Running', spec.relative)
})
}