@memberjunction/cli 5.37.0 → 5.38.0

package/dist/lib/regression/docker-helpers.js

@@ -0,0 +1,184 @@
+/**
+ * Shared helpers for `mj test regression *` subcommands.
+ *
+ * The CLI commands themselves are thin oclif wrappers — they just spawn
+ * `docker compose` / `bash` with the right flags. All the wiring (path
+ * resolution, profile selection, error reporting) lives here so the same
+ * conventions apply across every subcommand.
+ */
+import { spawn } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+export const REGRESSION_DIR = 'docker/regression';
+export const COMPOSE_FILE = `${REGRESSION_DIR}/docker-compose.test.yml`;
+export const BACPAC_OVERLAY = `${REGRESSION_DIR}/docker-compose.bacpac.yml`;
+export const STANDALONE_COMPOSE = `${REGRESSION_DIR}/docker-compose.standalone.yml`;
+export const BACPAC_STANDALONE_COMPOSE = `${REGRESSION_DIR}/docker-compose.bacpac-standalone.yml`;
+/**
+ * Package root of @memberjunction/cli (resolved from this compiled module at
+ * dist/lib/regression/docker-helpers.js → up 3). Used to locate compose assets
+ * bundled into the published package for external (no-monorepo) use.
+ */
+const PKG_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..', '..');
+/**
+ * Resolve a standalone compose file. Prefers the monorepo copy (cwd-relative
+ * `docker/regression/<name>`); falls back to the copy bundled into this CLI
+ * package at build time (`<pkg>/regression-compose/<name>`) so external users
+ * who only `npm i -g @memberjunction/cli` still have it. Returns the first path
+ * that exists, or the bundled path (so the caller can surface a clear error).
+ */
+export function resolveStandaloneCompose(monorepoRelPath) {
+    const monorepo = path.resolve(monorepoRelPath);
+    if (existsSync(monorepo))
+        return monorepo;
+    const bundled = path.join(PKG_ROOT, 'regression-compose', path.basename(monorepoRelPath));
+    return existsSync(bundled) ? bundled : monorepo;
+}
+export const ENV_FILE = `${REGRESSION_DIR}/.env.test`;
+export const TARGETS_DIR = `${REGRESSION_DIR}/targets`;
+export const LOAD_TARGET_SCRIPT = `${REGRESSION_DIR}/scripts/load-target-profile.cjs`;
+export const GEN_FORMS_SCRIPT = `${REGRESSION_DIR}/gen-forms.sh`;
+export const RESULTS_DIR = `${REGRESSION_DIR}/test-results`;
+export const INLINE_REPORT_SCRIPT = `${REGRESSION_DIR}/scripts/inline-report.cjs`;
+/**
+ * The pinned runner image tag used when `init` (and future external invocations)
+ * shell out to `docker run memberjunction/agentic-test-runner …`. Kept here so
+ * a single bump updates every CLI command that consumes the image. The
+ * version is pinned to the most recent release that includes Phase 8.
+ */
+export const AGENTIC_TEST_RUNNER_IMAGE = 'memberjunction/agentic-test-runner:latest';
+/**
+ * Verify the current working directory is the MJ monorepo root. If it isn't,
+ * print a helpful message and exit. Phase 4 still requires the user to be in
+ * the monorepo; Phase 8 will publish the docker image and lift this guard.
+ */
+export function requireMonorepoRoot() {
+    if (!existsSync(COMPOSE_FILE)) {
+        process.stderr.write(`✗ Expected to find ${COMPOSE_FILE} relative to the current directory.\n` +
+            `  'mj test regression *' commands must be run from the MemberJunction\n` +
+            `  monorepo root. (Phase 8 will lift this requirement by publishing the\n` +
+            `  test-runner image; for now, cd into the MJ repo first.)\n`);
+        process.exit(1);
+    }
+}
+/**
+ * Soft check — returns true when there's an MJ monorepo at-or-above cwd.
+ * Used by commands (compare, up, export, remote) to pick monorepo-relative
+ * paths over external/published-image paths. Unlike `requireMonorepoRoot()`,
+ * this does NOT exit on failure.
+ *
+ * The sentinel is the regression base compose file: it lives in every
+ * monorepo checkout and is never present in an external `npm i -g` install.
+ */
+export function isInsideMonorepo(startDir = process.cwd()) {
+    let dir = path.resolve(startDir);
+    const root = path.parse(dir).root;
+    while (dir !== root) {
+        if (existsSync(path.join(dir, COMPOSE_FILE)))
+            return true;
+        dir = path.dirname(dir);
+    }
+    return false;
+}
+/** Returns true when `<cwd>/<ENV_FILE>` exists (e.g. user copied .env.test.example). */
+export function envFileExists() {
+    return existsSync(ENV_FILE);
+}
+/**
+ * Spawn a child process inheriting stdio. Resolves with the exit code.
+ * The promise NEVER rejects on a non-zero exit code — callers inspect the
+ * resolved number and propagate it to the user.
+ */
+export function spawnInherit(command, args, options = {}) {
+    return new Promise((resolve) => {
+        const child = spawn(command, args, {
+            stdio: 'inherit',
+            ...options,
+        });
+        child.on('exit', (code) => resolve(code ?? 1));
+        child.on('error', (err) => {
+            process.stderr.write(`✗ failed to spawn ${command}: ${err.message}\n`);
+            resolve(1);
+        });
+    });
+}
+/**
+ * Capture stdout from a child process (stderr inherited so errors surface).
+ * Resolves with { code, stdout }. Used by the remote subcommand to read the
+ * target-profile loader's JSON output without printing it to the user.
+ */
+export function spawnCapture(command, args, options = {}) {
+    return new Promise((resolve) => {
+        const child = spawn(command, args, {
+            stdio: ['inherit', 'pipe', 'inherit'],
+            ...options,
+        });
+        let stdout = '';
+        child.stdout?.setEncoding('utf8');
+        child.stdout?.on('data', (chunk) => {
+            stdout += chunk;
+        });
+        child.on('exit', (code) => resolve({ code: code ?? 1, stdout }));
+        child.on('error', (err) => {
+            process.stderr.write(`✗ failed to spawn ${command}: ${err.message}\n`);
+            resolve({ code: 1, stdout: '' });
+        });
+    });
+}
+/**
+ * Build the base `docker compose -f <file> --env-file <file>` argument list.
+ * Optionally prepends a profile and additional overlay files (Mode D).
+ *
+ * Overlays are passed as additional `-f` flags AFTER the base compose file —
+ * compose merges them in order, so later overlays override earlier ones.
+ * Relative paths inside an overlay resolve against the FIRST `-f` file's
+ * directory (the base compose file at `docker/regression/`), NOT against the
+ * overlay's own location.
+ */
+export function dockerComposeArgs(profile, extra = [], overlays = []) {
+    const args = ['compose', '-f', COMPOSE_FILE];
+    for (const overlay of overlays) {
+        args.push('-f', overlay);
+    }
+    if (envFileExists()) {
+        args.push('--env-file', ENV_FILE);
+    }
+    if (profile) {
+        args.push('--profile', profile);
+    }
+    return args.concat(extra);
+}
+/**
+ * Resolve a target-profile argument to an absolute path. Accepts:
+ *   - "staging-mj"                  → docker/regression/targets/staging-mj.target.json
+ *   - "staging-mj.target.json"      → docker/regression/targets/staging-mj.target.json
+ *   - "./my/elsewhere.target.json"  → ./my/elsewhere.target.json (passthrough)
+ *   - absolute path                 → unchanged
+ */
+export function resolveTargetPath(input) {
+    if (path.isAbsolute(input))
+        return input;
+    if (input.includes('/'))
+        return path.resolve(input);
+    const withSuffix = input.endsWith('.target.json') ? input : `${input}.target.json`;
+    return path.resolve(TARGETS_DIR, withSuffix);
+}
+/**
+ * Build a `docker run …` argument list for the published image (external,
+ * no-monorepo path). Mounts are [hostPath, containerPath] pairs; envFile is
+ * injected with `--env-file`; `host.docker.internal` is always mapped so a DB
+ * published on the host is reachable on Linux too.
+ */
+export function dockerRunArgs(image, subArgs, opts = {}) {
+    const args = ['run', '--rm', '--add-host', 'host.docker.internal:host-gateway'];
+    if (opts.envFile && existsSync(opts.envFile)) {
+        args.push('--env-file', opts.envFile);
+    }
+    for (const [hostPath, containerPath] of opts.mounts ?? []) {
+        args.push('-v', `${hostPath}:${containerPath}`);
+    }
+    args.push(image, ...subArgs);
+    return args;
+}
+//# sourceMappingURL=docker-helpers.js.map

