Merge pull request #232 from akd-io/feature/65-cli-make-tests-run-in-parallel

Make tests run in parallel

Author: akd-io

.github/workflows/cli-ci.yml

@@ -3,13 +3,48 @@ name: "CLI - CI"
 on: [pull_request]
 
 jobs:
+  get-test-files:
+    name: "Gets all e2e Jest test files for use in a later job"
+
+    runs-on: ubuntu-latest
+
+    outputs:
+      test-files: ${{ steps.set-test-files.outputs.files }}
+
+    steps:
+      - name: "Checkout repo"
+        uses: actions/checkout@v3
+
+      - name: "Set up pnpm"
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: "Set up Node 18"
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: pnpm
+
+      - name: "Install dependencies"
+        run: pnpm install
+
+      - name: "Get test files"
+        id: set-test-files
+        working-directory: packages/create-next-stack
+        run: |
+          echo "files=$(pnpm --silent get-e2e-test-files-array)" >> $GITHUB_OUTPUT
+
   build:
-    name: "Build, lint, test - ${{ matrix.os }}"
+    name: "Test - ${{ matrix.test-file.fileName }} - ${{ matrix.os }}"
+
+    needs: get-test-files
 
     strategy:
       matrix:
         node: ["18"]
         os: [ubuntu-latest, windows-latest, macOS-latest]
+        test-file: ${{ fromJSON(needs.get-test-files.outputs.test-files) }}
 
     runs-on: ${{ matrix.os }}
 
@@ -38,4 +73,5 @@ jobs:
         run: pnpm lint:cli
 
       - name: "Test"
-        run: pnpm test:cli
+        working-directory: packages/create-next-stack
+        run: pnpm jest-e2e:ci ${{ matrix.test-file.filePath }}

packages/create-next-stack/jest.config.js

@@ -3,5 +3,6 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
-  testPathIgnorePatterns: ["/node_modules/", "/lib/", "/src/tests/"],
+  testPathIgnorePatterns: ["/node_modules/", "/lib/"],
+  setupFilesAfterEnv: ["./override-jest-console.js"],
 }

packages/create-next-stack/override-jest-console.js

@@ -0,0 +1,2 @@
+// Overrides the default Jest console with the Node.js console.
+global.console = require("console")

packages/create-next-stack/package.json

@@ -50,15 +50,20 @@
     "check-types": "tsc --noEmit",
     "check-types:watch": "tsc --noEmit --watch",
     "build": "rimraf lib && tsc --build",
-    "build:watch": "rimraf lib && tsc --build --watch",
-    "clean": "rimraf lib && pnpm run clean-tests-dir",
+    "build:watch": "pnpm build --watch",
+    "clean": "rimraf lib && pnpm clean-tests-dir",
     "clean-tests-dir": "ts-node src/tests/e2e/clean-tests-dir.ts",
-    "test": "pnpm build && pnpm run jest && ts-node src/tests/e2e/test.ts",
+    "test": "pnpm build && pnpm jest-unit && pnpm jest-e2e",
     "jest": "jest",
-    "jest:watch": "jest --watch",
+    "jest-unit": "jest src/main/",
+    "jest-unit:ci": "jest --ci src/main/",
+    "jest-unit:watch": "pnpm jest-unit --watch",
+    "get-e2e-test-files-array": "jest --listTests src/tests/e2e/ | ts-node src/scripts/file-list-to-array.ts",
+    "jest-e2e": "jest --runInBand src/tests/e2e/",
+    "jest-e2e:watch": "pnpm jest-e2e --watch",
+    "jest-e2e:single": "jest --runInBand",
+    "jest-e2e:ci": "jest --runInBand --ci",
     "test:manual": "pnpm build && ts-node src/tests/e2e/test-manual.ts --debug",
-    "test:small": "pnpm build && ts-node src/tests/e2e/test-manual.ts --debug --package-manager=pnpm --styling=css-modules",
-    "test:large": "pnpm build && ts-node src/tests/e2e/test-manual.ts --debug --package-manager=pnpm --styling=emotion --react-hook-form --formik --prettier --formatting-pre-commit-hook --chakra --framer-motion --github-actions",
     "test:cna": "pnpm build && ts-node src/tests/e2e/test-live-cna.ts",
     "test:cns": "pnpm build && ts-node src/tests/e2e/test-live-cns.ts",
     "test:raw": "pnpm build && ./bin/dev",

packages/create-next-stack/src/scripts/file-list-to-array.ts

@@ -0,0 +1,20 @@
+import { resolve } from "path"
+
+/*
+This script reads each line of stdin and outputs a JSON array of the lines.
+This is useful for passing a list of files to a command.
+Example usage: `ls | node file-list-to-array.ts`
+*/
+
+let input = ""
+process.stdin.on("data", (data) => {
+  input += data.toString()
+})
+process.stdin.on("end", () => {
+  const filePaths = input.split("\n").filter(Boolean)
+  const files = filePaths.map((filePath) => ({
+    filePath: filePath.replace(resolve(process.cwd()) + "/", ""),
+    fileName: filePath.split("/").pop()?.split(".")[0] || filePath,
+  }))
+  console.log(JSON.stringify(files))
+})

packages/create-next-stack/src/tests/e2e/helpers/log-test-meta.ts

@@ -2,7 +2,7 @@ import { Options } from "execa"
 import { runCommand } from "../../../main/helpers/run-command"
 import { logTestInfo } from "../test-logging"
 
-export const performE2eChecks = async (
+export const performFinalChecks = async (
   runDirectory: string,
   args: string[]
 ): Promise<void> => {

packages/create-next-stack/src/tests/e2e/helpers/minutes-to-milliseconds.ts

@@ -3,13 +3,22 @@ import path from "path"
 import { v4 as uuidv4 } from "uuid"
 import { makeDirectory } from "../../../main/helpers/io"
 import { logTestInfo } from "../test-logging"
+import { setGitNameAndEmailIfMissing } from "./set-git-name-and-email"
 
-export const prepareE2eTest = async (
-  createNextStackDir: string
-): Promise<{
+/**
+ * Prepare an e2e test by creating a directory to run the CLI in.
+ *
+ * @returns The path to the CLI and the directory where the CLI was run.
+ */
+export const prepareE2eTest = async (): Promise<{
   pathToCLI: string
   runDirectory: string
 }> => {
+  process.env["TEST"] = "true"
+  await setGitNameAndEmailIfMissing()
+
+  const createNextStackDir = path.resolve(process.cwd())
+
   const testRunId = uuidv4()
 
   const runDirectory = path.resolve(

…elpers/check-formatting-linting-build.ts …ests/e2e/helpers/perform-final-checks.tspackages/create-next-stack/src/tests/e2e/helpers/check-formatting-linting-build.ts renamed to packages/create-next-stack/src/tests/e2e/helpers/perform-final-checks.ts packages/create-next-stack/src/tests/e2e/helpers/check-formatting-linting-build.ts renamed to packages/create-next-stack/src/tests/e2e/helpers/perform-final-checks.ts

@@ -1,7 +1,11 @@
 import { runCommand } from "../../../main/helpers/run-command"
 import { logTestError, logTestInfo } from "../test-logging"
 
-export const setGitNameAndEmail = async (): Promise<void> => {
+/**
+ * If not set already, sets Git name and email so `git commit` doesn't fail during create-next-app
+ * Missing git name and email is mainly a problem in CI/CD environments
+ */
+export const setGitNameAndEmailIfMissing = async (): Promise<void> => {
   try {
     await runCommand("git", ["config", "--global", "user.name"])
       .then((result) => {