-
Notifications
You must be signed in to change notification settings - Fork 0
379 lines (324 loc) · 12 KB
/
api-test-runner.yml
File metadata and controls
379 lines (324 loc) · 12 KB
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
name: API test runner
on:
workflow_dispatch:
pull_request:
push:
branches: [main]
permissions:
contents: read
jobs:
smoke-local-rest-graphql:
name: Smoke suite (local REST + GraphQL via httpbin fixture)
runs-on: ${{ matrix.os }}
timeout-minutes: 10
strategy:
matrix:
os: [macos-latest, ubuntu-latest]
env:
AGENT_HOME: ${{ github.workspace }}
SUITE_NAME: smoke-local-rest-graphql
SUITE_DIR: out/api-test-runner/smoke-local-rest-graphql
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Homebrew + nils-cli
run: |
scripts/install-homebrew-nils-cli.sh
- name: Install jq
run: |
if ! command -v jq >/dev/null 2>&1; then
brew install jq
fi
- name: Bootstrap public suite (gitignored setup/)
run: |
rm -rf setup
cp -R skills/tools/testing/api-test-runner/assets/scaffold/setup ./setup
- name: Run suite
env:
AGENT_HOME: ${{ github.workspace }}
run: |
set -euo pipefail
port=43127
mkdir -p "$SUITE_DIR"
python3 -u setup/fixtures/httpbin/server.py --port "$port" >"$SUITE_DIR/httpbin-fixture.log" 2>&1 &
pid=$!
trap 'kill "$pid" >/dev/null 2>&1 || true' EXIT
for i in $(seq 1 50); do
if curl -fsS "http://127.0.0.1:${port}/health" >/dev/null 2>&1; then
break
fi
sleep 0.1
done
curl -fsS "http://127.0.0.1:${port}/health" >/dev/null
api-test run \
--suite smoke-demo \
--out "$SUITE_DIR/results.json" \
--junit "$SUITE_DIR/junit.xml"
- name: Summarize results
if: always()
run: |
set -euo pipefail
results_file="$SUITE_DIR/results.json"
summary_file="$SUITE_DIR/summary.md"
mkdir -p "$SUITE_DIR"
if ! command -v api-test >/dev/null 2>&1; then
printf '%s\n' '_Summary skipped: api-test not found._' >"$summary_file"
elif [[ ! -f "$results_file" ]]; then
printf '%s\n' "_Summary skipped: missing ${results_file}._" >"$summary_file"
elif ! api-test summary --in "$results_file" --out "$summary_file" --slow 5; then
printf '%s\n' "_Summary generation failed for ${results_file}._" >"$summary_file"
fi
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
{
echo "## API test summary: ${SUITE_NAME} (${RUNNER_OS})"
echo ""
cat "$summary_file"
echo ""
echo "Artifacts: \`${SUITE_DIR}/\`"
echo ""
} >>"$GITHUB_STEP_SUMMARY"
fi
- name: Upload artifacts
if: always()
uses: actions/upload-artifact@v4
with:
name: api-test-runner-${{ env.SUITE_NAME }}-${{ matrix.os }}
if-no-files-found: warn
path: |
${{ env.SUITE_DIR }}/
cleanup-fixture-rest-graphql:
name: Cleanup fixture suite (REST + GraphQL writes + cleanup)
runs-on: ${{ matrix.os }}
timeout-minutes: 10
strategy:
matrix:
os: [macos-latest, ubuntu-latest]
env:
AGENT_HOME: ${{ github.workspace }}
SUITE_NAME: cleanup-fixture-rest-graphql
SUITE_DIR: out/api-test-runner/cleanup-fixture-rest-graphql
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Homebrew + nils-cli
run: |
scripts/install-homebrew-nils-cli.sh
- name: Install jq
run: |
if ! command -v jq >/dev/null 2>&1; then
brew install jq
fi
- name: Run cleanup fixture suite
env:
AGENT_HOME: ${{ github.workspace }}
API_TEST_ALLOW_WRITES_ENABLED: "true"
API_TEST_OUTPUT_DIR: ${{ env.SUITE_DIR }}
run: |
set -euo pipefail
port=43127
mkdir -p "$SUITE_DIR"
python3 -u tests/fixtures/api-test-runner/cleanup/server.py --port "$port" >"$SUITE_DIR/server.log" 2>&1 &
pid=$!
trap 'kill "$pid" >/dev/null 2>&1 || true' EXIT
for i in $(seq 1 50); do
if curl -fsS "http://127.0.0.1:${port}/health" >/dev/null 2>&1; then
break
fi
sleep 0.1
done
curl -fsS "http://127.0.0.1:${port}/health" >/dev/null
api-test run \
--suite-file tests/fixtures/api-test-runner/cleanup/cleanup.suite.json \
--out "$SUITE_DIR/results.json" \
--junit "$SUITE_DIR/junit.xml"
- name: Summarize results
if: always()
run: |
set -euo pipefail
results_file="$SUITE_DIR/results.json"
summary_file="$SUITE_DIR/summary.md"
mkdir -p "$SUITE_DIR"
if ! command -v api-test >/dev/null 2>&1; then
printf '%s\n' '_Summary skipped: api-test not found._' >"$summary_file"
elif [[ ! -f "$results_file" ]]; then
printf '%s\n' "_Summary skipped: missing ${results_file}._" >"$summary_file"
elif ! api-test summary --in "$results_file" --out "$summary_file" --slow 5; then
printf '%s\n' "_Summary generation failed for ${results_file}._" >"$summary_file"
fi
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
{
echo "## API test summary: ${SUITE_NAME} (${RUNNER_OS})"
echo ""
cat "$summary_file"
echo ""
echo "Artifacts: \`${SUITE_DIR}/\`"
echo ""
} >>"$GITHUB_STEP_SUMMARY"
fi
- name: Upload artifacts
if: always()
uses: actions/upload-artifact@v4
with:
name: api-test-runner-${{ env.SUITE_NAME }}-${{ matrix.os }}
if-no-files-found: warn
path: |
${{ env.SUITE_DIR }}/
public-auth-rest-graphql-demo:
name: Public auth demo (DummyJSON REST + Escuelajs GraphQL expected fail)
runs-on: ${{ matrix.os }}
timeout-minutes: 10
strategy:
matrix:
os: [macos-latest, ubuntu-latest]
env:
AGENT_HOME: ${{ github.workspace }}
SUITE_NAME: public-auth-rest-graphql-demo
SUITE_DIR: out/api-test-runner/public-auth-rest-graphql-demo
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Homebrew + nils-cli
run: |
scripts/install-homebrew-nils-cli.sh
- name: Install jq
run: |
if ! command -v jq >/dev/null 2>&1; then
brew install jq
fi
- name: Bootstrap public suite (gitignored setup/)
run: |
rm -rf setup
cp -R skills/tools/testing/api-test-runner/assets/scaffold/setup ./setup
- name: Run suite (expected GraphQL failure demo)
continue-on-error: true
env:
AGENT_HOME: ${{ github.workspace }}
run: |
set -euo pipefail
mkdir -p "$SUITE_DIR"
api-test run \
--suite public-auth-demo \
--out "$SUITE_DIR/results.json" \
--junit "$SUITE_DIR/junit.xml"
- name: Summarize results
if: always()
run: |
set -euo pipefail
results_file="$SUITE_DIR/results.json"
summary_file="$SUITE_DIR/summary.md"
mkdir -p "$SUITE_DIR"
if ! command -v api-test >/dev/null 2>&1; then
printf '%s\n' '_Summary skipped: api-test not found._' >"$summary_file"
elif [[ ! -f "$results_file" ]]; then
printf '%s\n' "_Summary skipped: missing ${results_file}._" >"$summary_file"
elif ! api-test summary --in "$results_file" --out "$summary_file" --slow 5; then
printf '%s\n' "_Summary generation failed for ${results_file}._" >"$summary_file"
fi
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
{
echo "## API test summary: ${SUITE_NAME} (${RUNNER_OS})"
echo ""
cat "$summary_file"
echo ""
echo "Artifacts: \`${SUITE_DIR}/\`"
echo ""
} >>"$GITHUB_STEP_SUMMARY"
fi
- name: Upload artifacts
if: always()
uses: actions/upload-artifact@v4
with:
name: api-test-runner-${{ env.SUITE_NAME }}-${{ matrix.os }}
if-no-files-found: warn
path: |
${{ env.SUITE_DIR }}/
auth-secrets-rest-graphql:
# Requires a repo secret named API_TEST_AUTH_JSON (single JSON string).
# Note: `jobs.<job_id>.if` cannot use `secrets` context, so we gate steps via env instead.
name: Auth via API_TEST_AUTH_JSON (DummyJSON REST + Countries GraphQL)
runs-on: ${{ matrix.os }}
timeout-minutes: 10
strategy:
matrix:
os: [macos-latest, ubuntu-latest]
env:
API_TEST_AUTH_JSON: ${{ secrets.API_TEST_AUTH_JSON }}
AGENT_HOME: ${{ github.workspace }}
SUITE_NAME: auth-secrets-rest-graphql
SUITE_DIR: out/api-test-runner/auth-secrets-rest-graphql
steps:
- name: Skip (missing API_TEST_AUTH_JSON)
if: ${{ env.API_TEST_AUTH_JSON == '' }}
run: |
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
{
echo "## API test summary: ${SUITE_NAME} (${RUNNER_OS})"
echo ""
echo "_Skipped: missing repo secret \`API_TEST_AUTH_JSON\`._"
echo ""
echo "Artifacts: \`${SUITE_DIR}/\` (not generated)"
echo ""
} >>"$GITHUB_STEP_SUMMARY"
fi
echo "Skipping ${SUITE_NAME}: missing repo secret API_TEST_AUTH_JSON."
- name: Checkout
if: ${{ env.API_TEST_AUTH_JSON != '' }}
uses: actions/checkout@v4
- name: Install Homebrew + nils-cli
if: ${{ env.API_TEST_AUTH_JSON != '' }}
run: |
scripts/install-homebrew-nils-cli.sh
- name: Install jq
if: ${{ env.API_TEST_AUTH_JSON != '' }}
run: |
if ! command -v jq >/dev/null 2>&1; then
brew install jq
fi
- name: Bootstrap public suite (gitignored setup/)
if: ${{ env.API_TEST_AUTH_JSON != '' }}
run: |
rm -rf setup
cp -R skills/tools/testing/api-test-runner/assets/scaffold/setup ./setup
- name: Run suite (auth via GitHub Secrets)
if: ${{ env.API_TEST_AUTH_JSON != '' }}
env:
AGENT_HOME: ${{ github.workspace }}
run: |
set -euo pipefail
mkdir -p "$SUITE_DIR"
api-test run \
--suite auth-secrets-demo \
--out "$SUITE_DIR/results.json" \
--junit "$SUITE_DIR/junit.xml"
- name: Summarize results
if: ${{ always() && env.API_TEST_AUTH_JSON != '' }}
run: |
set -euo pipefail
results_file="$SUITE_DIR/results.json"
summary_file="$SUITE_DIR/summary.md"
mkdir -p "$SUITE_DIR"
if ! command -v api-test >/dev/null 2>&1; then
printf '%s\n' '_Summary skipped: api-test not found._' >"$summary_file"
elif [[ ! -f "$results_file" ]]; then
printf '%s\n' "_Summary skipped: missing ${results_file}._" >"$summary_file"
elif ! api-test summary --in "$results_file" --out "$summary_file" --slow 5; then
printf '%s\n' "_Summary generation failed for ${results_file}._" >"$summary_file"
fi
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
{
echo "## API test summary: ${SUITE_NAME} (${RUNNER_OS})"
echo ""
cat "$summary_file"
echo ""
echo "Artifacts: \`${SUITE_DIR}/\`"
echo ""
} >>"$GITHUB_STEP_SUMMARY"
fi
- name: Upload artifacts
if: ${{ always() && env.API_TEST_AUTH_JSON != '' }}
uses: actions/upload-artifact@v4
with:
name: api-test-runner-${{ env.SUITE_NAME }}-${{ matrix.os }}
if-no-files-found: warn
path: |
${{ env.SUITE_DIR }}/