testeranto 0.129.0 → 0.134.0

package/README.md

@@ -1,6 +1,6 @@
 # testeranto
 
-## the AI powered BDD test framework for typescript projects
+## The AI-powered BDD test framework for TypeScript projects
 
 🚧 WARNING: Testeranto is still under development and is not ready for production yet. 🚧
 
@@ -12,11 +12,7 @@ npm: [npmjs.com/package/testeranto](https://www.npmjs.com/package/testeranto)
 
 dev: [github.dev/adamwong246/testeranto](https://github.dev/adamwong246/testeranto)
 
-example test report: [chromapdx.github.io/kokomoBay](https://chromapdx.github.io/kokomoBay/testeranto/index.html)
-
-example repo: [kokomo bay](https://github.com/ChromaPDX/kokomoBay)
-
-example repo V2: [testeranto-starter](https://github.com/adamwong246/testeranto-starter)
+example repo: [testeranto-starter](https://github.com/adamwong246/testeranto-starter)
 
 ## What is testeranto?
 
@@ -27,28 +23,146 @@ example repo V2: [testeranto-starter](https://github.com/adamwong246/testeranto-
 - Testeranto connects "features" to "tests". This allows the AI to read feature documentation from external systems, like Jira.
 - Testeranto generates test results into static a website which can be deployed to github pages easily.
 
-## tech of note
+## Key Technologies
+
+Testeranto builds on modern JavaScript/TypeScript tooling:
+
+| Technology | Purpose                                |
+| ---------- | -------------------------------------- |
+| TypeScript | Strongly-typed test definitions        |
+| Puppeteer  | Cross-runtime testing (Node & Browser) |
+| esbuild    | Fast test bundling                     |
+| Aider.ai   | AI-powered test fixing                 |
+| ESLint     | Static analysis of test files          |
+| tsc        | Type checking of test files            |
+| Markdown   | Feature documentation format           |
+
+## Quick Start
+
+1. Install testeranto:
+
+```bash
+npm install testeranto
+```
+
+2. Create a test file (e.g., `rectangle.test.ts`):
+
+```typescript
+import { Given, When, Then } from "testeranto";
+
+type Rectangle = { width: number; height: number };
+
+const RectangleSpec = (Suite, Given, When, Then) => [
+  Suite.Default("Rectangle tests", {
+    test1: Given.Default(
+      ["Basic rectangle operations"],
+      [When.setWidth(5), When.setHeight(10)],
+      [Then.getWidth(5), Then.getHeight(10)]
+    ),
+  }),
+];
+```
+
+3. Run your tests in two separate terminals:
+
+```bash
+# Terminal 1 - Build in watch mode
+yarn t-build rectangle.test.ts dev
+
+# Terminal 2 - Run in watch mode
+yarn t-run rectangle.test.ts dev
+```
+
+## Architecture Overview
+
+```mermaid
+flowchart TD
+    subgraph ThreePillars["Testeranto Core"]
+        Builder[Test Builder]
+        Runner[Test Runner]
+        Aider[AI Integration]
+    end
+
+    subgraph BuilderComponents[" "]
+        Specification[Specification]
+        Implementation[Implementation]
+        Interface[Interface]
+    end
+
+    subgraph Runtimes[" "]
+        Node[Node]
+        Web[Browser]
+        Pure[JS]
+    end
+
+    Builder --> Runner
+    Runner --> Aider
+    Aider --> Builder
+
+    Builder --> BuilderComponents
+    Runner --> Runtimes
+
+    style ThreePillars fill:none,stroke:#586e75
+    style Builder fill:#268bd2,stroke:#586e75,color:#fdf6e3
+    style Runner fill:#268bd2,stroke:#586e75,color:#fdf6e3
+    style Aider fill:#b58900,stroke:#586e75,color:#002b36
+    style BuilderComponents fill:#002b36,stroke:#586e75,color:#eee8d5
+    style Runtimes fill:#073642,stroke:#586e75,color:#eee8d5
+    style Specification fill:#2aa198,stroke:#586e75,color:#002b36
+    style Implementation fill:#2aa198,stroke:#586e75,color:#002b36
+    style Interface fill:#2aa198,stroke:#586e75,color:#002b36
+    style Node fill:#859900,stroke:#586e75,color:#002b36
+    style Web fill:#859900,stroke:#586e75,color:#002b36
+    style Pure fill:#859900,stroke:#586e75,color:#002b36
+```
+
+## Runtime Platforms
+
+Testeranto runs tests in multiple runtime environments, each suited for different testing scenarios:
 
-- esm - Testeranto uses modern js
-- typescript - tests are functions with type parameters
-- puppeteer - provides access to both node and chrome runtimes
-- esbuild - used to quickly generate test bundles
-- aider - AI to automatically fix broken tests
-- eslint - runs upon the input files to generate a file of static analysis errors
-- tsc - runs upon the input files to generate a file of type errors
-- markdown - Markdown is used record feature files
+| Runtime  | Description                                       | When To Use                                                            | Key Characteristics                                     |
+| -------- | ------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------- |
+| **Node** | Full IO access with Node.js built-in modules      | Testing backend code, Node APIs, or anything needing filesystem access | Runs in Node v8 via fork, has access to fs, crypto, etc |
+| **Web**  | DOM API access with browser capabilities          | Testing frontend code, UI interactions, or visual regression           | Runs in Chrome page, can take screenshots/recordings    |
+| **Pure** | Isolated JS runtime without external dependencies | Fast unit tests that don't need external resources                     | Dynamically imported into main thread, no IO access     |
 
-## scripts
+**Key Considerations:**
 
-`yarn t-init`: startup a new testeranto project
+- Use **Node** for testing backend services, file operations, or anything requiring Node.js APIs
+- Use **Web** when testing browser-specific code that references `document` or `window`
+- Use **Pure** for fast, isolated unit tests where you don't need console output or external resources
 
-`yarn t-build <someTest> <once|dev>`: build the "someTest" project once, or continuously
+## CLI Commands
 
-`yarn t-run <someTest> <once|dev>`: run the "someTest" project once, or continuously
+| Command                               | Description                                   |
+| ------------------------------------- | --------------------------------------------- |
+| `yarn t-init`                         | Create a new testeranto project               |
+| `yarn t-build <YOUR_TESTS> dev\|once` | Build test bundles (watch or single-run mode) |
+| `yarn t-run <YOUR_TESTS> dev\|once`   | Run tests (watch or single-run mode)          |
+| `yarn t-report`                       | Launch test report server                     |
+| `yarn t-aider`                        | Fix failing tests with AI                     |
 
-`yarn t-report` Run the report server
+Example workflow:
 
-`yarn t-aider PATH_TO_PROMPT_FILE`: Execute a generated prompt file to fix broken tests.
+```bash
+# Initialize project
+yarn t-init
+
+# Write tests in test/*.test.ts
+
+# In terminal 1 - Build tests (watch mode)
+yarn t-build test/rectangle.test.ts dev
+
+# In terminal 2 - Run tests (watch mode)
+yarn t-run test/rectangle.test.ts dev
+
+# Or for single-run mode:
+yarn t-build test/rectangle.test.ts once
+yarn t-run test/rectangle.test.ts once
+
+# Get AI help with failures
+yarn t-aider
+```
 
 ## AI
 
@@ -74,17 +188,202 @@ Testeranto generates a "prompt" alongside test results. This prompt is passed to
 
 Testeranto connects "features" to tests. The features may be simple strings, but they can also take the form of local markdown files, or remote URLs to external feature tracking systems. For instance, this could be a jira ticket or a github issue. These features are used to inform the AI context.
 
-## Platforms
+```ts
+import someMarkdownFile from "someMarkdownFile.md";
+
+...
+
+test0: Given.Default(
+  [
+    "https://api.github.com/repos/adamwong246/testeranto/issues/8",
+    "you can set the width and height of a Rectangle",
+    someMarkdownFile
+    ],
+
+  [When.setWidth(4), When.setHeight(19)],
+  [Then.getWidth(4), Then.getHeight(19)]
+),
+...
+
+```
+
+## Core Concepts
+
+Testeranto's type system provides a rigorous framework for Behavior-Driven Development (BDD) testing. Let's break down the key components using a Rectangle class example.
+
+### 1. Test Subject
+
+First, define the class you want to test:
+
+```typescript
+class Rectangle {
+  constructor(public width: number, public height: number) {}
+
+  setWidth(w: number) {
+    this.width = w;
+  }
+  setHeight(h: number) {
+    this.height = h;
+  }
+  getArea() {
+    return this.width * this.height;
+  }
+}
+```
+
+### 2. Test Interface Types
+
+Testeranto uses a powerful type system to ensure your tests match your implementation:
+
+```typescript
+type IRectangle = Ibdd_in<
+  null, // No special initialization needed
+  null, // No special cleanup needed
+  Rectangle, // The test subject type
+  Rectangle, // State type between test steps
+  Rectangle, // Final state type
+  (n: number) => (r: Rectangle) => void, // When functions signature
+  (r: Rectangle) => number // Then functions signature
+>;
+```
+
+This type definition ensures:
+
+- Type safety throughout the test lifecycle
+- Clear separation of test phases (setup, execution, verification)
+- Proper function signatures for test steps
+
+### 3. Test Specification
+
+Define your BDD-style tests with full type checking:
+
+```typescript
+const RectangleSpec: ITestSpecification<IRectangle> = (
+  Suite,
+  Given,
+  When,
+  Then
+) => [
+  Suite.Default("Rectangle Operations", {
+    // Test case 1: Basic dimension setting
+    basicDimensions: Given.Default(
+      ["Validate basic rectangle operations"],
+      [When.setWidth(5), When.setHeight(10)], // Actions
+      [Then.getWidth(5), Then.getHeight(10)] // Assertions
+    ),
+
+    // Test case 2: Area calculation
+    areaCalculation: Given.Default(
+      ["Validate area calculation"],
+      [When.setWidth(3), When.setHeight(4)],
+      [(r) => r.getArea() === 12] // Custom assertion
+    ),
+  }),
+];
+```
+
+### Development Workflow
+
+```mermaid
+
+
+
+
+flowchart LR
+
+    subgraph hh["humans"]
+        direction LR
+        Human[🧑💻 ]
+    end
+
+    subgraph bb["AI"]
+        direction LR
+        Bot[🤖🧠 aider]
+    end
+
+
+    tests ---> L
+    subgraph tests
+        direction LR
+        A[Test Specification]
+        B[Test Interface]
+        C[Test Implementation]
+        K[application code]
+    end
+
+    subgraph buildSystem
+        direction TB
+        L["t-build"]
+        M[t-run]
+        L ---> M
+
+        M ---> N
+        M --->O
+        M --->P
+        N["BDD tests"]
+        O["Static analysis"]
+        P["Type checking"]
+
+        Q["reports"]
+        N ---> Q
+        O ---> Q
+        P ---> Q
+
+
+
+    end
+
+    Q ---> bb
+
+    buildSystem ---> bb
+    bb ---> tests
+    hh ---> tests
+
+
+
+
+
+
+    %% Styling
+    style Human fill:#268bd2,stroke:#586e75,color:#fdf6e3
+    style Bot fill:#d33682,stroke:#586e75,color:#fdf6e3
+
+    %% Layout tweaks
+    classDef column margin-right:20px
+
+```
+
+**Key Components:**
+
+1. **Specification** - BDD test definitions (Given/When/Then)
+2. **Implementation** - Concrete test logic and assertions
+3. **Interface** - Test lifecycle hooks (before/after each)
+
+**Rapid Development Loop:**
+
+1. `t-build` continuously type-checks and bundles tests
+2. `t-run` executes tests as they change
+3. Aider analyzes failures and suggests fixes
+4. Developer iterates based on feedback
+
+The workflow creates a tight feedback loop where:
+
+- Type errors are caught immediately during build
+- Test failures trigger AI-assisted fixes
+- Changes propagate instantly through the system
 
-Testeranto runs tests in multiple runtimes. You can run the same test (more or less) in multiple contexts, but depending on your test subject, not all may be applicable. For instance, if you are testing an http node server, you'll can't use the web runtime. If your code references `document` or `window`, you must use the web style. And if you wish to capture console.logs in a node context, you should use the `pure` runtime.
+2. **Autocomplete** - IDE support for test steps
+3. **Refactoring safety** - Changes to implementation trigger type errors in tests
+4. **Documentation** - Types serve as living documentation
 
-1. Node - the test is run in node v8 via fork.
-2. Web - the test is run in chrome, in a page.
-3. Pure - the test is dynamically imported into the main thread. It will not have access to IO (console.log, etc) but it is more performant.
+### The Testing Lifecycle
 
-## Concepts
+1. **Given** - Set up initial state
+2. **When** - Perform actions on the subject
+3. **Then** - Verify outcomes
+4. **Check** - Imperative-style validations (optional)
 
-Testeranto tests take some piece of javascript as input, and wraps it in testing apparatus, and then executes that test on the given platform. You must provide this apparatus in the following form:
+Each phase is type-checked against your interface definition, ensuring tests remain valid as your code evolves.
 
 ```js
 export default async <I extends IT, O extends OT, M>(
@@ -112,7 +411,7 @@ export default async <I extends IT, O extends OT, M>(
 
 Practically speaking, for each thing you test, you will need to implement 3 types and 4 objects.
 
-### type I
+#### type I
 
 this type describes the shape of the BDD test
 
@@ -128,7 +427,7 @@ export type I = Ibdd_in<
 >;
 ```
 
-### type O
+#### type O
 
 this type describes the shape of the "interface"
 
@@ -169,7 +468,7 @@ export type O = Ibdd_out<
 >;
 ```
 
-### type M (optional)
+#### type M (optional)
 
 this type describes the modifications to the shape of the "specification". It can be used to make your BDD tests DRYer but is not necessary
 
@@ -191,7 +490,7 @@ export type M = {
 };
 ```
 
-### the "specification" aka ITestSpecification<I, O>
+#### the "specification" aka ITestSpecification<I, O>
 
 The test specification is the BDD tests logic. The specification implements BDD directives "Given", "When", and Then"
 
@@ -229,7 +528,7 @@ export const RectangleTesterantoBaseTestSpecification: ITestSpecification<
 };
 ```
 
-### the "interface" aka testInterface: Partial<IWebTestInterface<I>>
+#### the "interface" aka testInterface: Partial<IWebTestInterface<I>>
 
 The test interface is code which is NOT BDD steps. The interface implements "before all", "after all", "before each", and "after each", all of which are optional. f
 
@@ -247,7 +546,7 @@ export const RectangleTesterantoBaseInterface: IPartialInterface<I> = {
 };
 ```
 
-## the "test resource requirement" aka ITTestResourceRequest (optional)
+#### the "test resource requirement" aka ITTestResourceRequest (optional)
 
 The test resource requirement describes things that the test needs to run, namely network ports. It is optional, but you should add this argument if your test needs to rely upon network ports
 

package/bundle.js

@@ -2,11 +2,17 @@ import * as esbuild from 'esbuild'
 
 await esbuild.build({
   outExtension: { '.js': '.mjs' },
-  entryPoints: ['src/build.ts', 'src/run.ts', 'src/init-docs.ts', 'src/ReportServer.ts', 'src/esbuildConfigs/eslint-formatter-testeranto.ts'],
+  entryPoints: [
+    'src/build.ts',
+    'src/run.ts',
+    'src/init-docs.ts',
+    'src/ReportServer.ts',
+    'src/esbuildConfigs/eslint-formatter-testeranto.ts',
+    'src/mothership/index.ts'
+  ],
   bundle: true,
   format: "esm",
   platform: "node",
-  // outfile: 'dist/prebuild/cli.mjs'
   outdir: 'dist/prebuild',
   packages: "external",
   supported: {
@@ -18,79 +24,6 @@ await esbuild.build({
   },
 })
 
-// await esbuild.build({
-//   entryPoints: ['src/init-docs.ts'],
-//   bundle: true,
-//   format: "esm",
-//   platform: "node",
-//   // format: "node",
-//   outfile: 'dist/prebuild/init-docs.mjs',
-//   // external: ['crypto', 'os'],
-//   supported: {
-//     "dynamic-import": true,
-//   },
-
-//   banner: {
-//     js: `import { createRequire } from 'module';const require = createRequire(import.meta.url);`,
-//   },
-// })
-
-
-
-// await esbuild.build({
-//   entryPoints: ['src/cli2.ts'],
-//   bundle: true,
-//   format: "esm",
-//   platform: "node",
-//   outfile: 'dist/prebuild/cli2.mjs',
-//   packages: "external",
-//   supported: {
-//     "dynamic-import": true,
-//   },
-
-//   banner: {
-//     js: `import { createRequire } from 'module';const require = createRequire(import.meta.url);`,
-//   },
-// })
-
-
-
-
-// await esbuild.build({
-//   entryPoints: ['src/ReportServer.ts'],
-//   bundle: true,
-//   format: "esm",
-//   platform: "node",
-//   outfile: 'dist/prebuild/ReportServer.mjs',
-//   packages: "external",
-//   // supported: {
-//   //   "dynamic-import": true,
-//   // },
-
-//   // banner: {
-//   //   js: `import { createRequire } from 'module';const require = createRequire(import.meta.url);`,
-//   // },
-// })
-
-// await esbuild.build({
-//   entryPoints: ['src/esbuildConfigs/eslint-formatter-testeranto.ts'],
-//   bundle: true,
-//   format: "esm",
-//   platform: "node",
-//   outfile: 'dist/prebuild/eslint-formatter-testeranto.mjs',
-//   packages: "external",
-//   // supported: {
-//   //   "dynamic-import": true,
-//   // },
-
-//   // banner: {
-//   //   js: `import { createRequire } from 'module';const require = createRequire(import.meta.url);`,
-//   // },
-// })
-
-
-/////////////////////////
-
 await esbuild.build({
   entryPoints: ['src/ReportClient.tsx', 'src/TestReport.tsx', 'src/Project.tsx'],
   bundle: true,

package/dist/common/src/Init.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
 const fs_1 = __importDefault(require("fs"));
 exports.default = async () => {
     [
@@ -14,6 +15,7 @@ exports.default = async () => {
         `testeranto/reports`,
         `testeranto/reports/`,
         `testeranto/features/`,
+        `testeranto/externalTests/`,
     ].forEach((f) => {
         try {
             fs_1.default.mkdirSync(`${process.cwd()}/${f}`);
@@ -25,7 +27,10 @@ exports.default = async () => {
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/Project.js`, `testeranto/Project.js`);
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/ReportClient.js`, `testeranto/ReportClient.js`);
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/Project.css`, `testeranto/Project.css`);
-    fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/ReportClient.css`, `testeranto/ReportClient.css`);
+    // fs.copyFileSync(
+    //   `node_modules/testeranto/dist/prebuild/ReportClient.css`,
+    //   `testeranto/ReportClient.css`
+    // );
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/TestReport.js`, `testeranto/TestReport.js`);
     fs_1.default.copyFileSync(`node_modules/testeranto/dist/prebuild/TestReport.css`, `testeranto/TestReport.css`);
 };

package/dist/common/src/Node.js

@@ -7,6 +7,7 @@ exports.NodeTesteranto = void 0;
 const core_js_1 = __importDefault(require("./lib/core.js"));
 const index_js_1 = require("./lib/index.js");
 const node_js_1 = require("./PM/node.js");
+let ipcfile;
 class NodeTesteranto extends core_js_1.default {
     constructor(input, testSpecification, testImplementation, testResourceRequirement, testInterface) {
         super(input, testSpecification, testImplementation, testResourceRequirement, testInterface, () => {
@@ -15,7 +16,7 @@ class NodeTesteranto extends core_js_1.default {
     }
     async receiveTestResourceConfig(partialTestResource) {
         const t = JSON.parse(partialTestResource);
-        const pm = new node_js_1.PM_Node(t);
+        const pm = new node_js_1.PM_Node(t, ipcfile);
         return await this.testJobs[0].receiveTestResourceConfig(pm);
         // const { failed, artifacts, logPromise, features } =
         //   await this.testJobs[0].receiveTestResourceConfig(pm);
@@ -29,15 +30,16 @@ const testeranto = async (input, testSpecification, testImplementation, testInte
     process.on("unhandledRejection", (reason, promise) => {
         console.error("Unhandled Rejection at:", promise, "reason:", reason);
         // Optionally, terminate the process or perform cleanup
+        // t.registerUncaughtPromise(reason, promise);
     });
     try {
-        console.log(process.argv);
+        ipcfile = process.argv[3];
         const f = await t.receiveTestResourceConfig(process.argv[2]);
-        console.error("goodbye node error", f.fails);
+        console.error("goodbye node with failures", f.fails);
         process.exit(f.fails);
     }
     catch (e) {
-        console.error("goodbye node error", e);
+        console.error("goodbye node with caught error", e);
         process.exit(-1);
         // fs.writeFileSync(`tests.json`, JSON.stringify(t.,
         //  null, 2));

package/dist/common/src/NodeSidecar.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeSidecar = void 0;
+const Sidecar_1 = require("./lib/Sidecar");
+const nodeSidecar_1 = require("./PM/nodeSidecar");
+class NodeSidecar extends Sidecar_1.Sidecar {
+    constructor(t) {
+        super();
+        this.pm = new nodeSidecar_1.PM_Node_Sidecar(t);
+        this.pm.start(this.stop).then(() => {
+            this.start(JSON.parse(process.argv[2]));
+        });
+    }
+}
+exports.NodeSidecar = NodeSidecar;