sxy-test-runner 1.0.1 → 1.0.3

package/dist/cli/lib/configBeforeAfterFuncs.js

@@ -0,0 +1,35 @@
+import { runTasks } from './runTasks.js';
+import { addExports } from './addExports.js';
+export async function configBeforeEachFile(config, exports) {
+  if (config.beforeEachFile) {
+    const theExports = await runTasks(config.beforeEachFile, undefined);
+    await addExports(exports, theExports);
+  }
+}
+export async function configAfterEachFile(config, exports) {
+  if (config.afterEachFile) {
+    await runTasks(config.afterEachFile, exports);
+  }
+}
+export async function configBeforeEachDescribe(config, exports) {
+  if (config.beforeEachDescribe) {
+    const theExports = await runTasks(config.beforeEachDescribe, undefined);
+    await addExports(exports, theExports);
+  }
+}
+export async function configAfterEachDescribe(config, exports) {
+  if (config.afterEachDescribe) {
+    await runTasks(config.afterEachDescribe, exports);
+  }
+}
+export async function configBeforeEachTest(config, exports) {
+  if (config.beforeEachTest) {
+    const theExports = await runTasks(config.beforeEachTest, undefined);
+    await addExports(exports, theExports);
+  }
+}
+export async function configAfterEachTest(config, exports) {
+  if (config.afterEachTest) {
+    await runTasks(config.afterEachTest, exports);
+  }
+}

package/dist/cli/lib/loadTestFile.unitTest.js

