Enhance test logging

akd-io · akd-io · commit b5822c9ba25a · 2023-04-29T21:41:44.000+02:00
diff --git a/packages/create-next-stack/package.json b/packages/create-next-stack/package.json
@@ -51,12 +51,12 @@
     "build": "rimraf lib && tsc --build",
     "clean": "rimraf lib && pnpm run clean-tests-dir",
     "clean-tests-dir": "ts-node src/tests/e2e/clean-tests-dir.ts",
-    "test": "pnpm build && node lib/tests/e2e/test.js",
-    "test:manual": "pnpm build && node lib/tests/e2e/test-manual.js --debug",
-    "test:small": "pnpm build && node lib/tests/e2e/test-manual.js --debug --package-manager=pnpm --styling=css-modules",
-    "test:large": "pnpm build && node lib/tests/e2e/test-manual.js --debug --package-manager=pnpm --styling=emotion --react-hook-form --formik --prettier --formatting-pre-commit-hook --chakra --framer-motion --github-actions",
-    "test:cna": "pnpm build && node lib/tests/e2e/test-live-cna.js",
-    "test:cns": "pnpm build && node lib/tests/e2e/test-live-cns.js",
+    "test": "pnpm build && ts-node src/tests/e2e/test.ts",
+    "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",
     "print:help": "pnpm build && ./bin/dev --help",
     "print:version": "pnpm build && ./bin/dev --help",
     "version": "oclif-dev readme && git add README.md",
diff --git a/packages/create-next-stack/src/main/helpers/in-debug-mode.ts b/packages/create-next-stack/src/main/helpers/in-debug-mode.ts
@@ -1 +1,2 @@
 export const inDebugMode = (): boolean => process.env["DEBUG"] === "true"
+export const inTestMode = (): boolean => process.env["TEST"] === "true"
diff --git a/packages/create-next-stack/src/main/helpers/run-command.ts b/packages/create-next-stack/src/main/helpers/run-command.ts
@@ -8,5 +8,6 @@ export const runCommand = (
   options?: Options
 ): ExecaChildProcess<string> => {
   logDebug("Running command:", prettyCommand(file, args))
+  logDebug("Running command in:", options?.cwd ?? process.cwd())
   return execa(file, args, options)
 }
diff --git a/packages/create-next-stack/src/main/logging.ts b/packages/create-next-stack/src/main/logging.ts
@@ -1,5 +1,5 @@
 import chalk from "chalk"
-import { inDebugMode } from "./helpers/in-debug-mode"
+import { inDebugMode, inTestMode } from "./helpers/in-debug-mode"
 import { prefixLines } from "./helpers/prefix-lines"
 
 const infoPrefix = chalk.cyan("info ")
