find-cypress-specs 1.20.2 → 1.22.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-12.0.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-12.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
 
@@ -19,6 +19,20 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## set GitHub Actions outputs
+
+If you add `--set-gh-outputs` command line switch, then the number of changed specs and the comma-separated file list will be set as GH Actions outputs `changedSpecsN` and `changedSpecs`. See [pr.yml](./.github/workflows/pr.yml) for example
+
+```yml
+- name: Print specs changed against the parent of this branch 🌳
+  # and set GitHub Actions output
+  id: step1
+  run: node ./bin/find --branch main --parent --set-gha-outputs
+
+- name: Print set outputs
+  run: echo ${{ steps.step1.outputs.changedSpecsN }} ${{ steps.step1.outputs.changedSpecs }}
+```
+
 ## against the parent commit
 
 When dealing with a long-term branch, you do not want to see the changed files in the main branch. Instead, you want to only consider the specs changed in the _current_ branch all the way to its parent commit. You can pass the flag `--parent` to only pick the modified and added specs.
@@ -37,6 +51,16 @@ $ git fetch
 $ npx find-cypress-specs --branch main --parent
 ```
 
+## with traced import and require statements
+
+Imagine you open a pull request and only change something in an `utils.js` file used by other specs. Which specs should you run? By default `--branch main --parent` would not find any changed specs, so no specs would execute, and you will have to run _all_ specs just to be safe. This program has a mode `--trace-imports <subfolder>` which uses [spec-change](https://github.com/bahmutov/spec-change) to inspect JS/TS files and find dependencies between them. Thus it can discover that when `utils.js` changes, the specs that `import './utils'` or `require('./utils')` should also be considered modified.
+
+```
+$ npx find-cypress-specs --branch main --parent --trace-imports cypress
+```
+
+**Note:** the argument is the subfolder name to limit the number of files to inspect when tracing the imports.
+
 ### number of changed files
 
 You can print just the number of changed specs

package/bin/find.js

@@ -7,9 +7,12 @@ const { addCounts } = require('../src/count')
 const { stringAllInfo } = require('../src/print')
 
 const fs = require('fs')
+const path = require('path')
 const { getTestNames, countTags } = require('find-test-names')
 const consoleTable = require('console.table')
 const debug = require('debug')('find-cypress-specs')
+const { getDependsInFolder } = require('spec-change')
+const core = require('@actions/core')
 
 const args = arg({
   '--names': Boolean,
@@ -25,7 +28,15 @@ const args = arg({
   '--tagged': String,
   // print only the "it.only" tests
   '--skipped': Boolean,
-
+  // when finding specs changed against a given parent of the branch
+  // also look at the import and require statements to trace dependencies
+  // and consider specs that import a changes source file changed to
+  // The value of this argument is the subfolder with Cypress tests, like "cypress"
+  '--trace-imports': String,
+  // when enabled, this code uses GitHub Actions Core package
+  // to set two named outputs, one for number of changed specs
+  // another for actual list of files
+  '--set-gha-outputs': Boolean,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -33,6 +44,7 @@ const args = arg({
   '--tag': '--tags',
   '-j': '--json',
   '-b': '--branch',
+  '--deps': '--trace-imports',
   // Cypress test status (just like Mocha)
   // calls "it.skip" pending tests
   // https://glebbahmutov.com/blog/cypress-test-statuses/
@@ -124,11 +136,39 @@ if (args['--names'] || args['--tags']) {
   }
 } else if (args['--branch']) {
   debug('determining specs changed against branch %s', args['--branch'])
-  const changedFiles = findChangedFiles(args['--branch'], args['--parent'])
+  let changedFiles = findChangedFiles(args['--branch'], args['--parent'])
   debug('changed files %o', changedFiles)
   debug('comparing against the specs %o', specs)
+  if (args['--trace-imports']) {
+    debug('tracing dependent changes in folder %s', args['--trace-imports'])
+    const absoluteFolder = path.join(process.cwd(), args['--trace-imports'])
+    const deps = getDependsInFolder(absoluteFolder)
+    debug('traced dependencies via imports and require')
+    debug(deps)
+    Object.entries(deps).forEach(([filename, fileDependents]) => {
+      const f = path.join(args['--trace-imports'], filename)
+      if (changedFiles.includes(f)) {
+        debug(
+          'the source file %s has changed, including its dependents %o in the list of changed files',
+          f,
+          fileDependents,
+        )
+        fileDependents.forEach((name) => {
+          const nameInCypressFolder = path.join(args['--trace-imports'], name)
+          if (!changedFiles.includes(nameInCypressFolder)) {
+            changedFiles.push(nameInCypressFolder)
+          }
+        })
+      }
+    })
+  }
   let changedSpecs = specs.filter((file) => changedFiles.includes(file))
-  debug('changed specs %o', changedSpecs)
+  debug('changed %d specs %o', changedSpecs.length, changedSpecs)
+  if (args['--set-gha-outputs']) {
+    debug('setting GitHub Actions outputs changedSpecsN and changedSpecs')
+    core.setOutput('changedSpecsN', changedSpecs.length)
+    core.setOutput('changedSpecs', changedSpecs.join(','))
+  }
 
   if (args['--tagged']) {
     const splitTags = args['--tagged']

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.20.2",
+  "version": "1.22.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -24,7 +24,9 @@
     "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"
+    "semantic-release": "semantic-release",
+    "deps": "spec-change --folder . --mask 'cypress/**/*.{js,ts}'",
+    "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress"
   },
   "repository": {
     "type": "git",
@@ -41,7 +43,7 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "12.0.1",
+    "cypress": "12.2.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",
@@ -50,6 +52,7 @@
     "typescript": "^4.6.3"
   },
   "dependencies": {
+    "@actions/core": "^1.10.0",
     "arg": "^5.0.1",
     "console.table": "^0.10.0",
     "debug": "^4.3.3",
@@ -59,6 +62,7 @@
     "pluralize": "^8.0.0",
     "require-and-forget": "^1.0.0",
     "shelljs": "^0.8.5",
+    "spec-change": "^1.4.0",
     "ts-node": "^10.9.1"
   }
 }

package/src/index.js

@@ -240,8 +240,8 @@ function findChangedFiles(branch, useParent) {
 
     const filenames = result.stdout
       .split('\n')
-      .filter(Boolean)
       .map((s) => s.trim())
+      .filter(Boolean)
     return filenames
   } else {
     const command = `git diff --name-only --diff-filter=AMR origin/${branch}`
@@ -255,8 +255,8 @@ function findChangedFiles(branch, useParent) {
 
     const filenames = result.stdout
       .split('\n')
-      .filter(Boolean)
       .map((s) => s.trim())
+      .filter(Boolean)
     debug(
       'found %d changed %s',
       filenames.length,