find-cypress-specs 1.7.0 → 1.11.0

package/README.md

@@ -1,4 +1,4 @@
-# find-cypress-specs ![cypress version](https://img.shields.io/badge/cypress-9.2.0-brightgreen)
+# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-9.2.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
 
@@ -8,6 +8,15 @@ $ npx find-cypress-specs
 cypress/e2e/spec.js,cypress/e2e/featureA/user.js
 ```
 
+## against branch
+
+By default, this module simply prints all spec filenames. You can add `--branch` parameter to only print the specs changed against that `origin/branch`.
+
+```bash
+$ npx find-cypress-specs --branch main
+# prints only some specs, the ones that have changed against the "origin/main"
+```
+
 ## Test names
 
 You can print each spec file with the suite and test names inside of it (found using [find-test-names](https://github.com/bahmutov/find-test-names))
@@ -31,6 +40,8 @@ found 2 specs (4 tests, 1 pending)
 
 Where the tags are listed inside `[ ... ]` (see [cypress-grep](https://github.com/cypress-io/cypress-grep)) and the [pending tests](https://glebbahmutov.com/blog/cypress-test-statuses/) are marked with `⊙` character.
 
+You can print the results in JSON format using `--json` or `-j` option.
+
 ## Test tags
 
 You can count tags attached to the individual tests using `--tags` arguments
@@ -47,6 +58,8 @@ Tag    Tests
 
 Each tag count includes the tests that use the tag directly, and the _effective_ tags applied from the parent suites.
 
+You can print the results in JSON format using `--json` or `-j` option.
+
 ## 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.
@@ -57,6 +70,10 @@ You can see how Cypress finds the specs using `DEBUG=cypress:cli,cypress:server:
 
 Run the utility with environment variable `DEBUG=find-cypress-specs` to see the verbose logs
 
