3.2.5

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,10 +18,11 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
   stage: security
@@ -31,89 +32,89 @@ snyk:
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

README.md

@@ -64,9 +64,13 @@ tap.test('my awesome test 5', async () => {
 tap.start(); // start the test, will automtically plan tests for you (so the tap parser knows when tests exit bofore they are finished)
 ```
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

docs/mkdocs.yml

@@ -1,87 +0,0 @@
-# Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to
-# deal in the Software without restriction, including without limitation the
-# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-# sell copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-
-# Project information
-site_name: tapbundle | docs
-site_description: a taprunner
-site_author: Lossless GmbH
-site_url: https://push.rocks
-
-# Repository
-repo_name: pushrocks/tapbundle
-repo_url: https://gitlab.com/pushrocks/tapbundle
-
-# Copyright
-copyright: 'Copyright &copy; 2014 Lossless GmbH'
-
-# Theme directory
-theme: material
-theme_dir: 'theme'
-
-# Options
-extra:
-  feature:
-    tabs: false
-  palette:
-    primary: indigo
-    accent: indigo
-  social:
-    - type: globe
-      link: http://lossless.com
-    - type: github-alt
-      link: https://github.com/philkunz
-    - type: twitter
-      link: https://twitter.com/philkunzcom
-    - type: linkedin
-      link: https://linkedin.com/in/philippkunz
-
-# Extensions
-markdown_extensions:
-  - markdown.extensions.admonition
-  - markdown.extensions.codehilite(guess_lang=false, linenums=true)
-  - markdown.extensions.def_list
-  - markdown.extensions.footnotes
-  - markdown.extensions.meta
-  - markdown.extensions.toc(permalink=true)
-  - pymdownx.arithmatex
-  - pymdownx.betterem(smart_enable=all)
-  - pymdownx.caret
-  - pymdownx.critic
-  - pymdownx.details
-  - pymdownx.emoji:
-      emoji_generator: !!python/name:pymdownx.emoji.to_svg
-  - pymdownx.inlinehilite
-  - pymdownx.magiclink
-  - pymdownx.mark
-  - pymdownx.smartsymbols
-  - pymdownx.superfences
-  - pymdownx.tasklist(custom_checkbox=true)
-  - pymdownx.tilde
-
-# Page tree
-pages:
-  - Repo Readme: index.md
-  - Get Started: getstarted.md
-  - License: license.md
-
-# Google Analytics
-google_analytics:
-  - !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
-  - auto

docs/theme/partials/footer.html

@@ -1,56 +0,0 @@
-{% import "partials/language.html" as lang %}
-<footer class="md-footer">
-  {% if page.previous_page or page.next_page %}
-    <div class="md-footer-nav">
-      <nav class="md-footer-nav__inner md-grid">
-        {% if page.previous_page %}
-          <a href="{{ page.previous_page.url }}" title="{{ page.previous_page.title }}" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
-            <div class="md-flex__cell md-flex__cell--shrink">
-              <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
-            </div>
-            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
-              <span class="md-flex__ellipsis">
-                <span class="md-footer-nav__direction">
-                  {{ lang.t("footer.previous") }}
-                </span>
-                {{ page.previous_page.title }}
-              </span>
-            </div>
-          </a>
-        {% endif %}
-        {% if page.next_page %}
-          <a href="{{ page.next_page.url }}" title="{{ page.next_page.title }}" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
-            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
-              <span class="md-flex__ellipsis">
-                <span class="md-footer-nav__direction">
-                  {{ lang.t("footer.next") }}
-                </span>
-                {{ page.next_page.title }}
-              </span>
-            </div>
-            <div class="md-flex__cell md-flex__cell--shrink">
-              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
-            </div>
-          </a>
-        {% endif %}
-      </nav>
-    </div>
-  {% endif %}
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-        {% if config.copyright %}
-          <div class="md-footer-copyright__highlight">
-            {{ config.copyright }}
-          </div>
-        {% endif %}
-        <a href="https://lossless.gmbh" title="push.rocks">Impressum</a>
-        |
-        <a href="https://lossless.com" title="Lossless GmbH">Company Website</a>
-      </div>
-      {% block social %}
-        {% include "partials/social.html" %}
-      {% endblock %}
-    </div>
-  </div>
-</footer>

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/tapbundle",
   "private": false,
-  "version": "3.0.8",
+  "version": "3.2.5",
   "description": "tap bundled for tapbuffer",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -20,19 +20,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/tapbundle#README",
   "dependencies": {
-    "@pushrocks/early": "^3.0.3",
-    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartdelay": "^2.0.9",
+    "@pushrocks/smartenv": "^4.0.10",
     "@pushrocks/smartpromise": "^3.0.2",
-    "leakage": "^0.4.0",
+    "@pushrocks/smarttime": "^3.0.19",
     "smartchai": "^2.0.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tsrun": "^1.2.5",
-    "@gitzone/tstest": "^1.0.20",
-    "@types/node": "^11.13.2",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.36",
+    "@types/node": "^14.0.19",
     "randomstring": "^1.1.5",
-    "tslint": "^5.15.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

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

@@ -15,9 +15,7 @@ const test2 = tap.test('should throw', async tools => {
       outsideArray.push(randomstring.generate(1000));
     });
   });
-  if (!process.version.startsWith('v11')) {
-    expect(err).to.be.instanceof(Error);
-  }
+  expect(err).to.be.undefined;
 });
 
 tap.start();

test/test.ts

@@ -1,5 +1,9 @@
 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;
 });

ts/tapbundle.classes.pretask.ts

@@ -0,0 +1,22 @@
+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,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 (descriptionArg: string, functionArg: IPreTaskFunction) {
+    this._tapPreTasks.push(new PreTask(descriptionArg, 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,18 @@ export class Tap {
   /**
    * starts the test evaluation
    */
-  async start(optionsArg?: { throwOnError: boolean }) {
-    let promiseArray: Promise<any>[] = [];
+  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,10 +105,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];
-      let testPromise = currentTest.run(testKey);
+      const currentTest = concerningTests[testKey];
+      const testPromise = currentTest.run(testKey);
       if (currentTest.parallel) {
         promiseArray.push(testPromise);
       } else {
@@ -106,10 +123,10 @@ export class Tap {
     await Promise.all(promiseArray);
 
     // when tests have been run and all promises are fullfilled
-    let failReasons: string[] = [];
-    let executionNotes: string[] = [];
+    const failReasons: 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 +137,7 @@ export class Tap {
     }
 
     // render fail Reasons
-    for (let failReason of failReasons) {
+    for (const failReason of failReasons) {
       console.log(failReason);
     }
 
@@ -132,7 +149,7 @@ export class Tap {
   /**
    * handle errors
    */
-  threw(err) {
+  public threw(err) {
     console.log(err);
   }
 }

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 {
-  (tapTools?: TapTools): Promise<any>;
-}
+export type ITestFunction = (tapTools?: TapTools) => Promise<any>;
 
 export class TapTest {
-  description: string;
-  failureAllowed: boolean;
-  hrtMeasurement: HrtMeasurement;
-  parallel: boolean;
-  status: TTestStatus;
-  tapTools: TapTools;
-  testFunction: ITestFunction;
-  testKey: number; // the testKey the position in the test qeue. Set upon calling .run()
-  testDeferred: Deferred<TapTest> = plugins.smartpromise.defer();
-  testPromise: Promise<TapTest> = this.testDeferred.promise;
+  public description: string;
+  public failureAllowed: boolean;
+  public hrtMeasurement: HrtMeasurement;
+  public parallel: boolean;
+  public status: TTestStatus;
+  public tapTools: TapTools;
+  public testFunction: ITestFunction;
+  public testKey: number; // the testKey the position in the test qeue. Set upon calling .run()
+  public testDeferred: Deferred<TapTest> = plugins.smartpromise.defer();
+  public testPromise: Promise<TapTest> = this.testDeferred.promise;
   /**
    * constructor
    */
@@ -39,11 +37,12 @@ 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') {
         throw new Error('Test succeeded, but timed out...');

ts/tapbundle.classes.taptools.ts

@@ -43,11 +43,7 @@ export class TapTools {
   }
 
   public async checkIterationLeak(iterationfuncArg: IPromiseFunc) {
-  if (process.version.startsWith('v11')) {
-    console.log('iteration leakage checks disabled for now on version 11 due to low performance');
-  } else {
-    await plugins.leakage.iterate.async(iterationfuncArg);
-  }
+    console.log('iteration leakage checks disabled for now due to incompatibilities with node v12');
   }
 
   public async returnError(throwingFuncArg: IPromiseFunc) {
@@ -60,7 +56,7 @@ export class TapTools {
     return funcErr;
   }
 
-  public defer () {
+  public defer() {
     return plugins.smartpromise.defer();
   }
 }

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,6 +1,11 @@
-import * as early from '@pushrocks/early';
-import * as leakage from 'leakage';
+// pushrocks
 import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartenv from '@pushrocks/smartenv';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { early, smartdelay, smartpromise, leakage };
+export { smartdelay, smartenv, smartpromise };
+
+// third party
+/* import * as leakage from 'leakage';
+
+export { leakage }; */