Validation page improvements (librenms#18515)

* Per-group validation

* Manual running of a group's validation

* Fix webserver validation url

* stagger initial fetch calls to prevent ui blocking

* better error

Author: murrant

LibreNMS/Validations/WebServer.php

@@ -47,8 +47,8 @@ public function validate(Validator $validator): void
         if (! app()->runningInConsole()) {
             $url = $this->removeStandardPorts(request()->url());
             $base_url = LibrenmsConfig::get('base_url');
-            $expected = $this->removeStandardPorts(Str::finish($base_url, '/') . 'validate/results');
-            $correct_base = str_replace('/validate/results', '', $url);
+            $expected = $this->removeStandardPorts(Str::finish($base_url, '/') . 'validate/results/webserver');
+            $correct_base = str_replace('/validate/results/webserver', '', $url);
 
             if ($url !== $expected) {
                 preg_match($this->host_regex, $url, $actual_host_match);

LibreNMS/Validator.php

@@ -35,12 +35,12 @@
 
 class Validator
 {
-    /** @var array */
-    private $validation_groups = [];
-    /** @var array */
-    private $results = [];
-    /** @var string|null */
-    private $username;
+    /** @var array<string, ValidationGroup> */
+    private array $validation_groups = [];
+    /** @var array<string, ValidationResult[]> */
+    private array $results = [];
+
+    private ?string $username = null;
 
     /**
      * Validator constructor.
@@ -67,6 +67,14 @@ public function __construct()
         }
     }
 
+    /**
+     * @return array<string, bool>
+     */
+    public function getValidationGroups(): array
+    {
+        return array_map(fn (ValidationGroup $validator) => $validator->isDefault(), $this->validation_groups);
+    }
+
     /**
      * Run validations. An empty array will run all default validations.
      *
@@ -159,8 +167,6 @@ public function getAllResults(): array
 
     /**
      * Print all ValidationResults or a group of them.
-     *
-     * @param  string|null  $validation_group
      */
     public function printResults(?string $validation_group = null): void
     {

app/Http/Controllers/ValidateController.php

@@ -12,13 +12,26 @@ class ValidateController extends Controller
 {
     public function index(): View
     {
-        return view('validate.index');
+        $validationGroups = (new Validator())->getValidationGroups();
+
+        $groups = collect($validationGroups)
+            ->map(fn (bool $enabled, string $group) => [
+                'group' => $group,
+                'enabled' => $enabled,
+                'name' => trans("validation.validations.groups.{$group}"),
+            ])
+            ->values()
+            ->all();
+
+        return view('validate.index', [
+            'groups' => $groups,
+        ]);
     }
 
-    public function runValidation(): JsonResponse
+    public function runValidation(?string $group = null): JsonResponse
     {
         $validator = new Validator();
-        $validator->validate();
+        $validator->validate($group ? [$group] : []);
 
         return response()->json($validator->toArray());
     }

composer.json

@@ -65,6 +65,7 @@
         "fakerphp/faker": "^1.23",
         "friendsofphp/php-cs-fixer": "^3.66",
         "larastan/larastan": "^3.1",
+        "laravel/boost": "^1.8",
         "laravel/dusk": "^8.2.2",
         "mockery/mockery": "^1.6",
         "nunomaduro/collision": "^8.6",

composer.lock

@@ -54,14 +54,36 @@
         'fix' => 'Fix',
         'fixed' => 'Fix has completed, refresh to re-run validations.',
         'fetch_failed' => 'Failed to fetch validation results',
-        'backend_failed' => 'Failed to load data from backend, check console for error.',
+        'backend_failed' => 'Failed to load data from backend, run ./validate.php on the console to check.',
         'invalid_fixer' => 'Invalid Fixer',
         'show_all' => 'Show all',
         'show_less' => 'Show less',
         'validate' => 'Validate',
         'validating' => 'Validating',
+        'skipped' => 'Skipped',
+        'run' => 'Run',
     ],
     'validations' => [
+        // Display names for validation groups
+        'groups' => [
+            'configuration' => 'Configuration',
+            'database' => 'Database',
+            'dependencies' => 'Dependencies',
+            'disk' => 'Disk',
+            'distributedpoller' => 'Distributed Poller',
+            'mail' => 'Mail',
+            'php' => 'PHP',
+            'poller' => 'Poller',
+            'programs' => 'Programs',
+            'python' => 'Python',
+            'rrd' => 'RRD',
+            'rrdcheck' => 'RRD Check',
+            'scheduler' => 'Scheduler',
+            'system' => 'System',
+            'updates' => 'Updates',
+            'user' => 'User',
+            'webserver' => 'Web Server',
+        ],
         'rrd' => [
             'CheckRrdVersion' => [
                 'fail' => 'The rrdtool version you have specified is newer than what is installed. Config: :config_version Installed :installed_version',