5.4.0

.gitea/workflows/default_tags.yaml

@@ -119,6 +119,6 @@ jobs:
         run: |
           npmci node install stable
           npmci npm install
-          pnpm install -g @gitzone/tsdoc
+          pnpm install -g @git.zone/tsdoc
           npmci command tsdoc
         continue-on-error: true

changelog.md

@@ -1,5 +1,75 @@
 # Changelog
 
+## 2024-11-06 - 5.4.0 - feat(node)
+Add smartmongo and smarts3 integration in node tools
+
+- Added createSmartmongo method to TapNodeTools for creating SmartMongo instances.
+- Added createSmarts3 method to TapNodeTools for creating Smarts3 instances.
+- Updated dependencies with smartmongo and smarts3 in package.json.
+
+## 2024-09-19 - 5.3.0 - feat(TapNodeTools)
+Add getEnvVarOnDemand method to TapNodeTools
+
+- Introduced a new method getEnvVarOnDemand to the TapNodeTools class to fetch environment variables on demand.
+- Enhanced getQenv function in TapNodeTools class to cache the Qenv instance for better performance.
+
+## 2024-09-19 - 5.2.2 - fix(core)
+Ensure reliability in test setup and execution
+
+- Added new pre-task functionality to log starting of tasks.
+- Enhanced `runCommand` method to better handle shell command execution.
+- Fixed issue in `createHttpsCert` to correctly generate self-signed certificates.
+
+## 2024-09-19 - 5.2.1 - fix(tapbundle)
+Add qenv package to dependencies for environment management
+
+- Added @push.rocks/qenv to dependencies in package.json.
+- Updated TapNodeTools class in ts_node/classes.tapnodetools.ts to include getQenv method.
+- Imported qenv in ts_node/plugins.ts.
+
+## 2024-09-18 - 5.2.0 - feat(TapNodeTools)
+Add ability to create HTTPS certificates with self-signed option
+
+- Introduced a new parameter `allowSelfSigned` to the `createHttpsCert` function.
+
+## 2024-09-18 - 5.1.4 - fix(ts_node)
+Fixed issues in HTTPS certificate generation for TapNodeTools
+
+- Updated 'createHttpsCert' method in 'TapNodeTools' to use 'smartcrypto' for generating RSA key pair and self-signed certificate.
+- Corrected certificate and private key PEM encoding.
+
+## 2024-09-18 - 5.1.3 - fix(ts_node/classes.tapnodetools.ts)
+Refactored methods and improved type annotations in TapNodeTools class.
+
+- Refactored `runCommand` method to include proper type annotations.
+- Enhanced `createHttpsCert` method with proper type annotations and key generation logic.
+- Introduced `generateSelfSignedCert` method for better code organization and readability.
+
+## 2024-09-18 - 5.1.2 - fix(TapNodeTools)
+Default parameter added to createHttpsCert method
+
+- Updated createHttpsCert method to provide a default value for the parameter commonName.
+
+## 2024-09-18 - 5.1.1 - fix(ts_node)
+Fixed createHttpsCert interface
+
+- Removed unnecessary keyFile and certFile parameters from createHttpsCert method.
+
+## 2024-09-18 - 5.1.0 - feat(ts_node)
+Add support for HTTPS certificate creation
+
+- Added TapNodeTools class with methods to run commands and create HTTPS certificates
+- Exported necessary plugins including crypto and fs for node
+- Updated test cases to include tests for HTTPS certificate creation
+
+## 2024-09-17 - 5.0.25 - fix(core)
+Fix typos in package.json, update dependencies and update workflow.
+
+- Fixed references to deprecated package names in workflows and package.json.
+- Updated versions of @push.rocks dependencies to latest stable.
+- Corrected scripts in package.json to reflect new build and documentation commands.
+- Fixed async startup in browser tests.
+
 ## 2024-08-17 - 5.0.24 - fix(dependencies)
 Update dependencies
 
@@ -119,7 +189,7 @@ Multiple core fixes and updates without specific feature changes
 - fix(dependencies): update
 
 ## 2018-08-08 - 3.0.3 - Dependency Update
-- fix(dependencies): use @gitzone/tsbuild instead of npmts
+- fix(dependencies): use @git.zone/tsbuild instead of npmts
 
 ## 2018-07-18 - 3.0.2 - Dependency Update
 - fix(dependencies): now typings-global free

package.json

