find-cypress-specs 1.43.6 → 1.44.0

package/README.md

@@ -1,4 +1,4 @@
-# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-13.11.0-brightgreen) [![ci](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml)
+# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-13.13.0-brightgreen) [![ci](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml)
 
 > Find Cypress spec files using the config settings
 
@@ -38,6 +38,16 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## find specs by part of the test title
+
+You can grep all test titles (only the test titles, not the suite names) and find the list of specs
+
+```bash
+$ npx find-cypress-specs --grep "works, needs"
+```
+
+This will find all specs with tests that have "works" in the title or "needs" in the title and output the list of specs. If you use `--set-gha-outputs` and GitHub Actions, it sets the outputs `grepSpecs` and `grepSpecsN`.
+
 ## find number of machines
 
 If we find all the changed specs to run, we might need to decide how many machines we need. We can do a rough job by specifying the number of specs per machine plus the max number.

package/bin/find.js

@@ -5,6 +5,7 @@ const { getSpecs, findChangedFiles, getTests } = require('../src')
 const { getTestCounts } = require('../src/tests-counts')
 const { stringAllInfo, stringMarkdownTests } = require('../src/print')
 const { updateBadge } = require('../src/badge')
+const { filterByGrep } = require('../src/grep')
 
 const fs = require('fs')
 const path = require('path')
@@ -56,6 +57,8 @@ const args = arg({
   // optional: output the number of machines needed to run the tests
   '--specs-per-machine': Number,
   '--max-machines': Number,
+  // find all specs and tests with part of the title
+  '--grep': String,
   //
   // aliases
   '-n': '--names',
@@ -328,6 +331,26 @@ if (args['--test-counts']) {
         }
       }
     }
+  } else if (args['--grep']) {
+    const grep = args['--grep']
+    // grep is a comma-separated string with parts of titles to find
+    debug('finding tests with title containing "%s"', grep)
+    const { jsonResults } = getTests(specs)
+    const filtered = filterByGrep(jsonResults, grep)
+    debug(filtered)
+    console.log(filtered.join(','))
+    if (args['--set-gha-outputs']) {
+      debug('printing the spec names list only')
+      const specNames = filtered.join(',')
+      console.log(specNames)
+
+      debug(
+        'setting GitHub Actions outputs grepSpecsN to %d and grepSpecs',
+        specNames.length,
+      )
+      core.setOutput('grepSpecsN', filtered.length)
+      core.setOutput('grepSpecs', specNames)
+    }
   } else {
     if (args['--count']) {
       debug('printing the number of specs %d', specs.length)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.43.6",
+  "version": "1.44.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -58,7 +58,7 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "13.11.0",
+    "cypress": "13.13.0",
     "dependency-version-badge": "^1.11.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",

package/src/grep.js

@@ -0,0 +1,56 @@
+const debug = require('debug')('find-cypress-specs')
+
+/**
+ * Recursively checks the tests structure to see
+ * if any of the leaf test objects have a name that includes
+ * any of the given strings
+ */
+function checkIncludesTestTitle(tests, greps) {
+  if (!tests) {
+    return false
+  }
+  debug('greps', greps)
+  return tests.some((test) => {
+    if (test.type === 'test' && test.name) {
+      debug('checking test "%s"', test.name)
+      return greps.some((grep) => test.name.includes(grep))
+    } else if (test.type === 'suite') {
+      debug('checking suite "%s"', test.name)
+      return (
+        checkIncludesTestTitle(test.tests, greps) ||
+        checkIncludesTestTitle(test.suites, greps)
+      )
+    } else if (Array.isArray(test.tests)) {
+      return checkIncludesTestTitle(test.tests, greps)
+    } else if (Array.isArray(test.suites)) {
+      return checkIncludesTestTitle(test.suites, greps)
+    }
+  })
+}
+
+/**
+ * returns a list of specs where any test title contains the given string.
+ * Leaves the original structure intact.
+ * @param {object} jsonResults - parsed JSON spec file structure
+ * @param {string} grep - comma-separated list of strings to filter by
+ * @returns {string[]} - list of spec filenames
+ */
+function filterByGrep(jsonResults, grep) {
+  const result = []
+  const greps = grep
+    .split(',')
+    .map((s) => s.trim())
+    .filter(Boolean)
+
+  Object.keys(jsonResults).forEach((specFilename) => {
+    debug('checking spec "%s"', specFilename)
+    const spec = jsonResults[specFilename]
+    if (checkIncludesTestTitle(spec.tests, greps)) {
+      result.push(specFilename)
+    }
+  })
+
+  return result
+}
+
+module.exports = { filterByGrep }