sxy-test-runner 1.0.3 → 1.0.4

package/dist/cli/lib/runDescribe.js

@@ -1,141 +0,0 @@
-// 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 () => {
-    // afterDescribe
-    let afterDescribeFunc;
-
-    async function afterDescribe(func) {
-      if (typeof func !== 'function') {
-        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
-      }
-
-      afterDescribeFunc = func;
-    } // beforeEachTest
-
-
-    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}`);
-      }
-
-      beforeEachTestFunc = func;
-    } // afterEachTest
-
-
-    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,7 +0,0 @@
-import { applyConfigDefaults } from './applyConfigDefaults.js';
-import { loadTestFile } from './loadTestFile.js';
-import { runDescribe } from './runDescribe.js';
-const defaultConfig = await applyConfigDefaults({});
-await mochaDescribe('runDescribe() function', async function () {
-  await mochaIt('...', async function () {});
-});

package/dist/cli/lib/runIt.js

@@ -1,70 +0,0 @@
-// 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 { configBeforeEachTest, configAfterEachTest } from './configBeforeAfterFuncs.js';
-const {
-  timeProfileAsync
-} = await createTimeProfiler(showTimeProfiling);
-export async function runIt(config, it, beforeEachTestFunc, afterEachTestFunc) {
-  return await timeProfileAsync(`run it ${it.should}`, async () => {
-    // run before test/it
-    const testExports = {};
-    await configBeforeEachTest(config, testExports);
-
-    if (typeof beforeEachTestFunc === 'function') {
-      const funcExports = await beforeEachTestFunc();
-      await addExports(testExports, funcExports);
-    }
-
-    const testParcel = {};
-    await addExports(testParcel, testExports); //const thisItCounter = itCounter++ // assign THEN increment
-    // capture the console.log output if we can
-
-    let originalConsoleLog, replacementConsoleLog;
-
-    if (await shouldCaptureConsoleLog(config, 'test')) {
-      ({
-        originalConsoleLog,
-        replacementConsoleLog
-      } = await overrideConsoleLog());
-    } //// run the it
-
-
-    let success = null;
-    let error;
-    const startTime = await new Date().getTime();
-
-    try {
-      await it.test(testParcel);
-      success = true;
-    } catch (e) {
-      success = false;
-      error = e;
-    }
-
-    const time = (await new Date().getTime()) - startTime;
-    const itResult = {
-      //counter: thisItCounter,
-      counter: it.counter,
-      should: it.should,
-      success,
-      time,
-      error
-    };
-
-    if (await shouldCaptureConsoleLog(config, 'test')) {
-      console.log = originalConsoleLog; // eslint-disable-line no-console
-
-      itResult.consoleLogs = replacementConsoleLog.logs;
-    } // run after test/it
-
-
-    if (typeof afterEachTestFunc === 'function') await afterEachTestFunc();
-    await configAfterEachTest(config, testExports);
-    return itResult;
-  });
-}

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

@@ -1,7 +0,0 @@
-import { applyConfigDefaults } from './applyConfigDefaults.js';
-import { loadTestFile } from './loadTestFile.js';
-import { runIt } from './runIt.js';
-const defaultConfig = await applyConfigDefaults({});
-await mochaDescribe('runIt() function', async function () {
-  await mochaIt('...', async function () {});
-});

package/dist/cli/lib/runTasks.js

@@ -1,42 +0,0 @@
-import { join } from 'path';
-import { out, log, debug } from '../../output.js';
-import { addExports } from './addExports.js';
-export async function runTasks(tasks, parcel = undefined) {
-  if (tasks) {
-    if (!(await Array.isArray(tasks))) tasks = [tasks];
-    const exports = {};
-
-    for (const task of tasks) {
-      await debug('task', typeof task, task);
-
-      switch (typeof task) {
-        case 'function':
-          {
-            const result = parcel !== undefined // redundent currently
-            ? await task(parcel) : await task();
-            await addExports(exports, result);
-            break;
-          }
-
-        case 'string':
-          {
-            const result = await import(`file://${await join(await process.cwd(), task)}`); //console.log
-
-            await addExports(exports, result);
-            break;
-          }
-
-        default:
-          {
-            await out(`Error: task entry has an invalid type, expected 'function' or 'string' of an file to import.`);
-            await out(`Received '${typeof task}'.`);
-          }
-      }
-    }
-
-    return exports;
-  } else {
-    await debug('no tasks');
-    return null;
-  }
-}

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

@@ -1,30 +0,0 @@
-import { runTasks } from './runTasks.js';
-import { defaultConfig } from './defaultConfig.js'; // runTasks(config, tasks)
-// config:
-// tasks: function, file location, or array of those
-
-await mochaDescribe('runTasks() function', async function () {
-  await mochaIt('runs tasks (functions and/or files) passed to it', async function () {
-    let functionHasRun = false;
-    global.taskFileHasRun = false;
-    const tasks = [async function () {
-      functionHasRun = true;
-    }, 'unitTesting/runTasks/task.js'];
-    await runTasks(tasks);
-    await functionHasRun.should.equal(true);
-    await global.taskFileHasRun.should.equal(true);
-  });
-  await mochaIt('passes back the properties returned from tasks', async function () {
-    const tasks = [async function () {
-      return {
-        a: 1
-      };
-    }, async function () {
-      return {
-        b: 2
-      };
-    }, 'unitTesting/runTasks/export.js'];
-    const exports = await runTasks(tasks);
-    await exports.should.have.keys(['a', 'b', 'c']);
-  });
-});