@@ -1,14 +1,16 @@
 {
   "name": "@push.rocks/tapbundle",
   "private": false,
-  "version": "5.0.24",
+  "version": "5.4.0",
   "description": "A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.",
-  "main": "dist_ts/index.js",
-  "typings": "dist_ts/index.d.ts",
+  "exports": {
+    ".": "./dist_ts/index.js",
+    "./node": "./dist_ts_node/index.js"
+  },
   "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web --allowimplicitany --skiplibcheck)",
+    "build": "(tsbuild tsfolders --web --allowimplicitany --skiplibcheck)",
     "buildDocs": "tsdoc"
   },
   "repository": {
@@ -24,18 +26,23 @@
   "dependencies": {
     "@open-wc/testing": "^4.0.0",
     "@push.rocks/consolecolor": "^2.0.2",
+    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/smartcrypto": "^2.0.4",
     "@push.rocks/smartdelay": "^3.0.5",
     "@push.rocks/smartenv": "^5.0.12",
-    "@push.rocks/smartexpect": "^1.1.0",
+    "@push.rocks/smartexpect": "^1.2.1",
     "@push.rocks/smartjson": "^5.0.20",
+    "@push.rocks/smartmongo": "^2.0.10",
     "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smarts3": "^2.2.1",
+    "@push.rocks/smartshell": "^3.0.6",
     "@push.rocks/smarttime": "^4.0.8"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.43",
-    "@gitzone/tstest": "^1.0.77",
-    "@types/node": "^22.4.0",
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.43",
+    "@git.zone/tstest": "^1.0.77",
+    "@types/node": "^22.5.5",
     "randomstring": "^1.3.0"
   },
   "files": [

test/test.browser.nonci.ts

@@ -45,4 +45,4 @@ const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async (to
   await tools.delayFor(100);
 });
 
-tap.start();
+await tap.start();

test/test.node.ts

@@ -0,0 +1,28 @@
+import { tap, expect } from '../ts/index.js';
+
+import { tapNodeTools } from '../ts_node/index.js';
+
+tap.test('should execure a command', async () => {
+  const result = await tapNodeTools.runCommand('ls -la');
+  expect(result.exitCode).toEqual(0);
+});
+
+tap.test('should create a https cert', async () => {
+  const { key, cert } = await tapNodeTools.createHttpsCert('localhost');
+  console.log(key);
+  console.log(cert);
+  expect(key).toInclude('-----BEGIN RSA PRIVATE KEY-----');
+  expect(cert).toInclude('-----BEGIN CERTIFICATE-----');
+});
+
+tap.test('should create a smartmongo instance', async () => {
+  const smartmongo = await tapNodeTools.createSmartmongo();
+  await smartmongo.stop();
+});
+
+tap.test('should create a smarts3 instance', async () => {
+  const smarts3 = await tapNodeTools.createSmarts3();
+  await smarts3.stop();
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/tapbundle',
-  version: '5.0.24',
+  version: '5.4.0',
   description: 'A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.'
 }

ts_node/classes.tapnodetools.ts

@@ -0,0 +1,95 @@
+import * as plugins from './plugins.js';
+
+class TapNodeTools {
+  private smartshellInstance: plugins.smartshell.Smartshell;
+
+  constructor() {}
+
+  private qenv: plugins.qenv.Qenv;
+  public async getQenv(): Promise<plugins.qenv.Qenv> {
+    this.qenv = this.qenv || new plugins.qenv.Qenv('./', '.nogit/');
+    return this.qenv;
+  }
+  public async getEnvVarOnDemand(envVarNameArg: string): Promise<string> {
+    const qenv = await this.getQenv();
+    return qenv.getEnvVarOnDemand(envVarNameArg);
+  }
+
+  public async runCommand(commandArg: string): Promise<any> {
+    if (!this.smartshellInstance) {
+      this.smartshellInstance = new plugins.smartshell.Smartshell({
+        executor: 'bash',
+      });
+    }
+    const result = await this.smartshellInstance.exec(commandArg);
+    return result;
+  }
+
+  public async createHttpsCert(
+    commonName: string = 'localhost',
+    allowSelfSigned: boolean = true
+  ): Promise<{ key: string; cert: string }> {
+    if (allowSelfSigned) {
+      // set node to allow self-signed certificates
+      process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+    }
+
+    // Generate a key pair
+    const keys = plugins.smartcrypto.nodeForge.pki.rsa.generateKeyPair(2048);
+
+    // Create a self-signed certificate
+    const cert = plugins.smartcrypto.nodeForge.pki.createCertificate();
+    cert.publicKey = keys.publicKey;
+    cert.serialNumber = '01';
+    cert.validity.notBefore = new Date();
+    cert.validity.notAfter = new Date();
+    cert.validity.notAfter.setFullYear(cert.validity.notBefore.getFullYear() + 1);
+
+    const attrs = [
+      { name: 'commonName', value: commonName },
+      { name: 'countryName', value: 'US' },
+      { shortName: 'ST', value: 'California' },
+      { name: 'localityName', value: 'San Francisco' },
+      { name: 'organizationName', value: 'My Company' },
+      { shortName: 'OU', value: 'Dev' },
+    ];
+    cert.setSubject(attrs);
+    cert.setIssuer(attrs);
+
+    // Sign the certificate with its own private key (self-signed)
+    cert.sign(keys.privateKey, plugins.smartcrypto.nodeForge.md.sha256.create());
+
+    // PEM encode the private key and certificate
+    const pemKey = plugins.smartcrypto.nodeForge.pki.privateKeyToPem(keys.privateKey);
+    const pemCert = plugins.smartcrypto.nodeForge.pki.certificateToPem(cert);
+
+    return {
+      key: pemKey,
+      cert: pemCert,
+    };
+  }
+
+  /**
+   * create and return a smartmongo instance
+   */
+  public async createSmartmongo() { 
+    const smartmongoMod = await import('@push.rocks/smartmongo');
+    const smartmongoInstance = new smartmongoMod.SmartMongo();
+    await smartmongoInstance.start();
+    return smartmongoInstance;
+  }
+
+  /**
+   * create and return a smarts3 instance
+   */
+  public async createSmarts3() {
+    const smarts3Mod = await import('@push.rocks/smarts3');
+    const smarts3Instance = new smarts3Mod.Smarts3({
+      cleanSlate: true,
+    });
+    await smarts3Instance.start();
+    return smarts3Instance;
+  }
+}
+
+export const tapNodeTools = new TapNodeTools();

ts_node/index.ts

@@ -0,0 +1 @@
+export * from './classes.tapnodetools.js';

ts_node/plugins.ts

@@ -0,0 +1,12 @@
+// node native
+import * as crypto from 'crypto';
+import * as fs from 'fs';
+
+export { crypto,fs };
+
+// @push.rocks scope
+import * as qenv from '@push.rocks/qenv';
+import * as smartcrypto from '@push.rocks/smartcrypto';
+import * as smartshell from '@push.rocks/smartshell';
+
+export { qenv, smartcrypto, smartshell };