Windsurf rules

1---
2name: smoke-test
3model: sonnet
4description: "Post-deploy health-check against a live URL. Validates HTTP status, response content, and critical endpoints. Runnable standalone OR as the final step of the deploy skill."
5---
6 
7# Smoke Test
8 
9> **HARD GATE** — Do NOT run smoke-test against a URL that hasn't been deployed yet. Always run `deploy` first, then `smoke-test`.
10>
11> **HARD GATE** — A failed smoke test means the deployment is broken. Do NOT mark a deploy as successful until all smoke checks pass.
12 
13Validate a deployed application is healthy by running HTTP checks against live URLs. Each check asserts HTTP status, optional body signal (regex), and optional response-time threshold.
14 
15## Configuration
16 
17Smoke checks live in `smoke-checks.yaml` at the project root:
18 
19```yaml
20base_url: "https://example.com"
21checks:
22  - name: "Homepage"
23    path: "/"
24    expected_status: 200
25    content_signal: "welcome|ok"
26    max_response_time_ms: 3000
27```
28 
29| Field | Required | Default | Description |
30|-------|----------|---------|-------------|
31| `name` | Yes | — | Human-readable check name |
32| `path` | Yes | `/` | URL path relative to base_url |
33| `method` | No | `GET` | HTTP method |
34| `expected_status` | No | `200` | Expected HTTP status code |
35| `content_signal` | No | — | Regex or string in response body |
36| `max_response_time_ms` | No | — | Fail if slower than threshold (ms) |
37 
38Ad-hoc single-URL mode: `DEPLOY_URL=https://host bash scripts/run-smoke.sh`
39 
40## Process
41 
42### 1. Load checks
43 
44```bash
45SMOKE_CHECKS_FILE="${SMOKE_CHECKS_FILE:-smoke-checks.yaml}"
46BASE_URL="${DEPLOY_URL:-$BASE_URL}"
47test -f "$SMOKE_CHECKS_FILE" || test -n "$BASE_URL" || { echo "ERROR: no checks file or URL"; exit 1; }
48```
49 
50### 2. Run each check
51 
52```bash
53bash scripts/run-smoke.sh "${DEPLOY_URL:-}" "${SMOKE_CHECKS_FILE:-smoke-checks.yaml}"
54```
55 
56The runner performs curl requests per check, records pass/fail per assertion, and prints a summary.
57 
58### 3. Assert results
59 
60- Any HTTP status mismatch → FAIL
61- Missing `content_signal` when configured → FAIL
62- Response time over `max_response_time_ms` → FAIL
63- Exit code non-zero → deployment not healthy
64 
65### 4. Generate report
66 
67Capture stdout from `run-smoke.sh` as evidence. Persist to `specs/verifications/smoke-<date>.log` for release-branch.
68 
69## Integration with deploy skill
70 
71```bash
72DEPLOY_URL=&quot;$DEPLOY_URL&quot; bash scripts/run-smoke.sh
73```
74 
75## Verify arc
76 
77Part of **★ VERIFY ★**: `verify-work` → `validate-contracts` → `smoke-test` → `run-evals` → `audit-code`
78 
79## Verify
80 
81→ verify: `test -x scripts/run-smoke.sh && grep -q 'run-smoke.sh' skills/smoke-test/SKILL.md && ! grep -q 'See \[REFERENCE.md\](REFERENCE.md)$' skills/smoke-test/SKILL.md && echo OK`
82 
83---
84 
85# Smoke Test — Reference
86 
87## Navigation
88 
89| Lines | Section |
90|-------|---------|
91| 1 | Title |
92| 3–17 | Navigation |
93| 18–34 | Runner script |
94| 35–46 | Configuration reference |
95| 47–55 | Verification |
96| 56–89 | Reference block 1 |
97| 90–107 | Reference block 2 |
98| 108–122 | Reference block 3 |
99| 123–159 | Reference block 4 |
100| 160–177 | Reference block 5 |
101 
102## Runner script
103 
104A ready-to-use runner is provided for standalone operation:
105 
106```bash
107bash scripts/run-smoke.sh [url] [smoke-checks-file]
108```
109 
110The runner:
1111. Uses `$DEPLOY_URL`, `$SMOKE_CHECKS_FILE`, or CLI arguments
1122. Runs all defined checks
1133. Prints a pass/fail summary
1144. Exits 0 on all pass, non-zero on any failure
115 
116 
117---
118 
119## Configuration reference
120 
121| Variable | Default | Description |
122|----------|---------|-------------|
123| `SMOKE_CHECKS_FILE` | `smoke-checks.yaml` | Path to smoke checks YAML |
124| `DEPLOY_URL` / `BASE_URL` | *(required)* | Base URL for all checks |
125| `SMOKE_TIMEOUT` | `30` | Per-check timeout (seconds) |
126| `SMOKE_RETRIES` | `0` | Number of retries on failure |
127 
128 
129---
130 
131## Verification
132 
133→ verify: `test -f smoke-test/SKILL.md && grep -q 'name: smoke-test' smoke-test/SKILL.md && echo OK`
134→ verify: `grep -qi 'smoke.checks.yaml\|checklist\|expected_status\|content_signal' smoke-test/SKILL.md && echo OK`
135→ verify: `grep -ci 'pass\|fail\|summary\|report' smoke-test/SKILL.md | awk '{if($1>=2) print "OK"; else print "FAIL"}'`
136→ verify: `grep -q 'smoke-test' SKILL-INDEX.md && echo OK`
137 
138---
139 
140## Reference block 1
141 
142```yaml
143# smoke-checks.yaml — auto-loaded if present at project root
144base_url: "https://example.com"
145checks:
146  - name: "Homepage"
147    path: "/"
148    method: GET
149    expected_status: 200
150    content_signal: "bigpowers"
151    max_response_time_ms: 3000
152
153  - name: "API Health"
154    path: "/api/health"
155    method: GET
156    expected_status: 200
157    content_signal: "ok|healthy"
158
159  - name: "API Jogos"
160    path: "/api/jogos"
161    method: GET
162    expected_status: 200
163    content_signal: "jogos|games"
164
165  - name: "Not Found handling"
166    path: "/nonexistent"
167    method: GET
168    expected_status: 404
169    content_signal: "not found|404"
170```
171 
172---
173 
174## Reference block 2
175 
176```bash
177SMOKE_CHECKS_FILE=&quot;${SMOKE_CHECKS_FILE:-smoke-checks.yaml}&quot;
178BASE_URL=&quot;${DEPLOY_URL:-$BASE_URL}&quot;
179
180if [ -f &quot;$SMOKE_CHECKS_FILE&quot; ]; then
181  echo &quot;Loaded smoke checks from $SMOKE_CHECKS_FILE&quot;
182elif [ -n &quot;$BASE_URL&quot; ]; then
183  echo &quot;No smoke-checks.yaml found. Using single URL check against $BASE_URL&quot;
184else
185  echo &quot;ERROR: No smoke-checks.yaml found and no DEPLOY_URL/BASE_URL set.&quot;
186  exit 1
187fi
188```
189 
190---
191 
192## Reference block 3
193 
194```bash
195url=&quot;${BASE_URL}${path}&quot;
196start_time=$(python3 -c 'import time; print(int(time.time() * 1000))')
197 
198# Perform the HTTP request
199response=$(curl -s -o /tmp/smoke_body.txt -w &quot;%{http_code}&quot; &quot;$url&quot;)
200response_time=$(( $(python3 -c 'import time; print(int(time.time() * 1000))') - start_time ))
201status=$response
202body=$(cat /tmp/smoke_body.txt)
203```
204 
205---
206 
207## Reference block 4
208 
209```bash
210checks_passed=0
211checks_failed=0
212failures=&quot;&quot;
213 
214# Assert status code
215if [ &quot;$status&quot; -ne &quot;${expected_status:-200}&quot; ]; then
216  echo &quot;  FAIL: expected status ${expected_status} but got $status&quot;
217  checks_failed=$((checks_failed + 1))
218  failures=&quot;${failures}  - $name: HTTP $status (expected ${expected_status})\n&quot;
219else
220  echo &quot;  PASS: HTTP $status&quot;
221fi
222 
223# Assert content signal
224if [ -n &quot;$content_signal&quot; ]; then
225  if echo &quot;$body&quot; | grep -qiE &quot;$content_signal&quot;; then
226    echo &quot;  PASS: body contains \&quot;$content_signal\&quot;&quot;
227  else
228    echo &quot;  FAIL: body does not contain \&quot;$content_signal\&quot;&quot;
229    checks_failed=$((checks_failed + 1))
230    failures=&quot;${failures}  - $name: missing content signal \&quot;$content_signal\&quot;\n&quot;
231  fi
232fi
233 
234# Assert response time
235if [ -n &quot;$max_response_time_ms&quot; ] && [ &quot;$response_time&quot; -gt &quot;$max_response_time_ms&quot; ]; then
236  echo &quot;  FAIL: response time ${response_time}ms exceeds ${max_response_time_ms}ms&quot;
237  checks_failed=$((checks_failed + 1))
238  failures=&quot;${failures}  - $name: response time ${response_time}ms (max ${max_response_time_ms}ms)\n&quot;
239fi
240```
241 
242---
243 
244## Reference block 5
245 
246```bash
247total=$((checks_passed + checks_failed))
248echo &quot;&quot;
249echo &quot;=== Smoke Test Summary ===&quot;
250echo &quot;Total: $total | Passed: $checks_passed | Failed: $checks_failed&quot;
251
252if [ &quot;$checks_failed&quot; -gt 0 ]; then
253  echo &quot;&quot;
254  echo &quot;Failures:&quot;
255  echo -e &quot;$failures&quot;
256  exit 1
257else
258  echo &quot;All checks passed.&quot;
259  exit 0
260fi
261```
262