Add setup check to verify that the used DB version is still supported in the next major release

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
This commit is contained in:
Morris Jobke 2021-01-07 16:26:51 +01:00
parent 6594ca4bbb
commit 349c9ef74f
No known key found for this signature in database
GPG Key ID: FE03C3A163FEDE68
7 changed files with 182 additions and 3 deletions

View File

@ -59,4 +59,5 @@ return array(
'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => $baseDir . '/../lib/SetupChecks/LegacySSEKeyFormat.php', 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => $baseDir . '/../lib/SetupChecks/LegacySSEKeyFormat.php',
'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => $baseDir . '/../lib/SetupChecks/PhpDefaultCharset.php', 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => $baseDir . '/../lib/SetupChecks/PhpDefaultCharset.php',
'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => $baseDir . '/../lib/SetupChecks/PhpOutputBuffering.php', 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => $baseDir . '/../lib/SetupChecks/PhpOutputBuffering.php',
'OCA\\Settings\\SetupChecks\\SupportedDatabase' => $baseDir . '/../lib/SetupChecks/SupportedDatabase.php',
); );

View File

@ -74,6 +74,7 @@ class ComposerStaticInitSettings
'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => __DIR__ . '/..' . '/../lib/SetupChecks/LegacySSEKeyFormat.php', 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => __DIR__ . '/..' . '/../lib/SetupChecks/LegacySSEKeyFormat.php',
'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpDefaultCharset.php', 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpDefaultCharset.php',
'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOutputBuffering.php', 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOutputBuffering.php',
'OCA\\Settings\\SetupChecks\\SupportedDatabase' => __DIR__ . '/..' . '/../lib/SetupChecks/SupportedDatabase.php',
); );
public static function getInitializer(ClassLoader $loader) public static function getInitializer(ClassLoader $loader)

View File

