1.0.61

.gitlab-ci.yml

@@ -19,23 +19,36 @@ 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
+  allow_failure: true
+
+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 +63,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +74,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +94,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"]
               }
             }
           }

cli.js

@@ -1,3 +1,4 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
-require('./dist/index');
+const cliTool = require('./dist_ts/index');
+cliTool.runCli();

cli.ts.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
 require('@gitzone/tsrun');
-require('./ts/index');
+const cliTool = require('./ts/index');
+cliTool.runCli();

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "gitzone",
       "gitrepo": "tstest",
-      "shortDescription": "a test utility to run tests that match test/**/*.ts",
+      "description": "a test utility to run tests that match test/**/*.ts",
       "npmPackagename": "@gitzone/tstest",
       "license": "MIT"
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitzone/tstest",
-  "version": "1.0.31",
+  "version": "1.0.61",
   "private": false,
   "description": "a test utility to run tests that match test/**/*.ts",
   "main": "dist_ts/index.js",
@@ -11,25 +11,29 @@
     "tstest": "./cli.js"
   },
   "scripts": {
-    "test": "(npm run prepareTest && npm run tstest && npm run cleanUp)",
+    "test": "(npm run cleanUp && npm run prepareTest && npm run tstest)",
     "prepareTest": "git clone https://gitlab.com/sandboxzone/sandbox-npmts.git .nogit/sandbox-npmts && cd .nogit/sandbox-npmts && npm install",
-    "tstest": "cd .nogit/sandbox-npmts && node ../../cli.ts.js test/",
+    "tstest": "cd .nogit/sandbox-npmts && node ../../cli.ts.js test/ --web",
     "cleanUp": "rm -rf .nogit/sandbox-npmts",
-    "format": "(gitzone format)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@pushrocks/tapbundle": "^3.0.13"
+    "@gitzone/tsbuild": "^2.1.28",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@gitzone/tsbundle": "^1.0.69",
-    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tsbundle": "^1.0.88",
+    "@gitzone/tsrun": "^1.2.18",
     "@pushrocks/consolecolor": "^2.0.1",
-    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartshell": "^2.0.25",
+    "@pushrocks/smartbrowser": "^1.0.22",
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartexpress": "^3.0.108",
+    "@pushrocks/smartfile": "^8.0.10",
+    "@pushrocks/smartlog": "^2.0.44",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartshell": "^2.0.29",
+    "@pushrocks/tapbundle": "^3.2.14",
     "@types/figures": "^3.0.1",
     "figures": "^3.0.0"
   },
