@glubean/cli 0.1.2

package/templates/data-driven.test.ts.tpl

@@ -0,0 +1,118 @@
+/**
+ * Data-driven API tests — generate many tests from external data files.
+ *
+ * Three patterns are shown:
+ *
+ * 1. JSON import (native) — simplest, no SDK helper needed
+ * 2. CSV loader — use fromCsv() for spreadsheet-style data
+ * 3. YAML loader — use fromYaml() for human-friendly data
+ *
+ * Each row in the data file becomes an independent test case.
+ * Use filter and tagFields for runtime control.
+ *
+ * Run: glubean run data-driven.test.ts
+ */
+import { fromCsv, fromYaml, test } from "@glubean/sdk";
+
+// Import JSON data natively (recommended for JSON files)
+import users from "../data/users.json" with { type: "json" };
+
+// ---------------------------------------------------------------------------
+// Pattern 1: JSON import → test.each
+// ---------------------------------------------------------------------------
+
+/**
+ * One test per user in users.json.
+ * tagFields auto-generates "role:admin", "role:user" etc. for filtering.
+ *
+ * Run only admin tests:  glubean run data-driven.test.ts --tag role:admin
+ */
+export const userTests = test.each(users)(
+  {
+    id: "get-user-$id",
+    name: "GET /users/$id → $expected",
+    tags: "smoke",
+    tagFields: "role",
+  },
+  async (ctx, { id, expected }) => {
+    const baseUrl = ctx.vars.require("BASE_URL");
+    const res = await ctx.http.get(`${baseUrl}/users/${id}`);
+
+    // Fluent assertion — guard status before parsing body
+    ctx.expect(res.status).toBe(expected).orFail();
+
+    if (expected === 200) {
+      const data = await res.json();
+
+      // Soft assertions — all run even if one fails
+      ctx.expect(data.id).toBe(id);
+      ctx.expect(data).toHaveProperty("firstName");
+      ctx.expect(data).toHaveProperty("email");
+
+      ctx.log(`User: ${data.firstName} ${data.lastName} (${data.email})`);
+    }
+  },
+);
+
+// ---------------------------------------------------------------------------
+// Pattern 2: CSV loader → test.each
+// ---------------------------------------------------------------------------
+
+/**
+ * One test per row in endpoints.csv.
+ * CSV values are always strings — cast as needed.
+ */
+export const endpointTests = test.each(
+  await fromCsv("./data/endpoints.csv"),
+)(
+  {
+    id: "endpoint-$method-$path",
+    name: "$method $path → $expected",
+    tags: ["smoke", "endpoints"],
+  },
+  async (ctx, { method, path, expected }) => {
+    const baseUrl = ctx.vars.require("BASE_URL");
+    const res = await ctx.http.get(`${baseUrl}${path}`);
+
+    ctx.assert(
+      res.status === Number(expected),
+      `${method} ${path} should return ${expected}`,
+      { actual: res.status, expected: Number(expected) },
+    );
+  },
+);
+
+// ---------------------------------------------------------------------------
+// Pattern 3: YAML loader → test.each (builder mode)
+// ---------------------------------------------------------------------------
+
+/**
+ * Multi-step test per scenario in scenarios.yaml.
+ * Builder mode gives you setup/steps/teardown with full metadata.
+ */
+export const scenarioTests = test.each(
+  await fromYaml("./data/scenarios.yaml"),
+)(
+  {
+    id: "scenario-$id",
+    name: "$description",
+    tags: "scenario",
+    filter: (row) => !!row.path && !!row.expected,
+  },
+)
+  .step("send request", async (ctx, _state, row) => {
+    const baseUrl = ctx.vars.require("BASE_URL");
+    const res = await ctx.http.get(`${baseUrl}${row.path}`);
+
+    ctx.assert(
+      res.status === row.expected,
+      `${row.method} ${row.path} should return ${row.expected}`,
+      { actual: res.status, expected: row.expected },
+    );
+
+    return { status: res.status };
+  })
+  // deno-lint-ignore require-await
+  .step("log result", async (ctx, state, row) => {
+    ctx.log(`${row.method} ${row.path} → ${state.status}`);
+  });

