3.2.0

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/tapbundle",
   "private": false,
-  "version": "3.0.14",
+  "version": "3.2.0",
   "description": "tap bundled for tapbuffer",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -22,6 +22,7 @@
   "dependencies": {
     "@pushrocks/early": "^3.0.3",
     "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartfile": "^7.0.6",
     "@pushrocks/smartpromise": "^3.0.2",
     "smartchai": "^2.0.1"
   },

ts/tapbundle.classes.pretask.ts

@@ -0,0 +1,19 @@
+import * as plugins from './tapbundle.plugins';
+import { TapTools } from './tapbundle.classes.taptools';
+
+
+export interface IPreTaskFunction {
+  (tapTools?: TapTools): Promise<any>;
+}
+
+export class PreTask {
+  public preTaskFunction: IPreTaskFunction;
+
+  constructor(preTaskFunctionArg: IPreTaskFunction) {
+    this.preTaskFunction = preTaskFunctionArg;
+  }
+
+  public async run () {
+    await this.preTaskFunction(new TapTools(null));
+  }
+}

ts/tapbundle.classes.tap.ts

@@ -1,5 +1,6 @@
 import * as plugins from './tapbundle.plugins';
 
+import { IPreTaskFunction, PreTask } from './tapbundle.classes.pretask';
 import { TapTest, ITestFunction } from './tapbundle.classes.taptest';
 import { TapWrap, ITapWrapFunction } from './tapbundle.classes.tapwrap';
 export class Tap {
@@ -7,7 +8,7 @@ export class Tap {
    * skips a test
    * tests marked with tap.skip.test() are never executed
    */
-  skip = {
+  public skip = {
     test: (descriptionArg: string, functionArg: ITestFunction) => {
       console.log(`skipped test: ${descriptionArg}`);
     },
@@ -19,12 +20,13 @@ export class Tap {
   /**
    * only executes tests marked as ONLY
    */
-  only = {
+  public only = {
     test: (descriptionArg: string, testFunctionArg: ITestFunction) => {
       this.test(descriptionArg, testFunctionArg, 'only');
     }
   };
 
+  private _tapPreTasks: PreTask[] = [];
   private _tapTests: TapTest[] = [];
   private _tapTestsOnly: TapTest[] = [];
 
@@ -33,14 +35,14 @@ export class Tap {
    * @param testDescription - A description of what the test does
    * @param testFunction - A Function that returns a Promise and resolves or rejects
    */
-  async test(
+  public async test(
     testDescription: string,
     testFunction: ITestFunction,
     modeArg: 'normal' | 'only' | 'skip' = 'normal'
   ) {
-    let localTest = new TapTest({
+    const localTest = new TapTest({
       description: testDescription,
-      testFunction: testFunction,
+      testFunction,
       parallel: false
     });
     if (modeArg === 'normal') {
@@ -51,10 +53,14 @@ export class Tap {
     return localTest;
   }
 
+  public preTask (functionArg: IPreTaskFunction) {
+    this._tapPreTasks.push(new PreTask(functionArg));
+  }
+
   /**
    * wraps function
    */
-  wrap(functionArg: ITapWrapFunction) {
+  public wrap(functionArg: ITapWrapFunction) {
     return new TapWrap(functionArg);
   }
 
@@ -63,11 +69,11 @@ export class Tap {
    * @param testDescription - A description of what the test does
    * @param testFunction - A Function that returns a Promise and resolves or rejects
    */
-  testParallel(testDescription: string, testFunction: ITestFunction) {
+  public testParallel(testDescription: string, testFunction: ITestFunction) {
     this._tapTests.push(
       new TapTest({
         description: testDescription,
-        testFunction: testFunction,
+        testFunction,
         parallel: true
       })
     );
@@ -76,12 +82,13 @@ export class Tap {
   /**
    * starts the test evaluation
    */
-  async start(optionsArg?: { throwOnError: boolean }) {
+  public async start(optionsArg?: { throwOnError: boolean }) {
-    let promiseArray: Promise<any>[] = [];
+    const promiseArray: Array<Promise<any>> = [];
 
     // safeguard against empty test array
     if (this._tapTests.length === 0) {
       console.log('no tests specified. Ending here!');
+      // TODO: throw proper error
       return;
     }
 
@@ -93,10 +100,15 @@ export class Tap {
       concerningTests = this._tapTests;
     }
 
+    // lets run the pretasks
+    for (const preTask of this._tapPreTasks) {
+      await preTask.run();
+    }
+
     console.log(`1..${concerningTests.length}`);
     for (let testKey = 0; testKey < concerningTests.length; testKey++) {
-      let currentTest = concerningTests[testKey];
+      const currentTest = concerningTests[testKey];
-      let testPromise = currentTest.run(testKey);
+      const testPromise = currentTest.run(testKey);
       if (currentTest.parallel) {
         promiseArray.push(testPromise);
       } else {
@@ -106,10 +118,10 @@ export class Tap {
     await Promise.all(promiseArray);
 
     // when tests have been run and all promises are fullfilled
-    let failReasons: string[] = [];
+    const failReasons: string[] = [];
-    let executionNotes: string[] = [];
+    const executionNotes: string[] = [];
     // collect failed tests
-    for (let tapTest of concerningTests) {
+    for (const tapTest of concerningTests) {
       if (tapTest.status !== 'success') {
         failReasons.push(
           `Test ${tapTest.testKey + 1} failed with status ${tapTest.status}:\n` +
@@ -120,7 +132,7 @@ export class Tap {
     }
 
     // render fail Reasons
-    for (let failReason of failReasons) {
+    for (const failReason of failReasons) {
       console.log(failReason);
     }
 
@@ -132,7 +144,7 @@ export class Tap {
   /**
    * handle errors
    */
-  threw(err) {
+  public threw(err) {
     console.log(err);
   }
 }

ts/tapbundle.classes.taptest.ts

@@ -9,21 +9,19 @@ import { Deferred } from '@pushrocks/smartpromise';
 // interfaces
 export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout';
 
-export interface ITestFunction {
+export type ITestFunction = (tapTools?: TapTools) => Promise<any>;
-  (tapTools?: TapTools): Promise<any>;
-}
 
 export class TapTest {
-  description: string;
+  public description: string;
-  failureAllowed: boolean;
+  public failureAllowed: boolean;
-  hrtMeasurement: HrtMeasurement;
+  public hrtMeasurement: HrtMeasurement;
-  parallel: boolean;
+  public parallel: boolean;
-  status: TTestStatus;
+  public status: TTestStatus;
-  tapTools: TapTools;
+  public tapTools: TapTools;
-  testFunction: ITestFunction;
+  public testFunction: ITestFunction;
-  testKey: number; // the testKey the position in the test qeue. Set upon calling .run()
+  public testKey: number; // the testKey the position in the test qeue. Set upon calling .run()
-  testDeferred: Deferred<TapTest> = plugins.smartpromise.defer();
+  public testDeferred: Deferred<TapTest> = plugins.smartpromise.defer();
-  testPromise: Promise<TapTest> = this.testDeferred.promise;
+  public testPromise: Promise<TapTest> = this.testDeferred.promise;
   /**
    * constructor
    */
@@ -39,10 +37,10 @@ export class TapTest {
   /**
    * run the test
    */
-  async run(testKeyArg: number) {
+  public async run(testKeyArg: number) {
     this.hrtMeasurement.start();
     this.testKey = testKeyArg;
-    let testNumber = testKeyArg + 1;
+    const testNumber = testKeyArg + 1;
     try {
       await this.testFunction(this.tapTools);
       if (this.status === 'timeout') {

ts/tapbundle.classes.taptools.ts

@@ -42,6 +42,10 @@ export class TapTools {
     }
   }
 
+  public async ensureDir(pathArg: string) {
+    await plugins.smartfile.fs.ensureDir(pathArg);
+  }
+
   public async checkIterationLeak(iterationfuncArg: IPromiseFunc) {
     console.log('iteration leakage checks disabled for now due to incompatibilities with node v12');
   }

ts/tapbundle.classes.tapwrap.ts

@@ -19,6 +19,7 @@ export class TapWrap {
    * run the wrapFunction
    */
   async run() {
+    // TODO: make sure it makes sense what we do here.
     await this.wrapFunction();
   }
 }

ts/tapbundle.plugins.ts

@@ -1,9 +1,10 @@
 // pushrocks
 import * as early from '@pushrocks/early';
 import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartfile from '@pushrocks/smartfile';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { early, smartdelay, smartpromise };
+export { early, smartfile, smartdelay, smartpromise };
 
 // third party
 /* import * as leakage from 'leakage';