@git.zone/tstest 1.0.79

package/ts/tstest.classes.tap.parser.ts

@@ -0,0 +1,202 @@
+import { ChildProcess } from 'child_process';
+import { coloredString as cs } from '@push.rocks/consolecolor';
+
+// ============
+// combines different tap test files to an overall result
+// ============
+import * as plugins from './tstest.plugins.js';
+import { TapTestResult } from './tstest.classes.tap.testresult.js';
+import * as logPrefixes from './tstest.logprefixes.js';
+
+export class TapParser {
+  testStore: TapTestResult[] = [];
+
+  expectedTestsRegex = /([0-9]*)\.\.([0-9]*)$/;
+  expectedTests: number;
+  receivedTests: number;
+
+  testStatusRegex = /(ok|not\sok)\s([0-9]+)\s-\s(.*)\s#\stime=(.*)ms$/;
+  activeTapTestResult: TapTestResult;
+
+  /**
+   * the constructor for TapParser
+   */
+  constructor(public fileName: string) {}
+
+  private _getNewTapTestResult() {
+    this.activeTapTestResult = new TapTestResult(this.testStore.length + 1);
+  }
+
+  private _processLog(logChunk: Buffer | string) {
+    if (Buffer.isBuffer(logChunk)) {
+      logChunk = logChunk.toString();
+    }
+    const logLineArray = logChunk.split('\n');
+    if (logLineArray[logLineArray.length - 1] === '') {
+      logLineArray.pop();
+    }
+
+    // lets parse the log information
+    for (const logLine of logLineArray) {
+      let logLineIsTapProtocol = false;
+      if (!this.expectedTests && this.expectedTestsRegex.test(logLine)) {
+        logLineIsTapProtocol = true;
+        const regexResult = this.expectedTestsRegex.exec(logLine);
+        this.expectedTests = parseInt(regexResult[2]);
+        console.log(
+          `${logPrefixes.TapPrefix} ${cs(`Expecting ${this.expectedTests} tests!`, 'blue')}`
+        );
+
+        // initiating first TapResult
+        this._getNewTapTestResult();
+      } else if (this.testStatusRegex.test(logLine)) {
+        logLineIsTapProtocol = true;
+        const regexResult = this.testStatusRegex.exec(logLine);
+        const testId = parseInt(regexResult[2]);
+        const testOk = (() => {
+          if (regexResult[1] === 'ok') {
+            return true;
+          }
+          return false;
+        })();
+
+        const testSubject = regexResult[3];
+        const testDuration = parseInt(regexResult[4]);
+
+        // test for protocol error
+        if (testId !== this.activeTapTestResult.id) {
+          console.log(
+            `${logPrefixes.TapErrorPrefix} Something is strange! Test Ids are not equal!`
+          );
+        }
+        this.activeTapTestResult.setTestResult(testOk);
+
+        if (testOk) {
+          console.log(
+            logPrefixes.TapPrefix,
+            `${cs(`T${testId} ${plugins.figures.tick}`, 'green')} ${plugins.figures.arrowRight} ` +
+              cs(testSubject, 'blue') +
+              ` | ${cs(`${testDuration} ms`, 'orange')}`
+          );
+        } else {
+          console.log(
+            logPrefixes.TapPrefix,
+            `${cs(`T${testId} ${plugins.figures.cross}`, 'red')} ${plugins.figures.arrowRight} ` +
+              cs(testSubject, 'blue') +
+              ` | ${cs(`${testDuration} ms`, 'orange')}`
+          );
+        }
+      }
+
+      if (!logLineIsTapProtocol) {
+        if (this.activeTapTestResult) {
+          this.activeTapTestResult.addLogLine(logLine);
+        }
+        console.log(logLine);
+      }
+
+      if (this.activeTapTestResult && this.activeTapTestResult.testSettled) {
+        this.testStore.push(this.activeTapTestResult);
+        this._getNewTapTestResult();
+      }
+    }
+  }
+
+  /**
+   * returns all tests that are not completed
+   */
+  public getUncompletedTests() {
+    // TODO:
+  }
+
+  /**
+   * returns all tests that threw an error
+   */
+  public getErrorTests() {
+    return this.testStore.filter((tapTestArg) => {
+      return !tapTestArg.testOk;
+    });
+  }
+
+  /**
+   * returns a test overview as string
+   */
+  getTestOverviewAsString() {
+    let overviewString = '';
+    for (const test of this.testStore) {
+      if (overviewString !== '') {
+        overviewString += ' | ';
+      }
+      if (test.testOk) {
+        overviewString += cs(`T${test.id} ${plugins.figures.tick}`, 'green');
+      } else {
+        overviewString += cs(`T${test.id} ${plugins.figures.cross}`, 'red');
+      }
+    }
+    return overviewString;
+  }
+
+  /**
+   * handles a tap process
+   * @param childProcessArg
+   */
+  public async handleTapProcess(childProcessArg: ChildProcess) {
+    const done = plugins.smartpromise.defer();
+    childProcessArg.stdout.on('data', (data) => {
+      this._processLog(data);
+    });
+    childProcessArg.stderr.on('data', (data) => {
+      this._processLog(data);
+    });
+    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'
+        )}`
+      );
+    }
+  }
+}

package/ts/tstest.classes.tap.testresult.ts

@@ -0,0 +1,26 @@
+// ============
+// combines different tap test files to an overall result
+// ============
+import * as plugins from './tstest.plugins.js';
+
+export class TapTestResult {
+  testLogBuffer = Buffer.from('');
+  testOk: boolean = false;
+  testSettled: boolean = false;
+  constructor(public id: number) {}
+
+  /**
+   * adds a logLine to the log buffer of the test
+   * @param logLine
+   */
+  addLogLine(logLine: string) {
+    logLine = logLine + '\n';
+    const logLineBuffer = Buffer.from(logLine);
+    this.testLogBuffer = Buffer.concat([this.testLogBuffer, logLineBuffer]);
+  }
+
+  setTestResult(testOkArg: boolean) {
+    this.testOk = testOkArg;
+    this.testSettled = true;
+  }
+}

package/ts/tstest.classes.testdirectory.ts

@@ -0,0 +1,57 @@
+import * as plugins from './tstest.plugins.js';
+import * as paths from './tstest.paths.js';
+import { Smartfile } from '@push.rocks/smartfile';
+
+// tap related stuff
+import { TapCombinator } from './tstest.classes.tap.combinator.js';
+import { TapParser } from './tstest.classes.tap.parser.js';
+import { TapTestResult } from './tstest.classes.tap.testresult.js';
+
+export class TestDirectory {
+  /**
+   * the current working directory
+   */
+  cwd: string;
+
+  /**
+   * the relative location of the test dir
+   */
+  relativePath: string;
+
+  /**
+   * the absolute path of the test dir
+   */
+  absolutePath: string;
+
+  /**
+   * an array of Smartfiles
+   */
+  testfileArray: Smartfile[] = [];
+
+  /**
+   * the constructor for TestDirectory
+   * tell it the path
+   * @param pathToTestDirectory
+   */
+  constructor(cwdArg: string, relativePathToTestDirectory: string) {
+    this.cwd = cwdArg;
+    this.relativePath = relativePathToTestDirectory;
+  }
+
+  private async _init() {
+    this.testfileArray = await plugins.smartfile.fs.fileTreeToObject(
+      plugins.path.join(this.cwd, this.relativePath),
+      'test*.ts'
+    );
+  }
+
+  async getTestFilePathArray() {
+    await this._init();
+    const testFilePaths: string[] = [];
+    for (const testFile of this.testfileArray) {
+      const filePath = plugins.path.join(this.relativePath, testFile.path);
+      testFilePaths.push(filePath);
+    }
+    return testFilePaths;
+  }
+}

package/ts/tstest.classes.tstest.ts

@@ -0,0 +1,227 @@
+import * as plugins from './tstest.plugins.js';
+import * as paths from './tstest.paths.js';
+import * as logPrefixes from './tstest.logprefixes.js';
+
+import { coloredString as cs } from '@push.rocks/consolecolor';
+
+import { TestDirectory } from './tstest.classes.testdirectory.js';
+import { TapCombinator } from './tstest.classes.tap.combinator.js';
+import { TapParser } from './tstest.classes.tap.parser.js';
+
+export class TsTest {
+  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);
+  }
+
+  async run() {
+    const fileNamesToRun: string[] = await this.testDir.getTestFilePathArray();
+    console.log(cs(plugins.figures.hamburger.repeat(80), 'cyan'));
+    console.log('');
+    console.log(`${logPrefixes.TsTestPrefix} FOUND ${fileNamesToRun.length} TESTFILE(S):`);
+    for (const fileName of fileNamesToRun) {
+      console.log(`${logPrefixes.TsTestPrefix} ${cs(fileName, 'orange')}`);
+    }
+    console.log('-'.repeat(48));
+    console.log(''); // force new line
+
+    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}, since we are CI and file name includes '.nonci.' tag`
+          );
+          console.log('!!!!!!!!!!!');
+          break;
+        case fileNameArg.endsWith('.browser.ts') || fileNameArg.endsWith('.browser.nonci.ts'):
+          const tapParserBrowser = await this.runInChrome(fileNameArg);
+          tapCombinator.addTapParser(tapParserBrowser);
+          break;
+        case fileNameArg.endsWith('.both.ts') || fileNameArg.endsWith('.both.nonci.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;
+      }
+
+      console.log(cs(`^`.repeat(16), 'cyan'));
+      console.log(''); // force new line
+    }
+    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.ensureEmptyDir(tsbundleCacheDirPath);
+    await this.tsbundleInstance.build(process.cwd(), fileNameArg, bundleFilePath, {
+      bundler: 'esbuild',
+    });
+
+    // lets create a server
+    const server = new plugins.typedserver.servertools.Server({
+      cors: true,
+      port: 3007,
+    });
+    server.addRoute(
+      '/test',
+      new plugins.typedserver.servertools.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.typedserver.servertools.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: string[] = [];
+
+          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() {}
+}

