3.2.8

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -24,13 +24,14 @@ mirror:
     - docker
     - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -9,6 +9,7 @@
     }
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/tapbundle",
   "private": false,
-  "version": "3.1.0",
+  "version": "3.2.8",
   "description": "tap bundled for tapbuffer",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -20,30 +20,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/tapbundle#README",
   "dependencies": {
-    "@pushrocks/early": "^3.0.3",
+    "@pushrocks/smartdelay": "^2.0.9",
-    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartenv": "^4.0.10",
-    "@pushrocks/smartfile": "^7.0.6",
     "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smarttime": "^3.0.19",
     "smartchai": "^2.0.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.41",
-    "@types/node": "^12.7.2",
+    "@types/node": "^14.0.22",
     "randomstring": "^1.1.5",
-    "tslint": "^5.19.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,13 +8,20 @@ tap bundled for tapbuffer
 * [docs (typedoc)](https://pushrocks.gitlab.io/tapbundle/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/tapbundle/badges/master/build.svg)](https://gitlab.com/pushrocks/tapbundle/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/tapbundle/badges/master/coverage.svg)](https://gitlab.com/pushrocks/tapbundle/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/tapbundle.svg)](https://www.npmjs.com/package/@pushrocks/tapbundle)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/tapbundle/badge.svg)](https://snyk.io/test/npm/@pushrocks/tapbundle)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/tapbundle/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/tapbundle/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/tapbundle)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/tapbundle)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/tapbundle)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/tapbundle)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/tapbundle)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -35,24 +42,24 @@ import { tap, expect } from 'tapbundle'; // has typings in place
 
 import * as myAwesomeModuleToTest from '../dist/index'; // '../dist/index' is the standard path for npmts modules
 
-tap.test('my awesome description', async tools => {
+tap.test('my awesome description', async (tools) => {
   // tools are optional parameter
   tools.timeout(2000); // test will fail if it takes longer than 2000 millisenconds
 });
 
-let myTest2 = tap.test('my awesome test 2', async tools => {
+let myTest2 = tap.test('my awesome test 2', async (tools) => {
   myAwsomeModuleToTest.doSomethingAsync(); // we don't wait here
   await tools.delayFor(3000); // yay! :) promise based timeouts :)
   console.log('This gets logged 3000 ms into the test');
 });
 
-tap.test('my awesome test 3', async tools => {
+tap.test('my awesome test 3', async (tools) => {
   expect(true).to.be.true; // will not throw
   await expect(tools.delayFor(2000)).to.eventually.be.fulfilled; // yay expect promises :)
   expect((await myTest2.promise).hrtMeasurement.milliSeconds > 1000).to.be.true; // access other tests metadata :)
 });
 
-let myTest4 = tap.testParallel('my awesome test 4', async tools => {
+let myTest4 = tap.testParallel('my awesome test 4', async (tools) => {
   await tools.delayFor(4000);
   console.log('logs to console after 4 seconds into this test');
 });

test/test.browser.ts

@@ -0,0 +1,40 @@
+import { tap, expect } from '../ts/index';
+
+tap.preTask('hi there', async () => {
+  console.log('this is a pretask');
+});
+
+const test1 = tap.test('my first test -> expect true to be true', async () => {
+  return expect(true).to.be.true;
+});
+
+const test2 = tap.test('my second test', async (tools) => {
+  await tools.delayFor(50);
+});
+
+const test3 = tap.test(
+  'my third test -> test2 should take longer than test1 and endure at least 1000ms',
+  async () => {
+    expect((await test1).hrtMeasurement.milliSeconds < (await test2).hrtMeasurement.milliSeconds).to
+      .be.true;
+    expect((await test2).hrtMeasurement.milliSeconds > 10).to.be.true;
+  }
+);
+
+const test4 = tap.skip.test('my 4th test -> should fail', async (tools) => {
+  tools.allowFailure();
+  expect(false).to.be.true;
+});
+
+const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
+  tools.timeout(1000);
+  await tools.delayFor(500);
+});
+
+const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async (tools) => {
+  tools.allowFailure();
+  tools.timeout(1000);
+  await tools.delayFor(100);
+});
+
+tap.start();

test/test.iterationleak.ts

@@ -1,21 +0,0 @@
-import { tap, expect } from '../ts/index';
-import * as randomstring from 'randomstring';
-
-const test1 = tap.test('my first test -> expect true to be true', async tools => {
-  await tools.checkIterationLeak(async () => {
-    const domain = randomstring.generate(1000);
-  });
-});
-
-const outsideArray = [];
-
-const test2 = tap.test('should throw', async tools => {
-  const err = await tools.returnError(async () => {
-    await tools.checkIterationLeak(async () => {
-      outsideArray.push(randomstring.generate(1000));
-    });
-  });
-  expect(err).to.be.undefined;
-});
-
-tap.start();

test/test.tapwrap.ts

@@ -1,10 +1,5 @@
-import { tap, expect } from '../ts/index';
+import { tap, expect, TapWrap } from '../ts/index';
 
-const tapwrap = tap.wrap(async () => {
+tap.test('should run a test', async () => {});
-  tap.test('should do something', async () => {
-    console.log('test1');
-  });
-  tap.start();
-});
 
-tapwrap.run();
+tap.start();

test/test.ts

@@ -1,10 +1,14 @@
 import { tap, expect } from '../ts/index';
 
+tap.preTask('hi there', async () => {
+  console.log('this is a pretask');
+});
+
 const test1 = tap.test('my first test -> expect true to be true', async () => {
   return expect(true).to.be.true;
 });
 
-const test2 = tap.test('my second test', async tools => {
+const test2 = tap.test('my second test', async (tools) => {
   await tools.delayFor(1000);
 });
 
@@ -17,17 +21,17 @@ const test3 = tap.test(
   }
 );
 
-const test4 = tap.skip.test('my 4th test -> should fail', async tools => {
+const test4 = tap.skip.test('my 4th test -> should fail', async (tools) => {
   tools.allowFailure();
   expect(false).to.be.true;
 });
 
-const test5 = tap.test('my 5th test -> should pass in about 500ms', async tools => {
+const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
   tools.timeout(1000);
   await tools.delayFor(500);
 });
 
-const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async tools => {
+const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async (tools) => {
   tools.allowFailure();
   tools.timeout(1000);
   await tools.delayFor(2000);

ts/index.ts

@@ -1,2 +1,3 @@
 export { expect } from 'smartchai';
 export { tap } from './tapbundle.classes.tap';
+export { TapWrap } from './tapbundle.classes.tapwrap';

ts/tapbundle.classes.pretask.ts

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

ts/tapbundle.classes.tap.ts

@@ -1,7 +1,7 @@
 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 {
   /**
    * skips a test
@@ -13,7 +13,7 @@ export class Tap {
     },
     testParallel: (descriptionArg: string, functionArg: ITestFunction) => {
       console.log(`skipped test: ${descriptionArg}`);
-    }
+    },
   };
 
   /**
@@ -22,9 +22,10 @@ export class Tap {
   public only = {
     test: (descriptionArg: string, testFunctionArg: ITestFunction) => {
       this.test(descriptionArg, testFunctionArg, 'only');
-    }
+    },
   };
 
+  private _tapPreTasks: PreTask[] = [];
   private _tapTests: TapTest[] = [];
   private _tapTestsOnly: TapTest[] = [];
 
@@ -41,7 +42,7 @@ export class Tap {
     const localTest = new TapTest({
       description: testDescription,
       testFunction,
-      parallel: false
+      parallel: false,
     });
     if (modeArg === 'normal') {
       this._tapTests.push(localTest);
@@ -51,11 +52,8 @@ export class Tap {
     return localTest;
   }
 
-  /**
+  public preTask(descriptionArg: string, functionArg: IPreTaskFunction) {
-   * wraps function
+    this._tapPreTasks.push(new PreTask(descriptionArg, functionArg));
-   */
-  public wrap(functionArg: ITapWrapFunction) {
-    return new TapWrap(functionArg);
   }
 
   /**
@@ -68,7 +66,7 @@ export class Tap {
       new TapTest({
         description: testDescription,
         testFunction,
-        parallel: true
+        parallel: true,
       })
     );
   }
@@ -77,11 +75,19 @@ export class Tap {
    * starts the test evaluation
    */
   public async start(optionsArg?: { throwOnError: boolean }) {
+    // lets set the tapbundle promise
+    const smartenvInstance = new plugins.smartenv.Smartenv();
+    smartenvInstance.isBrowser
+      ? (globalThis.tapbundleDeferred = plugins.smartpromise.defer())
+      : null;
+
+    // lets continue with running the tests
     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,6 +99,11 @@ 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++) {
       const currentTest = concerningTests[testKey];
@@ -125,7 +136,10 @@ export class Tap {
     }
 
     if (optionsArg && optionsArg.throwOnError && failReasons.length > 0) {
-      process.exit(1);
+      if (!smartenvInstance.isBrowser) process.exit(1);
+    }
+    if (smartenvInstance.isBrowser) {
+      globalThis.tapbundleDeferred.resolve();
     }
   }
 

ts/tapbundle.classes.taptest.ts

@@ -3,27 +3,25 @@ import { tapCreator } from './tapbundle.tapcreator';
 import { TapTools } from './tapbundle.classes.taptools';
 
 // imported interfaces
-import { HrtMeasurement } from '@pushrocks/early';
 import { Deferred } from '@pushrocks/smartpromise';
+import { HrtMeasurement } from '@pushrocks/smarttime';
 
 // 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,14 +42,6 @@ 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');
-  }
-
   public async returnError(throwingFuncArg: IPromiseFunc) {
     let funcErr: Error;
     try {

ts/tapbundle.classes.tapwrap.ts

@@ -1,24 +1,13 @@
 import * as plugins from './tapbundle.plugins';
 
-export interface ITapWrapFunction {
+export interface ITapWrapOptions {
-  (): Promise<any>;
+  before: () => Promise<any>;
+  after: () => {};
 }
 
 export class TapWrap {
-  wrapFunction: ITapWrapFunction;
+  public options: ITapWrapOptions;
-
+  constructor(optionsArg: ITapWrapOptions) {
-  /**
+    this.options = optionsArg;
-   * the constructor
-   */
-  constructor(wrapFunctionArg: ITapWrapFunction) {
-    // nothing here
-    this.wrapFunction = wrapFunctionArg;
-  }
-
-  /**
-   * run the wrapFunction
-   */
-  async run() {
-    await this.wrapFunction();
   }
 }

ts/tapbundle.plugins.ts

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