3.2.11

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/tapbundle",
   "private": false,
-  "version": "3.2.9",
+  "version": "3.2.11",
   "description": "tap bundled for tapbuffer",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -20,19 +20,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/tapbundle#README",
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.9",
-    "@pushrocks/smartenv": "^4.0.10",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smarttime": "^3.0.19",
+    "@pushrocks/smartdelay": "^2.0.10",
+    "@pushrocks/smartenv": "^4.0.16",
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/smarttime": "^3.0.38",
     "smartchai": "^2.0.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.25",
     "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.41",
-    "@types/node": "^14.0.22",
+    "@gitzone/tstest": "^1.0.52",
+    "@types/node": "^14.14.22",
     "randomstring": "^1.1.5",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [

test/test.ts

@@ -15,18 +15,22 @@ const test2 = tap.test('my second test', async (tools) => {
 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 > 1000).to.be.true;
+    expect(
+      (await test1.testPromise).hrtMeasurement.milliSeconds <
+        (await test2).hrtMeasurement.milliSeconds
+    ).to.be.true;
+    expect((await test2.testPromise).hrtMeasurement.milliSeconds > 1000).to.be.true;
   }
 );
 
-const test4 = tap.skip.test('my 4th test -> should fail', async (tools) => {
+const test4 = tap.test('my 4th test -> should fail', async (tools) => {
   tools.allowFailure();
   expect(false).to.be.true;
+  return 'hello';
 });
 
 const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
+  const test4Result = await test4.testResultPromise;
   tools.timeout(1000);
   await tools.delayFor(500);
 });

ts/tapbundle.classes.tap.ts

@@ -2,7 +2,7 @@ import * as plugins from './tapbundle.plugins';
 
 import { IPreTaskFunction, PreTask } from './tapbundle.classes.pretask';
 import { TapTest, ITestFunction } from './tapbundle.classes.taptest';
-export class Tap {
+export class Tap <T> {
   /**
    * skips a test
    * tests marked with tap.skip.test() are never executed
@@ -20,26 +20,26 @@ export class Tap {
    * only executes tests marked as ONLY
    */
   public only = {
-    test: (descriptionArg: string, testFunctionArg: ITestFunction) => {
+    test: (descriptionArg: string, testFunctionArg: ITestFunction<T>) => {
       this.test(descriptionArg, testFunctionArg, 'only');
     },
   };
 
   private _tapPreTasks: PreTask[] = [];
-  private _tapTests: TapTest[] = [];
-  private _tapTestsOnly: TapTest[] = [];
+  private _tapTests: TapTest<any>[] = [];
+  private _tapTestsOnly: TapTest<any>[] = [];
 
   /**
    * Normal test function, will run one by one
    * @param testDescription - A description of what the test does
    * @param testFunction - A Function that returns a Promise and resolves or rejects
    */
-  public async test(
+  public test(
     testDescription: string,
-    testFunction: ITestFunction,
+    testFunction: ITestFunction<T>,
     modeArg: 'normal' | 'only' | 'skip' = 'normal'
   ) {
-    const localTest = new TapTest({
+    const localTest = new TapTest<T>({
       description: testDescription,
       testFunction,
       parallel: false,

ts/tapbundle.classes.taptest.ts

@@ -9,23 +9,25 @@ import { HrtMeasurement } from '@pushrocks/smarttime';
 // interfaces
 export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout';
 
-export type ITestFunction = (tapTools?: TapTools) => Promise<any>;
+export interface ITestFunction <T = unknown> { (tapTools?: TapTools): Promise<T> };
 
-export class TapTest {
+export class TapTest <T = unknown> {
   public description: string;
   public failureAllowed: boolean;
   public hrtMeasurement: HrtMeasurement;
   public parallel: boolean;
   public status: TTestStatus;
   public tapTools: TapTools;
-  public testFunction: ITestFunction;
+  public testFunction: ITestFunction<T>;
   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;
+  private testDeferred: Deferred<TapTest<T>> = plugins.smartpromise.defer();
+  public testPromise: Promise<TapTest<T>> = this.testDeferred.promise;
+  private testResultDeferred: Deferred<T> = plugins.smartpromise.defer();
+  public testResultPromise: Promise<T> = this.testResultDeferred.promise;
   /**
    * constructor
    */
-  constructor(optionsArg: { description: string; testFunction: ITestFunction; parallel: boolean }) {
+  constructor(optionsArg: { description: string; testFunction: ITestFunction<T>; parallel: boolean }) {
     this.description = optionsArg.description;
     this.hrtMeasurement = new HrtMeasurement();
     this.parallel = optionsArg.parallel;
@@ -42,7 +44,7 @@ export class TapTest {
     this.testKey = testKeyArg;
     const testNumber = testKeyArg + 1;
     try {
-      await this.testFunction(this.tapTools);
+      const testReturnValue = await this.testFunction(this.tapTools);
       if (this.status === 'timeout') {
         throw new Error('Test succeeded, but timed out...');
       }
@@ -52,12 +54,14 @@ export class TapTest {
       );
       this.status = 'success';
       this.testDeferred.resolve(this);
+      this.testResultDeferred.resolve(testReturnValue);
     } catch (err) {
       this.hrtMeasurement.stop();
       console.log(
         `not ok ${testNumber} - ${this.description} # time=${this.hrtMeasurement.milliSeconds}ms`
       );
       this.testDeferred.resolve(this);
+      this.testResultDeferred.resolve(err);
 
       // if the test has already succeeded before
       if (this.status === 'success') {