feat(parser): Implement hosts file parser with intelligent formatting

- Added `internal/core/parser.go` for parsing hosts files, including:
  - Support for standard entries (IPv4, IPv6, multiple aliases, inline comments)
  - Handling of comments and disabled entries
  - Error recovery for malformed lines with warnings
  - Intelligent formatting with adaptive spacing and column alignment
  - Backup and atomic write operations for file safety

test(parser): Add comprehensive tests for hosts file parsing

- Created `tests/parser_test.go` with 54 test cases covering:
  - Standard entries and comments
  - Malformed lines and whitespace variations
  - Round-trip parsing to ensure format preservation
  - Backup functionality for hosts files

docs(progress): Update project progress and next steps

- Mark Phase 1 as complete and outline tasks for Phase 2 (TUI implementation)
- Highlight completed features and testing coverage
This commit is contained in:
Philip Henning 2025-08-13 10:33:36 +02:00
parent d66ec51ebd
commit b81f11f711
10 changed files with 1303 additions and 210 deletions

View file

@ -87,28 +87,38 @@ Manager
## Critical Implementation Paths
### 1. **File Operations**
### 1. **File Operations** ✅ IMPLEMENTED
```go
// Atomic file updates with backup
1. Read current /etc/hosts → backup
2. Parse entries → validate changes
3. Write to temporary file → verify
4. Atomic move temp → /etc/hosts
5. Remove backup on success
// Atomic file updates with backup - COMPLETED
1. Read current /etc/hosts → backup (✅ BackupHostsFile)
2. Parse entries → validate changes (✅ ParseHostsContent with warnings)
3. Write to temporary file → verify (✅ WriteHostsFile with temp files)
4. Atomic move temp → /etc/hosts (✅ os.Rename for atomic operation)
5. Remove backup on success (✅ Backup retained for safety)
```
### 2. **State Management**
### 2. **Parser Implementation** ✅ IMPLEMENTED
```go
// Bubble Tea update cycle
// Hosts file parsing with format preservation - COMPLETED
1. Line-by-line parsing → classify comments vs entries (✅ parseCommentLine)
2. Regex-based field extraction → handle whitespace variations (✅ regexp.Split)
3. IP/hostname validation → comprehensive validation (✅ net.ParseIP, validateHostname)
4. Format style detection → GCD-based spacing analysis (✅ DetectFormattingStyle)
5. Intelligent formatting → preserve style while improving alignment (✅ FormatHostsFile)
```
### 3. **State Management** (READY FOR IMPLEMENTATION)
```go
// Bubble Tea update cycle - READY FOR PHASE 2
1. User input → Command
2. Command → State change
3. State change → View update
4. View update → Screen render
```
### 3. **DNS Resolution**
### 4. **DNS Resolution** (PLANNED FOR PHASE 4)
```go
// Background IP resolution
// Background IP resolution - FUTURE FEATURE
1. Extract hostnames from entries
2. Resolve in background goroutines
3. Compare resolved vs current IPs
@ -116,9 +126,9 @@ Manager
5. User chooses whether to update
```
### 4. **Edit Mode Transition**
### 5. **Edit Mode Transition** (PLANNED FOR PHASE 3)
```go
// Permission elevation
// Permission elevation - FUTURE FEATURE
1. User requests edit mode
2. Check current permissions
3. Request sudo if needed
@ -128,34 +138,52 @@ Manager
## Error Handling Strategy
### 1. **Graceful Degradation**
- **No sudo**: Continue in view-only mode
### 1. **Graceful Degradation** ✅ IMPLEMENTED
- **Parser warnings**: Non-fatal errors allow continued processing (✅ ParseWarning system)
- **Malformed entries**: Invalid lines generate warnings but don't stop parsing (✅ Implemented)
- **Format preservation**: Unknown formatting preserved while improving known patterns (✅ Implemented)
### 2. **Validation Layers** ✅ IMPLEMENTED
- **IP validation**: IPv4/IPv6 validation using Go's net.ParseIP (✅ Implemented)
- **Hostname validation**: RFC-compliant validation with detailed error messages (✅ validateHostname)
- **Entry completeness**: Check for required fields before processing (✅ Implemented)
### 3. **Recovery Mechanisms** ✅ IMPLEMENTED
- **Backup system**: Automatic timestamped backups before any write operation (✅ BackupHostsFile)
- **Atomic operations**: Temporary files prevent corruption during writes (✅ WriteHostsFile)
- **Warning aggregation**: Collect and report all issues without stopping (✅ ParseWarning slice)
- **Round-trip validation**: Ensure parse → format → parse consistency (✅ Tested)
### 4. **Future Error Handling** (PLANNED)
- **File locked**: Show warning, allow retry
- **DNS failure**: Show cached/manual IP options
### 2. **Validation Layers**
- **Input validation**: Real-time feedback on forms
- **Business rules**: Validate complete entries
- **System constraints**: Check file permissions, IP formats
### 3. **Recovery Mechanisms**
- **Backup restoration**: Automatic rollback on write failures
- **DNS failure**: Show cached/manual IP options
- **State recovery**: Restore UI state after errors
- **User guidance**: Clear error messages with suggested actions
## Testing Architecture
### 1. **Unit Tests**
- **Pure functions**: Parser, validator, DNS resolver
- **Mocked dependencies**: File system, network calls
- **Edge cases**: Malformed files, network errors
### 1. **Unit Tests** ✅ IMPLEMENTED (54 TESTS)
- **Parser functions**: ParseHostsContent, FormatHostsFile, DetectFormattingStyle (✅ Comprehensive coverage)
- **Model validation**: HostEntry creation, hostname/IP validation (✅ 44 foundation tests)
- **Edge cases**: Malformed files, empty files, comment-only files (✅ Extensive edge case testing)
- **File operations**: Backup functionality, atomic writes (✅ BackupHostsFile tested)
### 2. **Integration Tests**
- **TUI workflows**: Complete user interactions
- **File operations**: Real file system operations (in temp dirs)
- **Permission scenarios**: Test sudo/non-sudo paths
### 2. **Test Coverage Achieved**
- **Standard entries**: IPv4, IPv6, aliases, comments (✅ TestParseHostsFile_StandardEntries)
- **Comment handling**: Disabled entries vs standalone comments (✅ TestParseHostsFile_CommentsAndDisabled)
- **Error scenarios**: Invalid IPs, malformed lines, missing data (✅ TestParseHostsFile_MalformedLines)
- **Whitespace handling**: Tabs, spaces, mixed formatting (✅ TestParseHostsFile_WhitespaceVariations)
- **Round-trip parsing**: Parse → format → parse consistency (✅ TestWriteHostsFile_RoundTrip)
- **Format detection**: Tab vs space detection with GCD analysis (✅ TestDetectFormattingStyle)
### 3. **Test Patterns**
- **Table-driven tests**: Multiple input scenarios
- **Mock interfaces**: Controllable external dependencies
- **Golden files**: Expected output comparisons
### 3. **Test Patterns** ✅ IMPLEMENTED
- **Table-driven tests**: Multiple input scenarios for comprehensive coverage (✅ Used extensively)
- **Helper functions**: parseHostsContent helper for string-based testing (✅ Implemented)
- **Temporary files**: Safe testing of file operations (✅ TestBackupHostsFile)
- **Error validation**: Verify specific error messages and warning content (✅ Implemented)
### 4. **Future Testing** (PLANNED)
- **TUI workflows**: Complete user interactions (Phase 2)
- **Permission scenarios**: Test sudo/non-sudo paths (Phase 3)
- **Integration tests**: Full application workflows (Phase 3)
- **Mock interfaces**: Controllable external dependencies (Phase 3)