Commit 249cd93
authored
## Summary
Fixes #72 by implementing a graceful solution for missing
`OPENAI_API_KEY` environment variable that prevents application startup
crashes.
## Changes Made
### Core Implementation
- **Modified `struct_module/model_wrapper.py`**:
- Added automatic placeholder API key (`sk-default-placeholder-key`)
when `OPENAI_API_KEY` is not set for OpenAI models
- Added warning message when placeholder key is set
- Enhanced `generate_content()` method to detect placeholder keys and
provide user-friendly messages
- Improved error handling for API key-related issues
### Testing
- **Added comprehensive test suite `tests/test_model_wrapper.py`**:
- Test initialization with existing API key (should not set placeholder)
- Test initialization without API key (should set placeholder)
- Test non-OpenAI models (should not interfere)
- Test content generation with placeholder vs valid keys
- Test dry run functionality
- Test enhanced error handling
## Benefits
✅ **Prevents crashes**: Tool starts successfully without
`OPENAI_API_KEY`
✅ **Better UX**: Users can explore non-AI features immediately
✅ **Graceful degradation**: Clear messages when AI features are
unavailable
✅ **Backward compatibility**: Existing configurations work unchanged
✅ **Smart detection**: Only affects OpenAI models, other providers
unaffected
## Testing Results
- All 42 existing tests pass ✅
- 8 new tests added and passing ✅
- Manual testing confirms no startup crashes ✅
- Warning messages display correctly ✅
## Technical Details
The solution implements Option 2 from the issue description with
enhanced error handling:
1. **Startup Protection**: Sets placeholder key only for OpenAI models
when `OPENAI_API_KEY` is missing
2. **Clear Communication**: Warns users about placeholder usage
3. **Smart Fallback**: AI generation gracefully fails with helpful
messages
4. **Minimal Impact**: Only affects the specific error case, no changes
to working configurations
## Acceptance Criteria
- [x] STRUCT tool starts successfully without `OPENAI_API_KEY`
environment variable
- [x] Default/placeholder API key is set programmatically at startup
- [x] Clear warning message when using placeholder API key
- [x] AI features gracefully handle invalid/placeholder API keys
- [x] Existing functionality with valid API keys remains unchanged
- [x] Comprehensive test coverage added
Closes #72
1 parent 4d6a1b1 commit 249cd93
2 files changed
Lines changed: 147 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
15 | 21 | | |
16 | 22 | | |
17 | 23 | | |
| |||
22 | 28 | | |
23 | 29 | | |
24 | 30 | | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
25 | 37 | | |
26 | 38 | | |
27 | 39 | | |
28 | 40 | | |
29 | 41 | | |
30 | 42 | | |
31 | 43 | | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
32 | 47 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 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 | + | |
0 commit comments