@@ -12,7 +12,7 @@ export const logInfo = (...strings: string[]): void => {
 }
 
 export const logDebug = (...strings: string[]): void => {
-  if (inDebugMode()) {
+  if (inDebugMode() || inTestMode()) {
     console.debug(prefixLines(debugPrefix, chalk.white(strings.join(" "))))
   }
 }
diff --git a/packages/create-next-stack/src/tests/e2e/clean-tests-dir.ts b/packages/create-next-stack/src/tests/e2e/clean-tests-dir.ts
@@ -1,6 +1,8 @@
 import fs from "fs/promises"
 import path from "path"
 ;(async () => {
+  process.env["TEST"] = "true"
+
   const testsDirectory = path.resolve(
     __dirname,
     "../../../../../../create-next-stack-tests"
diff --git a/packages/create-next-stack/src/tests/e2e/helpers/log-test-meta.ts b/packages/create-next-stack/src/tests/e2e/helpers/log-test-meta.ts
@@ -0,0 +1,7 @@
+import chalk from "chalk"
+import { logTestInfo } from "../test-logging"
+
+export const logTestMeta = (testName: string, testFilePath: string): void => {
+  logTestInfo(chalk.yellow`Running test: ${testName}`)
+  logTestInfo(`Test file path: ${testFilePath}`)
+}
diff --git a/packages/create-next-stack/src/tests/e2e/test-live-cna.ts b/packages/create-next-stack/src/tests/e2e/test-live-cna.ts
@@ -1,11 +1,12 @@
 import chalk from "chalk"
 import endent from "endent"
 import { v4 as uuidv4 } from "uuid"
-import { prettyCommand } from "../../main/helpers/pretty-command"
 import { runCommand } from "../../main/helpers/run-command"
 import { exitWithError } from "./helpers/exit-with-error"
 import { logTestInfo } from "./test-logging"
 ;(async () => {
+  process.env["TEST"] = "true"
+
   try {
     const projectName = uuidv4()
     const runDirectory = `../../../create-next-stack-tests/${projectName}`
@@ -17,7 +18,6 @@ import { logTestInfo } from "./test-logging"
       ...process.argv.slice(2),
     ]
 
-    logTestInfo("Running command:", prettyCommand(command, args))
     await runCommand(command, args, { stdio: "inherit" })
 
     logTestInfo("")
diff --git a/packages/create-next-stack/src/tests/e2e/test-live-cns.ts b/packages/create-next-stack/src/tests/e2e/test-live-cns.ts
@@ -1,12 +1,13 @@
 import chalk from "chalk"
 import endent from "endent"
 import { v4 as uuidv4 } from "uuid"
-import { prettyCommand } from "../../main/helpers/pretty-command"
 import { runCommand } from "../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "./helpers/check-formatting-linting-build"
 import { exitWithError } from "./helpers/exit-with-error"
 import { logTestInfo } from "./test-logging"
 ;(async () => {
+  process.env["TEST"] = "true"
+
   try {
     const projectName = uuidv4()
     const runDirectory = `../../../create-next-stack-tests/${projectName}`
@@ -18,8 +19,6 @@ import { logTestInfo } from "./test-logging"
       runDirectory,
     ]
 
-    logTestInfo("Running command:", prettyCommand(command, args))
-
     await runCommand(command, args, { stdio: "inherit" })
 
     await checkFormattingLintingBuild(runDirectory)
diff --git a/packages/create-next-stack/src/tests/e2e/test-manual.ts b/packages/create-next-stack/src/tests/e2e/test-manual.ts
@@ -1,24 +1,19 @@
 import chalk from "chalk"
 import endent from "endent"
 import { v4 as uuidv4 } from "uuid"
-import { prettyCommand } from "../../main/helpers/pretty-command"
 import { runCommand } from "../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "./helpers/check-formatting-linting-build"
 import { exitWithError } from "./helpers/exit-with-error"
 import { logTestInfo } from "./test-logging"
 ;(async () => {
+  process.env["TEST"] = "true"
+
   try {
     const projectName = uuidv4()
     const runDirectory = `../../../create-next-stack-tests/${projectName}`
 
     const pathToCLI = "./bin/dev"
     const args = [...process.argv.slice(2), runDirectory]
-    logTestInfo(
-      "Running command:",
-      prettyCommand(pathToCLI, args),
-      "in directory:",
-      runDirectory
-    )
     await runCommand(pathToCLI, args, { stdio: "inherit" })
 
     await checkFormattingLintingBuild(runDirectory)
diff --git a/packages/create-next-stack/src/tests/e2e/test.ts b/packages/create-next-stack/src/tests/e2e/test.ts
@@ -21,6 +21,8 @@ import { testYarn } from "./tests/test-yarn"
 ;(async () => {
   // TODO: Find a way to run tests in parallel. Currently failing because simultaneous calls to `npm i -g yarn` or `npm install -g mrm@^3.0.0 mrm-task-lint-staged@^6.0.0` cause crashes.
 
+  process.env["TEST"] = "true"
+
   try {
     // If not done already, Set Git name and email so `git commit` doesn't fail during create-next-app
     await setGitNameAndEmail()
diff --git a/packages/create-next-stack/src/tests/e2e/tests/css-modules-with-sass/css-modules-with-sass-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/css-modules-with-sass/css-modules-with-sass-all-flags.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testCssModulesWithSassAllFlags = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testCssModulesWithSassAllFlags.name}`)
+  logTestMeta(testCssModulesWithSassAllFlags.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -25,13 +24,6 @@ export const testCssModulesWithSassAllFlags = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/css-modules-with-sass/css-modules-with-sass-only.ts b/packages/create-next-stack/src/tests/e2e/tests/css-modules-with-sass/css-modules-with-sass-only.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testCssModulesWithSassOnly = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testCssModulesWithSassOnly.name}`)
+  logTestMeta(testCssModulesWithSassOnly.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -19,13 +18,6 @@ export const testCssModulesWithSassOnly = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/css-modules/css-modules-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/css-modules/css-modules-all-flags.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testCssModulesAllFlags = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testCssModulesAllFlags.name}`)
+  logTestMeta(testCssModulesAllFlags.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -25,13 +24,6 @@ export const testCssModulesAllFlags = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/css-modules/css-modules-only.ts b/packages/create-next-stack/src/tests/e2e/tests/css-modules/css-modules-only.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testCssModulesOnly = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testCssModulesOnly.name}`)
+  logTestMeta(testCssModulesOnly.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -19,13 +18,6 @@ export const testCssModulesOnly = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/emotion/emotion-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/emotion/emotion-all-flags.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testEmotionAllFlags = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testEmotionAllFlags.name}`)
+  logTestMeta(testEmotionAllFlags.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -27,13 +26,6 @@ export const testEmotionAllFlags = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/emotion/emotion-only.ts b/packages/create-next-stack/src/tests/e2e/tests/emotion/emotion-only.ts
@@ -1,26 +1,18 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testEmotionOnly = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testEmotionOnly.name}`)
+  logTestMeta(testEmotionOnly.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
   const args = ["--debug", "--package-manager=pnpm", "--styling=emotion", "."]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/styled-components/styled-components-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/styled-components/styled-components-all-flags.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testStyledComponentsAllFlags = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testStyledComponentsAllFlags.name}`)
+  logTestMeta(testStyledComponentsAllFlags.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -25,13 +24,6 @@ export const testStyledComponentsAllFlags = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/styled-components/styled-components-only.ts b/packages/create-next-stack/src/tests/e2e/tests/styled-components/styled-components-only.ts
@@ -1,14 +1,13 @@
-import { prettyCommand } from "../../../../main/helpers/pretty-command"
 import { runCommand } from "../../../../main/helpers/run-command"
 import { checkFormattingLintingBuild } from "../../helpers/check-formatting-linting-build"
+import { logTestMeta } from "../../helpers/log-test-meta"
 import { minutesToMilliseconds } from "../../helpers/minutes-to-milliseconds"
 import { prepareE2eTest } from "../../helpers/prepare-e2e-test"
-import { logTestInfo } from "../../test-logging"
 
 export const testStyledComponentsOnly = async (
   createNextStackDir: string
 ): Promise<void> => {
-  logTestInfo(`Running test: ${testStyledComponentsOnly.name}`)
+  logTestMeta(testStyledComponentsOnly.name, __filename)
 
   const { pathToCLI, runDirectory } = await prepareE2eTest(createNextStackDir)
 
@@ -19,13 +18,6 @@ export const testStyledComponentsOnly = async (
     ".",
   ]
 
-  logTestInfo(
-    "Running command:",
-    prettyCommand(pathToCLI, args),
-    "in directory:",
-    runDirectory
-  )
-
   await runCommand(pathToCLI, args, {
     timeout: minutesToMilliseconds(10),
     cwd: runDirectory,
diff --git a/packages/create-next-stack/src/tests/e2e/tests/tailwind-css/tailwind-css-all-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/tailwind-css/tailwind-css-all-flags.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/tailwind-css/tailwind-css-only.ts b/packages/create-next-stack/src/tests/e2e/tests/tailwind-css/tailwind-css-only.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-help-flag.ts b/packages/create-next-stack/src/tests/e2e/tests/test-help-flag.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-invalid-inputs.ts b/packages/create-next-stack/src/tests/e2e/tests/test-invalid-inputs.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-no-flags.ts b/packages/create-next-stack/src/tests/e2e/tests/test-no-flags.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-npm.ts b/packages/create-next-stack/src/tests/e2e/tests/test-npm.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-version-flag.ts b/packages/create-next-stack/src/tests/e2e/tests/test-version-flag.ts
diff --git a/packages/create-next-stack/src/tests/e2e/tests/test-yarn.ts b/packages/create-next-stack/src/tests/e2e/tests/test-yarn.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export const inDebugMode = (): boolean => process.env["DEBUG"] === "true"`
	`2`	`+export const inTestMode = (): boolean => process.env["TEST"] === "true"`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ export const runCommand = (`
`8`	`8`	`options?: Options`
`9`	`9`	`): ExecaChildProcess<string> => {`
`10`	`10`	`logDebug("Running command:", prettyCommand(file, args))`
	`11`	`+ logDebug("Running command in:", options?.cwd ?? process.cwd())`
`11`	`12`	`return execa(file, args, options)`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import chalk from "chalk"`
`2`		`-import { inDebugMode } from "./helpers/in-debug-mode"`
	`2`	`+import { inDebugMode, inTestMode } from "./helpers/in-debug-mode"`
`3`	`3`	`import { prefixLines } from "./helpers/prefix-lines"`
`4`	`4`
`5`	`5`	`const infoPrefix = chalk.cyan("info ")`
`@@ -12,7 +12,7 @@ export const logInfo = (...strings: string[]): void => {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`export const logDebug = (...strings: string[]): void => {`
`15`		`- if (inDebugMode()) {`
	`15`	`+ if (inDebugMode() \|\| inTestMode()) {`
`16`	`16`	`console.debug(prefixLines(debugPrefix, chalk.white(strings.join(" "))))`
`17`	`17`	`}`
`18`	`18`	`}`