Spaces:
Build error
Build error
File size: 5,958 Bytes
c8e832f | 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 | # Testing Guide
This document lists the environment variables you may need, the available routes, which params are required, and how to test each route quickly.
## 1) Environment Variables
## Server runtime variables
Use these when running the FastAPI app (local or container):
- HOST: default 0.0.0.0 in Docker, localhost in app main()
- PORT: default 8000
- WORKERS: default 1 (used by container command)
- MAX_CONCURRENT_ENVS: default 32
Minimal local run on Windows PowerShell:
```powershell
$env:HOST = "127.0.0.1"
$env:PORT = "8000"
$env:MAX_CONCURRENT_ENVS = "32"
uvicorn server.app:app --host $env:HOST --port $env:PORT
```
## Inference script variables
Required:
- API_BASE_URL
- MODEL_NAME
- HF_TOKEN or OPENAI_API_KEY
Optional:
- ENV_BASE_URL (if omitted, inference.py launches from Docker image)
- PYTHON_ENV_IMAGE (default python_env-env:latest)
- MAX_STEPS (default 3)
- MAX_TASKS (default 3)
- INFERENCE_REPORT_PATH (default inference_results.json)
- TEMPERATURE (default 0)
- MAX_TOKENS (default 900)
Example:
```powershell
$env:API_BASE_URL = "https://api.openai.com/v1"
$env:MODEL_NAME = "gpt-4.1-mini"
$env:OPENAI_API_KEY = "<your-key>"
$env:ENV_BASE_URL = "http://127.0.0.1:8000"
python inference.py
```
## 2) Task IDs You Can Use
- py-review-easy
- py-review-medium
- py-review-hard
## 3) Route Testing (Params + Examples)
Base URL:
```text
http://127.0.0.1:8000
```
## OpenEnv routes
### POST /reset
- Required params: none
- Body: none
Test:
```powershell
Invoke-RestMethod -Method Post -Uri "http://127.0.0.1:8000/reset"
```
### POST /step
- Required params: none in query/path
- Required body shape:
- operation: one of submit_findings, request_hint, finalize
- findings: array (can be empty)
- Optional body fields:
- patched_code: string or null
- note: string or null
Minimal body example:
```json
{
"operation": "request_hint",
"findings": []
}
```
Test:
```powershell
$body = @{
operation = "request_hint"
findings = @()
} | ConvertTo-Json
Invoke-RestMethod -Method Post -Uri "http://127.0.0.1:8000/step" -ContentType "application/json" -Body $body
```
Example with finding:
```powershell
$body = @{
operation = "submit_findings"
findings = @(
@{
title = "Avoid eval on untrusted input"
line = 2
category = "security"
severity = "critical"
rationale = "eval can execute attacker-controlled code"
recommendation = "Use json.loads instead"
rule_id = "avoid-eval"
}
)
patched_code = $null
note = "first pass"
} | ConvertTo-Json -Depth 6
Invoke-RestMethod -Method Post -Uri "http://127.0.0.1:8000/step" -ContentType "application/json" -Body $body
```
### GET /state
- Required params: none
Test:
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/state"
```
### GET /schema
- Required params: none
Test:
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/schema"
```
### WS /ws
- Use a websocket client to connect.
- No route params required.
## Custom REST routes
### GET /health
- Required params: none
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/health"
```
### GET /tasks
- Required params: none
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/tasks"
```
### GET /tasks/{task_id}
- Required path param: task_id
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/tasks/py-review-easy"
```
### POST /tasks/{task_id}/grade
- Required path param: task_id
- Body uses PythonReviewAction shape
- operation defaults to submit_findings if omitted
- findings array accepted
- patched_code optional
- note optional
```powershell
$body = @{
findings = @(
@{
title = "Avoid eval on untrusted input"
line = 2
category = "security"
severity = "critical"
rationale = "eval executes arbitrary code"
recommendation = "Use json.loads"
}
)
} | ConvertTo-Json -Depth 6
Invoke-RestMethod -Method Post -Uri "http://127.0.0.1:8000/tasks/py-review-easy/grade" -ContentType "application/json" -Body $body
```
### POST /review
- Required body field:
- code: string
- Optional body field:
- context: string
```powershell
$body = @{
code = "def f(x):`n return eval(x)`n"
} | ConvertTo-Json
Invoke-RestMethod -Method Post -Uri "http://127.0.0.1:8000/review" -ContentType "application/json" -Body $body
```
### GET /history
- Required params: none
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/history"
```
### DELETE /history
- Required params: none
```powershell
Invoke-RestMethod -Method Delete -Uri "http://127.0.0.1:8000/history"
```
### GET /config
- Required params: none
```powershell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8000/config"
```
### PUT /config
- Required params: none
- Body: PythonEnvConfig object
- All fields have defaults, so {} is valid for a reset-like update
Minimal test:
```powershell
Invoke-RestMethod -Method Put -Uri "http://127.0.0.1:8000/config" -ContentType "application/json" -Body "{}"
```
Full body example:
```powershell
$body = @{
task_order = @("py-review-easy", "py-review-medium", "py-review-hard")
max_steps_per_task = 4
hint_penalty = 0.05
false_positive_penalty = 0.08
duplicate_penalty = 0.03
patch_bonus_multiplier = 0.2
max_history_entries = 50
} | ConvertTo-Json
Invoke-RestMethod -Method Put -Uri "http://127.0.0.1:8000/config" -ContentType "application/json" -Body $body
```
## 4) Quick Validation Commands
Run automated tests:
```powershell
pytest -q
```
Run only API tests:
```powershell
pytest -q tests/test_api.py
```
|