@memberjunction/testing-cli 5.36.0 → 5.38.0

package/dist/utils/oracle-module-loader.js

@@ -0,0 +1,135 @@
+/**
+ * @fileoverview Custom-oracle plugin loader for `--oracles-module=path/to/module.cjs`.
+ * @module @memberjunction/testing-cli
+ *
+ * Lets non-MJ users plug app-specific oracles into the regression suite without
+ * modifying TestingFramework itself. The module path is resolved relative to the
+ * caller's cwd, dynamically imported (Node resolves CJS + ESM automatically),
+ * and every exported `IOracle` is registered on the engine.
+ */
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { existsSync } from 'node:fs';
+/**
+ * Duck-type check: an `IOracle` has a string `type` and an async `evaluate`
+ * function. We don't `instanceof` against a class because the user's module
+ * may import its own copy of the interface (different package version, etc.).
+ */
+function isOracleInstance(value) {
+    if (!value || typeof value !== 'object')
+        return false;
+    const candidate = value;
+    return (typeof candidate.type === 'string' &&
+        candidate.type.length > 0 &&
+        typeof candidate.evaluate === 'function');
+}
+/**
+ * Heuristic class-vs-instance check. Classes are functions whose prototype
+ * defines `evaluate`. We instantiate them with no args — Oracle implementations
+ * shouldn't need constructor arguments since their config flows through `evaluate()`.
+ */
+function isOracleClass(value) {
+    if (typeof value !== 'function')
+        return false;
+    const proto = value.prototype;
+    if (!proto)
+        return false;
+    return typeof proto.evaluate === 'function';
+}
+/**
+ * Load a user-supplied oracle module and register every `IOracle` export
+ * onto the provided TestEngine instance. Returns a summary so the caller
+ * can log what happened.
+ *
+ * Exports recognized:
+ *   - A class implementing `IOracle` — instantiated with no args.
+ *   - An object instance with `{ type: string, evaluate: fn }` — used as-is.
+ *
+ * Anything else (constants, helper functions, unrelated exports) is silently
+ * skipped — callers like the CLI surface this as a warning, not an error.
+ *
+ * @throws if the module file doesn't exist or the import itself fails.
+ */
+export async function loadOraclesModule(modulePath, engine) {
+    const absPath = path.resolve(modulePath);
+    if (!existsSync(absPath)) {
+        throw new Error(`Oracle module not found: ${absPath}`);
+    }
+    // Dynamic import: this is plugin discovery from a path that's only known
+    // at runtime (per CLI flag). Static import isn't possible here. Node's
+    // ESM resolver handles both .cjs and .mjs/.js targets when given a
+    // file:// URL.
+    const fileUrl = pathToFileURL(absPath).href;
+    const mod = await import(fileUrl);
+    // Walk both the namespace exports (named exports + a synthetic `default`)
+    // and any CJS `module.exports = {...}` shape that landed under `.default`.
+    // Node's CJS interop exposes the same value at BOTH `mod.A` and
+    // `mod.default.A` for a `module.exports = { A }`, so dedupe by reference
+    // to avoid double-registering.
+    const seen = new Set();
+    const candidates = [];
+    const consider = (name, value) => {
+        if (value === undefined || value === null)
+            return;
+        if (seen.has(value))
+            return;
+        seen.add(value);
+        candidates.push([name, value]);
+    };
+    // Walk top-level names first so they win the dedupe "first seen" slot —
+    // those are the names the author actually wrote. Then walk into a CJS
+    // `module.exports = { … }` namespace if present (it lands under
+    // `mod.default` when imported via ESM `import()`). Skip the `default`
+    // key itself when it's the CJS wrapper so we don't surface it as a
+    // bogus "skipped" candidate.
+    const defaultExport = mod.default;
+    const defaultIsCjsNamespace = defaultExport &&
+        typeof defaultExport === 'object' &&
+        defaultExport !== null &&
+        !isOracleInstance(defaultExport) &&
+        !isOracleClass(defaultExport);
+    // CJS-interop synthetic keys Node exposes on imported CJS modules — these
+    // aren't real user exports and shouldn't show up in summary.skipped.
+    const CJS_NOISE_KEYS = new Set(['module.exports', '__esModule']);
+    for (const [name, value] of Object.entries(mod)) {
+        if (name === 'default' && defaultIsCjsNamespace)
+            continue;
+        if (CJS_NOISE_KEYS.has(name))
+            continue;
+        consider(name, value);
+    }
+    if (defaultIsCjsNamespace) {
+        for (const [name, value] of Object.entries(defaultExport)) {
+            consider(`default.${name}`, value);
+        }
+    }
+    const registered = [];
+    const skipped = [];
+    for (const [name, value] of candidates) {
+        let oracle;
+        if (isOracleInstance(value)) {
+            oracle = value;
+        }
+        else if (isOracleClass(value)) {
+            try {
+                oracle = new value();
+                if (!isOracleInstance(oracle)) {
+                    skipped.push(`${name} (instantiated but missing 'type' or 'evaluate')`);
+                    continue;
+                }
+            }
+            catch (err) {
+                skipped.push(`${name} (instantiation threw: ${err.message})`);
+                continue;
+            }
+        }
+        else {
+            skipped.push(name);
+            continue;
+        }
+        engine.RegisterOracle(oracle);
+        registered.push(oracle.type);
+    }
+    return { modulePath: absPath, registered, skipped };
+}
+//# sourceMappingURL=oracle-module-loader.js.map