package/ts/tstest.logprefixes.ts

@@ -0,0 +1,7 @@
+import * as plugins from './tstest.plugins.js';
+import { coloredString as cs } from '@push.rocks/consolecolor';
+
+export const TapPrefix = cs(`::TAP::`, 'pink', 'black');
+export const TapErrorPrefix = cs(` !!!TAP PROTOCOL ERROR!!! `, 'red', 'black');
+
+export const TsTestPrefix = cs(`**TSTEST**`, 'pink', 'black');

package/ts/tstest.paths.ts

@@ -0,0 +1,5 @@
+import * as plugins from './tstest.plugins.js';
+
+export const cwd = process.cwd();
+export const testDir = plugins.path.join(cwd, './test/');
+export const binDirectory = plugins.path.join(cwd, './node_modules/.bin');

package/ts/tstest.plugins.ts

@@ -0,0 +1,42 @@
+// node native
+import * as path from 'path';
+
+export { path };
+
+// @apiglobal scope
+import * as typedserver from '@apiglobal/typedserver';
+
+export {
+  typedserver
+}
+
+// @push.rocks scope
+import * as consolecolor from '@push.rocks/consolecolor';
+import * as smartbrowser from '@push.rocks/smartbrowser';
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartlog from '@push.rocks/smartlog';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartshell from '@push.rocks/smartshell';
+import * as tapbundle from '@push.rocks/tapbundle';
+
+export {
+  consolecolor,
+  smartbrowser,
+  smartdelay,
+  smartfile,
+  smartlog,
+  smartpromise,
+  smartshell,
+  tapbundle,
+};
+
+// @gitzone scope
+import * as tsbundle from '@gitzone/tsbundle';
+
+export { tsbundle };
+
+// sindresorhus
+import figures from 'figures';
+
+export { figures };