File size: 4,531 Bytes
2f95553 |
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 |
# How to Check Environment Variables (JSON Format)
## Method 1: Using the Test Script (Easiest)
Run this command:
```bash
python test_env.json.py
```
**Example Output:**
```json
{
"status": "ok",
"variables": {
"QUIZ_SECRET": {
"set": true,
"length": 8,
"preview": "Easy...Quiz"
},
"OPENAI_API_KEY": {
"set": true,
"length": 200,
"preview": "sk-proj...4UA",
"valid_format": true
},
"PORT": {
"set": true,
"value": "8000"
}
},
"ready": true,
"llm_enabled": true,
"message": "Ready to run"
}
```
## Method 2: Using the API Endpoint
### Step 1: Start the Server
```bash
python -m app.main
```
### Step 2: Check Environment Variables
**Using curl:**
```bash
curl http://localhost:8000/env-check
```
**Using PowerShell:**
```powershell
Invoke-RestMethod -Uri http://localhost:8000/env-check -Method Get | ConvertTo-Json
```
**Using Python:**
```python
import requests
response = requests.get("http://localhost:8000/env-check")
print(response.json())
```
**Example JSON Response:**
```json
{
"status": "ok",
"variables": {
"QUIZ_SECRET": {
"set": true,
"length": 8,
"preview": "Easy...Quiz"
},
"OPENAI_API_KEY": {
"set": true,
"length": 200,
"preview": "sk-proj...4UA",
"valid_format": true
},
"PORT": {
"set": true,
"value": "8000"
}
},
"ready": true,
"llm_enabled": true
}
```
## Method 3: Test the Full API
### Health Check
```bash
curl http://localhost:8000/health
```
**Response:**
```json
{
"status": "healthy"
}
```
### Test Quiz Endpoint (with wrong secret - should return 403)
```bash
curl -X POST http://localhost:8000/solve \
-H "Content-Type: application/json" \
-d '{
"email": "test@example.com",
"secret": "wrong_secret",
"url": "https://example.com"
}'
```
**Expected Response (403):**
```json
{
"detail": {
"error": "forbidden"
}
}
```
### Test Quiz Endpoint (with correct secret)
```bash
curl -X POST http://localhost:8000/solve \
-H "Content-Type: application/json" \
-d '{
"email": "test@example.com",
"secret": "EasyQuiz",
"url": "https://example.com/quiz"
}'
```
## Method 4: Quick PowerShell Test
```powershell
# Check variables directly
$env:QUIZ_SECRET
$env:OPENAI_API_KEY
# Test with API (if server is running)
$response = Invoke-RestMethod -Uri http://localhost:8000/env-check
$response | ConvertTo-Json -Depth 10
```
## JSON Response Fields Explained
| Field | Description |
|-------|-------------|
| `status` | Always "ok" if script runs |
| `variables.QUIZ_SECRET.set` | `true` if QUIZ_SECRET is set |
| `variables.QUIZ_SECRET.length` | Length of the secret |
| `variables.QUIZ_SECRET.preview` | Masked preview (first 4 + last 4 chars) |
| `variables.OPENAI_API_KEY.set` | `true` if API key is set |
| `variables.OPENAI_API_KEY.valid_format` | `true` if key starts with "sk-" |
| `ready` | `true` if QUIZ_SECRET is set (required) |
| `llm_enabled` | `true` if OPENAI_API_KEY is set (optional) |
| `message` | Human-readable status message |
## Quick Test Commands
### All-in-One Test (PowerShell)
```powershell
# 1. Check variables
python test_env.json.py
# 2. Start server (in another terminal)
python -m app.main
# 3. Test API (in another terminal)
Invoke-RestMethod -Uri http://localhost:8000/env-check | ConvertTo-Json
```
### All-in-One Test (Bash/Linux)
```bash
# 1. Check variables
python test_env.json.py
# 2. Start server (in another terminal)
python -m app.main
# 3. Test API (in another terminal)
curl http://localhost:8000/env-check | python -m json.tool
```
## Expected Results
### ✅ Everything Working:
```json
{
"ready": true,
"llm_enabled": true,
"variables": {
"QUIZ_SECRET": { "set": true },
"OPENAI_API_KEY": { "set": true, "valid_format": true }
}
}
```
### ⚠️ Missing QUIZ_SECRET:
```json
{
"ready": false,
"llm_enabled": true,
"variables": {
"QUIZ_SECRET": { "set": false },
"OPENAI_API_KEY": { "set": true }
},
"message": "QUIZ_SECRET is required"
}
```
### ⚠️ Missing OPENAI_API_KEY (still works, but no LLM):
```json
{
"ready": true,
"llm_enabled": false,
"variables": {
"QUIZ_SECRET": { "set": true },
"OPENAI_API_KEY": { "set": false }
}
}
```
|