@skyramp/testbot-core 0.13.0-v3.181 → 0.13.0-v3.183

package/assets/skyramp-api/gen.cjs

@@ -11,11 +11,17 @@
  *     statusCode: 201, language: "python", framework: "pytest", outputDir: "tests/api", output: "test_products.py" });
  *   // several requests: a trace built from the steps, then an integration test from it
  *   const trace = await api.trace([
- *     { method: "POST", path: "/api/v1/products", request: { name: "Lamp" }, status: 201, response: { id: 7, name: "Lamp" } },
+ *     { method: "POST", path: "/api/v1/products", request: { name: "Lamp" }, unique: ["name"], status: 201, response: { id: 7, name: "Lamp" } },
  *     { method: "GET", path: "/api/v1/products/{{1.id}}", status: 200, response: { id: 7, name: "Lamp" } },
  *   ], { baseUrl: "http://localhost:8000", authHeader: "Authorization", authScheme: "Bearer" });
  *   await api.generate({ kind: "integration", trace, language: "python", framework: "pytest", outputDir: "tests/api", output: "test_product_flow.py" });
  *
+ * A generated test's data is its own across runs. `unique` (a step's, or a contract test's) names the request-body
+ * fields the API keeps unique (a name, slug, SKU or email): the test sends a run-unique value for each, so a rerun or
+ * a parallel run does not collide (409) with what an earlier one left. An integration test deletes what it created
+ * when it ends, failed or not. A contract test of a create does too when given `cleanupPath`, the item route of what
+ * it creates ("/api/v1/products/{product_id}"), with the id in `responseData`.
+ *
  * `{{N.field}}` in a step's path, query or request is the value of `field` (dotted) in step N's response (1-based). The
  * trace then carries the real value, and the generator chains it: the test reads it from that step's response.
  * `schema` (a spec path or URL) may stand in for requestData/responseData in a contract or fuzz test.
@@ -80,6 +86,8 @@ function resolveRefs(value, responses) {
 }
 
 const asJson = (v) => (v === undefined ? undefined : typeof v === "string" ? v : JSON.stringify(v));
+// The MCP's path and query params are "key=value,key2=value2"; an object ({ product_id: 1 }) is written that way.
+const asParams = (v) => (v && typeof v === "object" ? Object.entries(v).map(([k, x]) => `${k}=${x}`).join(",") : String(v));
 const parsed = (v) => {
   if (typeof v !== "string") return v;
   try { return JSON.parse(v); } catch { return v; }
@@ -111,6 +119,7 @@ function traceEntries(steps, opts, toEntry) {
       queryParams: asJson(query),
       responseBody: asJson(s.response),
       statusCode: s.status === undefined ? undefined : Number(s.status),
+      ...(Array.isArray(s.unique) && s.unique.length ? { uniqueFields: s.unique.map(String) } : {}),
       authHeader: opts.authHeader,
       authScheme: opts.authScheme,
     });
@@ -210,8 +219,13 @@ async function generate(opts) {
     ...(opts.authHeader !== undefined ? { authHeader: opts.authHeader } : {}),
     ...(opts.authScheme !== undefined ? { authScheme: opts.authScheme } : {}),
     ...(opts.chainingKey ? { chainingKey: opts.chainingKey } : {}),
-    ...(opts.pathParams ? { pathParams: opts.pathParams } : {}),
-    ...(opts.queryParams ? { queryParams: opts.queryParams } : {}),
+    ...(opts.pathParams ? { pathParams: asParams(opts.pathParams) } : {}),
+    ...(opts.queryParams ? { queryParams: asParams(opts.queryParams) } : {}),
+    // The test's data stays its own: an integration test cleans up what it created; a contract test sends unique
+    // values for the fields it names and deletes its create through cleanupPath.
+    ...(opts.kind === "integration" ? { emitIntegrationTeardown: true } : {}),
+    ...(opts.kind === "contract" && Array.isArray(opts.unique) && opts.unique.length ? { uniqueFields: opts.unique.map(String) } : {}),
+    ...(opts.kind === "contract" && opts.cleanupPath ? { cleanupPath: String(opts.cleanupPath) } : {}),
     language: opts.language,
     ...(opts.framework ? { framework: opts.framework } : {}),
     outputDir,

package/dist/VERSION.json

@@ -1 +1 @@
-{"version":"0.13.0-v3.181","commit":"301a6fa10fd353e0dd1a5c52f8f0d3bac25d952e"}
+{"version":"0.13.0-v3.183","commit":"cb6e5e20b9bca9342b8c9cd4e5e4e54efb1a91c6"}