Add new plugin events 'before:spec', 'after:spec', 'before:run', 'after:run'

[chrisbreiding]

Add four new events that fire in the plugins file:

• before:run: Fires before the run starts, with details about the run.
• before:spec: Fires before a spec file is run, with details about the spec file.
• after:spec: Fires after a spec file and its tests run, with details about the spec file and its test results.
• after:run: Fires after the run finishes, with the results of the run.

In interactive mode, the behavior is slightly different, since there isn't a discrete 'run' and specs can be re-run at will:

• before:run fires when opening a project.
• before:spec fires when the browser opens.
• after:spec fires when the browser closes (and may not fire at all (if, for example, you force quit Cypress).
• after:run fires when you close the project (and may not fire at all (if, for example, you force quit Cypress).

The after:* events will only receive results in run mode, since there's no way to aggregate results from interactive mode.

Note: this is take 2 on this previous issue: #2286. This will be able to be released in the next feature release instead of waiting for the next major version.

[amitzur]

Is there a way for a plugin to detect if it's running in interactive mode or run mode?

[denis-domanskii]

Hi @chrisbreiding, please don't forget about parallel run. I'll expect that run:start and run:end will be called once per run, not once on each parallel machine - I have explained my issue in #9196. Thank you for working on it :)

[jennifer-shehane]

Released in 6.2.0.

You can now listen to before:run, after:run, before:spec and after:spec events in the plugins file when setting the experimentalRunEvents configuration option to true. See the appropriate events doc for more details: https://on.cypress.io/writing-a-plugin#List-of-events

The use of the 'before:spec', 'after:spec', 'before:run', 'after:run' are not triggered in interactive mode currently. If you have a use case for needing these to run during cypress open, please open a new issue requesting this feature and explaining your use case.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v6.2.0, please open a new issue.