@bahmutov/cy-grep 1.0.0 → 1.2.0

package/README.md

@@ -19,13 +19,13 @@ All other tests will be marked pending, see why in the [Cypress test statuses](h
 
 If you have multiple spec files, all specs will be loaded, and every test will be filtered the same way, since the grep is run-time operation and cannot eliminate the spec files without loading them. If you want to run only specific tests, use the built-in [--spec](https://on.cypress.io/command-line#cypress-run-spec-lt-spec-gt) CLI argument.
 
-Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=HS-Px-Sghd8)
+Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=HS-Px-Sghd8) and study my 🎓 Cypress course [Cypress Plugins](https://cypress.tips/courses/cypress-plugins).
 
 Table of Contents
 
 <!-- MarkdownTOC autolink="true" -->
 
-- [@bahmutov/cy-grep](#bahmutovcy-grep)
+- [@bahmutov/cy-grep ](#bahmutovcy-grep-)
   - [Install](#install)
     - [Support file](#support-file)
     - [Config file](#config-file)
@@ -49,6 +49,7 @@ Table of Contents
   - [TypeScript support](#typescript-support)
   - [General advice](#general-advice)
   - [DevTools console](#devtools-console)
+    - [grepFailed](#grepfailed)
   - [Debugging](#debugging)
     - [Log messages](#log-messages)
     - [Debugging in the plugin](#debugging-in-the-plugin)
@@ -80,7 +81,8 @@ yarn add -D @bahmutov/cy-grep
 **required:** load this module from the [support file](https://on.cypress.io/writing-and-organizing-tests#Support-file) or at the top of the spec file if not using the support file. You import the registration function and then call it:
 
 ```js
-// cypress/support/index.js
+// cypress/support/e2e.js
+
 // load and register the grep feature using "require" function
 // https://github.com/bahmutov/cy-grep
 const registerCypressGrep = require('@bahmutov/cy-grep')
@@ -89,7 +91,7 @@ registerCypressGrep()
 // if you want to use the "import" keyword
 // note: `./index.d.ts` currently extends the global Cypress types and
 // does not define `registerCypressGrep` so the import path is directly
-// pointed to the `support.js` file
+// pointed to the support file
 import registerCypressGrep from '@bahmutov/cy-grep/src/support'
 registerCypressGrep()
 
@@ -110,13 +112,14 @@ registerCypressGrep()
   e2e: {
     setupNodeEvents(on, config) {
       require('@bahmutov/cy-grep/src/plugin')(config);
+      // IMPORTANT: return the config object
       return config;
-  },
+    },
   }
 }
 ```
 
-Installing the plugin via `setupNodeEvents()` is required to enable the [grepFilterSpecs](#grepfilterspecs) feature.
+Installing the plugin via `setupNodeEvents()` is required to enable the [grepFilterSpecs](#pre-filter-specs-grepfilterspecs) feature.
 
 ## Usage Overview
 
@@ -352,9 +355,12 @@ $ npx cypress run --env grepTags=@smoke,grepFilterSpecs=true
 **Tip:** you can set this environment variable in the [config file](https://docs.cypress.io/guides/references/configuration) file to enable it by default and skip using the environment variable:
 
 ```js
+// config file
 {
-  "env": {
-    "grepFilterSpecs": true
+  "e2e": {
+    "env": {
+      "grepFilterSpecs": true
+    }
   }
 }
 ```
@@ -494,20 +500,33 @@ Cypress.grep('hello', '@smoke', 10)
 
 - to remove the grep strings enter `Cypress.grep()`
 
+### grepFailed
+
+Once the tests finish, you can run just the failed tests from DevTools console
+
+```text
+> Cypress.grepFailed()
+```
+
+**Tip:** use `Cypress.grep()` to reset and run all the tests
+
+📝 Read the blog post [Run Just The Failed Tests In Cypress](https://glebbahmutov.com/blog/run-failed-tests/).
+
 ## Debugging
 
-When debugging a problem, first make sure you are using the expected version of this plugin, as some features might be only available in the [later releases](https://github.com/cypress-io/cypress-grep/releases).
+When debugging a problem, first make sure you are using the expected version of this plugin, as some features might be only available in the [later releases](https://github.com/bahmutov/cy-grep/releases).
 
 ```
-# get the cypress-grep version using NPM
-$ npm ls cypress-grep
+# get the plugin's version using NPM
+$ npm ls @bahmutov/cy-grep
 ...
-└── cypress-grep@2.10.1
-# get the cypress-grep version using Yarn
-$ yarn why cypress-grep
+└── @bahmutov/cy-grep@1.1.0
+
+# get the plugin's version using Yarn
+$ yarn why @bahmutov/cy-grep
 ...
-=> Found "cypress-grep@2.10.1"
-info Has been hoisted to "cypress-grep"
+=> Found "@bahmutov/cy-grep@1.1.0"
+info Has been hoisted to "@bahmutov/cy-grep"
 info This module exists because it's specified in "devDependencies".
 ...
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {

package/src/index.d.ts

@@ -26,6 +26,20 @@ declare namespace Cypress {
   }
 
   interface Cypress {
+    /**
+     * Runs only the tests that contain the given "grep" string
+     * in the title, or have specific tags.
+     * @param grep Part of the test title
+     * @param tags Tags to filter tests by
+     * @param burn Number of times to repeat each test
+     */
     grep?: (grep?: string, tags?: string, burn?: string) => void
+    /**
+     * Take the current test statuses and run only the failed tests.
+     * Run this static method from the DevTools console.
+     * Tip: use Cypress.grep() to reset and run all tests.
+     * @example Cypress.grepFailed()
+     */
+    grepFailed?: () => void
   }
 }

package/src/plugin.js

@@ -1,6 +1,6 @@
 const debug = require('debug')('cypress-grep')
 const globby = require('globby')
-const { getTestNames } = require('find-test-names')
+const { getTestNames, findEffectiveTestTags } = require('find-test-names')
 const fs = require('fs')
 const { version } = require('../package.json')
 const { parseGrep, shouldTestRun } = require('./utils')
@@ -9,7 +9,7 @@ const { parseGrep, shouldTestRun } = require('./utils')
  * Prints the cypress-grep environment values if any.
  * @param {Cypress.ConfigOptions} config
  */
-function cypressGrepPlugin (config) {
+function cypressGrepPlugin(config) {
   if (!config || !config.env) {
     return config
   }
@@ -117,15 +117,14 @@ function cypressGrepPlugin (config) {
         const text = fs.readFileSync(specFile, { encoding: 'utf8' })
 
         try {
-          const testInfo = getTestNames(text)
-
+          const testTags = findEffectiveTestTags(text)
+          // we get back a single object with keys being full test titles
+          // and the values being arrays of effective test tags
           debug('spec file %s', specFile)
-          debug('test info: %o', testInfo.tests)
-
-          return testInfo.tests.some((info) => {
-            const shouldRun = shouldTestRun(parsedGrep, null, info.tags)
-
-            return shouldRun
+          debug('effective test tags %o', testTags)
+          return Object.keys(testTags).some((testTitle) => {
+            const effectiveTags = testTags[testTitle]
+            return shouldTestRun(parsedGrep, null, effectiveTags)
           })
         } catch (err) {
           console.error('Could not determine test names in file: %s', specFile)

package/src/support.js

@@ -253,4 +253,38 @@ if (!Cypress.grep) {
   }
 }
 
+if (!Cypress.grepFailed) {
+  Cypress.grepFailed = function () {
+    // @ts-ignore
+    let root = Cypress.state('runnable')
+    while (root.parent) {
+      root = root.parent
+    }
+    const failedTestTitles = []
+
+    function findFailedTests(suite) {
+      suite.tests.forEach((test) => {
+        if (test.state === 'failed') {
+          // TODO use the full test title
+          failedTestTitles.push(test.title)
+        }
+      })
+      suite.suites.forEach((suite) => {
+        findFailedTests(suite)
+      })
+    }
+    findFailedTests(root)
+
+    if (!failedTestTitles.length) {
+      console.log('No failed tests found')
+    } else {
+      console.log('running only the failed tests')
+      console.log(failedTestTitles)
+      const grepTitles = failedTestTitles.join(';')
+      // @ts-ignore
+      Cypress.grep(grepTitles)
+    }
+  }
+}
+
 module.exports = cypressGrep