find-cypress-specs 1.12.0 → 1.14.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-9.4.1-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-9.5.1-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
 
@@ -70,6 +70,21 @@ Each tag count includes the tests that use the tag directly, and the _effective_
 
 You can print the results in JSON format using `--json` or `-j` option.
 
+## Test names filtered by a tag
+
+```bash
+$ npx find-cypress-specs --names --tagged <single tag>
+# finds all specs and tests, then filters the output by a single tag
+```
+
+## Test names filtered by multiple tags
+
+```bash
+$ npx find-cypress-specs --names --tagged <tag1>,<tag2>,<tag3>,...
+# finds all specs and tests, then filters the output showing all tests
+# tagged with tag1 or tag2 or tag3 or ...
+```
+
 ## Details
 
 Cypress uses the resolved [configuration values](https://on.cypress.io/configuration) to find the spec files to run. It searches the `integrationFolder` for all patterns listed in `testFiles` and removes any files matching the `ignoreTestFiles` patterns.

package/bin/find.js

@@ -2,9 +2,12 @@
 
 const arg = require('arg')
 const { getSpecs, collectResults, findChangedFiles } = require('../src')
+const { pickTaggedTestsFrom } = require('../src/tagged')
+const { addCounts } = require('../src/count')
+const { stringAllInfo } = require('../src/print')
+
 const fs = require('fs')
-const pluralize = require('pluralize')
-const { getTestNames, formatTestList, countTags } = require('find-test-names')
+const { getTestNames, countTags } = require('find-test-names')
 const consoleTable = require('console.table')
 const debug = require('debug')('find-cypress-specs')
 
@@ -15,7 +18,9 @@ const args = arg({
   '--json': Boolean,
   // find the specs that have changed against this Git branch
   '--branch': String,
-  '--count': Number,
+  '--count': Boolean,
+  // filter all tests to those that have the given tag
+  '--tagged': String,
 
   // aliases
   '-n': '--names',
@@ -34,43 +39,23 @@ if (args['--names'] || args['--tags']) {
     console.log('no specs found')
   } else {
     console.log('')
-    let testsN = 0
-    let pendingTestsN = 0
-
     // counts the number of tests for each tag across all specs
     const tagTestCounts = {}
-
     const jsonResults = {}
 
     specs.forEach((filename) => {
-      jsonResults[filename] = []
+      jsonResults[filename] = {
+        counts: {
+          tests: 0,
+          pending: 0,
+        },
+        tests: [],
+      }
       const source = fs.readFileSync(filename, 'utf8')
       const result = getTestNames(source, true)
       // enable if need to debug the parsed test
       // console.dir(result.structure, { depth: null })
-
-      testsN += result.testCount
-      const testCount = pluralize('test', result.testNames.length, true)
-      pendingTestsN += result.pendingTestCount
-
-      if (args['--names']) {
-        if (args['--json']) {
-          collectResults(result.structure, jsonResults[filename])
-        } else {
-          if (result.pendingTestCount) {
-            console.log(
-              '%s (%s, %d pending)',
-              filename,
-              testCount,
-              result.pendingTestCount,
-            )
-          } else {
-            console.log('%s (%s)', filename, testCount)
-          }
-          console.log(formatTestList(result.structure))
-          console.log('')
-        }
-      }
+      collectResults(result.structure, jsonResults[filename].tests)
 
       if (args['--tags']) {
         const specTagCounts = countTags(result.structure)
@@ -84,24 +69,26 @@ if (args['--names'] || args['--tags']) {
       }
     })
 
+    addCounts(jsonResults)
+
     if (args['--names']) {
+      if (args['--tagged']) {
+        // filter all collected tests to those that have the given tag(s)
+        const splitTags = args['--tagged']
+          .split(',')
+          .map((s) => s.trim())
+          .filter(Boolean)
+        debug('filtering all tests by tag "%o"', splitTags)
+        pickTaggedTestsFrom(jsonResults, splitTags)
+        // recompute the number of tests
+        addCounts(jsonResults)
+      }
+
       if (args['--json']) {
         console.log(JSON.stringify(jsonResults, null, 2))
       } else {
-        if (pendingTestsN) {
-          console.log(
-            'found %s (%s, %d pending)',
-            pluralize('spec', specs.length, true),
-            pluralize('test', testsN, true),
-            pendingTestsN,
-          )
-        } else {
-          console.log(
-            'found %s (%s)',
-            pluralize('spec', specs.length, true),
-            pluralize('test', testsN, true),
-          )
-        }
+        const str = stringAllInfo(jsonResults)
+        console.log(str)
       }
       console.log('')
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -20,7 +20,9 @@
     "demo-names-and-tags": "node ./bin/find --names --tags",
     "demo-names-and-tags-json": "node ./bin/find --names --tags --json",
     "demo-names-json": "node ./bin/find --names --json",
+    "demo-names-tagged": "node ./bin/find --names --tagged @user",
     "print-changed-specs": "node ./bin/find --branch main",
+    "count-changed-specs": "node ./bin/find --branch main --count",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -38,7 +40,7 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "9.4.1",
+    "cypress": "9.5.1",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "semantic-release": "19.0.2"

package/src/count.js

@@ -0,0 +1,56 @@
+/**
+ * For each file and each
+ */
+function addCounts(json) {
+  Object.keys(json).forEach((filename) => {
+    const fileInfo = json[filename]
+    if (!fileInfo.counts) {
+      fileInfo.counts = {
+        tests: 0,
+        pending: 0,
+      }
+    }
+
+    fileInfo.counts.tests =
+      countTests(fileInfo.tests) + countTests(fileInfo.suites)
+    fileInfo.counts.pending =
+      countPendingTests(fileInfo.tests) + countPendingTests(fileInfo.suites)
+  })
+}
+
+function countTests(testsOrSuites) {
+  if (!testsOrSuites) {
+    return 0
+  }
+
+  return testsOrSuites.reduce((count, test) => {
+    if (test.type === 'test') {
+      return count + 1
+    } else if (test.type === 'suite') {
+      return count + countTests(test.tests) + countTests(test.suites)
+    }
+  }, 0)
+}
+
+function countPendingTests(testsOrSuites) {
+  if (!testsOrSuites) {
+    return 0
+  }
+
+  return testsOrSuites.reduce((count, test) => {
+    if (test.type === 'test') {
+      return test.pending ? count + 1 : count
+    } else if (test.type === 'suite') {
+      if (test.pending) {
+        // all tests inside should count as pending
+        return count + countTests(test.tests) + countTests(test.suites)
+      }
+
+      return (
+        count + countPendingTests(test.tests) + countPendingTests(test.suites)
+      )
+    }
+  }, 0)
+}
+
+module.exports = { addCounts }

package/src/print.js

@@ -0,0 +1,50 @@
+const pluralize = require('pluralize')
+const { formatTestList } = require('find-test-names')
+
+/**
+ * Outputs a string representation of the json test results object,
+ * like a tree of suites and tests.
+ */
+function stringFileTests(fileName, fileInfo) {
+  const testCount = pluralize('test', fileInfo.counts.tests, true)
+  const headerLine = fileInfo.counts.pending
+    ? `${fileName} (${testCount}, ${fileInfo.counts.pending} pending)`
+    : `${fileName} (${testCount})`
+
+  const body = formatTestList(fileInfo.tests)
+
+  return headerLine + '\n' + body + '\n'
+}
+
+function stringAllInfo(allInfo) {
+  let fileCount = 0
+  let testCount = 0
+  let pendingTestCount = 0
+
+  const allInfoString = Object.keys(allInfo)
+    .map((fileName) => {
+      const fileInfo = allInfo[fileName]
+      fileCount += 1
+      testCount += fileInfo.counts.tests
+      pendingTestCount += fileInfo.counts.pending
+      return stringFileTests(fileName, fileInfo)
+    })
+    .join('\n')
+
+  // footer line is something like
+  // found 2 specs (4 tests, 1 pending)
+  let footer = `found ${pluralize('spec', fileCount, true)}`
+  const testWord = pluralize('test', testCount, true)
+  if (pendingTestCount) {
+    footer += ` (${testWord}, ${pendingTestCount} pending)`
+  } else {
+    footer += ` (${testWord})`
+  }
+
+  return allInfoString + '\n' + footer
+}
+
+module.exports = {
+  stringFileTests,
+  stringAllInfo,
+}

package/src/tagged.js

@@ -0,0 +1,72 @@
+const { addCounts } = require('./count')
+
+function arraysOverlap(a, b) {
+  if (!Array.isArray(a) || !Array.isArray(b)) {
+    return false
+  }
+
+  if (a.length < b.length) {
+    return a.some((item) => b.includes(item))
+  } else {
+    return b.some((item) => a.includes(item))
+  }
+}
+
+// note: modifies the tests in place
+function pickTaggedTests(tests, tag) {
+  if (!Array.isArray(tests)) {
+    return false
+  }
+  const tags = Array.isArray(tag) ? tag : [tag]
+  const filteredTests = tests.filter((test) => {
+    if (test.type === 'test') {
+      return test.tags && arraysOverlap(test.tags, tags)
+    } else if (test.type === 'suite') {
+      if (test.tags && arraysOverlap(test.tags, tags)) {
+        return true
+      }
+
+      // maybe there is some test inside this suite
+      // with the tag? Filter all other tests
+      return (
+        pickTaggedTests(test.tests, tags) || pickTaggedTests(test.suites, tags)
+      )
+    }
+  })
+  tests.length = 0
+  tests.push(...filteredTests)
+  return filteredTests.length > 0
+}
+
+function removeEmptyNodes(json) {
+  Object.keys(json).forEach((filename) => {
+    const fileTests = json[filename].tests
+    if (!fileTests.length) {
+      delete json[filename]
+    }
+  })
+  return json
+}
+
+/**
+ * Takes an object of tests collected from all files,
+ * and removes all tests that do not have the given tag applied.
+ * Modifies the given object in place.
+ */
+function pickTaggedTestsFrom(json, tag) {
+  Object.keys(json).forEach((filename) => {
+    const fileTests = json[filename].tests
+    pickTaggedTests(fileTests, tag)
+  })
+
+  const result = removeEmptyNodes(json)
+  addCounts(result)
+  return result
+}
+
+module.exports = {
+  arraysOverlap,
+  pickTaggedTestsFrom,
+  removeEmptyNodes,
+  pickTaggedTests,
+}