@ -57,6 +57,7 @@ use OC\MemoryInfo;
use OCA\Settings\SetupChecks\LegacySSEKeyFormat; use OCA\Settings\SetupChecks\LegacySSEKeyFormat;
use OCA\Settings\SetupChecks\PhpDefaultCharset; use OCA\Settings\SetupChecks\PhpDefaultCharset;
use OCA\Settings\SetupChecks\PhpOutputBuffering; use OCA\Settings\SetupChecks\PhpOutputBuffering;
use OCA\Settings\SetupChecks\SupportedDatabase;
use OCP\AppFramework\Controller; use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\DataDisplayResponse; use OCP\AppFramework\Http\DataDisplayResponse;
use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\DataResponse;
@ -101,6 +102,8 @@ class CheckSetupController extends Controller {
private $secureRandom; private $secureRandom;
/** @var IniGetWrapper */ /** @var IniGetWrapper */
private $iniGetWrapper; private $iniGetWrapper;
/** @var IDBConnection */
private $connection;
public function __construct($AppName, public function __construct($AppName,
IRequest $request, IRequest $request,
@ -116,7 +119,8 @@ class CheckSetupController extends Controller {
IDateTimeFormatter $dateTimeFormatter, IDateTimeFormatter $dateTimeFormatter,
MemoryInfo $memoryInfo, MemoryInfo $memoryInfo,
ISecureRandom $secureRandom, ISecureRandom $secureRandom,
IniGetWrapper $iniGetWrapper) { IniGetWrapper $iniGetWrapper,
IDBConnection $connection) {
parent::__construct($AppName, $request); parent::__construct($AppName, $request);
$this->config = $config; $this->config = $config;
$this->clientService = $clientService; $this->clientService = $clientService;
@ -131,6 +135,7 @@ class CheckSetupController extends Controller {
$this->memoryInfo = $memoryInfo; $this->memoryInfo = $memoryInfo;
$this->secureRandom = $secureRandom; $this->secureRandom = $secureRandom;
$this->iniGetWrapper = $iniGetWrapper; $this->iniGetWrapper = $iniGetWrapper;
$this->connection = $connection;
} }
/** /**
@ -707,6 +712,7 @@ Raw output
$phpDefaultCharset = new PhpDefaultCharset(); $phpDefaultCharset = new PhpDefaultCharset();
$phpOutputBuffering = new PhpOutputBuffering(); $phpOutputBuffering = new PhpOutputBuffering();
$legacySSEKeyFormat = new LegacySSEKeyFormat($this->l10n, $this->config, $this->urlGenerator); $legacySSEKeyFormat = new LegacySSEKeyFormat($this->l10n, $this->config, $this->urlGenerator);
$supportedDatabases = new SupportedDatabase($this->l10n, $this->connection);
return new DataResponse( return new DataResponse(
[ [
'isGetenvServerWorking' => !empty(getenv('PATH')), 'isGetenvServerWorking' => !empty(getenv('PATH')),
@ -751,6 +757,7 @@ Raw output
PhpDefaultCharset::class => ['pass' => $phpDefaultCharset->run(), 'description' => $phpDefaultCharset->description(), 'severity' => $phpDefaultCharset->severity()], PhpDefaultCharset::class => ['pass' => $phpDefaultCharset->run(), 'description' => $phpDefaultCharset->description(), 'severity' => $phpDefaultCharset->severity()],
PhpOutputBuffering::class => ['pass' => $phpOutputBuffering->run(), 'description' => $phpOutputBuffering->description(), 'severity' => $phpOutputBuffering->severity()], PhpOutputBuffering::class => ['pass' => $phpOutputBuffering->run(), 'description' => $phpOutputBuffering->description(), 'severity' => $phpOutputBuffering->severity()],
LegacySSEKeyFormat::class => ['pass' => $legacySSEKeyFormat->run(), 'description' => $legacySSEKeyFormat->description(), 'severity' => $legacySSEKeyFormat->severity(), 'linkToDocumentation' => $legacySSEKeyFormat->linkToDocumentation()], LegacySSEKeyFormat::class => ['pass' => $legacySSEKeyFormat->run(), 'description' => $legacySSEKeyFormat->description(), 'severity' => $legacySSEKeyFormat->severity(), 'linkToDocumentation' => $legacySSEKeyFormat->linkToDocumentation()],
SupportedDatabase::class => ['pass' => $supportedDatabases->run(), 'description' => $supportedDatabases->description(), 'severity' => $supportedDatabases->severity()],
] ]
); );
} }

View File

@ -0,0 +1,112 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2021 Morris Jobke <hey@morrisjobke.de>
*
* @author Morris Jobke <hey@morrisjobke.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Settings\SetupChecks;
use Doctrine\DBAL\Platforms\MariaDb1027Platform;
use Doctrine\DBAL\Platforms\MySQL57Platform;
use Doctrine\DBAL\Platforms\MySQL80Platform;
use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Platforms\OraclePlatform;
use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
use Doctrine\DBAL\Platforms\SqlitePlatform;
use OCP\IDBConnection;
use OCP\IL10N;
class SupportedDatabase {
/** @var IL10N */
private $l10n;
/** @var IDBConnection */
private $connection;
private $checked = false;
private $description = '';
public function __construct(IL10N $l10n, IDBConnection $connection) {
$this->l10n = $l10n;
$this->connection = $connection;
}
public function check() {
if ($this->checked === true) {
return;
}
$this->checked = true;
switch (get_class($this->connection->getDatabasePlatform())) {
case MySQL80Platform::class: # extends MySQL57Platform
case MySQL57Platform::class: # extends MySQLPlatform
case MariaDb1027Platform::class: # extends MySQLPlatform
case MySqlPlatform::class:
$result = $this->connection->prepare('SHOW VARIABLES LIKE "version";');
$result->execute();
$row = $result->fetch();
$version = strtolower($row['Value']);
if (strpos($version, 'mariadb') !== false) {
if (version_compare($version, '10.2', '<')) {
$this->description = $this->l10n->t('MariaDB version "%s" is used. Nextcloud 21 will no longer support this version and requires MariaDB 10.2 or higher.', $row['Value']);
return;
}
} else {
if (version_compare($version, '8', '<')) {
$this->description = $this->l10n->t('MySQL version "%s" is used. Nextcloud 21 will no longer support this version and requires MySQL 8 or higher.', $row['Value']);
return;
}
}
break;
case SqlitePlatform::class:
break;
case PostgreSQL100Platform::class: # extends PostgreSQL94Platform
case PostgreSQL94Platform::class:
$result = $this->connection->prepare('SHOW server_version;');
$result->execute();
$row = $result->fetch();
if (version_compare($row['server_version'], '9.6', '<')) {
$this->description = $this->l10n->t('PostgreSQL version "%s" is used. Nextcloud 21 will no longer support this version and requires PostgreSQL 9.6 or higher.', $row['server_version']);
return;
}
break;
case OraclePlatform::class:
break;
}
}
public function description(): string {
$this->check();
return $this->description;
}
public function severity(): string {
return 'info';
}
public function run(): bool {
$this->check();
return $this->description === '';
}
}

View File

@ -35,6 +35,7 @@
namespace OCA\Settings\Tests\Controller; namespace OCA\Settings\Tests\Controller;
use bantu\IniGetWrapper\IniGetWrapper; use bantu\IniGetWrapper\IniGetWrapper;
use Doctrine\DBAL\Platforms\SqlitePlatform;
use OC; use OC;
use OC\DB\Connection; use OC\DB\Connection;
use OC\IntegrityCheck\Checker; use OC\IntegrityCheck\Checker;
@ -48,6 +49,7 @@ use OCP\AppFramework\Http\RedirectResponse;
use OCP\Http\Client\IClientService; use OCP\Http\Client\IClientService;
use OCP\IConfig; use OCP\IConfig;
use OCP\IDateTimeFormatter; use OCP\IDateTimeFormatter;
use OCP\IDBConnection;
use OCP\IL10N; use OCP\IL10N;
use OCP\ILogger; use OCP\ILogger;
use OCP\IRequest; use OCP\IRequest;
@ -95,6 +97,8 @@ class CheckSetupControllerTest extends TestCase {
private $secureRandom; private $secureRandom;
/** @var IniGetWrapper|\PHPUnit\Framework\MockObject\MockObject */ /** @var IniGetWrapper|\PHPUnit\Framework\MockObject\MockObject */
private $iniGetWrapper; private $iniGetWrapper;
/** @var IDBConnection|\PHPUnit\Framework\MockObject\MockObject */
private $connection;
/** /**
* Holds a list of directories created during tests. * Holds a list of directories created during tests.
@ -135,6 +139,8 @@ class CheckSetupControllerTest extends TestCase {
->getMock(); ->getMock();
$this->secureRandom = $this->getMockBuilder(SecureRandom::class)->getMock(); $this->secureRandom = $this->getMockBuilder(SecureRandom::class)->getMock();
$this->iniGetWrapper = $this->getMockBuilder(IniGetWrapper::class)->getMock(); $this->iniGetWrapper = $this->getMockBuilder(IniGetWrapper::class)->getMock();
$this->connection = $this->getMockBuilder(IDBConnection::class)
->disableOriginalConstructor()->getMock();
$this->checkSetupController = $this->getMockBuilder(CheckSetupController::class) $this->checkSetupController = $this->getMockBuilder(CheckSetupController::class)
->setConstructorArgs([ ->setConstructorArgs([
'settings', 'settings',
@ -152,6 +158,7 @@ class CheckSetupControllerTest extends TestCase {
$this->memoryInfo, $this->memoryInfo,
$this->secureRandom, $this->secureRandom,
$this->iniGetWrapper, $this->iniGetWrapper,
$this->connection,
]) ])
->setMethods([ ->setMethods([
'isReadOnlyConfig', 'isReadOnlyConfig',
@ -553,6 +560,9 @@ class CheckSetupControllerTest extends TestCase {
} }
return ''; return '';
}); });
$sqlitePlatform = $this->getMockBuilder(SqlitePlatform::class)->getMock();
$this->connection->method('getDatabasePlatform')
->willReturn($sqlitePlatform);
$expected = new DataResponse( $expected = new DataResponse(
[ [
@ -605,6 +615,7 @@ class CheckSetupControllerTest extends TestCase {
'OCA\Settings\SetupChecks\PhpDefaultCharset' => ['pass' => true, 'description' => 'PHP configuration option default_charset should be UTF-8', 'severity' => 'warning'], 'OCA\Settings\SetupChecks\PhpDefaultCharset' => ['pass' => true, 'description' => 'PHP configuration option default_charset should be UTF-8', 'severity' => 'warning'],
'OCA\Settings\SetupChecks\PhpOutputBuffering' => ['pass' => true, 'description' => 'PHP configuration option output_buffering must be disabled', 'severity' => 'error'], 'OCA\Settings\SetupChecks\PhpOutputBuffering' => ['pass' => true, 'description' => 'PHP configuration option output_buffering must be disabled', 'severity' => 'error'],
'OCA\Settings\SetupChecks\LegacySSEKeyFormat' => ['pass' => true, 'description' => 'The old server-side-encryption format is enabled. We recommend disabling this.', 'severity' => 'warning', 'linkToDocumentation' => ''], 'OCA\Settings\SetupChecks\LegacySSEKeyFormat' => ['pass' => true, 'description' => 'The old server-side-encryption format is enabled. We recommend disabling this.', 'severity' => 'warning', 'linkToDocumentation' => ''],
'OCA\Settings\SetupChecks\SupportedDatabase' => ['pass' => true, 'description' => '', 'severity' => 'info'],
] ]
); );
$this->assertEquals($expected, $this->checkSetupController->check()); $this->assertEquals($expected, $this->checkSetupController->check());
@ -628,6 +639,7 @@ class CheckSetupControllerTest extends TestCase {
$this->memoryInfo, $this->memoryInfo,
$this->secureRandom, $this->secureRandom,
$this->iniGetWrapper, $this->iniGetWrapper,
$this->connection,
]) ])
->setMethods(null)->getMock(); ->setMethods(null)->getMock();
@ -662,6 +674,7 @@ class CheckSetupControllerTest extends TestCase {
$this->memoryInfo, $this->memoryInfo,
$this->secureRandom, $this->secureRandom,
$this->iniGetWrapper, $this->iniGetWrapper,
$this->connection,
]) ])
->setMethods(null)->getMock(); ->setMethods(null)->getMock();
@ -1430,7 +1443,8 @@ Array
$this->dateTimeFormatter, $this->dateTimeFormatter,
$this->memoryInfo, $this->memoryInfo,
$this->secureRandom, $this->secureRandom,
$this->iniGetWrapper $this->iniGetWrapper,
$this->connection
); );
$this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isMysqlUsedWithoutUTF8MB4')); $this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isMysqlUsedWithoutUTF8MB4'));
@ -1479,7 +1493,8 @@ Array
$this->dateTimeFormatter, $this->dateTimeFormatter,
$this->memoryInfo, $this->memoryInfo,
$this->secureRandom, $this->secureRandom,
$this->iniGetWrapper $this->iniGetWrapper,
$this->connection
); );
$this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed')); $this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed'));

View File

@ -0,0 +1,42 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2021 Morris Jobke <hey@morrisjobke.de>
*
* @author Morris Jobke <hey@morrisjobke.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Settings\Tests;
use OCA\Settings\SetupChecks\SupportedDatabase;
use OCP\IL10N;
use Test\TestCase;
/**
* @group DB
*/
class SupportedDatabaseTest extends TestCase {
public function testPass(): void {
$l10n = $this->getMockBuilder(IL10N::class)->getMock();
$check = new SupportedDatabase($l10n, \OC::$server->getDatabaseConnection());
$this->assertTrue($check->run());
}
}

View File

@ -506,6 +506,7 @@
OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset', messages) OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset', messages)
OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering', messages) OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering', messages)
OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat', messages) OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat', messages)
OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\SupportedDatabase', messages)
} else { } else {
messages.push({ messages.push({