slicetest 0.7.0 → 0.9.0

package/schema/scenario.schema.json

@@ -86,6 +86,14 @@
             "items": {
               "$ref": "#/$defs/step"
             }
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^[^\\s,!]+$"
+            },
+            "description": "Labels to select scenarios by: npx slicetest --tag smoke (or !slow to leave some out)"
           }
         }
       }
@@ -127,6 +135,10 @@
                 "json": {
                   "description": "Subset of the request JSON"
                 },
+                "form": {
+                  "type": "object",
+                  "description": "Subset of a form-encoded body's fields; bracket keys are nested (metadata[order] → metadata: { order })"
+                },
                 "body": {},
                 "variables": {
                   "description": "Subset of the GraphQL variables (with `graphql`)"
@@ -149,6 +161,10 @@
                 "body": {
                   "description": "String, or anything else to send as JSON. May use {{call.params.x}}, {{call.json.x}}, {{call.query.x}}"
                 },
+                "file": {
+                  "type": "string",
+                  "description": "Answer with this file's content, relative to the scenario file: .json and .yaml are sent as JSON (and may use {{call.*}}), other files as they are, with a content type from the extension"
+                },
                 "sse": {
                   "type": "array",
                   "description": "A streamed reply (Server-Sent Events), instead of body: a list of { event, data, id }. Data that isn't a string is sent as JSON",
@@ -221,6 +237,30 @@
                       "sse",
                       "errors"
                     ]
+                  },
+                  {
+                    "required": [
+                      "file",
+                      "body"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "file",
+                      "sse"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "file",
+                      "data"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "file",
+                      "errors"
+                    ]
                   }
                 ]
               }
@@ -243,6 +283,10 @@
                   "body": {
                     "description": "String, or anything else to send as JSON. May use {{call.params.x}}, {{call.json.x}}, {{call.query.x}}"
                   },
+                  "file": {
+                    "type": "string",
+                    "description": "Answer with this file's content, relative to the scenario file: .json and .yaml are sent as JSON (and may use {{call.*}}), other files as they are, with a content type from the extension"
+                  },
                   "sse": {
                     "type": "array",
                     "description": "A streamed reply (Server-Sent Events), instead of body: a list of { event, data, id }. Data that isn't a string is sent as JSON",
@@ -315,6 +359,30 @@
                         "sse",
                         "errors"
                       ]
+                    },
+                    {
+                      "required": [
+                        "file",
+                        "body"
+                      ]
+                    },
+                    {
+                      "required": [
+                        "file",
+                        "sse"
+                      ]
+                    },
+                    {
+                      "required": [
+                        "file",
+                        "data"
+                      ]
+                    },
+                    {
+                      "required": [
+                        "file",
+                        "errors"
+                      ]
                     }
                   ]
                 }
@@ -389,6 +457,103 @@
             "form": {
               "type": "object"
             },