+## Videos
+
+- [Use Ava Snapshots And Execa-wrap To Write End-to-End Tests For CLI Utilities](https://youtu.be/rsw17RqP0G0)
+
 ## Small print
 
 Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022
@@ -97,3 +114,6 @@ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
+
+[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
+[renovate-app]: https://renovateapp.com/

package/bin/find.js

@@ -1,23 +1,32 @@
 #!/usr/bin/env node
 
 const arg = require('arg')
-const { getSpecs } = require('../src')
+const { getSpecs, collectResults, findChangedFiles } = require('../src')
 const fs = require('fs')
 const pluralize = require('pluralize')
 const { getTestNames, formatTestList, countTags } = require('find-test-names')
 const consoleTable = require('console.table')
+const debug = require('debug')('find-cypress-specs')
 
 const args = arg({
   '--names': Boolean,
   '--tags': Boolean,
+  // output in JSON format
+  '--json': Boolean,
+  // find the specs that have changed against this Git branch
+  '--branch': String,
 
   // aliases
   '-n': '--names',
   '--name': '--names',
   '-t': '--tags',
   '--tag': '--tags',
+  '-j': '--json',
+  '-b': '--branch',
 })
 
+debug('arguments %o', args)
+
 const specs = getSpecs()
 if (args['--names'] || args['--tags']) {
   if (!specs.length) {
@@ -30,7 +39,10 @@ if (args['--names'] || args['--tags']) {
     // counts the number of tests for each tag across all specs
     const tagTestCounts = {}
 
+    const jsonResults = {}
+
     specs.forEach((filename) => {
+      jsonResults[filename] = []
       const source = fs.readFileSync(filename, 'utf8')
       const result = getTestNames(source, true)
       // enable if need to debug the parsed test
@@ -41,18 +53,22 @@ if (args['--names'] || args['--tags']) {
       pendingTestsN += result.pendingTestCount
 
       if (args['--names']) {
-        if (result.pendingTestCount) {
-          console.log(
-            '%s (%s, %d pending)',
-            filename,
-            testCount,
-            result.pendingTestCount,
-          )
+        if (args['--json']) {
+          collectResults(result.structure, jsonResults[filename])
         } else {
-          console.log('%s (%s)', filename, testCount)
+          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('')
         }
-        console.log(formatTestList(result.structure))
-        console.log('')
       }
 
       if (args['--tags']) {
@@ -68,19 +84,23 @@ if (args['--names'] || args['--tags']) {
     })
 
     if (args['--names']) {
-      if (pendingTestsN) {
-        console.log(
-          'found %s (%s, %d pending)',
-          pluralize('spec', specs.length, true),
-          pluralize('test', testsN, true),
-          pendingTestsN,
-        )
+      if (args['--json']) {
+        console.log(JSON.stringify(jsonResults, null, 2))
       } else {
-        console.log(
-          'found %s (%s)',
-          pluralize('spec', specs.length, true),
-          pluralize('test', testsN, true),
-        )
+        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),
+          )
+        }
       }
       console.log('')
     }
@@ -91,10 +111,22 @@ if (args['--names'] || args['--tags']) {
         // every entry is [tag, count], so compare the tags
         return a[0].localeCompare(b[0])
       })
-      const table = consoleTable.getTable(['Tag', 'Tests'], sortedTagEntries)
-      console.log(table)
+      if (args['--json']) {
+        // assemble a json object with the tag counts
+        const tagResults = Object.fromEntries(sortedTagEntries)
+        console.log(JSON.stringify(tagResults, null, 2))
+      } else {
+        const table = consoleTable.getTable(['Tag', 'Tests'], sortedTagEntries)
+        console.log(table)
+      }
     }
   }
+} else if (args['--branch']) {
+  debug('determining specs changed against branch %s', args['--branch'])
+  const changedFiles = findChangedFiles(args['--branch'])
+  debug('changed files %o', changedFiles)
+  const changedSpecs = specs.filter((file) => changedFiles.includes(file))
+  console.log(changedSpecs.join(','))
 } else {
   console.log(specs.join(','))
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.7.0",
+  "version": "1.11.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -16,7 +16,11 @@
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
     "demo-names": "node ./bin/find --names",
     "demo-tags": "node ./bin/find --tags",
+    "demo-tags-json": "node ./bin/find --tags --json",
     "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",
+    "print-changed-specs": "node ./bin/find --branch main",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -35,6 +39,7 @@
   "devDependencies": {
     "ava": "^4.0.0",
     "cypress": "^9.2.0",
+    "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "semantic-release": "^18.0.1"
   },
@@ -45,6 +50,7 @@
     "find-test-names": "^1.14.1",
     "globby": "^11.0.4",
     "minimatch": "^3.0.4",
-    "pluralize": "^8.0.0"
+    "pluralize": "^8.0.0",
+    "shelljs": "^0.8.5"
   }
 }

package/src/index.js

@@ -3,6 +3,7 @@ const fs = require('fs')
 const path = require('path')
 const globby = require('globby')
 const minimatch = require('minimatch')
+const shell = require('shelljs')
 
 const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
 
@@ -72,9 +73,66 @@ function getSpecs() {
   return specs
 }
 
+function collectResults(structure, results) {
+  structure.forEach((t) => {
+    const info = {
+      name: t.name,
+      type: t.type,
+      tags: t.tags,
+    }
+    if (t.pending) {
+      info.pending = t.pending
+    }
+    results.push(info)
+    if (t.type === 'suite') {
+      if (t.suites && t.suites.length) {
+        // skip empty nested suites
+        info.suites = []
+        collectResults(t.suites, info.suites)
+      }
+
+      if (t.tests && t.tests.length) {
+        // skip empty nested tests
+        info.tests = []
+        collectResults(t.tests, info.tests)
+      }
+    }
+  })
+}
+
+/**
+ * Finds files changed or added in the current branch when compared to the "origin/branch".
+ * Returns a list of filenames. If there are no files, returns an empty list.
+ * @param {string} branch The branch to compare against.
+ */
+function findChangedFiles(branch) {
+  if (!branch) {
+    throw new Error('branch is required')
+  }
+
+  if (!shell.which('git')) {
+    shell.echo('Sorry, this script requires git')
+    return []
+  }
+
+  const result = shell.exec(
+    `git diff --name-only --diff-filter=AMR origin/${branch}`,
+    { silent: true },
+  )
+  if (result.code !== 0) {
+    debug('git diff failed with code %d', result.code)
+    return []
+  }
+
+  const filenames = result.stdout.split('\n').filter(Boolean)
+  return filenames
+}
+
 module.exports = {
   getSpecs,
   // individual utilities
   getConfig,
   findCypressSpecs,
+  collectResults,
+  findChangedFiles,
 }