7ceb124e9b
This commit adds comprehensive validation improvements and DRY principles for handling Coolify's custom Docker Compose extensions. ## Changes ### 1. Created Reusable stripCoolifyCustomFields() Function - Added shared helper in bootstrap/helpers/docker.php - Removes all Coolify custom fields (exclude_from_hc, content, isDirectory, is_directory) - Handles both long syntax (arrays) and short syntax (strings) for volumes - Well-documented with comprehensive docblock - Follows DRY principle for consistent field stripping ### 2. Fixed Docker Compose Modal Validation - Updated validateComposeFile() to use stripCoolifyCustomFields() - Now removes ALL custom fields before Docker validation (previously only removed content) - Fixes validation errors when using templates with custom fields (e.g., traccar.yaml) - Users can now validate compose files with Coolify extensions in UI ### 3. Enhanced YAML Validation in CalculatesExcludedStatus - Added proper exception handling with ParseException vs generic Exception - Added structure validation (checks if parsed result and services are arrays) - Comprehensive logging with context (error message, line number, snippet) - Maintains safe fallback behavior (returns empty collection on error) ### 4. Added Integer Validation to ContainerStatusAggregator - Validates maxRestartCount parameter in both aggregateFromStrings() and aggregateFromContainers() - Corrects negative values to 0 with warning log - Logs warnings for suspiciously high values (> 1000) - Prevents logic errors in crash loop detection ### 5. Comprehensive Unit Tests - tests/Unit/StripCoolifyCustomFieldsTest.php (NEW) - 9 tests, 43 assertions - tests/Unit/ContainerStatusAggregatorTest.php - Added 6 tests for integer validation - tests/Unit/ExcludeFromHealthCheckTest.php - Added 4 tests for YAML validation - All tests passing with proper Log facade mocking ### 6. Documentation - Added comprehensive Docker Compose extensions documentation to .ai/core/deployment-architecture.md - Documents all custom fields: exclude_from_hc, content, isDirectory/is_directory - Includes examples, use cases, implementation details, and test references - Updated .ai/README.md with navigation links to new documentation ## Benefits - Better UX: Users can validate compose files with custom fields - Better Debugging: Comprehensive logging for errors - Better Code Quality: DRY principle with reusable validation - Better Reliability: Prevents logic errors from invalid parameters - Better Maintainability: Easy to add new custom fields in future 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
540 lines
17 KiB
PHP
540 lines
17 KiB
PHP
<?php
|
|
|
|
use App\Services\ContainerStatusAggregator;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
beforeEach(function () {
|
|
$this->aggregator = new ContainerStatusAggregator;
|
|
});
|
|
|
|
describe('aggregateFromStrings', function () {
|
|
test('returns exited:unhealthy for empty collection', function () {
|
|
$result = $this->aggregator->aggregateFromStrings(collect());
|
|
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('returns running:healthy for single healthy running container', function () {
|
|
$statuses = collect(['running:healthy']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:healthy');
|
|
});
|
|
|
|
test('returns running:unhealthy for single unhealthy running container', function () {
|
|
$statuses = collect(['running:unhealthy']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
|
|
test('returns running:unknown for single running container with unknown health', function () {
|
|
$statuses = collect(['running:unknown']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unknown');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for restarting container', function () {
|
|
$statuses = collect(['restarting']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for mixed running and exited containers', function () {
|
|
$statuses = collect(['running:healthy', 'exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns running:unhealthy when one of multiple running containers is unhealthy', function () {
|
|
$statuses = collect(['running:healthy', 'running:unhealthy', 'running:healthy']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
|
|
test('returns running:unknown when running containers have unknown health', function () {
|
|
$statuses = collect(['running:unknown', 'running:healthy']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unknown');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for crash loop (exited with restart count)', function () {
|
|
$statuses = collect(['exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 5);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns exited:unhealthy for exited containers without restart count', function () {
|
|
$statuses = collect(['exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 0);
|
|
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for dead container', function () {
|
|
$statuses = collect(['dead']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for removing container', function () {
|
|
$statuses = collect(['removing']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns paused:unknown for paused container', function () {
|
|
$statuses = collect(['paused']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('paused:unknown');
|
|
});
|
|
|
|
test('returns starting:unknown for starting container', function () {
|
|
$statuses = collect(['starting']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('starting:unknown');
|
|
});
|
|
|
|
test('returns starting:unknown for created container', function () {
|
|
$statuses = collect(['created']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('starting:unknown');
|
|
});
|
|
|
|
test('handles parentheses format input (backward compatibility)', function () {
|
|
$statuses = collect(['running (healthy)', 'running (unhealthy)']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
|
|
test('handles mixed colon and parentheses formats', function () {
|
|
$statuses = collect(['running:healthy', 'running (unhealthy)', 'running:healthy']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
|
|
test('prioritizes restarting over all other states', function () {
|
|
$statuses = collect(['restarting', 'running:healthy', 'paused', 'starting']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('prioritizes crash loop over running containers', function () {
|
|
$statuses = collect(['exited', 'exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 3);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('prioritizes mixed state over healthy running', function () {
|
|
$statuses = collect(['running:healthy', 'exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 0);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('prioritizes running over paused/starting/exited', function () {
|
|
$statuses = collect(['running:healthy', 'starting', 'paused']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:healthy');
|
|
});
|
|
|
|
test('prioritizes dead over paused/starting/exited', function () {
|
|
$statuses = collect(['dead', 'paused', 'starting']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('prioritizes paused over starting/exited', function () {
|
|
$statuses = collect(['paused', 'starting', 'exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('paused:unknown');
|
|
});
|
|
|
|
test('prioritizes starting over exited', function () {
|
|
$statuses = collect(['starting', 'exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('starting:unknown');
|
|
});
|
|
});
|
|
|
|
describe('aggregateFromContainers', function () {
|
|
test('returns exited:unhealthy for empty collection', function () {
|
|
$result = $this->aggregator->aggregateFromContainers(collect());
|
|
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('returns running:healthy for single healthy running container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => (object) ['Status' => 'healthy'],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('running:healthy');
|
|
});
|
|
|
|
test('returns running:unhealthy for single unhealthy running container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => (object) ['Status' => 'unhealthy'],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
|
|
test('returns running:unknown for running container without health check', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => null,
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('running:unknown');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for restarting container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'restarting',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for mixed running and exited containers', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => (object) ['Status' => 'healthy'],
|
|
],
|
|
],
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'exited',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for crash loop (exited with restart count)', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'exited',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers, maxRestartCount: 5);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns exited:unhealthy for exited containers without restart count', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'exited',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers, maxRestartCount: 0);
|
|
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('returns degraded:unhealthy for dead container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'dead',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('returns paused:unknown for paused container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'paused',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('paused:unknown');
|
|
});
|
|
|
|
test('returns starting:unknown for starting container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'starting',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('starting:unknown');
|
|
});
|
|
|
|
test('returns starting:unknown for created container', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'created',
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('starting:unknown');
|
|
});
|
|
|
|
test('handles multiple containers with various states', function () {
|
|
$containers = collect([
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => (object) ['Status' => 'healthy'],
|
|
],
|
|
],
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => (object) ['Status' => 'unhealthy'],
|
|
],
|
|
],
|
|
(object) [
|
|
'State' => (object) [
|
|
'Status' => 'running',
|
|
'Health' => null,
|
|
],
|
|
],
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromContainers($containers);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
});
|
|
|
|
describe('state priority enforcement', function () {
|
|
test('restarting has highest priority', function () {
|
|
$statuses = collect([
|
|
'restarting',
|
|
'running:healthy',
|
|
'dead',
|
|
'paused',
|
|
'starting',
|
|
'exited',
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('crash loop has second highest priority', function () {
|
|
$statuses = collect([
|
|
'exited',
|
|
'running:healthy',
|
|
'paused',
|
|
'starting',
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 1);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('mixed state (running + exited) has third priority', function () {
|
|
$statuses = collect([
|
|
'running:healthy',
|
|
'exited',
|
|
'paused',
|
|
'starting',
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 0);
|
|
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('running:unhealthy has priority over running:unknown', function () {
|
|
$statuses = collect([
|
|
'running:unknown',
|
|
'running:unhealthy',
|
|
'running:healthy',
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unhealthy');
|
|
});
|
|
|
|
test('running:unknown has priority over running:healthy', function () {
|
|
$statuses = collect([
|
|
'running:unknown',
|
|
'running:healthy',
|
|
]);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('running:unknown');
|
|
});
|
|
});
|
|
|
|
describe('maxRestartCount validation', function () {
|
|
test('negative maxRestartCount is corrected to 0 in aggregateFromStrings', function () {
|
|
// Mock the Log facade to avoid "facade root not set" error in unit tests
|
|
Log::shouldReceive('warning')->once();
|
|
|
|
$statuses = collect(['exited']);
|
|
|
|
// With negative value, should be treated as 0 (no restarts)
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: -5);
|
|
|
|
// Should return exited:unhealthy (not degraded) since corrected to 0
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('negative maxRestartCount is corrected to 0 in aggregateFromContainers', function () {
|
|
// Mock the Log facade to avoid "facade root not set" error in unit tests
|
|
Log::shouldReceive('warning')->once();
|
|
|
|
$containers = collect([
|
|
[
|
|
'State' => [
|
|
'Status' => 'exited',
|
|
'ExitCode' => 1,
|
|
],
|
|
],
|
|
]);
|
|
|
|
// With negative value, should be treated as 0 (no restarts)
|
|
$result = $this->aggregator->aggregateFromContainers($containers, maxRestartCount: -10);
|
|
|
|
// Should return exited:unhealthy (not degraded) since corrected to 0
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('zero maxRestartCount works correctly', function () {
|
|
$statuses = collect(['exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 0);
|
|
|
|
// Zero is valid default - no crash loop detection
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
|
|
test('positive maxRestartCount works correctly', function () {
|
|
$statuses = collect(['exited']);
|
|
|
|
$result = $this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 5);
|
|
|
|
// Positive value enables crash loop detection
|
|
expect($result)->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('crash loop detection still functions after validation', function () {
|
|
$statuses = collect(['exited']);
|
|
|
|
// Test with various positive restart counts
|
|
expect($this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 1))
|
|
->toBe('degraded:unhealthy');
|
|
|
|
expect($this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 100))
|
|
->toBe('degraded:unhealthy');
|
|
|
|
expect($this->aggregator->aggregateFromStrings($statuses, maxRestartCount: 999))
|
|
->toBe('degraded:unhealthy');
|
|
});
|
|
|
|
test('default maxRestartCount parameter works', function () {
|
|
$statuses = collect(['exited']);
|
|
|
|
// Call without specifying maxRestartCount (should default to 0)
|
|
$result = $this->aggregator->aggregateFromStrings($statuses);
|
|
|
|
expect($result)->toBe('exited:unhealthy');
|
|
});
|
|
});
|