Add "Under maintenance" status to components and systems (cachethq#287)

Co-authored-by: THIPHONET Stephane DGAC/DTI <stephane.thiphonet@aviation-civile.gouv.fr>

Author: Pingoo31

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "cachethq/core",
+    "name": "pingoo31/cachet-3-core",
     "description": "Cachet core package.",
     "license": "proprietary",
     "keywords": [

resources/lang/en/component.php

@@ -33,6 +33,7 @@
         'performance_issues' => 'Performance Issues',
         'partial_outage' => 'Partial Outage',
         'major_outage' => 'Major Outage',
+        'under_maintenance' => 'Under maintenance',
         'unknown' => 'Unknown',
     ],
 

resources/lang/en/system_status.php

@@ -4,4 +4,5 @@
     'operational' => 'All systems are operational.',
     'partial_outage' => 'Some systems are experiencing issues.',
     'major_outage' => 'Some systems are experiencing major issues.',
+    'under_maintenance' => 'Some systems are under maintenance.',
 ];

resources/lang/fr/component.php

@@ -33,6 +33,7 @@
         'performance_issues' => 'Problèmes de performance',
         'partial_outage' => 'Panne partielle',
         'major_outage' => 'Panne majeure',
+        'under_maintenance' => 'En maintenance',
         'unknown' => 'Inconnu',
     ],
 ];

resources/lang/fr/system_status.php

@@ -4,4 +4,5 @@
     'operational' => 'Tous les systèmes sont opérationnels.',
     'partial_outage' => 'Certains systèmes rencontrent des problèmes.',
     'major_outage' => 'Certains systèmes rencontrent des problèmes majeurs.',
+    'under_maintenance' => 'Certains systèmes sont en maintenance.',
 ];

resources/svg/component-under-maintenance.svg

@@ -14,6 +14,7 @@ enum ComponentStatusEnum: int implements HasColor, HasIcon, HasLabel
     case partial_outage = 3;
     case major_outage = 4;
     case unknown = 5;
+    case under_maintenance = 6;
 
     public static function outage(): array
     {
@@ -31,6 +32,7 @@ public function getLabel(): string
             self::performance_issues => __('cachet::component.status.performance_issues'),
             self::partial_outage => __('cachet::component.status.partial_outage'),
             self::major_outage => __('cachet::component.status.major_outage'),
+            self::under_maintenance => __('cachet::component.status.under_maintenance'),
             default => __('cachet::component.status.unknown'),
         };
     }
@@ -42,6 +44,7 @@ public function getIcon(): string
             self::performance_issues => 'cachet-component-performance-issues',
             self::partial_outage => 'cachet-component-partial-outage',
             self::major_outage => 'cachet-component-major-outage',
+            self::under_maintenance => 'cachet-component-under-maintenance',
             default => 'cachet-unknown',
         };
     }
@@ -53,6 +56,7 @@ public function getColor(): array
             self::performance_issues => Color::Purple,
             self::partial_outage => Color::Amber,
             self::major_outage => Color::Red,
+            self::under_maintenance => Color::Orange,
             default => Color::Blue,
         };
     }

src/Enums/ComponentStatusEnum.php

@@ -12,13 +12,15 @@ enum SystemStatusEnum implements HasColor, HasIcon, HasLabel
     case operational;
     case partial_outage;
     case major_outage;
+    case under_maintenance;
 
     public function getLabel(): string
     {
         return match ($this) {
             self::operational => __('cachet::system_status.operational'),
             self::partial_outage => __('cachet::system_status.partial_outage'),
             self::major_outage => __('cachet::system_status.major_outage'),
+            self::under_maintenance => __('cachet::system_status.under_maintenance'),
         };
     }
 
@@ -28,6 +30,7 @@ public function getColor(): array
             self::operational => Color::Green,
             self::partial_outage => Color::Amber,
             self::major_outage => Color::Red,
+            self::under_maintenance => Color::Orange,
         };
     }
 
@@ -37,6 +40,7 @@ public function getIcon(): string
             self::operational => 'heroicon-m-check-circle',
             self::partial_outage => 'cachet-component-partial-outage',
             self::major_outage => 'cachet-component-major-outage',
+            self::under_maintenance => 'cachet-component-under-maintenance',
         };
     }
 }

src/Enums/SystemStatusEnum.php

@@ -24,6 +24,10 @@ public function current(): SystemStatusEnum
     {
         $components = $this->components();
 
+        if ($this->underMaintenance()) {
+            return SystemStatusEnum::under_maintenance;
+        }
+
         if ($this->majorOutage()) {
             return SystemStatusEnum::major_outage;
         }
@@ -39,6 +43,18 @@ public function current(): SystemStatusEnum
         return SystemStatusEnum::partial_outage;
     }
 
+    /**
+     * Determine if the system is under maintenance.
+     */
+    public function underMaintenance(): bool
+    {
+        if ((int) $this->components()->total === 0) {
+            return false;
+        }
+
+        return (int) $this->components()->under_maintenance >= 1;
+    }
+
     /**
      * Determine if there is a major outage.
      */
@@ -67,6 +83,7 @@ public function components(): object
             ->selectRaw('sum(case when status = ? then 1 else 0 end) as performance_issues', [ComponentStatusEnum::performance_issues])
             ->selectRaw('sum(case when status = ? then 1 else 0 end) as partial_outage', [ComponentStatusEnum::partial_outage])
             ->selectRaw('sum(case when status = ? then 1 else 0 end) as major_outage', [ComponentStatusEnum::major_outage])
+            ->selectRaw('sum(case when status = ? then 1 else 0 end) as under_maintenance', [ComponentStatusEnum::under_maintenance])
             ->first();
     }
 

src/Status.php

@@ -46,6 +46,14 @@
     $this->assertEquals((new Status)->current(), SystemStatusEnum::operational);
 });
 
+it('can get the current system status as under maintenance', function () {
+    Component::factory()->create([
+        'status' => ComponentStatusEnum::under_maintenance->value,
+    ]);
+
+    $this->assertEquals((new Status)->current(), SystemStatusEnum::under_maintenance);
+});
+
 it('can get the current system status as partial outage', function () {
     Component::factory()->create([
         'status' => ComponentStatusEnum::operational->value,
@@ -73,16 +81,18 @@
             ['status' => ComponentStatusEnum::operational->value],
             ['status' => ComponentStatusEnum::partial_outage->value],
             ['status' => ComponentStatusEnum::major_outage->value],
+            ['status' => ComponentStatusEnum::under_maintenance->value],
         )
-        ->count(4)
+        ->count(5)
         ->create();
 
     $components = (new Status)->components();
 
     expect($components)
-        ->total->toBe(4)
+        ->total->toBe(5)
         ->operational->toBe(1)
         ->performance_issues->toBe(0)
         ->partial_outage->toBe(1)
-        ->major_outage->toBe(1);
+        ->major_outage->toBe(1)
+        ->under_maintenance->toBe(1);
 });