Prepare process-test-directory scripts to be testable

lib/data/process-test-directory-v1.js

@@ -30,11 +30,13 @@ const { createExampleScriptsTemplate } = require('./example-scripts-template');
 
 /**
  * @param {string} directory - path to directory of data to be used to generate test
+ * @param {string} buildOutputDirectory - path to build directory. Defaults to '<root>/build'
  * @param {object} args={}
  */
-const processTestDirectory = async ({ directory, args = {} }) => {
+const processTestDirectory = async ({ directory, buildOutputDirectory, args = {} }) => {
   let VERBOSE_CHECK = false;
   let VALIDATE_CHECK = false;
+  let TEST_MODE = false;
 
   let suppressedMessages = 0;
 
@@ -68,9 +70,10 @@ const processTestDirectory = async ({ directory, args = {} }) => {
     process.exit(1);
   };
 
-  // setup from arguments passed to npm script
+  // setup from arguments passed to npm script or test runner
   VERBOSE_CHECK = !!args.verbose;
   VALIDATE_CHECK = !!args.validate;
+  TEST_MODE = !!args.testMode;
 
   const validModes = ['reading', 'interaction', 'item'];
 
@@ -91,8 +94,9 @@ const processTestDirectory = async ({ directory, args = {} }) => {
   const referencesCsvFilePath = path.join(testPlanDirectory, 'data', 'referencesV1.csv');
 
   // build output folders and file paths setup
-  const buildDirectory = path.join(rootDirectory, 'build');
-  const testPlanBuildDirectory = path.join(buildDirectory, 'tests', testPlanName);
+  const buildDirectory = buildOutputDirectory ?? path.join(rootDirectory, 'build');
+  const buildTestsDirectory = path.join(buildDirectory, 'tests');
+  const testPlanBuildDirectory = path.join(buildTestsDirectory, testPlanName);
   const indexFileBuildOutputPath = path.join(testPlanBuildDirectory, 'index.html');
 
   let backupTestsCsvFile, backupReferencesCsvFile;
@@ -807,7 +811,7 @@ ${rows}
   const buildFiles = [
     ...createScriptFiles(scripts, testPlanBuildDirectory),
     ...exampleScriptedFiles.map(({ path: pathSuffix, content }) => ({
-      path: path.join('build', 'tests', testPlanName, pathSuffix),
+      path: path.join(buildTestsDirectory, testPlanName, pathSuffix),
       content,
     })),
     ...testsCollected.map(collectedTest =>
@@ -858,13 +862,16 @@ ${rows}
     emitFile,
   });
 
+  const prefixBuildPath = TEST_MODE ? '__test__/' : '';
+  const prefixTestsPath = TEST_MODE ? '__test__/__mocks__/' : '';
+
   const existingRoot = new FileRecordChain({});
-  existingRoot.add('build', await existingBuildPromise);
-  existingRoot.add(`tests/${testPlanName}`, testPlanRecord);
+  existingRoot.add(`${prefixBuildPath}build`, await existingBuildPromise);
+  existingRoot.add(`${prefixTestsPath}tests/${testPlanName}`, testPlanRecord);
 
   const newRoot = new FileRecordChain({});
-  newRoot.add('build', newBuild);
-  newRoot.add(`tests/${testPlanName}`, testPlanUpdate);
+  newRoot.add(`${prefixBuildPath}build`, newBuild);
+  newRoot.add(`${prefixTestsPath}tests/${testPlanName}`, testPlanUpdate);
 
   const buildChanges = newRoot.changesAfter(existingRoot);
 

lib/data/process-test-directory.js

@@ -32,9 +32,10 @@ const { createExampleScriptsTemplate } = require('./example-scripts-template');
 
 /**
  * @param {string} directory - path to directory of data to be used to generate test
+ * @param {string} buildOutputDirectory - path to build directory. Defaults to '<root>/build'
  * @param {object} args={}
  */
-const processTestDirectory = async ({ directory, args = {} }) => {
+const processTestDirectory = async ({ directory, buildOutputDirectory, args = {} }) => {
   let suppressedMessages = 0;
 
   /**
@@ -70,6 +71,7 @@ const processTestDirectory = async ({ directory, args = {} }) => {
   // setup from arguments passed to npm script
   const VERBOSE_CHECK = !!args.verbose;
   const VALIDATE_CHECK = !!args.validate;
+  const TEST_MODE = !!args.testMode;
 
   /** Name of the test plan. */
   const testPlanName = path.basename(directory);
@@ -90,8 +92,9 @@ const processTestDirectory = async ({ directory, args = {} }) => {
   const scriptsCsvFilePath = path.join(testPlanDirectory, 'data', 'scripts.csv');
 
   // build output folders and file paths setup
-  const buildDirectory = path.join(rootDirectory, 'build');
-  const testPlanBuildDirectory = path.join(buildDirectory, 'tests', testPlanName);
+  const buildDirectory = buildOutputDirectory ?? path.join(rootDirectory, 'build');
+  const buildTestsDirectory = path.join(buildDirectory, 'tests');
+  const testPlanBuildDirectory = path.join(buildTestsDirectory, testPlanName);
   const indexFileBuildOutputPath = path.join(testPlanBuildDirectory, 'index.html');
 
   const existingBuildPromise = FileRecordChain.read(buildDirectory, {
@@ -1015,7 +1018,7 @@ ${rows}
   const buildFiles = [
     ...createScriptFiles(scriptsSource, testPlanBuildDirectory),
     ...exampleScriptedFiles.map(({ path: pathSuffix, content }) => ({
-      path: path.join('build', 'tests', testPlanName, pathSuffix),
+      path: path.join(buildTestsDirectory, testPlanName, pathSuffix),
       content,
     })),
     // TODO: If there is a need to individually view jaws-pcCursor or nvda-browseMode for example
@@ -1084,13 +1087,16 @@ ${rows}
     emitFile,
   });
 
+  const prefixBuildPath = TEST_MODE ? '__test__/' : '';
+  const prefixTestsPath = TEST_MODE ? '__test__/__mocks__/' : '';
+
   const existingRoot = new FileRecordChain({});
-  existingRoot.add('build', await existingBuildPromise);
-  existingRoot.add(`tests/${testPlanName}`, testPlanRecord);
+  existingRoot.add(`${prefixBuildPath}build`, await existingBuildPromise);
+  existingRoot.add(`${prefixTestsPath}tests/${testPlanName}`, testPlanRecord);
 
   const newRoot = new FileRecordChain({});
-  newRoot.add('build', newBuild);
-  newRoot.add(`tests/${testPlanName}`, testPlanUpdate);
+  newRoot.add(`${prefixBuildPath}build`, newBuild);
+  newRoot.add(`${prefixTestsPath}tests/${testPlanName}`, testPlanUpdate);
 
   const buildChanges = newRoot.changesAfter(existingRoot);
 

scripts/create-all-tests/createAllTests.js

@@ -1,15 +1,13 @@
 const path = require('path');
-
 const fse = require('fs-extra');
-
 const {
   processTestDirectory: processTestDirectoryV2,
 } = require('../../lib/data/process-test-directory');
 const {
   processTestDirectory: processTestDirectoryV1,
 } = require('../../lib/data/process-test-directory-v1');
 
-const args = require('minimist')(process.argv.slice(2), {
+const cliArgs = require('minimist')(process.argv.slice(2), {
   alias: {
     h: 'help',
     t: 'testplan',
@@ -20,7 +18,7 @@ const args = require('minimist')(process.argv.slice(2), {
   },
 });
 
-if (args.help) {
+if (cliArgs.help) {
   console.log(`Default use:
   No arguments:
     Generate tests and view report summary.
@@ -41,7 +39,21 @@ if (args.help) {
   process.exit();
 }
 
+/**
+ *
+ * @param {object} config
+ * @param {object} config.args
+ * @param {string} config.args.testplan
+ * @param {boolean} config.args.validate
+ * @param {boolean} config.args.verbose
+ * @param {boolean} config.args.testMode
+ * @param {string} config.buildOutputDirectory
+ * @param {string} config.testsDirectory
+ * @returns {Promise<void>}
+ */
 async function createAllTests({ config } = {}) {
+  const args = config?.args ?? cliArgs;
+
   // on some OSes, it seems the `npm_config_testplan` environment variable will come back as the actual variable name rather than empty if it does not exist
   const TARGET_TEST_PLAN =
     args.testplan && !args.testplan.includes('npm_config_testplan') ? args.testplan : null; // individual test plan to generate test assets for
@@ -53,9 +65,7 @@ async function createAllTests({ config } = {}) {
 
   const scriptsDirectory = path.dirname(__filename);
   const rootDirectory = path.join(scriptsDirectory, '../..');
-  const testsDirectory = config?.testsDirectory
-    ? config.testsDirectory
-    : path.join(rootDirectory, 'tests');
+  const testsDirectory = config?.testsDirectory ?? path.join(rootDirectory, 'tests');
 
   const filteredTestPlans = fse.readdirSync(testsDirectory).filter(f =>
     TARGET_TEST_PLAN
@@ -88,6 +98,7 @@ async function createAllTests({ config } = {}) {
       if (FALLBACK_V2_CHECK || V2_CHECK) {
         return processTestDirectoryV2({
           directory: path.join('tests', directory),
+          buildOutputDirectory: config?.buildOutputDirectory,
           args,
         }).catch(error => {
           error.directory = directory;
@@ -96,6 +107,7 @@ async function createAllTests({ config } = {}) {
       } else if (FALLBACK_V1_CHECK || V1_CHECK) {
         return processTestDirectoryV1({
           directory: path.join('tests', directory),
+          buildOutputDirectory: config?.buildOutputDirectory,
           args,
         }).catch(error => {
           error.directory = directory;