@elench/testkit 0.1.3 → 0.1.5

package/README.md

@@ -1,6 +1,6 @@
 # @elench/testkit
 
-CLI that reads `runner.manifest.json` from a product repo, spins up an ephemeral environment (Neon DB branch + Fly machine), runs k6 tests, and tears down.
+CLI that reads `testkit.manifest.json` from a product repo, spins up ephemeral infrastructure (Neon DB branch + Fly machine) per service, runs k6 tests, and tears down.
 
 ## Prerequisites
 
@@ -13,41 +13,51 @@ fly auth login
 
 ## Setup
 
-Set platform secrets in your shell (e.g. `.envrc`):
+Add platform secrets to each product's `.env`:
 
 ```bash
-export NEON_API_KEY='...'
-export FLY_API_TOKEN='...'
+NEON_API_KEY='...'
+FLY_API_TOKEN='...'
 ```
 
-Product secrets (`JWT_SECRET`, `ENCRYPTION_KEY`, etc.) are loaded from each product's `.env`.
+Product secrets (`CLERK_SECRET_KEY`, etc.) are also loaded from the same `.env`.
 
 ## Usage
 
-From the `elench/` workspace root:
-
 ```bash
-# Full run — build, create env, test, stop machine
-node testkit/bin/testkit.mjs bourne --build
+cd bourne
 
-# Fast re-run — reuse machine + branch, reset tables
-node testkit/bin/testkit.mjs bourne
+# Run all suites
+npx @elench/testkit
 
 # Specific type / suite
-node testkit/bin/testkit.mjs bourne int -s health
-node testkit/bin/testkit.mjs outreach e2e
+npx @elench/testkit int -s health
+npx @elench/testkit e2e
+
+# Specific service (multi-service products)
+npx @elench/testkit avocado_api int -s health
+
+# Build from source first
+npx @elench/testkit int --build
 
 # Lifecycle
-node testkit/bin/testkit.mjs bourne status
-node testkit/bin/testkit.mjs bourne destroy
+npx @elench/testkit status
+npx @elench/testkit destroy
 ```
 
 ## How it works
 
-1. **Config** — reads `<product>/runner.manifest.json` for infra config + test suites
-2. **Neon** — creates/reuses a persistent branch, truncates tables between runs
-3. **Fly** — builds image (if `--build`), creates/reuses a machine with the right env vars
+1. **Config** — reads `testkit.manifest.json` for per-service infra config + test suites
+2. **Neon** — discovers or creates a `<service>-test` branch, truncates tables between runs
+3. **Fly** — discovers or creates a machine on the service's test app, updates env vars
 4. **k6** — runs matched test files with `BASE_URL` and `MACHINE_ID` injected
-5. **Cleanup** — stops the Fly machine (preserved for next run)
+5. **DAL** — DAL tests use a bundled k6-sql binary (`vendor/k6`) — no external binary needed
+6. **Cleanup** — stops the Fly machine (preserved for next run)
+
+Multi-service products run all services in parallel. Each service gets its own Neon branch and Fly machine.
+
+State is persisted in `.testkit/` (or `.testkit/<service>/` for multi-service) so subsequent runs reuse existing infrastructure.
+
+## Manifest schema
 
-State is persisted in `<product>/.testkit/` so subsequent runs skip setup.
+See [testkit-manifest-schema.md](testkit-manifest-schema.md).

package/lib/config.mjs

@@ -1,5 +1,6 @@
 import fs from "fs";
 import path from "path";