package/templates/demo.test.result.json

@@ -0,0 +1,398 @@
+{
+  "target": "/Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts",
+  "files": [
+    "packages/cli/templates/demo.test.ts"
+  ],
+  "runAt": "2026-02-16 13:46:18",
+  "summary": {
+    "total": 6,
+    "passed": 0,
+    "failed": 6,
+    "skipped": 0,
+    "durationMs": 216,
+    "stats": {
+      "httpRequestTotal": 0,
+      "httpErrorTotal": 0,
+      "assertionTotal": 0,
+      "assertionFailed": 0,
+      "warningTotal": 0,
+      "warningTriggered": 0,
+      "stepTotal": 5,
+      "stepPassed": 0,
+      "stepFailed": 2
+    }
+  },
+  "tests": [
+    {
+      "testId": "auth-flow",
+      "testName": "Authentication Flow",
+      "tags": [
+        "auth"
+      ],
+      "success": false,
+      "durationMs": 39,
+      "events": [
+        {
+          "type": "log",
+          "message": "Loading test module: file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts"
+        },
+        {
+          "type": "start",
+          "id": "auth-flow",
+          "name": "Authentication Flow",
+          "tags": [
+            "auth"
+          ]
+        },
+        {
+          "type": "step_start",
+          "index": 0,
+          "name": "login",
+          "total": 3
+        },
+        {
+          "type": "step_end",
+          "index": 0,
+          "name": "login",
+          "status": "failed",
+          "durationMs": 0,
+          "assertions": 0,
+          "failedAssertions": 0,
+          "error": "Missing required var: BASE_URL"
+        },
+        {
+          "type": "step_end",
+          "index": 1,
+          "name": "get profile",
+          "status": "skipped",
+          "durationMs": 0,
+          "assertions": 0,
+          "failedAssertions": 0
+        },
+        {
+          "type": "step_end",
+          "index": 2,
+          "name": "refresh token",
+          "status": "skipped",
+          "durationMs": 0,
+          "assertions": 0,
+          "failedAssertions": 0
+        },
+        {
+          "type": "summary",
+          "data": {
+            "httpRequestTotal": 0,
+            "httpErrorTotal": 0,
+            "httpErrorRate": 0,
+            "assertionTotal": 0,
+            "assertionFailed": 0,
+            "warningTotal": 0,
+            "warningTriggered": 0,
+            "schemaValidationTotal": 0,
+            "schemaValidationFailed": 0,
+            "schemaValidationWarnings": 0,
+            "stepTotal": 3,
+            "stepPassed": 0,
+            "stepFailed": 1,
+            "stepSkipped": 2
+          }
+        },
+        {
+          "type": "status",
+          "status": "failed",
+          "error": "One or more steps failed",
+          "stack": "Error: One or more steps failed\n    at executeNewTest (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:1329:15)\n    at async file:///Users/peisong/glubean/oss/packages/runner/harness.ts:971:5"
+        },
+        {
+          "type": "error",
+          "message": "Process exited with code 1"
+        }
+      ]
+    },
+    {
+      "testId": "cart-integrity",
+      "testName": "Cart Data Integrity",
+      "tags": [
+        "data-integrity"
+      ],
+      "success": false,
+      "durationMs": 37,
+      "events": [
+        {
+          "type": "log",
+          "message": "Loading test module: file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts"
+        },
+        {
+          "type": "start",
+          "id": "cart-integrity",
+          "name": "Cart Data Integrity",
+          "tags": [
+            "data-integrity"
+          ]
+        },
+        {
+          "type": "summary",
+          "data": {
+            "httpRequestTotal": 0,
+            "httpErrorTotal": 0,
+            "httpErrorRate": 0,
+            "assertionTotal": 0,
+            "assertionFailed": 0,
+            "warningTotal": 0,
+            "warningTriggered": 0,
+            "schemaValidationTotal": 0,
+            "schemaValidationFailed": 0,
+            "schemaValidationWarnings": 0,
+            "stepTotal": 0,
+            "stepPassed": 0,
+            "stepFailed": 0,
+            "stepSkipped": 0
+          }
+        },
+        {
+          "type": "status",
+          "status": "failed",
+          "error": "Missing required var: BASE_URL",
+          "stack": "Error: Missing required var: BASE_URL\n    at Object.require (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:360:15)\n    at Object.fn (file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts:128:30)\n    at executeNewTest (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:1192:18)\n    at file:///Users/peisong/glubean/oss/packages/runner/harness.ts:971:11"
+        },
+        {
+          "type": "error",
+          "message": "Process exited with code 1"
+        }
+      ]
+    },
+    {
+      "testId": "list-products",
+      "testName": "List Products",
+      "tags": [
+        "smoke"
+      ],
+      "success": false,
+      "durationMs": 39,
+      "events": [
+        {
+          "type": "log",
+          "message": "Loading test module: file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts"
+        },
+        {
+          "type": "start",
+          "id": "list-products",
+          "name": "List Products",
+          "tags": [
+            "smoke"
+          ]
+        },
+        {
+          "type": "summary",
+          "data": {
+            "httpRequestTotal": 0,
+            "httpErrorTotal": 0,
+            "httpErrorRate": 0,
+            "assertionTotal": 0,
+            "assertionFailed": 0,
+            "warningTotal": 0,
+            "warningTriggered": 0,
+            "schemaValidationTotal": 0,
+            "schemaValidationFailed": 0,
+            "schemaValidationWarnings": 0,
+            "stepTotal": 0,
+            "stepPassed": 0,
+            "stepFailed": 0,
+            "stepSkipped": 0
+          }
+        },
+        {
+          "type": "status",
+          "status": "failed",
+          "error": "Missing required var: BASE_URL",
+          "stack": "Error: Missing required var: BASE_URL\n    at Object.require (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:360:15)\n    at Object.fn (file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts:21:30)\n    at executeNewTest (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:1192:18)\n    at file:///Users/peisong/glubean/oss/packages/runner/harness.ts:971:11"
+        },
+        {
+          "type": "error",
+          "message": "Process exited with code 1"
+        }
+      ]
+    },
+    {
+      "testId": "pagination-check",
+      "testName": "Pagination Consistency",
+      "tags": [
+        "data"
+      ],
+      "success": false,
+      "durationMs": 35,
+      "events": [
+        {
+          "type": "log",
+          "message": "Loading test module: file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts"
+        },
+        {
+          "type": "start",
+          "id": "pagination-check",
+          "name": "Pagination Consistency",
+          "tags": [
+            "data"
+          ]
+        },
+        {
+          "type": "summary",
+          "data": {
+            "httpRequestTotal": 0,
+            "httpErrorTotal": 0,
+            "httpErrorRate": 0,
+            "assertionTotal": 0,
+            "assertionFailed": 0,
+            "warningTotal": 0,
+            "warningTriggered": 0,
+            "schemaValidationTotal": 0,
+            "schemaValidationFailed": 0,
+            "schemaValidationWarnings": 0,
+            "stepTotal": 0,
+            "stepPassed": 0,
+            "stepFailed": 0,
+            "stepSkipped": 0
+          }
+        },
+        {
+          "type": "status",
+          "status": "failed",
+          "error": "Missing required var: BASE_URL",
+          "stack": "Error: Missing required var: BASE_URL\n    at Object.require (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:360:15)\n    at Object.fn (file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts:163:30)\n    at executeNewTest (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:1192:18)\n    at file:///Users/peisong/glubean/oss/packages/runner/harness.ts:971:11"
+        },
+        {
+          "type": "error",
+          "message": "Process exited with code 1"
+        }
+      ]
+    },
+    {
+      "testId": "search-products",
+      "testName": "Search Products",
+      "tags": [
+        "smoke"
+      ],
+      "success": false,
+      "durationMs": 33,
+      "events": [
+        {
+          "type": "log",
+          "message": "Loading test module: file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts"
+        },
+        {
+          "type": "start",
+          "id": "search-products",
+          "name": "Search Products",
+          "tags": [
+            "smoke"
+          ]
+        },
+        {
+          "type": "summary",
+          "data": {
+            "httpRequestTotal": 0,
+            "httpErrorTotal": 0,
+            "httpErrorRate": 0,
+            "assertionTotal": 0,
+            "assertionFailed": 0,
+            "warningTotal": 0,
+            "warningTriggered": 0,
+            "schemaValidationTotal": 0,
+            "schemaValidationFailed": 0,
+            "schemaValidationWarnings": 0,
+            "stepTotal": 0,
+            "stepPassed": 0,
+            "stepFailed": 0,
+            "stepSkipped": 0
+          }
+        },
+        {
+          "type": "status",
+          "status": "failed",
+          "error": "Missing required var: BASE_URL",
+          "stack": "Error: Missing required var: BASE_URL\n    at Object.require (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:360:15)\n    at Object.fn (file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts:42:30)\n    at executeNewTest (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:1192:18)\n    at file:///Users/peisong/glubean/oss/packages/runner/harness.ts:971:11"
+        },
+        {
+          "type": "error",
+          "message": "Process exited with code 1"
+        }
+      ]
+    },
+    {
+      "testId": "user-todos-integrity",
+      "testName": "User Todos Cross-Resource",
+      "tags": [
+        "data-integrity"
+      ],
+      "success": false,
+      "durationMs": 33,
+      "events": [
+        {
+          "type": "log",
+          "message": "Loading test module: file:///Users/peisong/glubean/oss/packages/cli/templates/demo.test.ts"
+        },
+        {
+          "type": "start",
+          "id": "user-todos-integrity",
+          "name": "User Todos Cross-Resource",
+          "tags": [
+            "data-integrity"
+          ]
+        },
+        {
+          "type": "step_start",
+          "index": 0,
+          "name": "fetch user",
+          "total": 2
+        },
+        {
+          "type": "step_end",
+          "index": 0,
+          "name": "fetch user",
+          "status": "failed",
+          "durationMs": 0,
+          "assertions": 0,
+          "failedAssertions": 0,
+          "error": "Missing required var: BASE_URL"
+        },
+        {
+          "type": "step_end",
+          "index": 1,
+          "name": "verify todos",
+          "status": "skipped",
+          "durationMs": 0,
+          "assertions": 0,
+          "failedAssertions": 0
+        },
+        {
+          "type": "summary",
+          "data": {
+            "httpRequestTotal": 0,
+            "httpErrorTotal": 0,
+            "httpErrorRate": 0,
+            "assertionTotal": 0,
+            "assertionFailed": 0,
+            "warningTotal": 0,
+            "warningTriggered": 0,
+            "schemaValidationTotal": 0,
+            "schemaValidationFailed": 0,
+            "schemaValidationWarnings": 0,
+            "stepTotal": 2,
+            "stepPassed": 0,
+            "stepFailed": 1,
+            "stepSkipped": 1
+          }
+        },
+        {
+          "type": "status",
+          "status": "failed",
+          "error": "One or more steps failed",
+          "stack": "Error: One or more steps failed\n    at executeNewTest (file:///Users/peisong/glubean/oss/packages/runner/harness.ts:1329:15)\n    at async file:///Users/peisong/glubean/oss/packages/runner/harness.ts:971:5"
+        },
+        {
+          "type": "error",
+          "message": "Process exited with code 1"
+        }
+      ]
+    }
+  ]
+}