Merge pull request #41081 from nextcloud/feat/add-occ-command-for-set…

…upchecks Add a command to run the setup checks from CLI
nextcloud · Nov 6, 2023 · f412c8d · f412c8d
2 parents 4154ba3 + 3cdb059
commit f412c8d
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 0 deletions.
diff --git a/core/Command/SetupChecks.php b/core/Command/SetupChecks.php
@@ -0,0 +1,94 @@
+<?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 $title => $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} ".
+							$title.
+							($description !== null ? ': '.$description : '').
+							($styleTag !== null ? "</{$styleTag}>" : ''),
+							$verbosity
+						);
+					}
+				}
+		}
+		foreach ($results as $category => $checks) {
+			foreach ($checks as $title => $check) {
+				if ($check->getSeverity() !== 'success') {
+					return self::FAILURE;
+				}
+			}
+		}
+		return self::SUCCESS;
+	}
+}
diff --git a/core/register_command.php b/core/register_command.php
@@ -214,6 +214,7 @@
 	$application->add(new OC\Core\Command\Security\RemoveCertificate(\OC::$server->getCertificateManager()));
 	$application->add(\OC::$server->get(\OC\Core\Command\Security\BruteforceAttempts::class));
 	$application->add(\OC::$server->get(\OC\Core\Command\Security\BruteforceResetAttempts::class));
+	$application->add(\OC::$server->get(\OC\Core\Command\SetupChecks::class));
 } else {
 	$application->add(\OC::$server->get(\OC\Core\Command\Maintenance\Install::class));
 }
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
@@ -1059,6 +1059,7 @@
     'OC\\Core\\Command\\Security\\ImportCertificate' => $baseDir . '/core/Command/Security/ImportCertificate.php',
     'OC\\Core\\Command\\Security\\ListCertificates' => $baseDir . '/core/Command/Security/ListCertificates.php',
     'OC\\Core\\Command\\Security\\RemoveCertificate' => $baseDir . '/core/Command/Security/RemoveCertificate.php',
+    'OC\\Core\\Command\\SetupChecks' => $baseDir . '/core/Command/SetupChecks.php',
     'OC\\Core\\Command\\Status' => $baseDir . '/core/Command/Status.php',
     'OC\\Core\\Command\\SystemTag\\Add' => $baseDir . '/core/Command/SystemTag/Add.php',
     'OC\\Core\\Command\\SystemTag\\Delete' => $baseDir . '/core/Command/SystemTag/Delete.php',

diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
@@ -1092,6 +1092,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Core\\Command\\Security\\ImportCertificate' => __DIR__ . '/../../..' . '/core/Command/Security/ImportCertificate.php',
         'OC\\Core\\Command\\Security\\ListCertificates' => __DIR__ . '/../../..' . '/core/Command/Security/ListCertificates.php',
         'OC\\Core\\Command\\Security\\RemoveCertificate' => __DIR__ . '/../../..' . '/core/Command/Security/RemoveCertificate.php',
+        'OC\\Core\\Command\\SetupChecks' => __DIR__ . '/../../..' . '/core/Command/SetupChecks.php',
         'OC\\Core\\Command\\Status' => __DIR__ . '/../../..' . '/core/Command/Status.php',
         'OC\\Core\\Command\\SystemTag\\Add' => __DIR__ . '/../../..' . '/core/Command/SystemTag/Add.php',
         'OC\\Core\\Command\\SystemTag\\Delete' => __DIR__ . '/../../..' . '/core/Command/SystemTag/Delete.php',