+            "multipart": {
+              "type": "object",
+              "description": "A multipart/form-data body: fields, and files as { file: avatar.png } (relative to the scenario file) or { content, filename, type }",
+              "additionalProperties": {
+                "oneOf": [
+                  {
+                    "oneOf": [
+                      {
+                        "type": [
+                          "string",
+                          "number",
+                          "boolean"
+                        ]
+                      },
+                      {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                          "file": {
+                            "type": "string",
+                            "description": "Path relative to the scenario file"
+                          },
+                          "content": {
+                            "description": "Inline file content; objects are sent as JSON"
+                          },
+                          "filename": {
+                            "type": "string"
+                          },
+                          "type": {
+                            "type": "string",
+                            "description": "Content type; from the file extension by default"
+                          }
+                        },
+                        "oneOf": [
+                          {
+                            "required": [
+                              "file"
+                            ]
+                          },
+                          {
+                            "required": [
+                              "content"
+                            ]
+                          }
+                        ]
+                      }
+                    ]
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "oneOf": [
+                        {
+                          "type": [
+                            "string",
+                            "number",
+                            "boolean"
+                          ]
+                        },
+                        {
+                          "type": "object",
+                          "additionalProperties": false,
+                          "properties": {
+                            "file": {
+                              "type": "string",
+                              "description": "Path relative to the scenario file"
+                            },
+                            "content": {
+                              "description": "Inline file content; objects are sent as JSON"
+                            },
+                            "filename": {
+                              "type": "string"
+                            },
+                            "type": {
+                              "type": "string",
+                              "description": "Content type; from the file extension by default"
+                            }
+                          },
+                          "oneOf": [
+                            {
+                              "required": [
+                                "file"
+                              ]
+                            },
+                            {
+                              "required": [
+                                "content"
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                  }
+                ]
+              }
+            },
             "body": {
               "type": "string"
             },
@@ -423,7 +588,14 @@
                         "github",
                         "slack",
                         "shopify",
-                        "standard"
+                        "standard",
+                        "line",
+                        "paddle",
+                        "linear",
+                        "gitlab",
+                        "zoom",
+                        "twitch",
+                        "twilio"
                       ]
                     },
                     {
@@ -467,6 +639,10 @@
                 "invalidSignature": {
                   "type": "boolean",
                   "description": "Signed with a different secret"
+                },
+                "url": {
+                  "type": "string",
+                  "description": "The URL the app validates against, for providers that sign it (twilio). Default: the app's address and the request path"
                 }
               }
             },
@@ -480,10 +656,18 @@
               "additionalProperties": false,
               "properties": {
                 "status": {
+                  "description": "A code (201), a class (\"2xx\") or a list of them ([200, 204]).",
                   "type": [
                     "integer",
-                    "string"
-                  ]
+                    "string",
+                    "array"
+                  ],
+                  "items": {
+                    "type": [
+                      "integer",
+                      "string"
+                    ]
+                  }
                 },
                 "headers": {
                   "type": "object"
@@ -492,6 +676,31 @@
                   "description": "Subset of the response JSON"
                 },
                 "text": {},
+                "events": {
+                  "type": "array",
+                  "items": {
+                    "type": "object"
+                  },
+                  "description": "Server-sent events of a text/event-stream response that must come in this order, others allowed between: [{ event: message_start }, { data: \"[DONE]\" }]. Each is a subset of { event, data, id }"
+                },
+                "cookies": {
+                  "type": "object",
+                  "description": "Cookies the response sets, by name: attributes as a subset ({ httpOnly: true, sameSite: Lax, value: ... }), or null for one it must not set",
+                  "additionalProperties": {
+                    "type": [
+                      "object",
+                      "null"
+                    ]
+                  }
+                },
+                "duration": {
+                  "description": "The response arrived within this many milliseconds, or a matcher on the time: { $lt: 200 }",
+                  "type": [
+                    "integer",
+                    "object"
+                  ],
+                  "minimum": 1
+                },
                 "statuses": {
                   "type": "object",
                   "propertyNames": {
@@ -553,6 +762,21 @@
                   }
                 }
               ]
+            },
+            "within": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "Repeat the request until `expect` passes, for up to this many milliseconds (polling a job the app finishes later)"
+            },
+            "every": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "With `within`: milliseconds between attempts. Default 200"
+            },
+            "timeout": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "Fail when the app hasn't answered within this many milliseconds (overrides http.timeout)"
             }
           },
           "not": {
@@ -574,8 +798,43 @@
                   "graphql",
                   "body"
                 ]
+              },
+              {
+                "required": [
+                  "multipart",
+                  "json"
+                ]
+              },
+              {
+                "required": [
+                  "multipart",
+                  "form"
+                ]
+              },
+              {
+                "required": [
+                  "multipart",
+                  "body"
+                ]
+              },
+              {
+                "required": [
+                  "multipart",
+                  "graphql"
+                ]
+              },
+              {
+                "required": [
+                  "within",
+                  "concurrency"
+                ]
               }
             ]
+          },
+          "dependentRequired": {
+            "every": [
+              "within"
+            ]
           }
         },
         {
@@ -610,7 +869,7 @@
             },
             "fields": {
               "type": "object",
-              "description": "Values typed into the form by field name; true / false / a list of values check checkboxes and radios",
+              "description": "Values typed into the form by field name; true / false / a list of values check checkboxes and radios; { file: path } uploads a file through a file input",
               "additionalProperties": {
                 "oneOf": [
                   {
@@ -628,6 +887,36 @@
                         "number"
                       ]
                     }
+                  },
+                  {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                      "file": {
+                        "type": "string",
+                        "description": "Path relative to the scenario file"
+                      },
+                      "content": {},
+                      "filename": {
+                        "type": "string"
+                      },
+                      "type": {
+                        "type": "string"
+                      }
+                    },
+                    "oneOf": [
+                      {
+                        "required": [
+                          "file"
+                        ]
+                      },
+                      {
+                        "required": [
+                          "content"
+                        ]
+                      }
+                    ],
+                    "description": "A file for a file input"
                   }
                 ]
               }