+import { fileURLToPath } from "url";
 
 /**
  * Parse a .env file into an object. Supports KEY=VALUE, KEY='VALUE', KEY="VALUE".
@@ -30,7 +31,7 @@ export function parseDotenv(filePath) {
  */
 export function getServiceNames(cwd) {
   const dir = cwd || process.cwd();
-  const manifestPath = path.join(dir, "runner.manifest.json");
+  const manifestPath = path.join(dir, "testkit.manifest.json");
   if (!fs.existsSync(manifestPath)) return [];
   const m = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
   if (!isObject(m.services)) return [];
@@ -47,7 +48,7 @@ export function getServiceNames(cwd) {
 export function loadConfigs(opts = {}) {
   const cwd = process.cwd();
   const productDir = resolveProductDir(cwd, opts.dir);
-  const manifestPath = path.join(productDir, "runner.manifest.json");
+  const manifestPath = path.join(productDir, "testkit.manifest.json");
   const raw = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
 
   if (!isObject(raw.services)) {
@@ -113,17 +114,13 @@ export function requireFlyToken(serviceName) {
 }
 
 /**
- * Resolve the custom k6 binary for DAL tests. Returns the absolute path.
+ * Resolve the bundled k6-sql binary for DAL tests. Returns the absolute path.
  */
-export function resolveDalBinary(config) {
-  const { productDir, manifest } = config;
-  const rel = manifest.testkit.dal?.k6Binary;
-  if (!rel) {
-    throw new Error("testkit.dal.k6Binary is required for DAL tests");
-  }
-  const abs = path.resolve(productDir, rel);
+export function resolveDalBinary() {
+  const thisFile = fileURLToPath(import.meta.url);
+  const abs = path.resolve(path.dirname(thisFile), "..", "vendor", "k6");
   if (!fs.existsSync(abs)) {
-    throw new Error(`DAL k6 binary not found: ${abs}`);
+    throw new Error(`Bundled DAL k6 binary not found: ${abs}`);
   }
   return abs;
 }
@@ -133,15 +130,15 @@ export function resolveDalBinary(config) {
 function resolveProductDir(cwd, explicitDir) {
   if (explicitDir) {
     const p = path.resolve(cwd, explicitDir);
-    if (fs.existsSync(path.join(p, "runner.manifest.json"))) return p;
-    throw new Error(`No runner.manifest.json in ${p}`);
+    if (fs.existsSync(path.join(p, "testkit.manifest.json"))) return p;
+    throw new Error(`No testkit.manifest.json in ${p}`);
   }
 
   // Check cwd
-  if (fs.existsSync(path.join(cwd, "runner.manifest.json"))) return cwd;
+  if (fs.existsSync(path.join(cwd, "testkit.manifest.json"))) return cwd;
 
   throw new Error(
-    `No runner.manifest.json in current directory. ` +
+    `No testkit.manifest.json in current directory. ` +
     `Either cd into a product directory or use --dir.`
   );
 }
@@ -152,7 +149,7 @@ function resolveProductDir(cwd, explicitDir) {
  */
 export function isSiblingProduct(name) {
   const candidate = path.join(process.cwd(), name);
-  return fs.existsSync(path.join(candidate, "runner.manifest.json"));
+  return fs.existsSync(path.join(candidate, "testkit.manifest.json"));
 }
 
 // ── Per-service validation ──────────────────────────────────────────────
@@ -185,16 +182,8 @@ function validateService(name, svc, manifestPath) {
       errors.push(`${ctx}: testkit.k6 must be an object`);
     }
 
-    if (tk.dal !== undefined) {
-      if (!isObject(tk.dal)) {
-        errors.push(`${ctx}: testkit.dal must be an object`);
-      } else if (svc.suites?.dal) {
-        requireString(errors, tk.dal, `${ctx}: testkit.dal.k6Binary`, "k6Binary");
-      }
-    }
-
-    if (svc.suites?.dal && !tk.dal) {
-      errors.push(`${ctx}: testkit.dal is required when suites.dal exists`);
+    if (tk.dal !== undefined && !isObject(tk.dal)) {
+      errors.push(`${ctx}: testkit.dal must be an object`);
     }
   }
 

package/lib/runner.mjs

@@ -62,6 +62,7 @@ export async function neonUp(config) {
   await runScript("neon-up.sh", {
     NEON_PROJECT_ID: tk.neon.projectId,
     NEON_DB_NAME: tk.neon.dbName,
+    NEON_BRANCH_NAME: tk.neon.branchName || `${config.name}-test`,
     STATE_DIR: stateDir,
   });
 }
@@ -155,7 +156,7 @@ export async function runTests(config, files) {
 export async function runDalTests(config, files) {
   const { productDir, stateDir, manifest } = config;
   const tk = manifest.testkit;
-  const k6Binary = resolveDalBinary(config);
+  const k6Binary = resolveDalBinary();
 
   // Read DATABASE_URL from neon state
   const databaseUrl = fs.readFileSync(path.join(stateDir, "database_url"), "utf8").trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elench/testkit",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "CLI for running k6 tests against real, ephemeral infrastructure",
   "type": "module",
   "bin": {
@@ -9,7 +9,8 @@
   "files": [
     "bin/",
     "lib/",
-    "infra/"
+    "infra/",
+    "vendor/"
   ],
   "dependencies": {
     "cac": "^6.7.14",