catalyst 0.2.9

A lightweight API testing tool
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

[config]
base_url = "https://httpbin.org"
default_headers = { "Content-Type" = "application/json" }

# Test 1: Basic test with simple assertion
[[tests]]
name = "Basic Test"
method = "GET"
endpoint = "/get"
expected_status = 200

[[tests.assertions]]
type = "Contains"
value = { "url" = "https://httpbin.org/get" }

# Test 2: Test with request body and complex assertions
[[tests]]
name = "Complex Test"
method = "POST"
endpoint = "/post"
expected_status = 200

[tests.body]
name = "Test User"
email = "test@example.com"

[[tests.assertions]]
type = "Contains"

[tests.assertions.value]
url = "https://httpbin.org/post"

[tests.assertions.value.json]
name = "Test User"

[[tests.assertions]]
type = "PathRegex"
value = ["$.json.email", "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"]

# Test 3: Variable storage test
[[tests]]
name = "Variable Storage Test"
method = "POST"
endpoint = "/post"
expected_status = 200

[tests.body]
id = "12345"
name = "Test Resource"

[tests.store]
"$.json.id" = "resource_id"
"$.json.name" = "resource_name"

# Test 4: Variable usage test
[[tests]]
name = "Variable Usage Test"
method = "GET"
endpoint = "/get"
expected_status = 200

[tests.query_params]
id = "${{resource_id}}"
name = "${{resource_name}}"

[tests.headers]
"X-Resource-ID" = "${{resource_id}}"

[[tests.assertions]]
type = "Contains"

[tests.assertions.value.args]
id = "12345"
name = "Test Resource"

# Test 5: Response time validation
[[tests]]
name = "Response Time Test"
method = "GET"
endpoint = "/get"
expected_status = 200
max_response_time = 1000

# Test 6: Expected body validation
[[tests]]
name = "Expected Body Test"
method = "GET"
endpoint = "/get"
expected_status = 200

[tests.expected_body]
url = "https://httpbin.org/get"

[tests.expected_body.args]

# Test 7: Multiple assertions of different types
[[tests]]
name = "Multiple Assertions Test"
method = "GET"
endpoint = "/get"
expected_status = 200

[[tests.assertions]]
type = "Exact"

[tests.assertions.value]
url = "https://httpbin.org/get"
args = {}

[[tests.assertions]]
type = "Regex"
value = ".*\"url\":\\s*\"https://httpbin.org/get\".*"

[[tests.assertions]]
type = "PathRegex"
value = ["$.url", "^https://httpbin.org/get$"]

[[tests]]
name = "Current User Test"
method = "POST"
endpoint = "/post"
expected_status = 200
body = { "username" = "${{USER}}" }

assertions = [
  { "type" = "Contains", "value" = { "json" = { "username" = "${{USER}}" } } },
]

store = { "$.json.username" = "current_user" }