feat: add monitor:health --json option (#317)

* fix: configured label was not being used in ping check

* feat: output in json format option

* fix: cleanup and added test

* fix: phpstan fixes

* fix: reduced test to only check if json flag works

* fix: ignore result code in json test

* chore: php-cs fixes

* fix: added formated json output

* fix: added formated json output

Author: sschueller

src/Command/HealthCheckCommand.php

@@ -45,29 +45,58 @@ protected function configure(): void
             ->addOption('fail-on-warning', description: 'Fail command if any checks have a warning result')
             ->addOption('fail-on-skip', description: 'Fail command if any checks are skipped')
             ->addOption('fail-on-unknown', description: 'Fail command if any checks have an unknown result')
+            ->addOption('json', description: 'Output in JSON format')
         ;
     }
 
+    /**
+     * @throws \JsonException
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $isJsonOutput = $input->getOption('json');
         $io = new SymfonyStyle($input, $output);
-        $subscriber = $io->isVerbose() ? new ConsoleCheckVerboseSubscriber($io) : new ConsoleCheckListSubscriber($input, $output);
 
-        $this->eventDispatcher->addSubscriber($subscriber);
+        if (!$isJsonOutput) {
+            $subscriber = $io->isVerbose() ? new ConsoleCheckVerboseSubscriber($io) : new ConsoleCheckListSubscriber($input, $output);
+            $this->eventDispatcher->addSubscriber($subscriber);
+        }
 
         $suite = $this->checkRegistry->suite($input->getOption('suite'));
 
         if (!$suite->count()) {
             throw new \RuntimeException(\sprintf('No checks found for suite "%s"', $suite));
         }
 
+        $results = $suite->run(!$input->getOption('no-cache'));
+        $failureStatuses = [];
+
+        if ($input->getOption('fail-on-warning')) {
+            $failureStatuses[] = Status::WARNING;
+        }
+
+        if ($input->getOption('fail-on-skip')) {
+            $failureStatuses[] = Status::SKIP;
+        }
+
+        if ($input->getOption('fail-on-unknown')) {
+            $failureStatuses[] = Status::UNKNOWN;
+        }
+
+        $isFail = $results->defects(...$failureStatuses)->count() > 0;
+
+        if ($isJsonOutput) {
+            $output->write(\json_encode($results, \JSON_THROW_ON_ERROR | \JSON_PRETTY_PRINT, 512));
+
+            return $isFail ? self::FAILURE : self::SUCCESS;
+        }
+
         $io->section($input->getOption('suite') ? \sprintf('Running Check Suite "%s"', $suite) : 'Running All Checks');
 
         if ($input->getOption('no-cache')) {
             $io->note('Running with cache disabled');
         }
 
-        $results = $suite->run(!$input->getOption('no-cache'));
         $warnings = $results->warnings();
         $unknowns = $results->unknowns();
         $summary = \array_filter([
@@ -79,21 +108,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $unknowns->count() ? \sprintf('%d unknown%s', $unknowns->count(), $unknowns->count() > 2 ? 's' : '') : null,
         ]);
         $message = \sprintf('%d check executed (%s)', $results->count(), \implode(', ', $summary));
-        $failureStatuses = [];
-
-        if ($input->getOption('fail-on-warning')) {
-            $failureStatuses[] = Status::WARNING;
-        }
-
-        if ($input->getOption('fail-on-skip')) {
-            $failureStatuses[] = Status::SKIP;
-        }
-
-        if ($input->getOption('fail-on-unknown')) {
-            $failureStatuses[] = Status::UNKNOWN;
-        }
-
-        $isFail = $results->defects(...$failureStatuses)->count() > 0;
 
         $io->newLine();
         $io->{$isFail ? 'error' : 'success'}($message);

tests/LiipMonitorBundleTest.php

@@ -98,6 +98,22 @@ public function execute_health_command(): void
         $logger->hasInfoThatContains('Health check "Check Service 1": Success');
     }
 
+    /**
+     * @test
+     * @group slow
+     * @throws \JsonException
+     */
+    public function execute_health_command_with_json_output(): void
+    {
+        $output = $this->executeConsoleCommand('monitor:health --json')
+            ->output()
+        ;
+
+        // Verify that the output is valid JSON
+        $jsonData = \json_decode($output, true, 512, \JSON_THROW_ON_ERROR);
+        $this->assertIsArray($jsonData);
+    }
+
     /**
      * @test
      * @group slow