slicetest 0.3.0 → 0.4.0

package/dist/yaml.js

@@ -1,7 +1,7 @@
 import { isMap, isSeq, LineCounter, parseDocument } from "yaml";
 const KINDS = {
     stub: ["on", "when", "reply", "sequence", "networkError", "times", "delay"],
-    request: ["headers", "query", "json", "form", "body", "follow", "expect", "capture"],
+    request: ["headers", "query", "json", "form", "body", "follow", "concurrency", "expect", "capture"],
     insert: ["rows", "capture"],
     sql: ["params", "expect", "capture", "within"],
     db: ["where", "orderBy", "expect", "capture", "within"],
@@ -10,17 +10,21 @@ const KINDS = {
     log: ["from", "within"],
     checkpoint: [],
     snapshot: ["mask"],
+    mail: ["times", "within", "capture"],
 };
 const EXPECT_KEYS = {
-    request: ["status", "headers", "json", "text"],
+    request: ["status", "statuses", "headers", "json", "text"],
     sql: ["rows", "count"],
     db: ["rows", "count"],
 };
 const CONDITION_KEYS = ["query", "headers", "json", "body"];
+const MAIL_KEYS = ["to", "from", "subject", "text", "html"];
 const CHANGE_KEYS = ["inserted", "updated", "deleted"];
 const RESPONSE_KEYS = ["status", "headers", "body"];
 const SCENARIO_KEYS = ["name", "steps", "each", "skip", "only", "timeout"];
 const CALL = /^([A-Za-z]+|\*)\s+(\/\S*)$/;
+/** A request may also go to a captured URL of the app, e.g. a link from a mail: `GET {{link}}`. */
+const REQUEST = /^[A-Za-z]+\s+(\/\S*|\{\{[^}]+\}\}\S*)$/;
 export class YamlScenarioError extends Error {
 }
 export function parseScenarioFile(text, file) {
@@ -108,6 +112,14 @@ function parseStep(node, fail, lineOf) {
             }
         }
     }
+    else if (kind === "mail") {
+        const filter = raw.mail;
+        if (!filter || typeof filter !== "object" || Array.isArray(filter))
+            fail(at(kind), "`mail:` must be a mapping such as { to: alice@example.com, subject: Welcome } ({} for any)");
+        for (const k of Object.keys(filter))
+            if (!MAIL_KEYS.includes(k))
+                fail(at(kind), `unknown key "${k}" in mail (allowed: ${MAIL_KEYS.join(", ")})`);
+    }
     else if (kind === "checkpoint") {
         if (raw.checkpoint !== true)
             fail(at(kind), "use `checkpoint: true`");
@@ -131,8 +143,8 @@ function parseStep(node, fail, lineOf) {
                 fail(at(key), `unknown key "${k}" in ${key} (allowed: ${allowedKeys.join(", ")})`);
         }
     };
