@edupia-tutor/spec-driven-docs 0.14.0

package/commands/dev-smoke-test.tmpl

@@ -0,0 +1,217 @@
+# /dev-smoke-test — Smoke Test Live Service or App
+
+Use when service/app is **already running**. Different from `/dev-run-test` (no live server needed).
+
+## Gate
+{{include:steps/gate.md}}
+
+*Note: For this command, the target in Step 1 is a UC-ID from `$ARGUMENTS`. Context loading provides `conventions.service_run`, port information, and `tech_stack.module`.*
+
+## Context
+{{include:steps/context-loader.md}}
+
+---
+
+## Service Detection
+
+Read `active_module` from context. Use to select the correct dev-smoke-test approach.
+
+| Platform | Modules |
+|---|---|
+| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
+| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
+| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
+
+---
+
+## If `platform_type = backend`
+
+### Phase 1 — Verify service is running
+
+Read `conventions.service_run` from project-context.yaml to determine port.
+
+```bash
+# Try common health endpoints (use whichever applies):
+curl -s http://localhost:{port}/health            # generic / Go / Node
+curl -s http://localhost:{port}/actuator/health   # Spring Boot
+curl -s http://localhost:{port}/ping              # some frameworks
+```
+
+If not running → "Start with `{conventions.service_run}` from project root."
+
+### Phase 2 — Identify endpoints
+
+From UC-ID → find controller/handler with `@trace.implements={UC-ID}`.
+List: method, path, required auth/role.
+
+### Phase 3 — Get auth token (if needed)
+
+```
+Endpoint requires auth. Options:
+1. Paste Bearer token (from Postman/DevTools)
+2. Use test/dev token from local config
+3. Skip — test public endpoints only
+```
+
+### Phase 4 — Run
+
+```bash
+# GET
+curl -s -X GET "http://localhost:{port}/v1/{resource}" \
+  -H "Authorization: Bearer {token}" | {JSON_FORMATTER}
+
+# POST
+curl -s -X POST "http://localhost:{port}/v1/{resource}" \
+  -H "Authorization: Bearer {token}" \
+  -H "Content-Type: application/json" \
+  -d '{"field1": "test_value"}'
+```
+
+| Result | Meaning |
+|--------|---------|
+| 200/201 + correct data | ✅ OK |
+| 200 + wrong data | ⚠️ Logic bug → /debug |
+| 400 | Wrong request body → check required fields |
+| 401 | Token expired or wrong config |
+| 403 | Wrong role → check auth rules |
+| 500 | Server error → /debug |
+| Connection refused | Service not running |
+
+### If `active_module = context-engineering`
+
+#### Phase 1 — Verify pipeline entry point is reachable
+
+Run the prompt function directly with a minimal valid input:
+
+```bash
+# Python (pytest / script):
+python -c "from {module}.{function} import {function}; print({function}(input='{test_input}'))"
+
+# Or using the project test command with a smoke marker:
+{conventions.test_command} -m smoke -v
+```
+
+#### Phase 2 — Verify output structure
+
+Check the output conforms to the expected schema:
+
+```
+Expected output schema: {output fields from @trace or tech-doc}
+Actual output: {paste output here}
+```
+
+#### Phase 3 — Interpret results
+
+| Result | Meaning |
+|--------|---------|
+| Output matches schema | ✅ OK |
+| Output present but wrong format | ⚠️ Logic bug → /debug |
+| `APIError` / `AuthenticationError` | API key invalid or service unavailable |
+| `TokenLimitError` | Input too long — check prompt template size |
+| Exception / traceback | Code error → /debug |
+
+---
+
+## If `platform_type = web-frontend`
+
+### Phase 1 — Verify dev server is running
+
+```bash
+# Linux / macOS:
+curl -s -o /dev/null -w "%{http_code}" http://localhost:{port}
+
+# Windows (cmd / PowerShell):
+curl -s -o NUL -w "%{http_code}" http://localhost:{port}
+
+# Should return 200. If not: start with {conventions.service_run} (e.g., npm run dev)
+```
+
+### Phase 2 — Run E2E smoke test
+
+Identify E2E tool in the project (Playwright or Cypress):
+
+```bash
+# Playwright — run scenarios tagged with this UC:
+npx playwright test --grep "{UC-ID}"
+
+# Cypress:
+npx cypress run --spec "cypress/e2e/{UC-ID}*"
+```
+
+If no E2E tests exist yet → open browser and manually verify:
+1. Navigate to the route for this UC
+2. Perform the main user action
+3. Confirm the expected outcome is visible
+
+### Phase 3 — Interpret results
+
+| Result | Meaning |
+|--------|---------|
+| All E2E tests pass | ✅ OK |
+| Assertion failed | ⚠️ Logic bug → /debug |
+| `ERR_CONNECTION_REFUSED` | Dev server not running |
+| API returns 4xx/5xx | Backend issue → check backend service |
+
+---
+
+## If `platform_type = mobile`
+
+### Phase 1 — Verify device/emulator is ready
+
+```bash
+# Flutter:
+flutter devices              # list connected devices/emulators
+flutter install              # install current build on device
+
+# React Native:
+npx react-native run-android   # build + install on connected Android
+npx react-native run-ios       # build + install on iOS simulator
+
+# Android (Compose):
+./gradlew installDebug         # install APK on connected device/emulator
+
+# iOS (SwiftUI):
+# Open Xcode → select simulator → Product → Run
+```
+
+### Phase 2 — Manual dev-smoke-test checklist
+
+For the UC under test, verify on device:
+1. Navigate to the screen for this UC
+2. Perform the main action from the `.feature` Scenario (`When` step)
+3. Confirm the expected outcome is visible (`Then` step)
+4. Check for any crash or unexpected error dialog
+
+### Phase 3 — Capture issues if found
+
+```bash
+# Flutter:
+flutter logs
+
+# Android:
+adb logcat -d | grep -i "error\|exception\|crash"
+
+# iOS:
+# Copy crash log from Xcode → Devices and Simulators → View Device Logs
+```
+
+Paste output into `/debug`.
+
+---
+
+## Output
+
+{{include:steps/report-footer.md}}
+
+```
+/dev-smoke-test Report — {UC-ID}
+Platform: {backend | web-frontend | mobile}
+| Endpoint / Flow       | Status      | Result  |
+|-----------------------|-------------|---------|
+| {method} {path/screen}| ✅/⚠️/❌   | {notes} |
+
+Status legend: ✅ = OK  |  ⚠️ = Responded but wrong data / logic bug  |  ❌ = Error / not running
+
+Issues: {describe any failures}
+Next: /debug (paste error interactively) OR /fix-bug {TICKET_ID} OR ready to PR
+```