perfscale/schema/test.schema.json at main · Perfscale/perfscale · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "GitImport": {
      "additionalProperties": false,
      "description": "`import: { git, ref, file }` — fetch `file` from `git` at `ref`.",
      "properties": {
        "file": {
          "description": "Path of the YAML document inside the repository.",
          "type": "string"
        },
        "git": {
          "description": "Git remote, e.g. `git@gitlab.example.com:group/repo.git` or `https://github.com/org/repo.git`.",
          "type": "string"
        },
        "ref": {
          "description": "Tag, branch, or commit SHA. Tags/SHAs cache forever; branches revalidate against the remote after a short TTL.",
          "type": "string"
        }
      },
      "required": [
        "file",
        "git",
        "ref"
      ],
      "type": "object"
    },
    "ImportSpec": {
      "anyOf": [
        {
          "description": "A relative filesystem path, or an `http(s)://` URL with the ref already pinned in the path.",
          "type": "string"
        },
        {
          "allOf": [
            {
              "$ref": "#/definitions/GitImport"
            }
          ],
          "description": "A file at a ref of an arbitrary git remote (SSH or HTTPS)."
        }
      ],
      "description": "The value of a top-level `import:` key."
    },
    "Step": {
      "anyOf": [
        {
          "required": [
            "use"
          ]
        },
        {
          "required": [
            "uses"
          ]
        }
      ],
      "description": "A single step in a test definition.",
      "properties": {
        "check": {
          "description": "Post-execution assertions.  Keys are assertion names; values are expected values.  Example: `{ \"status\": 200, \"duration_ms_lt\": 500 }`."
        },
        "message": {
          "description": "Custom message for `std/thresholds@v1` steps (interpolated, appended to the auto-generated violation summary). Meaningless for other actions.",
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "Human-readable label shown in log output.",
          "type": [
            "string",
            "null"
          ]
        },
        "outputs": {
          "description": "Variable name to store step output under for `${{ name.field }}` use.",
          "type": [
            "string",
            "null"
          ]
        },
        "severity": {
          "description": "Gate severity for `std/thresholds@v1` steps: `fail` (default), `warn`, or `info`. Meaningless for other actions.",
          "type": [
            "string",
            "null"
          ]
        },
        "use": {
          "description": "Action identifier, e.g. `\"std/http@v1\"`. Written as `use:` in YAML; `uses:` is accepted as an alias (GitHub-Actions muscle memory).",
          "type": "string"
        },
        "uses": {
          "description": "Action identifier, e.g. `\"std/http@v1\"`. Written as `use:` in YAML; `uses:` is accepted as an alias (GitHub-Actions muscle memory).",
          "type": "string"
        },
        "with": {
          "description": "Action-specific parameters (interpolation applied at runtime)."
        }
      },
      "type": "object"
    }
  },
  "description": "Top-level test definition — a list of steps executed per VU iteration.",
  "properties": {
    "import": {
      "anyOf": [
        {
          "$ref": "#/definitions/ImportSpec"
        },
        {
          "type": "null"
        }
      ],
      "description": "Base document to inherit from — a relative path, an `http(s)://` URL, or `{ git, ref, file }`. The base loads first (recursively), then this document deep-merges on top; a local `steps:` list replaces the base's. Remote sources require the caller's `--allow-remote-import`."
    },
    "steps": {
      "items": {
        "$ref": "#/definitions/Step"
      },
      "type": "array"
    }
  },
  "required": [
    "steps"
  ],
  "title": "TestDef",
  "type": "object"
}