5.2.2

changelog.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## 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.
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/tapbundle",
   "private": false,
-  "version": "5.0.25",
+  "version": "5.2.2",
   "description": "A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.",
   "exports": {
     ".": "./dist_ts/index.js",
@@ -26,6 +26,8 @@
   "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.2.1",

pnpm-lock.yaml

@@ -14,6 +14,12 @@ importers:
       '@push.rocks/consolecolor':
         specifier: ^2.0.2
         version: 2.0.2
+      '@push.rocks/qenv':
+        specifier: ^6.0.5
+        version: 6.0.5
+      '@push.rocks/smartcrypto':
+        specifier: ^2.0.4
+        version: 2.0.4
       '@push.rocks/smartdelay':
         specifier: ^3.0.5
         version: 3.0.5
@@ -88,6 +94,9 @@ packages:
   '@cloudflare/workers-types@4.20240909.0':
     resolution: {integrity: sha512-4knwtX6efxIsIxawdmPyynU9+S8A78wntU8eUIEldStWP4gNgxGkeWcfCMXulTx8oxr3DU4aevHyld9HGV8VKQ==}
 
+  '@configvault.io/interfaces@1.0.17':
+    resolution: {integrity: sha512-bEcCUR2VBDJsTin8HQh8Uw/mlYl2v8A3jMIaQ+MTB9Hrqd6CZL2dL7iJdWyFl/3EIX+LDxWFR+Oq7liIq7w+1Q==}
+
   '@cspotcode/source-map-support@0.8.1':
     resolution: {integrity: sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==}
     engines: {node: '>=12'}
@@ -346,6 +355,9 @@ packages:
   '@push.rocks/lik@6.0.15':
     resolution: {integrity: sha512-rZxln6l4NAU931MTxnsjy1pue+S3AXtDCidHH/tbkqBtrWIzWuXduo6Nz3zYkndbD64Knyta7F60JRvcOe4XqA==}
 
+  '@push.rocks/qenv@6.0.5':
+    resolution: {integrity: sha512-Id/eSKKqSDUGe+0Cp5HEJ58J1iVv1jQseLUMs9kFTPYwG+NJSETUCRsJV50w5cPv8bRFcSkSU+xVbUbOc1p29A==}
+
   '@push.rocks/smartbrowser@2.0.6':
     resolution: {integrity: sha512-Ne+KCVhV/DROc1rHRRw59K6h0+LpQAK9fdOUtgDZ7laLPmB/tmnbUh3IuRDNcIY1iVA9pydoobwjnTjVgio9eQ==}
 
@@ -361,6 +373,9 @@ packages:
   '@push.rocks/smartcli@4.0.11':
     resolution: {integrity: sha512-KDWfUqWBoUZsOEtsDx36d6qc8GG7Zo5E+HHamYY68KVDO8BMu6jbBucoUUPDksczLEmbXKLmroBP1mn/xozQOA==}
 
+  '@push.rocks/smartcrypto@2.0.4':
+    resolution: {integrity: sha512-1+/5bsjyataf5uUkUNnnVXGRAt+gHVk1KDzozjTqgqJxHvQk1d9fVDohL6CxUhUucTPtu5VR5xNBiV8YCDuGyw==}
+
   '@push.rocks/smartdelay@3.0.5':
     resolution: {integrity: sha512-mUuI7kj2f7ztjpic96FvRIlf2RsKBa5arw81AHNsndbxO6asRcxuWL8dTVxouEIK8YsBUlj0AsrCkHhMbLQdHw==}
 
@@ -754,6 +769,9 @@ packages:
   '@types/ms@0.7.34':
     resolution: {integrity: sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==}
 
+  '@types/node-forge@1.3.11':
+    resolution: {integrity: sha512-FQx220y22OKNTqaByeBGqHWYz4cl94tpcxeFdvBo3wjG6XPBuZ0BNgNZRV5J5TFmmcsJ4IzsLkmGRiQbnYsBEQ==}
+
   '@types/node@22.5.5':
     resolution: {integrity: sha512-Xjs4y5UPO/CLdzpgR6GirZJx36yScjh73+2NlLlkFRSoQN8B0DpfXPdZGnvVmLRLOsqDpOfTNv7D9trgGhmOIA==}
 
@@ -2186,6 +2204,10 @@ packages:
       encoding:
         optional: true
 
+  node-forge@1.3.1:
+    resolution: {integrity: sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==}
+    engines: {node: '>= 6.13.0'}
+
   normalize-newline@4.1.0:
     resolution: {integrity: sha512-ff4jKqMI8Xl50/4Mms/9jPobzAV/UK+kXG2XJ/7AqOmxIx8mqfqTIHYxuAnEgJ2AQeBbLnlbmZ5+38Y9A0w/YA==}
     engines: {node: '>=12'}
@@ -3104,6 +3126,10 @@ snapshots:
 
   '@cloudflare/workers-types@4.20240909.0': {}
 
+  '@configvault.io/interfaces@1.0.17':
+    dependencies:
+      '@api.global/typedrequest-interfaces': 3.0.19
+
   '@cspotcode/source-map-support@0.8.1':
     dependencies:
       '@jridgewell/trace-mapping': 0.3.9
@@ -3409,6 +3435,14 @@ snapshots:
       '@types/symbol-tree': 3.2.5
       symbol-tree: 3.2.4
 
+  '@push.rocks/qenv@6.0.5':
+    dependencies:
+      '@api.global/typedrequest': 3.0.32
+      '@configvault.io/interfaces': 1.0.17
+      '@push.rocks/smartfile': 11.0.21
+      '@push.rocks/smartlog': 3.0.7
+      '@push.rocks/smartpath': 5.0.18
+
   '@push.rocks/smartbrowser@2.0.6':
     dependencies:
       '@push.rocks/smartdelay': 3.0.5
@@ -3449,6 +3483,12 @@ snapshots:
       '@push.rocks/smartrx': 3.0.7
       yargs-parser: 21.1.1
 
+  '@push.rocks/smartcrypto@2.0.4':
+    dependencies:
+      '@push.rocks/smartpromise': 4.0.4
+      '@types/node-forge': 1.3.11
+      node-forge: 1.3.1
+
   '@push.rocks/smartdelay@3.0.5':
     dependencies:
       '@push.rocks/smartpromise': 4.0.4
@@ -4124,6 +4164,10 @@ snapshots:
 
   '@types/ms@0.7.34': {}
 
+  '@types/node-forge@1.3.11':
+    dependencies:
+      '@types/node': 22.5.5
+
   '@types/node@22.5.5':
     dependencies:
       undici-types: 6.19.8
@@ -5868,6 +5912,8 @@ snapshots:
     dependencies:
       whatwg-url: 5.0.0
 
+  node-forge@1.3.1: {}
+
   normalize-newline@4.1.0:
     dependencies:
       replace-buffer: 1.2.1

test/test.node.ts

@@ -7,4 +7,12 @@ tap.test('should execure a command', async () => {
   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.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/tapbundle',
-  version: '5.0.25',
+  version: '5.2.2',
   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,67 @@
+import * as plugins from './plugins.js';
+
+class TapNodeTools {
+  private smartshellInstance: plugins.smartshell.Smartshell;
+
+  constructor() {}
+
+  public async getQenv(): Promise<plugins.qenv.Qenv> {
+    return new plugins.qenv.Qenv('./', '.nogit/');
+  }
+
+  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,
+    };
+  }
+}
+
+export const tapNodeTools = new TapNodeTools();

ts_node/index.ts

@@ -1,21 +1 @@
-import * as plugins from './plugins.js';
-
-class TapNodeTools {
-  
-  private smartshellInstance: plugins.smartshell.Smartshell;
-  constructor() {
-
-  }
-
-  public async runCommand(commandArg) {
-    if (!this.smartshellInstance) {
-      this.smartshellInstance = new plugins.smartshell.Smartshell({
-        executor: 'bash',
-      });
-    }
-    const result = await this.smartshellInstance.exec(commandArg);
-    return result;
-  }
-}
-
-export const tapNodeTools = new TapNodeTools();
+export * from './classes.tapnodetools.js';

ts_node/plugins.ts

@@ -1,3 +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 { smartshell };
+export { qenv, smartcrypto, smartshell };