testeranto 0.100.0 → 0.111.0

package/src/lib/core.ts

@@ -1,13 +1,16 @@
 import { IStore } from "../SubPackages/react/jsx";
 import {
-  IBaseTest,
   ITestSpecification,
   ITestImplementation,
+  ITestInterface,
+  Ibdd_in,
+  Ibdd_out,
 } from "../Types.js";
+import { PM } from "../PM/index";
 
-import { IFinalResults, ITestInterface } from "./types.js";
 import {
   DefaultTestInterface,
+  IFinalResults,
   ITTestResourceRequest,
   ITestArtifactory,
   defaultTestResourceRequirement,
@@ -20,30 +23,31 @@ import {
   BaseCheck,
 } from "./abstractBase.js";
 import { ClassBuilder } from "./classBuilder.js";
-import { PM } from "../PM/index";
 
 export default abstract class Testeranto<
-  ITestShape extends IBaseTest<
-    unknown,
+  I extends Ibdd_in<
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
+    unknown
+  >,
+  O extends Ibdd_out<
     Record<string, any>,
     Record<string, any>,
     Record<string, any>,
     Record<string, any>,
     Record<string, any>
   >
-> extends ClassBuilder<ITestShape> {
+> extends ClassBuilder<I, O> {
   constructor(
-    input: ITestShape["iinput"],
-    testSpecification: ITestSpecification<ITestShape>,
-    testImplementation: ITestImplementation<ITestShape>,
+    input: I["iinput"],
+    testSpecification: ITestSpecification<I, O>,
+    testImplementation: ITestImplementation<I, O>,
     testResourceRequirement: ITTestResourceRequest = defaultTestResourceRequirement,
-    testInterface: Partial<ITestInterface<ITestShape>>,
+    testInterface: Partial<ITestInterface<I>>,
     uberCatcher: (cb) => void
   ) {
     const fullTestInterface = DefaultTestInterface(testInterface);
@@ -53,15 +57,15 @@ export default abstract class Testeranto<
       testSpecification,
       input,
 
-      class extends BaseSuite<ITestShape> {
+      class extends BaseSuite<I, O> {
         afterAll(store: IStore, artifactory: ITestArtifactory, pm: PM) {
           return fullTestInterface.afterAll(
             store,
-            (fPath: string, value: unknown) =>
-              // TODO does not work?
-              {
-                artifactory(`afterAll4-${this.name}/${fPath}`, value);
-              },
+            // (fPath: string, value: unknown) =>
+            //   // TODO does not work?
+            //   {
+            //     artifactory(`afterAll4-${this.name}/${fPath}`, value);
+            //   },
             pm
           );
         }
@@ -71,24 +75,29 @@ export default abstract class Testeranto<
         }
 
         async setup(
-          s: ITestShape["iinput"],
+          s: I["iinput"],
           artifactory: ITestArtifactory,
           tr,
           pm
-        ): Promise<ITestShape["isubject"]> {
+        ): Promise<I["isubject"]> {
           return (
             fullTestInterface.beforeAll ||
             (async (
-              input: ITestShape["iinput"],
+              input: I["iinput"],
               artifactory: ITestArtifactory,
               tr,
               pm: PM
             ) => input as any)
-          )(s, this.testResourceConfiguration, artifactory, pm);
+          )(
+            s,
+            this.testResourceConfiguration,
+            // artifactory,
+            pm
+          );
         }
       } as any,
 
-      class Given extends BaseGiven<ITestShape> {
+      class Given extends BaseGiven<I> {
         uberCatcher = uberCatcher;
 
         async givenThat(
@@ -102,7 +111,7 @@ export default abstract class Testeranto<
           return fullTestInterface.beforeEach(
             subject,
             initializer,
-            artifactory,
+            // artifactory,
             testResource,
             initialValues,
             pm
@@ -110,7 +119,7 @@ export default abstract class Testeranto<
         }
 
         afterEach(
-          store: ITestShape["istore"],
+          store: I["istore"],
           key: string,
           artifactory,
           pm
@@ -120,8 +129,8 @@ export default abstract class Testeranto<
               fullTestInterface.afterEach(
                 store,
                 key,
-                (fPath: string, value: unknown) =>
-                  artifactory(`after/${fPath}`, value),
+                // (fPath: string, value: unknown) =>
+                //   artifactory(`after/${fPath}`, value),
                 pm
               )
             )
@@ -129,7 +138,7 @@ export default abstract class Testeranto<
         }
       } as any,
 
-      class When extends BaseWhen<ITestShape> {
+      class When extends BaseWhen<I> {
         async andWhen(store, whenCB, testResource, pm) {
           try {
             return await fullTestInterface.andWhen(
@@ -158,13 +167,13 @@ export default abstract class Testeranto<
         }
       } as any,
 
-      class Then extends BaseThen<ITestShape> {
+      class Then extends BaseThen<I> {
         async butThen(
           store: any,
           thenCB,
           testResource: any,
           pm: PM
-        ): Promise<ITestShape["iselection"]> {
+        ): Promise<I["iselection"]> {
           return await fullTestInterface
             .butThen(store, thenCB, testResource, pm)
             .then(
@@ -198,7 +207,7 @@ export default abstract class Testeranto<
         }
       } as any,
 
-      class Check extends BaseCheck<ITestShape> {
+      class Check extends BaseCheck<I, O> {
         initialValues: any;
 
         constructor(
@@ -217,8 +226,8 @@ export default abstract class Testeranto<
           return fullTestInterface.beforeEach(
             subject,
             this.initialValues,
-            (fPath: string, value: unknown) =>
-              artifactory(`before/${fPath}`, value),
+            // (fPath: string, value: unknown) =>
+            //   artifactory(`before/${fPath}`, value),
             testResourceConfiguration,
             this.initialValues,
             pm
@@ -226,7 +235,7 @@ export default abstract class Testeranto<
         }
 
         afterEach(
-          store: ITestShape["istore"],
+          store: I["istore"],
           key: string,
           artifactory,
           pm
@@ -236,9 +245,9 @@ export default abstract class Testeranto<
               fullTestInterface.afterEach(
                 store,
                 key,
-                (fPath: string, value: unknown) =>
-                  // TODO does not work?
-                  artifactory(`afterEach2-${this.name}/${fPath}`, value),
+                // (fPath: string, value: unknown) =>
+                //   // TODO does not work?
+                //   artifactory(`afterEach2-${this.name}/${fPath}`, value),
                 pm
               )
             )

package/src/lib/index.ts

@@ -1,32 +1,11 @@
+import { IBaseTest } from "../../dist/types/src/Types.js";
 import { PM } from "../PM/index.js";
-import { IBaseTest } from "../Types.js";
+import { Ibdd_in, Ibdd_out, ITestInterface } from "../Types.js";
 
-import {
-  IGivens,
-  BaseCheck,
-  BaseSuite,
-  BaseWhen,
-  BaseThen,
-} from "./abstractBase.js";
-import { ITestInterface } from "./types.js";
-
-// import { INodeUtils, ITestInterface, IUtils, IWebUtils } from "./types.js";
+import { IGivens, BaseCheck, BaseSuite } from "./abstractBase.js";
 
 export const BaseTestInterface: ITestInterface<
-  IBaseTest<
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>
-  >
+  Ibdd_in<unknown, unknown, unknown, unknown, unknown, unknown, unknown>
 > = {
   beforeAll: async (s) => s,
   beforeEach: async function (
@@ -40,35 +19,25 @@ export const BaseTestInterface: ITestInterface<
   },
   afterEach: async (s) => s,
   afterAll: (
-    store: IBaseTest<
-      unknown,
+    store: Ibdd_in<
       unknown,
       unknown,
       unknown,
       unknown,
       unknown,
       unknown,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>
+      unknown
     >["istore"]
   ) => undefined,
   butThen: async (
-    store: IBaseTest<
-      unknown,
+    store: Ibdd_in<
       unknown,
       unknown,
       unknown,
       unknown,
       unknown,
       unknown,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>
+      unknown
     >["istore"],
     thenCb
   ) => thenCb(store),
@@ -120,30 +89,11 @@ type ITest = {
   toObj(): object;
   name: string;
   givens: IGivens<
-    IBaseTest<
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>,
-      Record<string, any>
-    >
+    Ibdd_in<unknown, unknown, unknown, unknown, unknown, unknown, unknown>
   >;
   checks: BaseCheck<
-    IBaseTest<
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      unknown,
-      unknown,
+    Ibdd_in<unknown, unknown, unknown, unknown, unknown, unknown, unknown>,
+    Ibdd_out<
       Record<string, any>,
       Record<string, any>,
       Record<string, any>,
@@ -162,14 +112,8 @@ export type ITestJob<T = PM> = {
     t: ITLog
   ) => Promise<
     BaseSuite<
-      IBaseTest<
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
+      Ibdd_in<unknown, unknown, unknown, unknown, unknown, unknown, unknown>,
+      Ibdd_out<
         Record<string, any>,
         Record<string, any>,
         Record<string, any>,
@@ -195,33 +139,38 @@ export const defaultTestResourceRequirement: ITTestResourceRequest = {
 
 export type ITestArtifactory = (key: string, value: unknown) => unknown;
 
-export type ITestCheckCallback<
-  ITestShape extends IBaseTest<
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    unknown,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>
-  >
-> = {
-  [K in keyof ITestShape["checks"]]: (
-    name: string,
-    features: string[],
-    callbackA: (
-      whens: {
-        [K in keyof ITestShape["whens"]]: (...unknown) => BaseWhen<ITestShape>;
-      },
-      thens: {
-        [K in keyof ITestShape["thens"]]: (...unknown) => BaseThen<ITestShape>;
-      }
-    ) => Promise<any>,
-    ...xtrasA: ITestShape["checks"][K]
-  ) => BaseCheck<ITestShape>;
+export type IRunnables = {
+  nodeEntryPoints: Record<string, string>;
+  webEntryPoints: Record<string, string>;
+};
+
+export type IFinalResults = { features: string[]; failed: number };
+
+export type IRunTime = `node` | `web`;
+
+export type ITestTypes = [string, IRunTime, { ports: number }, ITestTypes[]];
+
+export type IPluginFactory = (
+  register: (entrypoint, sources) => any,
+  entrypoints
+) => Plugin;
+
+export type IBaseConfig = {
+  src: string;
+  clearScreen: boolean;
+  debugger: boolean;
+  devMode: boolean;
+  externals: string[];
+  minify: boolean;
+  outbase: string;
+  outdir: string;
+  ports: string[];
+  tests: ITestTypes[];
+
+  nodePlugins: IPluginFactory[];
+  webPlugins: IPluginFactory[];
+
+  featureIngestor: (s: string) => Promise<string>;
 };
+
+export type IBuiltConfig = { buildDir: string } & IBaseConfig;

package/src/lib/readme.md

@@ -0,0 +1,12 @@
+# lib
+
+This folder represents testeranto internals.
+
+## layers
+
+Testeranto's core architecture is built in layers.
+
+0. abstractBase.ts - The lowest layer is composed of abstract BDD classes
+1. baseBuilder.ts - this layer extends the classes in `abstractBase` with the capacity to run and log tests.
+2. classBuilder.ts - this layer extends the classes in `baseBuilder` with the capacity to accept custom implementations of of abstract BDD classes in `abstractBase`
+3. core.ts - this layer extends the classes in `classBuilder` with the capacity to accept an input, a specification, a implementation a test resource requirement and an interface, and to map those entities to custom implementations of of abstract BDD classes in `abstractBase`.

package/src/lib/types.ts

@@ -1,6 +1,5 @@
-// import { IBaseTest } from "../Types";
+import { Ibdd_in, Ibdd_out } from "../Types";
 
-import type { Plugin } from "esbuild";
 import {
   IGivens,
   BaseCheck,
@@ -9,54 +8,51 @@ import {
   BaseWhen,
   BaseThen,
 } from "./abstractBase";
-import { IBaseTest } from "../Types";
 
-export type IFinalResults = { features: string[]; failed: number };
-
-export type IRunTime = `node` | `web`;
-
-export type ITestTypes = [string, IRunTime, { ports: number }, ITestTypes[]];
-
-export type IJsonConfig = {
-  outdir: string;
-  tests: ITestTypes[];
-  botEmail: string;
-};
-
-export type IPlugin = (
-  register: (entrypoint, sources) => any,
-  entrypoints
-) => Plugin;
-
-export type IBaseConfig = {
-  src: string;
-  clearScreen: boolean;
-  debugger: boolean;
-  devMode: boolean;
-  externals: string[];
-  minify: boolean;
-  outbase: string;
-  outdir: string;
-  ports: string[];
-  tests: ITestTypes[];
-
-  nodePlugins: IPlugin[];
-  webPlugins: IPlugin[];
-
-  featureIngestor: (s: string) => Promise<string>;
+export type ITestCheckCallback<
+  I extends Ibdd_in<
+    unknown,
+    unknown,
+    unknown,
+    unknown,
+    unknown,
+    unknown,
+    unknown
+  >,
+  O extends Ibdd_out<
+    Record<string, any>,
+    Record<string, any>,
+    Record<string, any>,
+    Record<string, any>,
+    Record<string, any>
+  >
+> = {
+  [K in keyof O["checks"]]: (
+    name: string,
+    features: string[],
+    callbackA: (
+      whens: {
+        [K in keyof O["whens"]]: (...unknown) => BaseWhen<I>;
+      },
+      thens: {
+        [K in keyof O["thens"]]: (...unknown) => BaseThen<I>;
+      }
+    ) => Promise<any>,
+    ...xtrasA: O["checks"][K]
+  ) => BaseCheck<I, O>;
 };
 
-export type IBuiltConfig = { buildDir: string } & IBaseConfig;
-
 export type ISuiteKlasser<
-  ITestShape extends IBaseTest<
-    unknown,
+  I extends Ibdd_in<
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
+    unknown
+  >,
+  O extends Ibdd_out<
     Record<string, any>,
     Record<string, any>,
     Record<string, any>,
@@ -66,74 +62,61 @@ export type ISuiteKlasser<
 > = (
   name: string,
   index: number,
-  givens: IGivens<ITestShape>,
-  checks: BaseCheck<ITestShape>[]
-) => BaseSuite<ITestShape>;
+  givens: IGivens<I>,
+  checks: BaseCheck<I, O>[]
+) => BaseSuite<I, O>;
 
 export type IGivenKlasser<
-  ITestShape extends IBaseTest<
-    unknown,
+  I extends Ibdd_in<
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>
+    unknown
   >
-> = (name, features, whens, thens, givenCB) => BaseGiven<ITestShape>;
+> = (name, features, whens, thens, givenCB) => BaseGiven<I>;
 
 export type IWhenKlasser<
-  ITestShape extends IBaseTest<
-    unknown,
+  I extends Ibdd_in<
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>
+    unknown
   >
-> = (s, o) => BaseWhen<ITestShape>;
+> = (s, o) => BaseWhen<I>;
 
 export type IThenKlasser<
-  ITestShape extends IBaseTest<
+  I extends Ibdd_in<
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
-    unknown,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>,
-    Record<string, any>
+    unknown
   >
-> = (s, o) => BaseThen<ITestShape>;
+> = (s, o) => BaseThen<I>;
 
 export type ICheckKlasser<
-  ITestShape extends IBaseTest<
-    unknown,
+  I extends Ibdd_in<
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
     unknown,
+    unknown
+  >,
+  O extends Ibdd_out<
     Record<string, any>,
     Record<string, any>,
     Record<string, any>,
     Record<string, any>,
     Record<string, any>
   >
-> = (n, f, cb, w, t) => BaseCheck<ITestShape>;
+> = (n, f, cb, w, t) => BaseCheck<I, O>;

package/src/run.ts

@@ -0,0 +1,31 @@
+import ansiC from "ansi-colors";
+import readline from "readline";
+
+import { PM_Main } from "./PM/main";
+import { IBaseConfig, IBuiltConfig } from "./lib";
+
+console.log(ansiC.inverse("Press 'x' to shutdown forcefully."));
+
+readline.emitKeypressEvents(process.stdin);
+if (process.stdin.isTTY) process.stdin.setRawMode(true);
+
+process.stdin.on("keypress", (str, key) => {
+  if (key.name === "x") {
+    console.log(ansiC.inverse("Shutting down forcefully..."));
+    process.exit(-1);
+  }
+});
+
+import(process.cwd() + "/" + process.argv[2]).then(async (module) => {
+  const rawConfig: IBaseConfig = module.default;
+
+  const config: IBuiltConfig = {
+    ...rawConfig,
+    buildDir: process.cwd() + "/" + rawConfig.outdir,
+  };
+
+  // let mode = config.devMode ? "DEV" : "PROD";
+  // const fileHashes = {};
+  let pm: PM_Main | undefined = new PM_Main(config);
+  pm.start();
+});

package/src/style.css

@@ -0,0 +1,8 @@
+footer {
+  background-color: lightgray;
+  margin: 0.5rem;
+  padding: 0.5rem;
+  position: fixed;
+  bottom: 0;
+  right: 0;
+}