package/dist/lib/regression/docker-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker-helpers.js","sourceRoot":"","sources":["../../../src/lib/regression/docker-helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,KAAK,EAAqB,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAClD,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,cAAc,0BAA0B,CAAC;AACxE,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,cAAc,4BAA4B,CAAC;AAC5E,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,cAAc,gCAAgC,CAAC;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,cAAc,uCAAuC,CAAC;AAElG;;;;GAIG;AACH,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE9F;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,eAAuB;IAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/C,IAAI,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,oBAAoB,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1F,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;AAClD,CAAC;AACD,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,cAAc,YAAY,CAAC;AACtD,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,cAAc,UAAU,CAAC;AACvD,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,cAAc,kCAAkC,CAAC;AACtF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,cAAc,eAAe,CAAC;AACjE,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,cAAc,eAAe,CAAC;AAC5D,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,cAAc,4BAA4B,CAAC;AAElF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,2CAA2C,CAAC;AAErF;;;;GAIG;AACH,MAAM,UAAU,mBAAmB;IACjC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,sBAAsB,YAAY,uCAAuC;YACvE,yEAAyE;YACzE,0EAA0E;YAC1E,6DAA6D,CAChE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAAmB,OAAO,CAAC,GAAG,EAAE;IAC/D,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IAClC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1D,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,aAAa;IAC3B,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAe,EACf,IAAc,EACd,UAAwB,EAAE;IAE1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;YACjC,KAAK,EAAE,SAAS;YAChB,GAAG,OAAO;SACX,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC;YACvE,OAAO,CAAC,CAAC,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAe,EACf,IAAc,EACd,UAAwB,EAAE;IAE1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;YACjC,KAAK,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC;YACrC,GAAG,OAAO;SACX,CAAC,CAAC;QACH,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC;YACvE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAgB,EAChB,QAAkB,EAAE,EACpB,WAAqB,EAAE;IAEvB,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IAC7C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,aAAa,EAAE,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,cAAc,CAAC;IACnF,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAa,EACb,OAAiB,EACjB,OAA+D,EAAE;IAEjE,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,mCAAmC,CAAC,CAAC;IAChF,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,KAAK,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,QAAQ,IAAI,aAAa,EAAE,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC;AACd,CAAC"}