@@ -1,38 +1,24 @@
-import { loadTestFile } from "./loadTestFile.js";
-import { defaultConfig } from './defaultConfig.js'; // loadTestFile(config, testFile) ???
+import { defaultConfig } from './defaultConfig.js';
+import { applyConfigDefaults } from './applyConfigDefaults.js';
+import { loadTestFile } from './loadTestFile.js'; // loadTestFile(config, testFile) ???
 
 await mochaDescribe('loadTestFile() function', async function () {
-  /*
-      mochaIt('should load a test file, retreiving describes', function() {
-  
-          const config = defaultConfig
-  
-          const sampleTestFile = 'unitTesting/sampleTests/1.test.js'
-  
-          const test = loadTestFile(config, sampleTestFile)
-  
-          test.describes.length.should.equal(1)
-          test.describes.at(-1).counter.should.equal(1)
-          test.describes[0].tests.should.be.a('function')
-          //test.describes.at(-1).its.at(-1).counter.should.equal(1)
-  
-      })
-  
-      mochaIt('should correctly load a second test file', function() {
-  
-          const config = defaultConfig
-  
-          const sampleTestFile = 'unitTesting/sampleTests/2.test.js'
-  
-          const test = loadTestFile(config, sampleTestFile)
-  
-          test.describes.length.should.equal(1)
-          test.describes.at(-1).counter.should.equal(1)
-          test.describes[0].tests.should.be.a('function')
-          //test.describes.at(-1).its.at(-1).counter.should.equal(2)
-  
-      })
-  */
+  await mochaIt('should load a test file, retreiving describes', async function () {
+    const config = defaultConfig;
+    const sampleTestFile = 'unitTesting/sampleTests/1.test.js';
+    const test = await loadTestFile(config, sampleTestFile);
+    await test.describes.length.should.equal(1);
+    await (await test.describes.at(-1)).counter.should.equal(1);
+    await test.describes[0].tests.should.be.a('function'); //test.describes.at(-1).its.at(-1).counter.should.equal(1)
+  });
+  await mochaIt('should correctly load a second test file', async function () {
+    const config = defaultConfig;
+    const sampleTestFile = 'unitTesting/sampleTests/2.test.js';
+    const test = await loadTestFile(config, sampleTestFile);
+    await test.describes.length.should.equal(1);
+    await (await test.describes.at(-1)).counter.should.equal(1);
+    await test.describes[0].tests.should.be.a('function'); //test.describes.at(-1).its.at(-1).counter.should.equal(2)
+  });
   await mochaIt('should correctly load a file with describes without any its/tests', async function () {
     const config = defaultConfig;
     const sampleTestFile = 'unitTesting/sampleTests/describesWithoutTests.test.js';
@@ -42,4 +28,24 @@ await mochaDescribe('loadTestFile() function', async function () {
     await (await test.describes.at(-1)).counter.should.equal(2);
     await test.describes[0].tests.should.be.a('function'); //test.describes.at(-1).its.at(-1).counter.should.equal(2)
   });
+  await mochaIt('should capture console.log output from a test file, when files are running sequentially', async function () {
+    const config = await applyConfigDefaults({
+      execution: {
+        files: 'sequential'
+      }
+    });
+    const sampleTestFile = 'unitTesting/sampleTests/consoleLog.test.js';
+    const testBlock = await loadTestFile(config, sampleTestFile);
+    await testBlock.consoleLogs.should.deep.equal([['foo'], ['bar']]);
+  });
+  await mochaIt('should capture console.log output from a test file, when files are running sequentially', async function () {
+    const config = await applyConfigDefaults({
+      execution: {
+        files: 'parallel'
+      }
+    });
+    const sampleTestFile = 'unitTesting/sampleTests/consoleLog.test.js';
+    const testBlock = await loadTestFile(config, sampleTestFile);
+    await chaiShould.not.exist(testBlock.consoleLogs);
+  }); // should not log output when running in parallel
 });

package/dist/cli/lib/overrideConsoleLog.js

@@ -0,0 +1,20 @@
+export async function overrideConsoleLog() {
+  // save the original func
+  const originalConsoleLog = console.log; // eslint-disable-line no-console
+  // create a catcher func
+
+  async function logCatcher(...texts) {
+    await logCatcher.logs.push(texts);
+  } // initise a variable on it
+
+
+  logCatcher.logs = []; // assign the new func to console.log
+
+  console.log = logCatcher; // eslint-disable-line no-console
+  // return the original func (for restoring) and the new func (for retreiving caught logging)
+
+  return {
+    originalConsoleLog,
+    replacementConsoleLog: logCatcher
+  };
+}

package/dist/cli/lib/runDescribe.js

@@ -1,29 +1,141 @@
-import { timeProfileAsync } from './timeProfier.js';
-import { parseDescribe } from './parseDescribe.js';
-import { runDescribeRun } from './runDescribeRun.js';
+// to be populated with the func from runTestFile.js
+import { createTimeProfiler } from 'sxy-dev-tools';
+import { showTimeProfiling } from '../../config.js';
+import { out, log, debug } from '../../output.js';
+import { shouldCaptureConsoleLog } from './shouldCaptureConsoleLog.js';
+import { overrideConsoleLog } from './overrideConsoleLog.js';
+import { addExports } from './addExports.js';
+import { configBeforeEachDescribe, configAfterEachDescribe } from './configBeforeAfterFuncs.js';
+import { runIt } from './runIt.js';
+const {
+  timeProfileAsync
+} = await createTimeProfiler(showTimeProfiling);
 export async function runDescribe(config, describe) {
   return await timeProfileAsync(`run describe ${describe.thing}`, async () => {
-    const capturingConsoleLog = config.execution.describes === 'sequential'; //// capture console.log output
+    // afterDescribe
+    let afterDescribeFunc;
 
-    let previousConsoleLog;
-    const logs = [];
+    async function afterDescribe(func) {
+      if (typeof func !== 'function') {
+        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
+      }
 
-    if (capturingConsoleLog) {
-      previousConsoleLog = console.log; // eslint-disable-line no-console
+      afterDescribeFunc = func;
+    } // beforeEachTest
 
-      console.log = async (...texts) => await logs.push(texts); // eslint-disable-line no-console
 
-    } ////
+    let beforeEachTestFunc;
 
+    async function beforeEachTest(func) {
+      if (typeof func !== 'function') {
+        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
+      }
 
-    const parsedDescribe = await parseDescribe(config, describe);
-    const describeResult = await runDescribeRun(config, describe, parsedDescribe);
-    describeResult.logs = logs;
+      beforeEachTestFunc = func;
+    } // afterEachTest
 
-    if (capturingConsoleLog) {
-      console.log = previousConsoleLog; // eslint-disable-line no-console
+
+    let afterEachTestFunc;
+
+    async function afterEachTest(func) {
+      if (typeof func !== 'function') {
+        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
+      }
+
+      afterEachTestFunc = func;
+    }
+
+    let itCounter = 1;
+    const its = []; // create functions to pass back
+    // it
+
+    async function it(should, test) {
+      const thisItCounter = itCounter++;
+      await its.push({
+        counter: thisItCounter,
+        should,
+        test
+      });
+    }
+
+    const test = it;
+    const describeExports = {};
+    await configBeforeEachDescribe(config, describeExports);
+    const describeParcel = {
+      it,
+      test,
+      afterDescribe,
+      beforeEachTest,
+      afterEachTest
+    };
+    await addExports(describeParcel, describeExports); // capture the console.log output if we can
+
+    let originalConsoleLog, replacementConsoleLog;
+
+    if (await shouldCaptureConsoleLog(config, 'describe')) {
+      ({
+        originalConsoleLog,
+        replacementConsoleLog
+      } = await overrideConsoleLog());
+    }
+
+    try {
+      await describe.tests(describeParcel);
+    } catch (e) {
+      const describeErrorResult = {
+        counter: describe.counter,
+        thing: describe.thing,
+        error: e.message,
+        success: false
+      };
+
+      if (await shouldCaptureConsoleLog(config, 'describe')) {
+        console.log = originalConsoleLog; // eslint-disable-line no-console
+
+        describeErrorResult.consoleLogs = replacementConsoleLog.logs;
+      }
+
+      return describeErrorResult;
+    } //!!!!! should this be here, or at the end after its?
+
+
+    let describeConsoleLogs;
+
+    if (await shouldCaptureConsoleLog(config, 'describe')) {
+      console.log = originalConsoleLog; // eslint-disable-line no-console
+
+      describeConsoleLogs = replacementConsoleLog.logs; //!!!!!! This needs to be applied
     }
 
+    const itResults = [];
+
+    for (const it of its) {
+      await itResults.push(await runIt(config, it, beforeEachTestFunc, afterEachTestFunc));
+    }
+
+    const itResultsSummary = {
+      total: 0,
+      passes: 0
+    };
+
+    for (const itResult of itResults) {
+      itResultsSummary.total += +(itResult.success !== null);
+      itResultsSummary.passes += +itResult.success;
+    }
+
+    await debug('itResultsSummary', itResultsSummary);
+    const describeResult = {
+      counter: describe.counter,
+      thing: describe.thing,
+      error: false,
+      success: itResultsSummary.total > 0 ? itResultsSummary.passes === itResultsSummary.total : null,
+      itResults,
+      itResultsSummary,
+      consoleLogs: describeConsoleLogs
+    }; // run after 
+
+    if (typeof afterDescribeFunc === 'function') await afterDescribeFunc();
+    await configAfterEachDescribe(config, describeExports);
     return describeResult;
   });
 }

package/dist/cli/lib/runDescribe.unitTest.js

@@ -1,287 +1,7 @@
 import { applyConfigDefaults } from './applyConfigDefaults.js';
 import { loadTestFile } from './loadTestFile.js';
 import { runDescribe } from './runDescribe.js';
-const defaultConfig = await applyConfigDefaults({}); // const beforeAfterTestFile = 'unitTesting/runTest/beforeAfter.test.js'
-// const beforeAfterTest = loadTestFile(defaultConfig, beforeAfterTestFile)
-
+const defaultConfig = await applyConfigDefaults({});
 await mochaDescribe('runDescribe() function', async function () {
-  await mochaIt('should run an it block that was loaded from a test file', async function () {
-    const sampleTestFile = 'unitTesting/runTest/1.test.js';
-    const sampleTest = await loadTestFile(defaultConfig, sampleTestFile);
-    const sampleDescribe = sampleTest.describes[0];
-    const describeResult = await runDescribe(defaultConfig, sampleDescribe);
-    await describeResult.should.include.keys(['counter', 'thing', 'success', 'itResults', 'itResultsSummary']);
-    await describeResult.success.should.equal(true);
-    await describeResult.itResultsSummary.total.should.equal(1);
-    await describeResult.itResultsSummary.passes.should.equal(1);
-  }); // mochaIt('should return sensible results from a test file without any describes', function() {
-  //     //const config = applyConfigDefaults({})
-  //     const sampleTestFile = 'unitTesting/sampletests/blank.test.js'
-  //     const sampleTest = loadTestFile(defaultConfig, sampleTestFile)
-  //     const testResult = runTest(defaultConfig, sampleTest)
-  //     //console.log(testResult)
-  //     //console.log(testResult.describeResults[0].itResults)
-  //     //console.log(testResult.describeResults[0].itResultsSummary)
-  //     testResult.should.include.keys([
-  //         'file',
-  //         'success',
-  //         'describeResults',
-  //         'describeResultsSummary'
-  //     ])
-  //     chaiExpect(testResult.success).to.be.null
-  //     //testResult.describeResultsSummary.total.should.equal(1)
-  //     //testResult.describeResultsSummary.passes.should.equal(1)
-  //     //testResult.describeResultsSummary.itsTotal.should.equal(1)
-  //     //testResult.describeResultsSummary.itsPasses.should.equal(1)
-  // })
-  // mochaIt('should return sensible results from a test file with describes without any its/tests', function() {
-  //     //const config = applyConfigDefaults({})
-  //     const sampleTestFile = 'unitTesting/sampletests/describesWithoutTests.test.js'
-  //     const sampleTest = loadTestFile(defaultConfig, sampleTestFile)
-  //     const testResult = runTest(defaultConfig, sampleTest)
-  //     //console.log(testResult)
-  //     //console.log(testResult.describeResults[0].itResults)
-  //     //console.log(testResult.describeResults[0].itResultsSummary)
-  //     testResult.should.include.keys([
-  //         'file',
-  //         'success',
-  //         'describeResults',
-  //         'describeResultsSummary'
-  //     ])
-  //     chaiExpect(testResult.success).to.be.null
-  //     testResult.describeResultsSummary.total.should.equal(0)
-  //     testResult.describeResultsSummary.passes.should.equal(0)
-  //     testResult.describeResultsSummary.invalid.should.equal(2)
-  //     testResult.describeResultsSummary.itsTotal.should.equal(0)
-  //     testResult.describeResultsSummary.itsPasses.should.equal(0)
-  // })
-  // mochaIt("should run beforeEachFile tasks (before - can't test)", function() {
-  //     let functionHasRun = false
-  //     global.beforeEachFileFileHasRun = false
-  //     const ourConfig = {
-  //         beforeEachFile: [
-  //             function() {
-  //                 functionHasRun = true
-  //             },
-  //             'unitTesting/runTest/beforeEachFile.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     functionHasRun.should.equal(true)
-  //     global.beforeEachFileFileHasRun.should.equal(true)
-  // })
-  // mochaIt("should run afterEachFile tasks (after - can't test)", function() {
-  //     let functionHasRun = false
-  //     global.afterEachFileFileHasRun = false
-  //     const ourConfig = {
-  //         afterEachFile: [
-  //             function() {
-  //                 functionHasRun = true
-  //             },
-  //             'unitTesting/runTest/afterEachFile.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     functionHasRun.should.equal(true)
-  //     global.afterEachFileFileHasRun.should.equal(true)
-  // })
-  // mochaIt("should run beforeEachDescribe tasks (before - can't test) each describe block", function() {
-  //     let functionHasRunTimes = 0
-  //     global.beforeEachDescribeFileHasRun = false
-  //     const ourConfig = {
-  //         beforeEachDescribe: [
-  //             function() {
-  //                 functionHasRunTimes++
-  //             },
-  //             'unitTesting/runTest/beforeEachDescribe.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     functionHasRunTimes.should.equal(2)
-  //     global.beforeEachDescribeFileHasRun.should.equal(true)
-  // })
-  // mochaIt("should run afterEachDescribe tasks (after - can't test) each describe block", function() {
-  //     let functionHasRunTimes = 0
-  //     global.afterEachDescribeFileHasRun = false
-  //     const ourConfig = {
-  //         afterEachDescribe: [
-  //             function() {
-  //                 functionHasRunTimes++
-  //             },
-  //             'unitTesting/runTest/afterEachDescribe.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     functionHasRunTimes.should.equal(2)
-  //     global.afterEachDescribeFileHasRun.should.equal(true)
-  // })
-  // mochaIt("should run beforeEachTest tasks (before - can't test) each test/it block", function() {
-  //     let functionHasRunTimes = 0
-  //     global.beforeEachTestbeforeEachFileFileHasRun = false
-  //     const ourConfig = {
-  //         beforeEachTest: [
-  //             function() {
-  //                 functionHasRunTimes++
-  //             },
-  //             'unitTesting/runTest/beforeEachTest.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     functionHasRunTimes.should.equal(3)
-  //     global.beforeEachTestFileHasRun.should.equal(true)
-  // })
-  // mochaIt("should run afterEachTest tasks (after - can't test) each test/it block", function() {
-  //     let functionHasRunTimes = 0
-  //     global.afterEachTestFileFileHasRun = false
-  //     const ourConfig = {
-  //         afterEachTest: [
-  //             function() {
-  //                 functionHasRunTimes++
-  //             },
-  //             'unitTesting/runTest/afterEachTest.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     functionHasRunTimes.should.equal(3)
-  //     global.afterEachTestFileHasRun.should.equal(true)
-  // })
-  // // exports provision to test file
-  // // current beforeEachFile exports aren't provided
-  // // perhaps extend sxy-loader to allow this
-  // mochaIt("should pass exported/returned data from beforeEachDescribe tasks", function() {
-  //     const testFile = 'unitTesting/runTest/beforeEachDescribe.test.js'
-  //     const test = loadTestFile(defaultConfig, testFile)
-  //     const ourConfig = {
-  //         beforeEachDescribe: [
-  //             function() {
-  //                 return { functionThing : 'foo' }
-  //             },
-  //             'unitTesting/runTest/beforeEachDescribeExport.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, test)
-  //     global.functionThing.should.equal('foo')
-  //     global.fileThing.should.equal('bar')
-  // })
-  // mochaIt("should pass exported/returned data from beforeEachTest tasks", function() {
-  //     const testFile = 'unitTesting/runTest/beforeEachTest.test.js'
-  //     const test = loadTestFile(defaultConfig, testFile)
-  //     const ourConfig = {
-  //         beforeEachTest: [
-  //             function() {
-  //                 return { functionThing : 'foo' }
-  //             },
-  //             'unitTesting/runTest/beforeEachTestExport.js'
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, test)
-  //     global.functionThing.should.equal('foo')
-  //     global.fileThing.should.equal('bar')
-  // })
-  // // exports pass through
-  // mochaIt("beforeEachFile exports are passed through to afterEachFile", function() {
-  //     // don't try to reload test, fails due to module caching
-  //     //const testFile = 'unitTesting/runTest/beforeAfter.test.js'
-  //     //const test = loadTestFile(defaultConfig, testFile)
-  //     let exports
-  //     const ourConfig = {
-  //         beforeEachFile: [
-  //             function() {
-  //                 return { functionThing : 'foo' }
-  //             },
-  //             'unitTesting/runTest/beforeEachExport.js'
-  //         ],
-  //         afterEachFile: [
-  //             function(theExports) {
-  //                 theExports.should.have.keys(['functionThing', 'fileThing'])
-  //                 exports = theExports
-  //             },
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     exports.functionThing.should.equal('foo')
-  //     exports.fileThing.should.equal('bar')
-  // })
-  // mochaIt("beforeEachDescribe exports are passed through to afterEachDescribe", function() {
-  //     // don't try to reload test, fails due to module caching
-  //     //const testFile = 'unitTesting/runTest/beforeAfter.test.js'
-  //     //const test = loadTestFile(defaultConfig, testFile)
-  //     let exports
-  //     const ourConfig = {
-  //         beforeEachDescribe: [
-  //             function() {
-  //                 return { functionThing : 'foo' }
-  //             },
-  //             'unitTesting/runTest/beforeEachExport.js'
-  //         ],
-  //         afterEachDescribe: [
-  //             function(theExports) {
-  //                 exports = theExports
-  //             },
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     //console.log('exports', exports)
-  //     exports.functionThing.should.equal('foo')
-  //     exports.fileThing.should.equal('bar')
-  // })
-  // mochaIt("beforeEachTest exports are passed through to afterEachTest", function() {
-  //     // don't try to reload test, fails due to module caching
-  //     //const testFile = 'unitTesting/runTest/beforeAfter.test.js'
-  //     //const test = loadTestFile(defaultConfig, testFile)
-  //     let exports
-  //     const ourConfig = {
-  //         beforeEachTest: [
-  //             function() {
-  //                 return { functionThing : 'foo' }
-  //             },
-  //             'unitTesting/runTest/beforeEachExport.js'
-  //         ],
-  //         afterEachTest: [
-  //             function(theExports) {
-  //                 exports = theExports
-  //             },
-  //         ]
-  //     }
-  //     const config = applyConfigDefaults(ourConfig)
-  //     runTest(config, beforeAfterTest)
-  //     //console.log('exports', exports)
-  //     exports.functionThing.should.equal('foo')
-  //     exports.fileThing.should.equal('bar')
-  // })
-  // mochaIt("we can run code beforeEachTest and afterEachTest from within the test file", function() {
-  //     // don't try to reload test, fails due to module caching
-  //     const testFile = 'unitTesting/runTest/internalBeforeAfterEachTest.test.js'
-  //     const test = loadTestFile(defaultConfig, testFile)
-  //     const config = applyConfigDefaults({})
-  //     global.internalBeforeEachTestRanNTimes = 0
-  //     global.internalAfterEachTestRanNTimes = 0
-  //     runTest(config, test)
-  //     global.internalBeforeAfterEachTest_test1Valid.should.equal(true)
-  //     global.internalBeforeAfterEachTest_test2Valid.should.equal(true)
-  //     global.internalBeforeAfterEachTest_test3Valid.should.equal(true)
-  //     global.internalBeforeEachTestRanNTimes.should.equal(3)
-  //     global.internalAfterEachTestRanNTimes.should.equal(3)
-  // })
-  // mochaIt("we can run code afterDescribe from within descibe in the test file", function() {
-  //     // don't try to reload test, fails due to module caching
-  //     const testFile = 'unitTesting/runTest/internalAfterDescribeTest.test.js'
-  //     const test = loadTestFile(defaultConfig, testFile)
-  //     const config = applyConfigDefaults({})
-  //     global.internalAfterDescribeRanNTimes = 0
-  //     runTest(config, test)
-  //     //global.internalAfterDescribe_test1Valid.should.equal(true)
-  //     //global.internalAfterDescribe_test2Valid.should.equal(true)
-  //     global.internalAfterDescribeRanNTimes.should.equal(2)
-  // })
+  await mochaIt('...', async function () {});
 });