test cleanup, remove or cleanup version checks, skip failing tsconfig "extends" tests on TS 2.7

cspotcode · cspotcode · commit 3f21c317038f · 2022-03-05T02:05:51.000-05:00
diff --git a/src/test/helpers.ts b/src/test/helpers.ts
@@ -17,17 +17,7 @@ import semver = require('semver');
 const createRequire: typeof _createRequire = require('create-require');
 export { tsNodeTypes };
 
-export const nodeSupportsEsmHooks = semver.gte(process.version, '12.16.0');
-export const nodeSupportsSpawningChildProcess = semver.gte(
-  process.version,
-  '12.17.0'
-);
-export const nodeUsesNewHooksApi = semver.gte(process.version, '16.12.0');
-export const nodeSupportsImportAssertions = semver.gte(
-  process.version,
-  '17.1.0'
-);
-
+//#region Paths
 export const ROOT_DIR = resolve(__dirname, '../..');
 export const DIST_DIR = resolve(__dirname, '..');
 export const TEST_DIR = join(__dirname, '../../tests');
@@ -40,6 +30,9 @@ export const BIN_SCRIPT_PATH = join(
 );
 export const BIN_CWD_PATH = join(TEST_DIR, 'node_modules/.bin/ts-node-cwd');
 export const BIN_ESM_PATH = join(TEST_DIR, 'node_modules/.bin/ts-node-esm');
+//#endregion
+
+//#region command lines
 /** Default `ts-node --project` invocation */
 export const CMD_TS_NODE_WITH_PROJECT_FLAG = `"${BIN_PATH}" --project "${PROJECT}"`;
 /** Default `ts-node` invocation without `--project` */
@@ -48,12 +41,33 @@ export const EXPERIMENTAL_MODULES_FLAG = semver.gte(process.version, '12.17.0')
   ? ''
   : '--experimental-modules';
 export const CMD_ESM_LOADER_WITHOUT_PROJECT = `node ${EXPERIMENTAL_MODULES_FLAG} --loader ts-node/esm`;
+//#endregion
 
 // `createRequire` does not exist on older node versions
 export const testsDirRequire = createRequire(join(TEST_DIR, 'index.js'));
 
 export const ts = testsDirRequire('typescript');
 
+//#region version checks
+export const nodeSupportsEsmHooks = semver.gte(process.version, '12.16.0');
+export const nodeSupportsSpawningChildProcess = semver.gte(
+  process.version,
+  '12.17.0'
+);
+export const nodeUsesNewHooksApi = semver.gte(process.version, '16.12.0');
+export const nodeSupportsImportAssertions = semver.gte(
+  process.version,
+  '17.1.0'
+);
+/** Supports tsconfig "extends" >= v3.2.0 */
+export const tsSupportsTsconfigInheritanceViaNodePackages = semver.gte(
+  ts.version,
+  '3.2.0'
+);
+/** Supports --showConfig: >= v3.2.0 */
+export const tsSupportsShowConfig = semver.gte(ts.version, '3.2.0');
+//#endregion
+
 export const xfs = new NodeFS(fs);
 
 /** Pass to `test.context()` to get access to the ts-node API under test */
@@ -65,6 +79,7 @@ export const contextTsNodeUnderTest = once(async () => {
   };
 });
 
+//#region install ts-node tarball
 const ts_node_install_lock = process.env.ts_node_install_lock as string;
 const lockPath = join(__dirname, ts_node_install_lock);
 
@@ -133,6 +148,7 @@ async function lockedMemoizedOperation(
     releaseLock();
   }
 }
+//#endregion
 
 /**
  * Get a stream into a string.
@@ -170,6 +186,8 @@ export function getStream(stream: Readable, waitForPattern?: string | RegExp) {
   }
 }
 
+//#region Reset node environment
+
 const defaultRequireExtensions = captureObjectState(require.extensions);
 const defaultProcess = captureObjectState(process);
 const defaultModule = captureObjectState(require('module'));
@@ -230,4 +248,6 @@ function resetObject(
   Object.defineProperties(object, state.descriptors);
 }
 
+//#endregion
+
 export const delay = promisify(setTimeout);
diff --git a/src/test/index.spec.ts b/src/test/index.spec.ts
@@ -3,7 +3,13 @@ import * as expect from 'expect';
 import { join, resolve, sep as pathSep } from 'path';
 import { tmpdir } from 'os';
 import semver = require('semver');
-import { BIN_PATH_JS, nodeSupportsEsmHooks, ts } from './helpers';
+import {
+  BIN_PATH_JS,
+  nodeSupportsEsmHooks,
+  ts,
+  tsSupportsShowConfig,
+  tsSupportsTsconfigInheritanceViaNodePackages,
+} from './helpers';
 import { lstatSync, mkdtempSync } from 'fs';
 import { npath } from '@yarnpkg/fslib';
 import type _createRequire from 'create-require';
@@ -167,31 +173,29 @@ test.suite('ts-node', (test) => {
       expect(stdout).toBe('object\n');
     });
 
-    if (semver.gte(ts.version, '1.8.0')) {
-      test('should allow js', async () => {
-        const { err, stdout } = await exec(
-          [
-            CMD_TS_NODE_WITH_PROJECT_FLAG,
-            '-O "{\\"allowJs\\":true}"',
-            '-pe "import { main } from \'./allow-js/run\';main()"',
-          ].join(' ')
-        );
-        expect(err).toBe(null);
-        expect(stdout).toBe('hello world\n');
-      });
+    test('should allow js', async () => {
+      const { err, stdout } = await exec(
+        [
+          CMD_TS_NODE_WITH_PROJECT_FLAG,
+          '-O "{\\"allowJs\\":true}"',
+          '-pe "import { main } from \'./allow-js/run\';main()"',
+        ].join(' ')
+      );
+      expect(err).toBe(null);
+      expect(stdout).toBe('hello world\n');
+    });
 
-      test('should include jsx when `allow-js` true', async () => {
-        const { err, stdout } = await exec(
-          [
-            CMD_TS_NODE_WITH_PROJECT_FLAG,
-            '-O "{\\"allowJs\\":true}"',
-            '-pe "import { Foo2 } from \'./allow-js/with-jsx\'; Foo2.sayHi()"',
-          ].join(' ')
-        );
-        expect(err).toBe(null);
-        expect(stdout).toBe('hello world\n');
-      });
-    }
+    test('should include jsx when `allow-js` true', async () => {
+      const { err, stdout } = await exec(
+        [
+          CMD_TS_NODE_WITH_PROJECT_FLAG,
+          '-O "{\\"allowJs\\":true}"',
+          '-pe "import { Foo2 } from \'./allow-js/with-jsx\'; Foo2.sayHi()"',
+        ].join(' ')
+      );
+      expect(err).toBe(null);
+      expect(stdout).toBe('hello world\n');
+    });
 
     test('should eval code', async () => {
       const { err, stdout } = await exec(
@@ -501,21 +505,16 @@ test.suite('ts-node', (test) => {
     });
 
     test.suite('issue #884', (test) => {
+      // TODO disabled because it consistently fails on Windows on TS 2.7
+      test.skipIf(
+        process.platform === 'win32' && semver.satisfies(ts.version, '2.7')
+      );
       test('should compile', async (t) => {
-        // TODO disabled because it consistently fails on Windows on TS 2.7
-        if (
-          process.platform === 'win32' &&
-          semver.satisfies(ts.version, '2.7')
-        ) {
-          t.log('Skipping');
-          return;
-        } else {
-          const { err, stdout } = await exec(
-            `"${BIN_PATH}" --project issue-884/tsconfig.json issue-884`
-          );
-          expect(err).toBe(null);
-          expect(stdout).toBe('');
-        }
+        const { err, stdout } = await exec(
+          `"${BIN_PATH}" --project issue-884/tsconfig.json issue-884`
+        );
+        expect(err).toBe(null);
+        expect(stdout).toBe('');
       });
     });
 
@@ -706,7 +705,7 @@ test.suite('ts-node', (test) => {
         ]);
       });
 
-      if (semver.gte(ts.version, '3.2.0')) {
+      if (tsSupportsTsconfigInheritanceViaNodePackages) {
         test('should pull ts-node options from extended `tsconfig.json`', async () => {
           const { err, stdout } = await exec(
             `${BIN_PATH} --show-config --project ./tsconfig-extends/tsconfig.json`
@@ -810,33 +809,33 @@ test.suite('ts-node', (test) => {
       }
     );
 
-    if (semver.gte(ts.version, '3.2.0')) {
-      test.suite(
-        'should bundle @tsconfig/bases to be used in your own tsconfigs',
-        (test) => {
-          const macro = test.macro((nodeVersion: string) => async (t) => {
-            const config = require(`@tsconfig/${nodeVersion}/tsconfig.json`);
-            const { err, stdout, stderr } = await exec(
-              `${BIN_PATH} --showConfig -e 10n`,
-              {
-                cwd: join(TEST_DIR, 'tsconfig-bases', nodeVersion),
-              }
-            );
-            expect(err).toBe(null);
-            t.like(JSON.parse(stdout), {
-              compilerOptions: {
-                target: config.compilerOptions.target,
-                lib: config.compilerOptions.lib,
-              },
-            });
+    test.suite(
+      'should bundle @tsconfig/bases to be used in your own tsconfigs',
+      (test) => {
+        test.runIf(tsSupportsTsconfigInheritanceViaNodePackages);
+
+        const macro = test.macro((nodeVersion: string) => async (t) => {
+          const config = require(`@tsconfig/${nodeVersion}/tsconfig.json`);
+          const { err, stdout, stderr } = await exec(
+            `${BIN_PATH} --showConfig -e 10n`,
+            {
+              cwd: join(TEST_DIR, 'tsconfig-bases', nodeVersion),
+            }
+          );
+          expect(err).toBe(null);
+          t.like(JSON.parse(stdout), {
+            compilerOptions: {
+              target: config.compilerOptions.target,
+              lib: config.compilerOptions.lib,
+            },
           });
-          test(`ts-node/node10/tsconfig.json`, macro, 'node10');
-          test(`ts-node/node12/tsconfig.json`, macro, 'node12');
-          test(`ts-node/node14/tsconfig.json`, macro, 'node14');
-          test(`ts-node/node16/tsconfig.json`, macro, 'node16');
-        }
-      );
-    }
+        });
+        test(`ts-node/node10/tsconfig.json`, macro, 'node10');
+        test(`ts-node/node12/tsconfig.json`, macro, 'node12');
+        test(`ts-node/node14/tsconfig.json`, macro, 'node14');
+        test(`ts-node/node16/tsconfig.json`, macro, 'node16');
+      }
+    );
 
     test.suite('compiler host', (test) => {
       test('should execute cli', async () => {
@@ -896,7 +895,7 @@ test.suite('ts-node', (test) => {
       });
     });
 
-    if (semver.gte(ts.version, '3.2.0')) {
+    if (tsSupportsShowConfig) {
       test('--showConfig should log resolved configuration', async (t) => {
         function native(path: string) {
           return path.replace(/\/|\\/g, pathSep);
diff --git a/src/test/pluggable-dep-resolution.spec.ts b/src/test/pluggable-dep-resolution.spec.ts
@@ -1,5 +1,9 @@
 import { context } from './testlib';
-import { contextTsNodeUnderTest, resetNodeEnvironment } from './helpers';
+import {
+  contextTsNodeUnderTest,
+  resetNodeEnvironment,
+  tsSupportsTsconfigInheritanceViaNodePackages,
+} from './helpers';
 import * as expect from 'expect';
 import { resolve } from 'path';
 
@@ -21,6 +25,8 @@ test.suite(
     // ts-node should resolve ts-patch or @swc/core relative to the extended tsconfig
     // to ensure we use the known working versions.
 
+    const macro = _macro.bind(null, test);
+
     macro('tsconfig-custom-compiler.json', 'root custom compiler');
     macro('tsconfig-custom-transpiler.json', 'root custom transpiler');
     macro('tsconfig-swc-custom-backend.json', 'root custom swc backend');
@@ -53,24 +59,30 @@ test.suite(
       'shared-config @swc/core'
     );
 
-    macro(
-      'tsconfig-extend-custom-compiler.json',
-      'shared-config custom compiler'
-    );
-    macro(
-      'tsconfig-extend-custom-transpiler.json',
-      'shared-config custom transpiler'
-    );
-    macro(
-      'tsconfig-extend-swc-custom-backend.json',
-      'shared-config custom swc backend'
-    );
-    macro('tsconfig-extend-swc-core.json', 'shared-config @swc/core');
-    macro('tsconfig-extend-swc-wasm.json', 'shared-config @swc/wasm');
-    macro('tsconfig-extend-swc.json', 'shared-config @swc/core');
+    test.suite('"extends"', (test) => {
+      test.runIf(tsSupportsTsconfigInheritanceViaNodePackages);
+
+      const macro = _macro.bind(null, test);
+
+      macro(
+        'tsconfig-extend-custom-compiler.json',
+        'shared-config custom compiler'
+      );
+      macro(
+        'tsconfig-extend-custom-transpiler.json',
+        'shared-config custom transpiler'
+      );
+      macro(
+        'tsconfig-extend-swc-custom-backend.json',
+        'shared-config custom swc backend'
+      );
+      macro('tsconfig-extend-swc-core.json', 'shared-config @swc/core');
+      macro('tsconfig-extend-swc-wasm.json', 'shared-config @swc/wasm');
+      macro('tsconfig-extend-swc.json', 'shared-config @swc/core');
+    });
 
-    function macro(config: string, expected: string) {
-      test(`${config} uses ${expected}`, async (t) => {
+    function _macro(_test: typeof test, config: string, expected: string) {
+      _test(`${config} uses ${expected}`, async (t) => {
         t.teardown(resetNodeEnvironment);
 
         const output = t.context.tsNodeUnderTest
diff --git a/src/test/testlib.ts b/src/test/testlib.ts
@@ -115,6 +115,8 @@ export interface TestInterface<
   skipUnless(conditional: boolean): void;
   /** If conditional is true, run tests, otherwise skip them */
   runIf(conditional: boolean): void;
+  /** If conditional is false, skip tests */
+  skipIf(conditional: boolean): void;
 
   // TODO add teardownEach
 }
@@ -286,5 +288,8 @@ function createTestInterface<Context>(opts: {
     assertOrderingForDeclaringSkipUnless();
     automaticallySkip = automaticallySkip || !runIfTrue;
   };
+  test.skipIf = function (skipIfTrue: boolean) {
+    test.runIf(!skipIfTrue);
+  };
   return test as any;
 }