package/dist/cli/lib/runTest-old.js

@@ -1,159 +0,0 @@
-/*
-import { createTimeProfiler } from 'sxy-dev-tools'
-import chalk from 'chalk-extensions'
-import { out, log, debug } from '../../output.js'
-import { showTimeProfiling } from '../../config.js'
-
-import { runTasks } from './runTasks.js'
-
-const { timeProfileAsync } = createTimeProfiler(showTimeProfiling)
-
-export function runTest(config, test, customOut = undefined) {
-
-    return timeProfileAsync(`run test ${test.file}`, () => {
-
-        // run before test
-        if (config.beforeEachFile) runTasks(config, config.beforeEachFile)
-
-        // const beforeEachFileExports = (config.beforeEachFile)
-        //     ? runTasks(config, config.beforeEachFile)
-        //     : {}
-
-        let describeCounter = 1
-        const describeRunPromises = []
-
-        for (const describe of test.describes) {
-
-            describeRunPromises.push(
-                promise( runDescribe(config, describe) )
-            )
-
-        }
-
-        const describeResults = Promise.all(describeRunPromises)
-
-        const describeResultsSummary = {
-            total: 0,
-            passes: 0,
-            itsTotal: 0,
-            itsPasses: 0,
-        }
-
-
-        for ( const describeResult of describeResults ) {
-            describeResultsSummary.total += +(describeResult.success !== null)
-            describeResultsSummary.passes += +describeResult.success
-            describeResultsSummary.itsTotal += describeResult.itResultsSummary.total
-            describeResultsSummary.itsPasses += describeResult.itResultsSummary.passes
-        }
-
-        const testResults = {
-            file: test.file,
-            success: (describeResultsSummary.total > 0)
-                ? describeResultsSummary.total === describeResultsSummary.passes
-                : null,
-            describeResults,
-            describeResultsSummary,
-        }
-        
-        // run after test
-        if (config.afterEachFile) runTasks(config, config.afterEachFile)
-
-        return testResults
-
-
-        function runDescribe(config, describe) {
-
-            return timeProfileAsync(`run describe ${describe.thing}`, () => {
-        
-                // run before describe
-                if (config.beforeEachDescribe) runTasks(config, config.beforeEachDescribe)
-
-                // const beforeEachDescribeExports = (config.beforeEachDescribe)
-                //     ? runTasks(config, config.beforeEachDescribe)
-                //     : {}
-
-                const thisDescribeCounter = describeCounter++ // assign THEN increment
-                let itCounter = 1
-                const itResults = []
-
-                for ( const it of describe.its ) {
-                    itResults.push( runIt(config, it) )
-                }
-
-                const itResultsSummary = {
-                    total: 0,
-                    passes: 0,
-                }
-
-                for ( const itResult of itResults ) {
-                    itResultsSummary.total += +(itResult.success !== null)
-                    itResultsSummary.passes += +itResult.success
-                }
-
-                const describeResult = {
-                    counter: thisDescribeCounter,
-                    thing: describe.thing,
-                    success: (itResultsSummary.total > 0)
-                        ? itResultsSummary.passes === itResultsSummary.total
-                        : null,
-                    itResults,
-                    itResultsSummary
-                }
-
-                // run after describe
-                if (config.afterEachDescribe) runTasks(config, config.afterEachDescribe)
-
-                return describeResult
-
-                
-                function runIt(config, it, exports) {
-
-                    return timeProfileAsync(`run it ${it.should}`, () => {
-
-                        // run before test/it
-                        if (config.beforeEachTest) runTasks(config, config.beforeEachTest)
-
-                        const thisItCounter = itCounter++ // assign THEN increment
-            
-                        //// run the it
-                        let success = null
-                        let error
-                        const startTime = (new Date).getTime()
-                        try {
-                            it.test()
-                            success = true
-                        } catch (e) {
-                            success = false
-                            error = e
-                        }
-
-                        const time = (new Date).getTime() - startTime
-
-                        const itResult = {
-                            counter: thisItCounter,
-                            should: it.should,
-                            success,
-                            time,
-                            error
-                        }
-
-                        // run after test/it
-                        if (config.afterEachTest) runTasks(config, config.afterEachTest)
-
-                        return itResult
-                        //testResults.push(testResult)
-                        //testsState.testResults.push(testResult)
-
-                    })
-            
-                }
-        
-            })
-        
-        }
-
-    })
-    
-}
-*/

package/dist/cli/lib/runTest-old.unitTest.js

@@ -1,183 +0,0 @@
-/*
-import { applyConfigDefaults } from './applyConfigDefaults.js'
-import { loadTestFile } from './loadTestFile.js'
-import { runTest } from './runTest.js'
-
-// loadTestFile(config, testFile) ???
-
-const defaultConfig = applyConfigDefaults({})
-
-const beforeAfterTestFile = 'unitTesting/runTest/beforeAfter.test.js'
-const beforeAfterTest = loadTestFile(defaultConfig, beforeAfterTestFile)
-
-mochaDescribe('runTest() function', function() {
-
-    mochaIt('should run a test that was previously loaded from a test file', function() {
-
-        //const config = applyConfigDefaults({})
-
-        const sampleTestFile = 'unitTesting/runTest/1.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'
-        ])
-
-        testResult.success.should.equal(true)
-
-        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 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)
-
-    })
-    
-})
-*/