@@ -643,10 +932,18 @@
               "additionalProperties": false,
               "properties": {
                 "status": {
+                  "description": "A code (201), a class (\"2xx\") or a list of them ([200, 204]).",
                   "type": [
                     "integer",
-                    "string"
-                  ]
+                    "string",
+                    "array"
+                  ],
+                  "items": {
+                    "type": [
+                      "integer",
+                      "string"
+                    ]
+                  }
                 },
                 "headers": {
                   "type": "object"
@@ -655,6 +952,31 @@
                   "description": "Subset of the response JSON"
                 },
                 "text": {},
+                "events": {
+                  "type": "array",
+                  "items": {
+                    "type": "object"
+                  },
+                  "description": "Server-sent events of a text/event-stream response that must come in this order, others allowed between: [{ event: message_start }, { data: \"[DONE]\" }]. Each is a subset of { event, data, id }"
+                },
+                "cookies": {
+                  "type": "object",
+                  "description": "Cookies the response sets, by name: attributes as a subset ({ httpOnly: true, sameSite: Lax, value: ... }), or null for one it must not set",
+                  "additionalProperties": {
+                    "type": [
+                      "object",
+                      "null"
+                    ]
+                  }
+                },
+                "duration": {
+                  "description": "The response arrived within this many milliseconds, or a matcher on the time: { $lt: 200 }",
+                  "type": [
+                    "integer",
+                    "object"
+                  ],
+                  "minimum": 1
+                },
                 "schema": {
                   "description": "A JSON Schema the response JSON must match: inline, or a file relative to this one with an optional pointer, e.g. ../openapi.yaml#/components/schemas/Poll",
                   "oneOf": [
@@ -940,6 +1262,10 @@
                 "json": {
                   "description": "Subset of the request JSON"
                 },
+                "form": {
+                  "type": "object",
+                  "description": "Subset of a form-encoded body's fields; bracket keys are nested (metadata[order] → metadata: { order })"
+                },
                 "body": {},
                 "variables": {
                   "description": "Subset of the GraphQL variables (with `graphql`)"
@@ -1038,6 +1364,105 @@
               "type": "integer",
               "minimum": 1,
               "description": "Retry this step for up to this many milliseconds, for effects the app applies asynchronously"
+            },
+            "ignore": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Columns or tables to leave out: updated_at (in every table), orders.synced_at, sessions.*"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "set"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "set": {
+              "type": "object",
+              "minProperties": 1,
+              "propertyNames": {
+                "pattern": "^[A-Za-z_]\\w*$"
+              },
+              "description": "Variables for later steps, e.g. { orderId: \"{{$uuid}}\", expires: \"{{$now+1d}}\" }"
+            },
+            "name": {
+              "type": "string",
+              "description": "Label shown when this step fails"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "order"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "order": {
+              "type": "array",
+              "minItems": 2,
+              "description": "Calls to stubs in the order they must have happened (others may come in between): \"<stub> METHOD /path\" or { stub, call, when }",
+              "items": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "pattern": "^\\S+\\s+([A-Za-z]+|\\*)\\s+/\\S*$"
+                  },
+                  {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                      "stub",
+                      "call"
+                    ],
+                    "properties": {
+                      "stub": {
+                        "type": "string"
+                      },
+                      "call": {
+                        "type": "string",
+                        "pattern": "^([A-Za-z]+|\\*)\\s+/\\S*$"
+                      },
+                      "when": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                          "query": {
+                            "type": "object"
+                          },
+                          "headers": {
+                            "type": "object"
+                          },
+                          "json": {
+                            "description": "Subset of the request JSON"
+                          },
+                          "form": {
+                            "type": "object",
+                            "description": "Subset of a form-encoded body's fields; bracket keys are nested (metadata[order] → metadata: { order })"
+                          },
+                          "body": {},
+                          "variables": {
+                            "description": "Subset of the GraphQL variables (with `graphql`)"
+                          }
+                        }
+                      }
+                    }
+                  }
+                ]
+              }
+            },
+            "within": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "Retry this step for up to this many milliseconds, for effects the app applies asynchronously"
+            },
+            "name": {
+              "type": "string",
+              "description": "Label shown when this step fails"
             }
           }
         },