tests: Split out DatabaseSqliteUpgradeTest class
The testUpgrades() method is slow and is easier to parallelize via paratest if it lies in a separate class/file Also make the test use a data provider Bug: T50217 Change-Id: I5c8df6ae0ff34941f4cf7275680b309e79565925
This commit is contained in:
Aaron Schulz
parent
b2ab37286a
commit
277d34818b
2 changed files with 268 additions and 98 deletions
|
|
@ -17,6 +17,9 @@ class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
|
|||
/** @var DatabaseSqlite */
|
||||
protected $db;
|
||||
|
||||
/** @var array|null */
|
||||
protected $currentTableInfo;
|
||||
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
|
||||
|
|
@ -48,7 +51,7 @@ class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
|
|||
'agent' => 'unit-tests',
|
||||
'serverName' => null,
|
||||
'flags' => DBO_DEFAULT,
|
||||
'variables' => [],
|
||||
'variables' => [ 'synchronous' => 'NORMAL', 'temp_store' => 'MEMORY' ],
|
||||
'profiler' => null,
|
||||
'topologyRole' => Database::ROLE_STREAMING_MASTER,
|
||||
'topologicalMaster' => null,
|
||||
|
|
@ -333,87 +336,6 @@ class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
|
|||
$this->assertTrue( $result, $result );
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs upgrades of older databases and compares results with current schema
|
||||
* @coversNothing
|
||||
*/
|
||||
public function testUpgrades() {
|
||||
global $IP;
|
||||
|
||||
// Versions tested
|
||||
$versions = [
|
||||
'1.29',
|
||||
'1.30',
|
||||
'1.31',
|
||||
'1.32',
|
||||
'1.33',
|
||||
'1.34',
|
||||
'1.35',
|
||||
'1.36',
|
||||
'1.37',
|
||||
];
|
||||
|
||||
// Mismatches for these columns we can safely ignore
|
||||
$ignoredColumns = [];
|
||||
|
||||
$currentDB = DatabaseSqlite::newStandaloneInstance( ':memory:' );
|
||||
$currentDB->sourceFile( "$IP/maintenance/tables.sql" );
|
||||
$currentDB->sourceFile( "$IP/maintenance/sqlite/tables-generated.sql" );
|
||||
|
||||
$currentTables = $this->getTables( $currentDB );
|
||||
sort( $currentTables );
|
||||
|
||||
foreach ( $versions as $version ) {
|
||||
$versions = "upgrading from $version to " . MW_VERSION;
|
||||
$db = $this->prepareTestDB( $version );
|
||||
$tables = $this->getTables( $db );
|
||||
$this->assertEquals( $currentTables, $tables, "Different tables $versions" );
|
||||
foreach ( $tables as $table ) {
|
||||
$currentCols = $this->getColumns( $currentDB, $table );
|
||||
$cols = $this->getColumns( $db, $table );
|
||||
$this->assertEquals(
|
||||
array_keys( $currentCols ),
|
||||
array_keys( $cols ),
|
||||
"Mismatching columns for table \"$table\" $versions"
|
||||
);
|
||||
foreach ( $currentCols as $name => $column ) {
|
||||
$fullName = "$table.$name";
|
||||
$this->assertEquals(
|
||||
(bool)$column->pk,
|
||||
(bool)$cols[$name]->pk,
|
||||
"PRIMARY KEY status does not match for column $fullName $versions"
|
||||
);
|
||||
if ( !in_array( $fullName, $ignoredColumns ) ) {
|
||||
$this->assertEquals(
|
||||
(bool)$column->notnull,
|
||||
(bool)$cols[$name]->notnull,
|
||||
"NOT NULL status does not match for column $fullName $versions"
|
||||
);
|
||||
if ( $cols[$name]->dflt_value === 'NULL' ) {
|
||||
$cols[$name]->dflt_value = null;
|
||||
}
|
||||
if ( $column->dflt_value === 'NULL' ) {
|
||||
$column->dflt_value = null;
|
||||
}
|
||||
$this->assertEquals(
|
||||
$column->dflt_value,
|
||||
$cols[$name]->dflt_value,
|
||||
"Default values does not match for column $fullName $versions"
|
||||
);
|
||||
}
|
||||
}
|
||||
$currentIndexes = $this->getIndexes( $currentDB, $table );
|
||||
$indexes = $this->getIndexes( $db, $table );
|
||||
$this->assertEquals(
|
||||
array_keys( $currentIndexes ),
|
||||
array_keys( $indexes ),
|
||||
"mismatching indexes for table \"$table\" $versions"
|
||||
);
|
||||
}
|
||||
$db->close();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers DatabaseSqlite::insertId
|
||||
*/
|
||||
|
|
@ -452,7 +374,7 @@ class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
|
|||
$this->assertTrue( $db->close(), "closing database" );
|
||||
}
|
||||
|
||||
private function prepareTestDB( $version ) {
|
||||
private function initAndUpgradeTestDB( $startingVersion ) {
|
||||
static $maint = null;
|
||||
if ( $maint === null ) {
|
||||
$maint = new FakeMaintenance();
|
||||
|
|
@ -461,7 +383,7 @@ class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
|
|||
|
||||
global $IP;
|
||||
$db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
|
||||
$db->sourceFile( "$IP/tests/phpunit/data/db/sqlite/tables-$version.sql" );
|
||||
$db->sourceFile( "$IP/tests/phpunit/data/db/sqlite/tables-$startingVersion.sql" );
|
||||
$updater = DatabaseUpdater::newForDB( $db, false, $maint );
|
||||
$updater->doUpdates( [ 'core' ] );
|
||||
|
||||
|
|
@ -469,20 +391,18 @@ class DatabaseSqliteTest extends \MediaWikiIntegrationTestCase {
|
|||
}
|
||||
|
||||
private function getTables( $db ) {
|
||||
$list = array_flip( $db->listTables() );
|
||||
$excluded = [
|
||||
'external_user', // removed from core in 1.22
|
||||
'math', // moved out of core in 1.18
|
||||
'trackbacks', // removed from core in 1.19
|
||||
'searchindex',
|
||||
'searchindex_content',
|
||||
'searchindex_segments',
|
||||
'searchindex_segdir',
|
||||
];
|
||||
foreach ( $excluded as $t ) {
|
||||
unset( $list[$t] );
|
||||
}
|
||||
$list = array_flip( $list );
|
||||
$list = array_diff(
|
||||
$db->listTables(),
|
||||
[
|
||||
'external_user', // removed from core in 1.22
|
||||
'math', // moved out of core in 1.18
|
||||
'trackbacks', // removed from core in 1.19
|
||||
'searchindex',
|
||||
'searchindex_content',
|
||||
'searchindex_segments',
|
||||
'searchindex_segdir',
|
||||
]
|
||||
);
|
||||
sort( $list );
|
||||
|
||||
return $list;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,250 @@
|
|||
<?php
|
||||
|
||||
use Psr\Log\NullLogger;
|
||||
use Wikimedia\Rdbms\Database;
|
||||
use Wikimedia\Rdbms\DatabaseSqlite;
|
||||
use Wikimedia\Rdbms\TransactionProfiler;
|
||||
|
||||
/**
|
||||
* @group sqlite
|
||||
* @group Database
|
||||
* @group medium
|
||||
*/
|
||||
class DatabaseSqliteUpgradeTest extends \MediaWikiIntegrationTestCase {
|
||||
/** @var DatabaseSqlite */
|
||||
protected $db;
|
||||
|
||||
/** @var array|null */
|
||||
protected $currentSchema;
|
||||
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
|
||||
if ( !Sqlite::isPresent() ) {
|
||||
$this->markTestSkipped( 'No SQLite support detected' );
|
||||
}
|
||||
$this->db = $this->newMockDb();
|
||||
if ( version_compare( $this->db->getServerVersion(), '3.6.0', '<' ) ) {
|
||||
$this->markTestSkipped( "SQLite at least 3.6 required, {$this->db->getServerVersion()} found" );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|null $version
|
||||
* @param string|null &$sqlDump
|
||||
* @return \PHPUnit\Framework\MockObject\MockObject|DatabaseSqlite
|
||||
*/
|
||||
private function newMockDb( $version = null, &$sqlDump = null ) {
|
||||
$mock = $this->getMockBuilder( DatabaseSqlite::class )
|
||||
->setConstructorArgs( [ [
|
||||
'dbFilePath' => ':memory:',
|
||||
'dbname' => 'Foo',
|
||||
'schema' => null,
|
||||
'host' => false,
|
||||
'user' => false,
|
||||
'password' => false,
|
||||
'tablePrefix' => '',
|
||||
'cliMode' => true,
|
||||
'agent' => 'unit-tests',
|
||||
'serverName' => null,
|
||||
'flags' => DBO_DEFAULT,
|
||||
'variables' => [ 'synchronous' => 'NORMAL', 'temp_store' => 'MEMORY' ],
|
||||
'profiler' => null,
|
||||
'topologyRole' => Database::ROLE_STREAMING_MASTER,
|
||||
'topologicalMaster' => null,
|
||||
'trxProfiler' => new TransactionProfiler(),
|
||||
'connLogger' => new NullLogger(),
|
||||
'queryLogger' => new NullLogger(),
|
||||
'replLogger' => new NullLogger(),
|
||||
'errorLogger' => null,
|
||||
'deprecationLogger' => new NullLogger(),
|
||||
'srvCache' => new HashBagOStuff(),
|
||||
] ] )->onlyMethods( array_merge(
|
||||
[ 'query' ],
|
||||
$version ? [ 'getServerVersion' ] : []
|
||||
) )->getMock();
|
||||
|
||||
$mock->initConnection();
|
||||
|
||||
$sqlDump = '';
|
||||
$mock->method( 'query' )->willReturnCallback( static function ( $sql ) use ( &$sqlDump ) {
|
||||
$sqlDump .= "$sql;";
|
||||
|
||||
return true;
|
||||
} );
|
||||
|
||||
if ( $version ) {
|
||||
$mock->method( 'getServerVersion' )->willReturn( $version );
|
||||
}
|
||||
|
||||
return $mock;
|
||||
}
|
||||
|
||||
/**
|
||||
* @coversNothing
|
||||
*/
|
||||
public function testEntireSchema() {
|
||||
$result = Sqlite::checkSqlSyntax( dirname( __FILE__, 6 ) . "/maintenance/tables.sql" );
|
||||
if ( $result !== true ) {
|
||||
$this->fail( $result );
|
||||
}
|
||||
$this->assertTrue( true ); // avoid test being marked as incomplete due to lack of assertions
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs upgrades of older databases and compares results with current schema
|
||||
* @coversNothing
|
||||
* @param string $version
|
||||
* @dataProvider provideSupportedVersions
|
||||
*/
|
||||
public function testUpgradeFromVersion( string $version ) {
|
||||
$currentSchema =& $this->currentSchema;
|
||||
if ( $currentSchema === null ) {
|
||||
$currentDB = $this->initAndUpgradeTestDB( null );
|
||||
$currentSchema = [];
|
||||
foreach ( $this->getTables( $currentDB ) as $table ) {
|
||||
$currentSchema[$table] = [
|
||||
'columns' => $this->getColumns( $currentDB, $table ),
|
||||
'indexes' => $this->getIndexes( $currentDB, $table )
|
||||
];
|
||||
}
|
||||
$currentDB->close();
|
||||
}
|
||||
|
||||
// Mismatches for these columns we can safely ignore
|
||||
$ignoredColumns = [];
|
||||
|
||||
$versions = "upgrading from $version to " . MW_VERSION;
|
||||
$db = $this->initAndUpgradeTestDB( $version );
|
||||
$tables = $this->getTables( $db );
|
||||
|
||||
$this->assertEquals( array_keys( $currentSchema ), $tables, "Different tables $versions" );
|
||||
|
||||
foreach ( $tables as $table ) {
|
||||
$cols = $this->getColumns( $db, $table );
|
||||
$this->assertEquals(
|
||||
array_keys( $currentSchema[$table]['columns'] ),
|
||||
array_keys( $cols ),
|
||||
"Mismatching columns for table \"$table\" $versions"
|
||||
);
|
||||
|
||||
foreach ( $currentSchema[$table]['columns'] as $name => $column ) {
|
||||
$fullName = "$table.$name";
|
||||
$this->assertEquals(
|
||||
(bool)$column->pk,
|
||||
(bool)$cols[$name]->pk,
|
||||
"PRIMARY KEY status does not match for column $fullName $versions"
|
||||
);
|
||||
if ( !in_array( $fullName, $ignoredColumns ) ) {
|
||||
$this->assertEquals(
|
||||
(bool)$column->notnull,
|
||||
(bool)$cols[$name]->notnull,
|
||||
"NOT NULL status does not match for column $fullName $versions"
|
||||
);
|
||||
if ( $cols[$name]->dflt_value === 'NULL' ) {
|
||||
$cols[$name]->dflt_value = null;
|
||||
}
|
||||
if ( $column->dflt_value === 'NULL' ) {
|
||||
$column->dflt_value = null;
|
||||
}
|
||||
$this->assertEquals(
|
||||
$column->dflt_value,
|
||||
$cols[$name]->dflt_value,
|
||||
"Default values does not match for column $fullName $versions"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$indexes = $this->getIndexes( $db, $table );
|
||||
$this->assertEquals(
|
||||
array_keys( $currentSchema[$table]['indexes'] ),
|
||||
array_keys( $indexes ),
|
||||
"mismatching indexes for table \"$table\" $versions"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public function provideSupportedVersions() {
|
||||
return [
|
||||
[ '1.29' ],
|
||||
[ '1.30' ],
|
||||
[ '1.31' ],
|
||||
[ '1.32' ],
|
||||
[ '1.33' ],
|
||||
[ '1.34' ],
|
||||
[ '1.35' ],
|
||||
[ '1.36' ],
|
||||
[ '1.37' ]
|
||||
];
|
||||
}
|
||||
|
||||
private function initAndUpgradeTestDB( $version = null ) {
|
||||
static $maint = null;
|
||||
|
||||
if ( $maint === null ) {
|
||||
$maint = new FakeMaintenance();
|
||||
$maint->loadParamsAndArgs( null, [ 'quiet' => 1 ] );
|
||||
}
|
||||
|
||||
$p = [ 'variables' => [ 'synchronous' => 'NORMAL', 'temp_store' => 'MEMORY' ] ];
|
||||
$db = DatabaseSqlite::newStandaloneInstance( ':memory:', $p );
|
||||
if ( $version !== null ) {
|
||||
$db->sourceFile( dirname( __FILE__, 6 ) . "/tests/phpunit/data/db/sqlite/tables-$version.sql" );
|
||||
$updater = DatabaseUpdater::newForDB( $db, false, $maint );
|
||||
$updater->doUpdates( [ 'core' ] );
|
||||
} else {
|
||||
$db->sourceFile( dirname( __FILE__, 6 ) . "/maintenance/tables.sql" );
|
||||
$db->sourceFile( dirname( __FILE__, 6 ) . "/maintenance/sqlite/tables-generated.sql" );
|
||||
}
|
||||
|
||||
return $db;
|
||||
}
|
||||
|
||||
private function getTables( $db ) {
|
||||
$list = array_diff(
|
||||
$db->listTables(),
|
||||
[
|
||||
'external_user', // removed from core in 1.22
|
||||
'math', // moved out of core in 1.18
|
||||
'trackbacks', // removed from core in 1.19
|
||||
'searchindex',
|
||||
'searchindex_content',
|
||||
'searchindex_segments',
|
||||
'searchindex_segdir',
|
||||
]
|
||||
);
|
||||
sort( $list );
|
||||
|
||||
return $list;
|
||||
}
|
||||
|
||||
private function getColumns( $db, $table ) {
|
||||
$cols = [];
|
||||
$res = $db->query( "PRAGMA table_info($table)" );
|
||||
$this->assertNotNull( $res );
|
||||
foreach ( $res as $col ) {
|
||||
$cols[$col->name] = $col;
|
||||
}
|
||||
ksort( $cols );
|
||||
|
||||
return $cols;
|
||||
}
|
||||
|
||||
private function getIndexes( $db, $table ) {
|
||||
$indexes = [];
|
||||
$res = $db->query( "PRAGMA index_list($table)" );
|
||||
$this->assertNotNull( $res );
|
||||
foreach ( $res as $index ) {
|
||||
$res2 = $db->query( "PRAGMA index_info({$index->name})" );
|
||||
$this->assertNotNull( $res2 );
|
||||
$index->columns = [];
|
||||
foreach ( $res2 as $col ) {
|
||||
$index->columns[] = $col;
|
||||
}
|
||||
$indexes[$index->name] = $index;
|
||||
}
|
||||
ksort( $indexes );
|
||||
|
||||
return $indexes;
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue