just-scripts 2.2.1 → 2.2.3

package/src/copy/__tests__/executeCopyInstructions.spec.ts

@@ -1,192 +0,0 @@
-import * as mockfs from 'mock-fs';
-import * as path from 'path';
-import * as fs from 'fs';
-// import { dirSync, fileSync, DirResult, FileResult } from 'tmp';
-import { executeCopyInstructions } from '../executeCopyInstructions';
-import { CopyInstruction } from '../CopyInstruction';
-
-describe('executeCopyInstructions functional tests', () => {
-  const sourceDir = 'sourceDir';
-  const sourceFile1 = 'sourceFile1';
-  const sourceFile2 = 'sourceFile2';
-  const sourceFilePath1 = path.join(sourceDir, sourceFile1);
-  const sourceFilePath2 = path.join(sourceDir, sourceFile2);
-  const sourceFileContents1 = 'source file contents 1';
-  const sourceFileContents2 = 'source file contents 2';
-  const destDir = 'destDir';
-  const destFile = 'destFile';
-  const destFilePath = path.join(destDir, destFile);
-
-  beforeEach(() => {
-    mockfs({
-      [sourceDir]: {
-        [sourceFile1]: sourceFileContents1,
-        [sourceFile2]: sourceFileContents2,
-      },
-      [destDir]: {},
-    });
-  });
-
-  afterEach(() => {
-    mockfs.restore();
-  });
-
-  it('executes single source copy instructions (symlink)', async () => {
-    const copyInstruction: CopyInstruction = {
-      sourceFilePath: sourceFilePath1,
-      destinationFilePath: destFilePath,
-    };
-
-    expect(fs.existsSync(destFilePath)).toBeFalsy();
-
-    await executeCopyInstructions({
-      copyInstructions: [copyInstruction],
-    });
-
-    expect(fs.existsSync(destFilePath)).toBeTruthy();
-    expect(fs.lstatSync(destFilePath).isSymbolicLink()).toBeTruthy();
-    expect(fs.readFileSync(destFilePath).toString()).toEqual(sourceFileContents1);
-  });
-
-  it('executes single source (arrayified) copy instructions (copy)', async () => {
-    const copyInstruction: CopyInstruction = {
-      sourceFilePath: [sourceFilePath1],
-      destinationFilePath: destFilePath,
-      noSymlink: true,
-    };
-
-    expect(fs.existsSync(destFilePath)).toBeFalsy();
-
-    await executeCopyInstructions({
-      copyInstructions: [copyInstruction],
-    });
-
-    expect(fs.existsSync(destFilePath)).toBeTruthy();
-    expect(fs.lstatSync(destFilePath).isSymbolicLink()).toBeFalsy();
-    expect(fs.readFileSync(destFilePath).toString()).toEqual(sourceFileContents1);
-  });
-
-  it('merges output', async () => {
-    const copyInstruction: CopyInstruction = {
-      sourceFilePath: [sourceFilePath1, sourceFilePath2],
-      destinationFilePath: destFilePath,
-    };
-
-    const expectedOutput = [sourceFileContents1, sourceFileContents2].join('\n');
-
-    expect(fs.existsSync(destFilePath)).toBeFalsy();
-
-    await executeCopyInstructions({
-      copyInstructions: [copyInstruction],
-    });
-
-    expect(fs.existsSync(destFilePath)).toBeTruthy();
-    expect(fs.lstatSync(destFilePath).isSymbolicLink()).toBeFalsy();
-    expect(fs.readFileSync(destFilePath).toString()).toEqual(expectedOutput);
-  });
-
-  it('fails to validate merge + symlink copy instruction', async () => {
-    const copyInstruction: CopyInstruction = {
-      sourceFilePath: [sourceFilePath1, sourceFilePath2],
-      destinationFilePath: destFilePath,
-      noSymlink: false,
-    };
-
-    const promise = executeCopyInstructions({
-      copyInstructions: [copyInstruction],
-    });
-
-    await expect(promise).rejects.toThrow();
-  });
-
-  /**
-   * TODO:
-   * Rationalize and document expected executeCopyInstructions behavior.
-   * If same source is present twice to same dest file, do we really want output duplicated?
-   * Fix / change these tests so that they pass after updating code / documentation on expected behavior.
-   */
-  // it('does not duplicate output from duplicate source files', async () => {
-  //   const copyInstruction = {
-  //     sourceFilePath: [sourceFilePath, sourceFilePath],
-  //     destinationFilePath: destFilePath
-  //   };
-
-  //   expect(fs.existsSync(destFilePath)).toBeFalsy();
-
-  //   await executeCopyInstructions({
-  //     copyInstructions: [
-  //       copyInstruction
-  //     ]
-  //   });
-
-  //   expect(fs.existsSync(destFilePath)).toBeTruthy();
-  //   expect(fs.readFileSync(destFilePath).toString()).toEqual(sourceFileContents1);
-  // });
-});
-
-// These tests test scenarios where multiple instructions end up deleting and overwriting the same
-// filepath multiple times. They are commented out because they currently fail, generating ENOENT and
-// EBUSY exceptions. We may want just to handle these types of conditions eventually, most
-// likely by having an optional validation step. Documentation should also be added to executeCopyInstructions
-// detailing caution and error scenarios.
-// These tests require 'tmp' and '@types/tmp` dev dependencies.
-// describe('executeCopyInstructions I/O exception tests', () => {
-//   let destDir: DirResult;
-//   let sourceFile: FileResult;
-//   let sourceNames: string[] = [];
-
-//   beforeEach(() => {
-//     // unsafeCleanup will clean up directories even when not empty
-//     destDir = dirSync({ unsafeCleanup: true });
-//     sourceFile = fileSync();
-//   });
-
-//   afterEach(() => {
-//     sourceNames.forEach(name => {
-//       if (fs.existsSync(name)) {
-//         fs.unlinkSync(name);
-//       }
-//     })
-//     destDir.removeCallback();
-//     sourceFile.removeCallback();
-//   });
-
-//   it('copies duplicate sources to empty dest without generating an exception', async () => {
-//     const basename = path.basename(sourceFile.name);
-//     const destinationFilePath = path.join(destDir.name, basename);
-
-//     const copyInstruction = {
-//       sourceFilePath: sourceFile.name,
-//       destinationFilePath
-//     };
-
-//     // Unchecked duplicate copy instructions will cause an EBUSY: resource busy or locked
-//     // as the copy instructions attempt to write to the same file.
-//     await executeCopyInstructions({
-//       copyInstructions: Array(100).fill(copyInstruction)
-//     });
-//   });
-
-//   it('copies duplicate sources to dest with pre-existing file without generating an exception', async () => {
-//     const basename = path.basename(sourceFile.name);
-//     const destinationFilePath = path.join(destDir.name, basename);
-
-//     const copyInstruction = {
-//       sourceFilePath: sourceFile.name,
-//       destinationFilePath
-//     };
-
-//     // Set up "pre-existing" file in dest first
-//     await executeCopyInstructions({
-//       copyInstructions: [
-//         copyInstruction,
-//       ]
-//     });
-
-//     // If file already exists, unchecked duplicate copy instructions will attempt to delete the file
-//     // when overwriting it, generating an ENOENT: no such file or directory error.
-//     await executeCopyInstructions({
-//       copyInstructions: Array(100).fill(copyInstruction)
-//     });
-//   });
-// });

package/src/tasks/__tests__/__snapshots__/tscTask.spec.ts.snap

@@ -1,205 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`tscTask using 'tscTask' function with 'build' option where 'build' is custom path and tsconfig.json exists execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--build",
-  "a/custom/path/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with 'build' option where 'build' is multiple paths and they all exist execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--build",
-  "project/a/tsconfig.json",
-  "project/b/tsconfig.json",
-  "project/c/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with 'project' option where 'project' is custom path and tsconfig.json exists execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "a/custom/path/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with a boolean 'false' switch execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with a boolean 'true' switch execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--allowJs",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with a combination of switches execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--allowJs",
-  "--build",
-  "tsconfig.json",
-  "--outDir",
-  "some/out/path",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with empty options execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with no arguments execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with string array option execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--lib",
-  "es6",
-  "dom",
-  "esnext.intl",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscTask' function with string value option execs expected command 1`] = `
-[
-  "\${nodeExePath}",
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--module",
-  "ESNext",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with 'build' option where 'build' is custom path and tsconfig.json exists execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--build",
-  "a/custom/path/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with 'build' option where 'build' is multiple paths and they all exist execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--build",
-  "project/a/tsconfig.json",
-  "project/b/tsconfig.json",
-  "project/c/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with 'project' option where 'project' is custom path and tsconfig.json exists execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "a/custom/path/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with a boolean 'false' switch execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with a boolean 'true' switch execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--allowJs",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with a combination of switches execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--allowJs",
-  "--build",
-  "tsconfig.json",
-  "--outDir",
-  "some/out/path",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with empty options execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with no arguments execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with string array option execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--lib",
-  "es6",
-  "dom",
-  "esnext.intl",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-  "--watch",
-]
-`;
-
-exports[`tscTask using 'tscWatchTask' function with string value option execs expected command 1`] = `
-[
-  "\${repoRoot}/node_modules/typescript/lib/tsc.js",
-  "--module",
-  "ESNext",
-  "--project",
-  "\${packageRoot}/tsconfig.json",
-  "--watch",
-]
-`;

package/src/tasks/__tests__/callTaskForTest.ts

@@ -1,28 +0,0 @@
-import * as asyncDoneAsCallback from 'async-done';
-import { promisify } from 'util';
-import type { Arguments } from 'yargs-parser';
-import { logger, TaskFunction, TaskContext } from 'just-task';
-
-const asyncDone = promisify(asyncDoneAsCallback);
-
-/**
- * Wrapper to call task function for the test.
- */
-function wrapTaskFunction(fn: TaskFunction, argv?: Arguments) {
-  const argvOurs = argv || { _: [], $0: '' };
-  const context: TaskContext = {
-    argv: argvOurs,
-    logger,
-  };
-  const taskRet = (fn as any).call(context, (_err: any) => undefined);
-  return taskRet;
-}
-
-/**
- * Call the task the way real code does.
- */
-export function callTaskForTest(fn: TaskFunction, argv?: Arguments) {
-  return asyncDone(() => {
-    return wrapTaskFunction(fn, argv);
-  });
-}

package/src/tasks/__tests__/mockExecFactory.ts

@@ -1,29 +0,0 @@
-/**
- * Mock factory for the `just-scripts-utils/lib/exec` module. We don't want to really exec or spawn anything,
- * but we do want the rest of the exports to work.
- */
-export function mockExecFactory() {
-  const originalModule = jest.requireActual('just-scripts-utils/lib/exec');
-  return {
-    // Use real implementation of exports except for `exec` and `spawn`
-    ...originalModule,
-    encodeArgs: jest
-      .fn((cmdArgs: string[]) => {
-        // Spy on encodeArgs, but keep its original implementation
-        return originalModule.encodeArgs(cmdArgs);
-      })
-      .mockName('encodeArgs'),
-    exec: jest
-      .fn(() => {
-        // Don't exec in real life
-        return Promise.resolve();
-      })
-      .mockName('exec'),
-    spawn: jest
-      .fn(() => {
-        // Don't spawn in real life
-        return Promise.resolve();
-      })
-      .mockName('spawn'),
-  };
-}

package/src/tasks/__tests__/normalizeCmdArgsForTest.ts

@@ -1,30 +0,0 @@
-import { resolve } from 'path';
-
-/**
- * Normalizes paths in cmd args so test comparisons work no matter the machine it runs on.
- */
-export function normalizeCmdArgsForTest(cmdArgs: string[]) {
-  const packageRootDir = process.cwd();
-  const repoRootDir = resolve(packageRootDir, '../..');
-  const nodePath = process.execPath;
-
-  if (!cmdArgs) {
-    return cmdArgs;
-  }
-
-  return cmdArgs.map(arg => {
-    let newArg = undefined;
-    if (arg.indexOf(nodePath) >= 0) {
-      newArg = arg.replace(nodePath, '${nodeExePath}');
-    } else if (arg.indexOf(packageRootDir) >= 0) {
-      newArg = arg.replace(packageRootDir, '${packageRoot}');
-    } else if (arg.indexOf(repoRootDir) >= 0) {
-      newArg = arg.replace(repoRootDir, '${repoRoot}');
-    }
-    if (newArg) {
-      // Convert backslashes to forward slashes
-      return newArg.replace(/\\/g, '/');
-    }
-    return arg;
-  });
-}