@@ -44,5 +48,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -19,12 +19,34 @@ TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x
 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/@gitzone/tstest)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@gitzone/tstest)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@gitzone/tstest)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@gitzone/tstest)](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
 
+## cli usage
+lets assume we have a directory called test/ where all our tests arae defined. Simply type
+
+```
+tstest test/
+```
+
+to run all tests.
+
+## Syntax
+tstest supports tap syntax. In other words your testfiles are run in a subprocess, and the console output contains trigger messages for tstest to determine test status. Inside your testfile you should use `@pushrocks/tapbundle` for the best results.
+
+## Environments
+
+tstest supports different environments:
+
+* a testfile called `test-something.node.ts` will be run in node
+* a testfile called `test-something.chrome.ts` will be run in chrome environment (bundled through parcel and run through puppeteer)
+* a testfile called `test-something.both.ts` will be run in node an chrome, which is good for isomorphic packages.
+
+> note: there is alpha support for the deno environment by naming a file test-something.deno.ts
+
 
 ## Contribution
 

ts/index.ts

@@ -1,9 +1,10 @@
 import { TsTest } from './tstest.classes.tstest';
 
-const cliRun = async () => {
-  if (process.env.CLI_CALL) {
-    const tsTestInstance = new TsTest(process.cwd(), process.argv[2]);
-    await tsTestInstance.run();
+export const runCli = async () => {
+  if (!process.argv[2]) {
+    console.error('You must specify a test directory as argument. Please try again.');
+    process.exit(1);
   }
+  const tsTestInstance = new TsTest(process.cwd(), process.argv[2]);
+  await tsTestInstance.run();
 };
-cliRun();

ts/tstest.classes.tap.combinator.ts

@@ -20,7 +20,24 @@ export class TapCombinator {
 
     let failGlobal = false; // determine wether tstest should fail
     for (const tapParser of this.tapParserStore) {
-      if (tapParser.getErrorTests().length === 0) {
+      if (!tapParser.expectedTests) {
+        failGlobal = true;
+        let overviewString =
+          logPrefixes.TsTestPrefix +
+          cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
+          ` ${plugins.figures.pointer} ` +
+          `does not specify tests!`;
+        console.log(overviewString);
+      } else if (tapParser.expectedTests !== tapParser.receivedTests) {
+        failGlobal = true;
+        let overviewString =
+          logPrefixes.TsTestPrefix +
+          cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
+          ` ${plugins.figures.pointer} ` +
+          tapParser.getTestOverviewAsString() +
+          `did not execute all specified tests!`;
+        console.log(overviewString);
+      } else if (tapParser.getErrorTests().length === 0) {
         let overviewString =
           logPrefixes.TsTestPrefix +
           cs(` ${tapParser.fileName} ${plugins.figures.tick}`, 'green') +
@@ -28,13 +45,13 @@ export class TapCombinator {
           tapParser.getTestOverviewAsString();
         console.log(overviewString);
       } else {
+        failGlobal = true;
         let overviewString =
           logPrefixes.TsTestPrefix +
           cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
           ` ${plugins.figures.pointer} ` +
           tapParser.getTestOverviewAsString();
         console.log(overviewString);
-        failGlobal = true;
       }
     }
     console.log(cs(plugins.figures.hamburger.repeat(48), 'cyan'));

ts/tstest.classes.tap.parser.ts

@@ -105,15 +105,15 @@ export class TapParser {
   /**
    * returns all tests that are not completed
    */
-  getUncompletedTests() {
+  public getUncompletedTests() {
     // TODO:
   }
 
   /**
    * returns all tests that threw an error
    */
-  getErrorTests() {
-    return this.testStore.filter(tapTestArg => {
+  public getErrorTests() {
+    return this.testStore.filter((tapTestArg) => {
       return !tapTestArg.testOk;
     });
   }
@@ -123,7 +123,7 @@ export class TapParser {
    */
   getTestOverviewAsString() {
     let overviewString = '';
-    for (let test of this.testStore) {
+    for (const test of this.testStore) {
       if (overviewString !== '') {
         overviewString += ' | ';
       }
@@ -140,45 +140,63 @@ export class TapParser {
    * handles a tap process
    * @param childProcessArg
    */
-  async handleTapProcess(childProcessArg: ChildProcess) {
+  public async handleTapProcess(childProcessArg: ChildProcess) {
     const done = plugins.smartpromise.defer();
-    childProcessArg.stdout.on('data', data => {
+    childProcessArg.stdout.on('data', (data) => {
       this._processLog(data);
     });
-    childProcessArg.stderr.on('data', data => {
+    childProcessArg.stderr.on('data', (data) => {
       this._processLog(data);
     });
-    childProcessArg.on('exit', () => {
-      this.receivedTests = this.testStore.length;
-
-      // check wether all tests ran
-      if (this.expectedTests === this.receivedTests) {
-        console.log(
-          `${logPrefixes.TapPrefix} ${cs(
-            `${this.receivedTests} out of ${this.expectedTests} Tests completed!`,
-            'green'
-          )}`
-        );
-      } else {
-        console.log(
-          `${logPrefixes.TapErrorPrefix} ${cs(
-            `Only ${this.receivedTests} out of ${this.expectedTests} completed!`,
-            'red'
-          )}`
-        );
-      }
-      if (this.getErrorTests().length === 0) {
-        console.log(`${logPrefixes.TapPrefix} ${cs(`All tests are successfull!!!`, 'green')}`);
-      } else {
-        console.log(
-          `${logPrefixes.TapPrefix} ${cs(
-            `${this.getErrorTests().length} tests threw an error!!!`,
-            'red'
-          )}`
-        );
-      }
+    childProcessArg.on('exit', async () => {
+      await this._evaluateResult();
       done.resolve();
     });
     await done.promise;
   }
+
+  public async handleTapLog(tapLog: string) {
+    this._processLog(tapLog);
+    await this._evaluateResult();
+  }
+
+  private async _evaluateResult() {
+    this.receivedTests = this.testStore.length;
+
+    // check wether all tests ran
+    if (this.expectedTests === this.receivedTests) {
+      console.log(
+        `${logPrefixes.TapPrefix} ${cs(
+          `${this.receivedTests} out of ${this.expectedTests} Tests completed!`,
+          'green'
+        )}`
+      );
+    } else {
+      console.log(
+        `${logPrefixes.TapErrorPrefix} ${cs(
+          `Only ${this.receivedTests} out of ${this.expectedTests} completed!`,
+          'red'
+        )}`
+      );
+    }
+    if (!this.expectedTests) {
+      console.log(cs('Error: No tests were defined. Therefore the testfile failed!', 'red'));
+    } else if (this.expectedTests !== this.receivedTests) {
+      console.log(
+        cs(
+          'Error: The amount of received tests and expectedTests is unequal! Therefore the testfile failed',
+          'red'
+        )
+      );
+    } else if (this.getErrorTests().length === 0) {
+      console.log(`${logPrefixes.TapPrefix} ${cs(`All tests are successfull!!!`, 'green')}`);
+    } else {
+      console.log(
+        `${logPrefixes.TapPrefix} ${cs(
+          `${this.getErrorTests().length} tests threw an error!!!`,
+          'red'
+        )}`
+      );
+    }
+  }
 }

ts/tstest.classes.tstest.ts

@@ -9,7 +9,16 @@ import { TapCombinator } from './tstest.classes.tap.combinator';
 import { TapParser } from './tstest.classes.tap.parser';
 
 export class TsTest {
-  testDir: TestDirectory;
+  public testDir: TestDirectory;
+
+  public smartshellInstance = new plugins.smartshell.Smartshell({
+    executor: 'bash',
+    pathDirectories: [paths.binDirectory],
+    sourceFilePaths: [],
+  });
+  public smartbrowserInstance = new plugins.smartbrowser.SmartBrowser();
+
+  public tsbundleInstance = new plugins.tsbundle.TsBundle();
 
   constructor(cwdArg: string, relativePathToTestDirectory: string) {
     this.testDir = new TestDirectory(cwdArg, relativePathToTestDirectory);
@@ -25,31 +34,192 @@ export class TsTest {
     }
     console.log('-'.repeat(48));
     console.log(''); // force new line
-    const smartshellInstance = new plugins.smartshell.Smartshell({
-      executor: 'bash',
-      pathDirectories: [paths.binDirectory],
-      sourceFilePaths: []
-    });
-    const tapCombinator = new TapCombinator(); // lets create the TapCombinator
-    for (const fileName of fileNamesToRun) {
-      console.log(`${cs('=> ', 'blue')} Running ${cs(fileName, 'orange')}`);
-      console.log(cs(`=`.repeat(16), 'cyan'));
-      const tapParser = new TapParser(fileName);
 
-      // tsrun options
-      let tsrunOptions = '';
-      if (process.argv.includes('--web')) {
-        tsrunOptions += ' --web';
+    const tapCombinator = new TapCombinator(); // lets create the TapCombinator
+    for (const fileNameArg of fileNamesToRun) {
+      switch (true) {
+        case process.env.CI && fileNameArg.includes('.nonci.'):
+          console.log('!!!!!!!!!!!');
+          console.log(
+            `not running testfile ${fileNameArg}, sinc we are CI and file name includes '.nonci.' tag`
+          );
+          console.log('!!!!!!!!!!!');
+          break;
+        case fileNameArg.endsWith('.browser.ts'):
+          const tapParserBrowser = await this.runInChrome(fileNameArg);
+          tapCombinator.addTapParser(tapParserBrowser);
+          break;
+        case fileNameArg.endsWith('.both.ts'):
+          console.log('>>>>>>> TEST PART 1: chrome');
+          const tapParserBothBrowser = await this.runInChrome(fileNameArg);
+          tapCombinator.addTapParser(tapParserBothBrowser);
+          console.log(cs(`|`.repeat(16), 'cyan'));
+          console.log(''); // force new line
+          console.log('>>>>>>> TEST PART 2: node');
+          const tapParserBothNode = await this.runInNode(fileNameArg);
+          tapCombinator.addTapParser(tapParserBothNode);
+          break;
+        default:
+          const tapParserNode = await this.runInNode(fileNameArg);
+          tapCombinator.addTapParser(tapParserNode);
+          break;
       }
 
-      const execResultStreaming = await smartshellInstance.execStreamingSilent(
-        `tsrun ${fileName}${tsrunOptions}`
-      );
-      await tapParser.handleTapProcess(execResultStreaming.childProcess);
       console.log(cs(`^`.repeat(16), 'cyan'));
       console.log(''); // force new line
-      tapCombinator.addTapParser(tapParser);
     }
     tapCombinator.evaluate();
   }
+
+  public async runInNode(fileNameArg: string): Promise<TapParser> {
+    console.log(`${cs('=> ', 'blue')} Running ${cs(fileNameArg, 'orange')} in node.js runtime.`);
+    console.log(`${cs(`= `.repeat(32), 'cyan')}`);
+    const tapParser = new TapParser(fileNameArg + ':node');
+
+    // tsrun options
+    let tsrunOptions = '';
+    if (process.argv.includes('--web')) {
+      tsrunOptions += ' --web';
+    }
+
+    const execResultStreaming = await this.smartshellInstance.execStreamingSilent(
+      `tsrun ${fileNameArg}${tsrunOptions}`
+    );
+    await tapParser.handleTapProcess(execResultStreaming.childProcess);
+    return tapParser;
+  }
+
+  public async runInChrome(fileNameArg: string): Promise<TapParser> {
+    console.log(`${cs('=> ', 'blue')} Running ${cs(fileNameArg, 'orange')} in chromium runtime.`);
+    console.log(`${cs(`= `.repeat(32), 'cyan')}`);
+
+    // lets get all our paths sorted
+    const tsbundleCacheDirPath = plugins.path.join(paths.cwd, './.nogit/tstest_cache');
+    const bundleFileName = fileNameArg.replace('/', '__') + '.js';
+    const bundleFilePath = plugins.path.join(tsbundleCacheDirPath, bundleFileName);
+
+    // lets bundle the test
+    await plugins.smartfile.fs.ensureDir(tsbundleCacheDirPath);
+    await this.tsbundleInstance.buildTest(process.cwd(), fileNameArg, bundleFilePath, 'parcel');
+
+    // lets create a server
+    const server = new plugins.smartexpress.Server({
+      cors: true,
+      port: 3007,
+    });
+    server.addRoute(
+      '/test',
+      new plugins.smartexpress.Handler('GET', async (req, res) => {
+        res.type('.html');
+        res.write(`
+        <html>
+          <head>
+            <script>
+              globalThis.testdom = true;
+            </script>
+          </head>
+          <body></body>
+        </html>
+      `);
+        res.end();
+      })
+    );
+    server.addRoute('*', new plugins.smartexpress.HandlerStatic(tsbundleCacheDirPath));
+    await server.start();
+
+    // lets do the browser bit
+    await this.smartbrowserInstance.start();
+    const evaluation = await this.smartbrowserInstance.evaluateOnPage(
+      `http://localhost:3007/test?bundleName=${bundleFileName}`,
+      async () => {
+        const convertToText = (obj: any): string => {
+          // create an array that will later be joined into a string.
+          const stringArray = [];
+
+          if (typeof obj === 'object' && typeof obj.toString === 'function') {
+            stringArray.push(obj.toString());
+          } else if (typeof obj === 'object' && obj.join === undefined) {
+            stringArray.push('{');
+            for (const prop of Object.keys(obj)) {
+              stringArray.push(prop, ': ', convertToText(obj[prop]), ',');
+            }
+            stringArray.push('}');
+
+            // is array
+          } else if (typeof obj === 'object' && !(obj.join === undefined)) {
+            stringArray.push('[');
+            for (const prop of Object.keys(obj)) {
+              stringArray.push(convertToText(obj[prop]), ',');
+            }
+            stringArray.push(']');
+
+            // is function
+          } else if (typeof obj === 'function') {
+            stringArray.push(obj.toString());
+
+            // all other values can be done with JSON.stringify
+          } else {
+            stringArray.push(JSON.stringify(obj));
+          }
+
+          return stringArray.join('');
+        };
+
+        let logStore = '';
+        // tslint:disable-next-line: max-classes-per-file
+        const log = console.log.bind(console);
+        console.log = (...args) => {
+          args = args.map((argument) => {
+            return typeof argument !== 'string' ? convertToText(argument) : argument;
+          });
+          logStore += `${args}\n`;
+          log(...args);
+        };
+        const error = console.error;
+        console.error = (...args) => {
+          args = args.map((argument) => {
+            return typeof argument !== 'string' ? convertToText(argument) : argument;
+          });
+          logStore += `${args}\n`;
+          error(...args);
+        };
+        const bundleName = new URLSearchParams(window.location.search).get('bundleName');
+        console.log(`::TSTEST IN CHROMIUM:: Relevant Script name is: ${bundleName}`);
+        const bundleResponse = await fetch(`/${bundleName}`);
+        console.log(
+          `::TSTEST IN CHROMIUM:: Got ${bundleName} with STATUS ${bundleResponse.status}`
+        );
+        const bundle = await bundleResponse.text();
+        console.log(`::TSTEST IN CHROMIUM:: Executing ${bundleName}`);
+        try {
+          // tslint:disable-next-line: no-eval
+          eval(bundle);
+        } catch (err) {
+          console.error(err);
+        }
+
+        if (
+          (globalThis as any).tapbundleDeferred &&
+          (globalThis as any).tapbundleDeferred.promise
+        ) {
+          await (globalThis as any).tapbundleDeferred.promise;
+        } else {
+          console.log('Error: Could not find tapbundle Deferred');
+        }
+        return logStore;
+      }
+    );
+    await this.smartbrowserInstance.stop();
+    await server.stop();
+    console.log(
+      `${cs('=> ', 'blue')} Stopped ${cs(fileNameArg, 'orange')} chromium instance and server.`
+    );
+    console.log(`${cs('=> ', 'blue')} See the result captured from the chromium execution:`);
+    // lets create the tap parser
+    const tapParser = new TapParser(fileNameArg + ':chrome');
+    tapParser.handleTapLog(evaluation);
+    return tapParser;
+  }
+
+  public async runInDeno() {}
 }

ts/tstest.plugins.ts

@@ -1,14 +1,37 @@
 // node native
 import * as path from 'path';
 
+export { path };
+
 // @pushrocks scope
 import * as consolecolor from '@pushrocks/consolecolor';
+import * as smartbrowser from '@pushrocks/smartbrowser';
+import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartlog from '@pushrocks/smartlog';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartshell from '@pushrocks/smartshell';
+import * as tapbundle from '@pushrocks/tapbundle';
+
+export {
+  consolecolor,
+  smartbrowser,
+  smartexpress,
+  smartdelay,
+  smartfile,
+  smartlog,
+  smartpromise,
+  smartshell,
+  tapbundle,
+};
+
+// @gitzone scope
+import * as tsbundle from '@gitzone/tsbundle';
+
+export { tsbundle };
 
 // sindresorhus
 import * as figures from 'figures';
 
-export { consolecolor, figures, path, smartfile, smartlog, smartpromise, smartshell };
+export { figures };