nextcloud/core/Command/SetupChecks.php
Côme Chilliet 39d2970191
Add $name property in SetupResult and improve API
Keys for check results are not locale dependent anymore, the name of the
 setup check is instead stored in the setup result object.

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
2023-11-07 14:15:47 +01:00

95 lines
2.7 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Côme Chilliet <come.chilliet@nextcloud.com>
*
* @author Côme Chilliet <come.chilliet@nextcloud.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Core\Command;
use OCP\SetupCheck\ISetupCheckManager;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
class SetupChecks extends Base {
public function __construct(
private ISetupCheckManager $setupCheckManager,
) {
parent::__construct();
}
protected function configure(): void {
parent::configure();
$this
->setName('setupchecks')
->setDescription('Run setup checks and output the results')
;
}
protected function execute(InputInterface $input, OutputInterface $output): int {
$results = $this->setupCheckManager->runAll();
switch ($input->getOption('output')) {
case self::OUTPUT_FORMAT_JSON:
case self::OUTPUT_FORMAT_JSON_PRETTY:
$this->writeArrayInOutputFormat($input, $output, $results);
break;
default:
foreach ($results as $category => $checks) {
$output->writeln("\t{$category}:");
foreach ($checks as $check) {
$styleTag = match ($check->getSeverity()) {
'success' => 'info',
'error' => 'error',
'warning' => 'comment',
default => null,
};
$emoji = match ($check->getSeverity()) {
'success' => '✓',
'error' => '✗',
'warning' => '⚠',
default => '',
};
$verbosity = ($check->getSeverity() === 'error' ? OutputInterface::VERBOSITY_QUIET : OutputInterface::VERBOSITY_NORMAL);
$description = $check->getDescription();
$output->writeln(
"\t\t".
($styleTag !== null ? "<{$styleTag}>" : '').
"{$emoji} ".
($check->getName() ?? $check::class).
($description !== null ? ': '.$description : '').
($styleTag !== null ? "</{$styleTag}>" : ''),
$verbosity
);
}
}
}
foreach ($results as $category => $checks) {
foreach ($checks as $check) {
if ($check->getSeverity() !== 'success') {
return self::FAILURE;
}
}
}
return self::SUCCESS;
}
}