cypress-plugin-grep-boxes
v1.0.1
Published
Cypress plugin that allows user to run specific tests in open mode.
Downloads
3,288
Maintainers
Readme
Features
- ✅ A new UI test selection within
cypress open
to filter and run only selected tests in a given spec
Table of Contents
📦 Installation
- Install the following packages:
npm install --save-dev @bahmutov/cy-grep # Dependent package for the plugin
npm install --save-dev cypress-plugin-grep-boxes
- In
cypress/support/e2e.js
(For E2E tests) and/orcypress/support/component.js
(For Component tests),
import { greppedTestToggle, addGrepButtons } from 'cypress-plugin-grep-boxes';
import registerCypressGrep from '@bahmutov/cy-grep/src/support';
registerCypressGrep();
greppedTestToggle();
addGrepButtons();
🦺 Setup
Recommended: Set two common environment variables tied to the @bahmutov/cy-grep
package to enhance the experience utilizing the grep logic within the Cypress Test Runner UI using cypress open:
{
"env": {
"grepOmitFiltered": true,
"grepFilterSpecs": true
}
}
[!NOTE] More information on
grepOmitFiltered
andgrepFilterSpecs
can be read within the README for@bahmutov/cy-grep
.
✅ Open mode
Within each spec, you can select any given number of suite(s) or individual test(s) and click the filter toggle located on the reporter above:
Use Required Test Tags Instead Of Skipping Tests
[!NOTE] Read more about this topic within a blog post Use Required Test Tags Instead Of Skipping Tests and within the README for
@bahmutov/cy-grep
.
Normally, any Cypress test or suite of tests marked with a .skip
will be shown when running tests or within the Cypress test runner UI.
Since this plugin uses @bahmutov/cy-grep
plugin, we can instead designate skipped tests using a required tag:
it('deletes an item', { requiredTags: '@skip' }, () => {
expect(1).to.equal(2);
});
Now running or opening Cypress in interactive mode, you will not see any tests with requiredTags
including @skip
(unless setting environment variable grepTags=@skip
).
To run just those tests with the required tag @skip
in interactive mode:
npx cypress open --env grepTags=@skip
Contributions
Feel free to open a pull request or drop any feature request or bug in the issues.
Please see more details in the contributing doc.