alef-e2e 0.16.58

Fixture-driven e2e test generator for alef
Documentation 
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Alef E2E Test Fixture",
  "description": "Schema for alef e2e test fixture files. Each file contains either a single fixture object or an array of fixtures.",
  "oneOf": [
    { "$ref": "#/$defs/fixture" },
    { "type": "array", "items": { "$ref": "#/$defs/fixture" } }
  ],
  "$defs": {
    "fixture": {
      "type": "object",
      "required": ["id", "description"],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_]*$",
          "description": "Unique snake_case identifier used as the test function name"
        },
        "category": {
          "type": "string",
          "description": "Test category. Defaults to parent directory name if omitted"
        },
        "description": { "type": "string", "description": "Human-readable test description" },
        "tags": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Optional tags for filtering"
        },
        "skip": { "$ref": "#/$defs/skip" },
        "call": {
          "type": "string",
          "description": "Named call config to use. References [e2e.calls.<name>]. Defaults to [e2e.call] when omitted"
        },
        "input": {
          "type": "object",
          "description": "Input data passed to the function under test. Fields map to args via [e2e.call.args] config"
        },
        "assertions": {
          "type": "array",
          "items": { "$ref": "#/$defs/assertion" },
          "description": "List of assertions to check on the result"
        }
      }
    },
    "skip": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "languages": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Languages to skip. Empty array means skip all"
        },
        "reason": { "type": "string", "description": "Human-readable reason for skipping" }
      }
    },
    "assertion": {
      "type": "object",
      "required": ["type"],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "not_error",
            "error",
            "equals",
            "not_equals",
            "contains",
            "contains_all",
            "contains_any",
            "not_contains",
            "not_empty",
            "is_empty",
            "starts_with",
            "ends_with",
            "min_length",
            "max_length",
            "count_min",
            "count_equals",
            "matches_regex",
            "is_true",
            "is_false",
            "greater_than",
            "less_than",
            "greater_than_or_equal",
            "less_than_or_equal",
            "method_result"
          ],
          "description": "Assertion type"
        },
        "field": {
          "type": "string",
          "description": "Dot-separated field path on the result object"
        },
        "value": { "description": "Expected value (type depends on assertion type)" },
        "values": {
          "type": "array",
          "description": "Expected values (for contains_all, contains_any, not_contains)"
        },
        "method": { "type": "string", "description": "Method name to call on the result" },
        "check": {
          "type": "string",
          "description": "Assertion check type for the method result (equals, is_true, is_false, greater_than_or_equal, count_min)"
        },
        "args": { "type": "object", "description": "Arguments to pass to the method call" }
      }
    }
  }
}