-    const call = (key) => {
-        if (raw[key] !== undefined && !CALL.test(String(raw[key])))
+    const call = (key, pattern = CALL) => {
+        if (raw[key] !== undefined && !pattern.test(String(raw[key])))
             fail(at(key), `\`${key}\` must look like "POST /path", got "${raw[key]}"`);
     };
     if (raw.within !== undefined && (typeof raw.within !== "number" || raw.within <= 0))
@@ -166,9 +178,23 @@ function parseStep(node, fail, lineOf) {
             break;
         }
         case "request":
-            call("request");
+            call("request", REQUEST);
             if (["json", "form", "body"].filter((k) => raw[k] !== undefined).length > 1)
                 fail(node, "use only one of json / form / body");
+            if (raw.concurrency !== undefined && !(Number.isInteger(raw.concurrency) && raw.concurrency >= 1))
+                fail(at("concurrency"), "`concurrency` must be a positive whole number");
+            if (raw.concurrency !== undefined && raw.capture !== undefined)
+                fail(at("capture"), "`capture` can't be used with `concurrency`: there is more than one response");
+            {
+                const statuses = raw.expect?.statuses;
+                if (statuses !== undefined) {
+                    if (raw.concurrency === undefined)
+                        fail(at("expect"), "`expect.statuses` needs `concurrency`");
+                    if (!statuses || typeof statuses !== "object" || Object.entries(statuses).some(([k, v]) => !/^\d{3}$/.test(k) || !Number.isInteger(v))) {
+                        fail(at("expect"), "`expect.statuses` maps status codes to counts, e.g. { 201: 1, 409: 9 }");
+                    }
+                }
+            }
             break;
         case "insert":
             if (!raw.rows || typeof raw.rows !== "object")
@@ -188,6 +214,9 @@ function parseStep(node, fail, lineOf) {
             call("call");
             number("times");
             break;
+        case "mail":
+            number("times");
+            break;
     }
     return { ...raw, line: lineOf(node) };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "slicetest",
-  "version": "0.3.0",
-  "description": "Framework-agnostic slice tests: drive a real app process over HTTP with a real Postgres and stubbed outbound APIs, checked against OpenAPI contracts.",
+  "version": "0.4.0",
+  "description": "Framework-agnostic slice tests: drive a real app process over HTTP with a real Postgres, MySQL or SQLite and stubbed outbound APIs, checked against OpenAPI contracts.",
   "keywords": [
     "testing",
     "integration-testing",
@@ -9,6 +9,7 @@
     "api-testing",
     "postgres",
     "mysql",
+    "sqlite",
     "stub",
     "mock-server",
     "vitest",
@@ -55,7 +56,7 @@
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
-    "test:dist": "npm run build && tsc -p examples/tsconfig.dist.json && vitest run --config examples/vitest.dist.config.ts && node dist/cli.js --config examples/slicetest.config.yaml",
+    "test:dist": "npm run build && tsc -p examples/tsconfig.dist.json && vitest run --config examples/vitest.dist.config.ts && node dist/cli.js --config examples/slicetest.config.yaml && node test/record-dist.mjs",
     "prepublishOnly": "npm run typecheck && npm run build"
   },
   "peerDependencies": {

package/schema/scenario.schema.json

@@ -180,6 +180,11 @@
             "follow": {
               "type": "boolean"
             },
+            "concurrency": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "Send the request this many times at once, to provoke races. `expect` applies to every response"
+            },
             "expect": {
               "type": "object",
               "additionalProperties": false,
@@ -196,7 +201,18 @@
                 "json": {
                   "description": "Subset of the response JSON"
                 },
-                "text": {}
+                "text": {},
+                "statuses": {
+                  "type": "object",
+                  "propertyNames": {
+                    "pattern": "^\\d{3}$"
+                  },
+                  "additionalProperties": {
+                    "type": "integer",
+                    "minimum": 0
+                  },
+                  "description": "With `concurrency`: how many responses have each status, e.g. { 201: 1, 409: 9 }"
+                }
               }
             },
             "capture": {
@@ -525,6 +541,138 @@
               "description": "Label shown when this step fails"
             }
           }
+        },
+        {
+          "type": "object",
+          "required": [
+            "mail"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "mail": {
+              "type": "object",
+              "additionalProperties": false,
+              "description": "The app sent mail matching these fields (needs `mail: true` in the config). to/from are exact addresses; subject/text/html are substrings. {} matches any message",
+              "properties": {
+                "to": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "object",
+                      "required": [
+                        "$regex"
+                      ],
+                      "additionalProperties": false,
+                      "properties": {
+                        "$regex": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  ]
+                },
+                "from": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "object",
+                      "required": [
+                        "$regex"
+                      ],
+                      "additionalProperties": false,
+                      "properties": {
+                        "$regex": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  ]
+                },
+                "subject": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "object",
+                      "required": [
+                        "$regex"
+                      ],
+                      "additionalProperties": false,
+                      "properties": {
+                        "$regex": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  ]
+                },
+                "text": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "object",
+                      "required": [
+                        "$regex"
+                      ],
+                      "additionalProperties": false,
+                      "properties": {
+                        "$regex": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  ]
+                },
+                "html": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "object",
+                      "required": [
+                        "$regex"
+                      ],
+                      "additionalProperties": false,
+                      "properties": {
+                        "$regex": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            },
+            "times": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Exact number of matching messages. Default: at least one"
+            },
+            "within": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "Milliseconds to wait. Default 5000"
+            },
+            "capture": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Values of the last matching message: subject, text, html, from, to.0, links.0"
+            },
+            "name": {
+              "type": "string",
+              "description": "Label shown when this step fails"
+            }
+          }
         }
       ]
     },