package/dist/utils/oracle-module-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oracle-module-loader.js","sourceRoot":"","sources":["../../src/utils/oracle-module-loader.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAIrC;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,KAAc;IACpC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,MAAM,SAAS,GAAG,KAA+C,CAAC;IAClE,OAAO,CACH,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ;QAClC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QACzB,OAAO,SAAS,CAAC,QAAQ,KAAK,UAAU,CAC3C,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,KAAc;IACjC,IAAI,OAAO,KAAK,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAC9C,MAAM,KAAK,GAAI,KAAgE,CAAC,SAAS,CAAC;IAC1F,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,OAAO,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU,CAAC;AAChD,CAAC;AAWD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACnC,UAAkB,EAClB,MAAkB;IAElB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACzC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,yEAAyE;IACzE,uEAAuE;IACvE,mEAAmE;IACnE,eAAe;IACf,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;IAC5C,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;IAElC,0EAA0E;IAC1E,2EAA2E;IAC3E,gEAAgE;IAChE,yEAAyE;IACzE,+BAA+B;IAC/B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAW,CAAC;IAChC,MAAM,UAAU,GAA6B,EAAE,CAAC;IAEhD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE;QAC9C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO;QAClD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO;QAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChB,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,wEAAwE;IACxE,sEAAsE;IACtE,gEAAgE;IAChE,sEAAsE;IACtE,mEAAmE;IACnE,6BAA6B;IAC7B,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC;IAClC,MAAM,qBAAqB,GACvB,aAAa;QACb,OAAO,aAAa,KAAK,QAAQ;QACjC,aAAa,KAAK,IAAI;QACtB,CAAC,gBAAgB,CAAC,aAAa,CAAC;QAChC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAElC,0EAA0E;IAC1E,qEAAqE;IACrE,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC,CAAC;IAEjE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS,IAAI,qBAAqB;YAAE,SAAS;QAC1D,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,SAAS;QACvC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,IAAI,qBAAqB,EAAE,CAAC;QACxB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAwC,CAAC,EAAE,CAAC;YACnF,QAAQ,CAAC,WAAW,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;QACvC,CAAC;IACL,CAAC;IAED,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC;QACrC,IAAI,MAA2B,CAAC;QAEhC,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,GAAG,KAAK,CAAC;QACnB,CAAC;aAAM,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACD,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;gBACrB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5B,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,kDAAkD,CAAC,CAAC;oBACxE,SAAS;gBACb,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,0BAA2B,GAAa,CAAC,OAAO,GAAG,CAAC,CAAC;gBACzE,SAAS;YACb,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,SAAS;QACb,CAAC;QAED,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9B,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;AACxD,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@memberjunction/testing-cli",
   "type": "module",
-  "version": "5.36.0",
+  "version": "5.38.0",
   "description": "MemberJunction Testing Framework CLI - Command-line interface for test execution and management",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,12 +21,12 @@
     "@types/debug": "^4.1.12"
   },
   "dependencies": {
-    "@memberjunction/global": "5.36.0",
-    "@memberjunction/core": "5.36.0",
-    "@memberjunction/core-entities": "5.36.0",
-    "@memberjunction/testing-engine": "5.36.0",
-    "@memberjunction/testing-engine-base": "5.36.0",
-    "@memberjunction/sqlserver-dataprovider": "5.36.0",
+    "@memberjunction/global": "5.38.0",
+    "@memberjunction/core": "5.38.0",
+    "@memberjunction/core-entities": "5.38.0",
+    "@memberjunction/testing-engine": "5.38.0",
+    "@memberjunction/testing-engine-base": "5.38.0",
+    "@memberjunction/sqlserver-dataprovider": "5.38.0",
     "@oclif/core": "^3.27.0",
     "ora-classic": "^5.4.2",
     "chalk": "^5.6.2",