Smoke tests (#458)

gustavohenke · web-flow · commit fd21485203fa · 2024-02-25T05:28:06.000-03:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -55,9 +55,13 @@ jobs:
       - name: Install dependencies
         run: pnpm install && pnpm add --global concurrently
 
-      - name: Build & Test
+      - name: Build & Unit Test
         run: concurrently --prefix none --group "pnpm:build" "pnpm:test"
 
+      - name: Smoke Test
+        # Don't collect coverage here as it overrides the unit test's coverage
+        run: pnpm test:smoke --coverage=false
+
       - name: Submit coverage
         uses: coverallsapp/github-action@master
         continue-on-error: true
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 # Outputs
-/dist
+dist
 
 # Logs
 *.log
diff --git a/jest.config.js b/jest.config.js
@@ -1,11 +1,30 @@
-/** @type {import('@jest/types').Config.InitialOptions} */
-const config = {
+// Need to extend from a base config because projects don't inherit configurations as documented
+// https://github.com/jestjs/jest/issues/11411
+/** @type {import('@jest/types').Config.InitialProjectOptions} */
+const baseConfig = {
     transform: {
-        '^.+\\.(t|j)sx?$': ['@swc/jest'],
+        '.*': ['@swc/jest'],
     },
-    collectCoverage: true,
-    collectCoverageFrom: ['src/**/*.ts', '!src/index.ts'],
     testPathIgnorePatterns: ['/node_modules/', '/dist'],
 };
 
+/** @type {import('@jest/types').Config.InitialOptions} */
+const config = {
+    collectCoverage: true,
+    projects: [
+        {
+            ...baseConfig,
+            displayName: 'unit',
+            collectCoverageFrom: ['src/**/*.ts', '!src/index.ts'],
+            // (src|bin) doesn't seem to work on Windows
+            testMatch: ['src', 'bin'].map((dir) => `<rootDir>/${dir}/**/*.spec.ts`),
+        },
+        {
+            ...baseConfig,
+            displayName: 'smoke',
+            testMatch: ['<rootDir>/tests/**/*.spec.ts'],
+        },
+    ],
+};
+
 module.exports = config;
diff --git a/package.json b/package.json
@@ -35,7 +35,8 @@
     "lint:fix": "pnpm run lint --fix",
     "prepublishOnly": "safe-publish-latest && pnpm run build",
     "report-coverage": "cat coverage/lcov.info | coveralls",
-    "test": "jest",
+    "test": "jest --selectProjects unit",
+    "test:smoke": "jest --selectProjects smoke",
     "prepare": "husky install"
   },
   "repository": {
diff --git a/tests/cjs-import/package.json b/tests/cjs-import/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}
diff --git a/tests/cjs-import/smoke-test.ts b/tests/cjs-import/smoke-test.ts
@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type { ConcurrentlyResult } from 'concurrently';
+import concurrently, { concurrently as concurrently2, createConcurrently } from 'concurrently';
+
+const result: ConcurrentlyResult = concurrently(['ls'], {
+    raw: true,
+});
+
+const result2: ConcurrentlyResult = concurrently2(['ls'], {
+    killOthers: ['failure'],
+});
+
+const result3: ConcurrentlyResult = createConcurrently(['ls'], {
+    successCondition: 'all',
+});
diff --git a/tests/cjs-import/tsconfig.json b/tests/cjs-import/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "skipLibCheck": true
+  }
+}
diff --git a/tests/cjs-require/package.json b/tests/cjs-require/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}
diff --git a/tests/cjs-require/smoke-test.ts b/tests/cjs-require/smoke-test.ts
@@ -0,0 +1,17 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import concurrently = require('concurrently');
+
+const { concurrently: concurrently2, createConcurrently } = concurrently;
+
+const result: concurrently.ConcurrentlyResult = concurrently(['ls'], {
+    raw: true,
+});
+
+const result2: concurrently.ConcurrentlyResult = concurrently2(['ls'], {
+    killOthers: ['failure'],
+});
+
+const result3: concurrently.ConcurrentlyResult = createConcurrently(['ls'], {
+    successCondition: 'all',
+});
diff --git a/tests/cjs-require/tsconfig.json b/tests/cjs-require/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "skipLibCheck": true
+  }
+}
diff --git a/tests/esm/package.json b/tests/esm/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}
diff --git a/tests/esm/smoke-test.ts b/tests/esm/smoke-test.ts
@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type { ConcurrentlyResult } from 'concurrently';
+import concurrently, { concurrently as concurrently2, createConcurrently } from 'concurrently';
+
+const result: ConcurrentlyResult = concurrently(['ls'], {
+    raw: true,
+});
+
+const result2: ConcurrentlyResult = concurrently2(['ls'], {
+    killOthers: ['failure'],
+});
+
+const result3: ConcurrentlyResult = createConcurrently(['ls'], {
+    successCondition: 'all',
+});
diff --git a/tests/esm/tsconfig.json b/tests/esm/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "Node16",
+    "moduleResolution": "Node16"
+  }
+}
diff --git a/tests/package.json b/tests/package.json
@@ -0,0 +1,8 @@
+{
+  "dependencies": {
+    "concurrently": "file:.."
+  },
+  "scripts": {
+    "test": "pnpm --prefix .. test -- --selectProjects smoke"
+  }
+}
diff --git a/tests/pnpm-lock.yaml b/tests/pnpm-lock.yaml
diff --git a/tests/smoke-tests.spec.ts b/tests/smoke-tests.spec.ts
@@ -0,0 +1,21 @@
+import { exec as originalExec } from 'child_process';
+import * as util from 'util';
+
+const exec = util.promisify(originalExec);
+
+beforeAll(async () => {
+    await exec('pnpm build', { cwd: `${__dirname}/..` });
+    await exec('pnpm install', { cwd: __dirname });
+}, 10000);
+
+it.each(['cjs-import', 'cjs-require', 'esm'])(
+    '%s',
+    async (project) => {
+        // Use as separate execs as tsc outputs to stdout, instead of stderr, and so its text isn't shown
+        await exec(`tsc -p ${project}`, { cwd: __dirname }).catch((err) =>
+            Promise.reject(err.stdout),
+        );
+        await exec(`node ${project}/dist/smoke-test.js`, { cwd: __dirname });
+    },
+    10000,
+);

-Original file line number
+Diff line change
@@ @@ -1,5 +1,5 @@ @@
 # Outputs
 -/dist
 +dist
 # Logs
 *.log