wiki.techinc.nl/tests/phpunit/unit/includes/libs/rdbms/database/QueryBuilderFromRawSqlTest.php
Timo Tijhof 9153336c7b rdbms: Widen @covers tags in phpunit tests
> Given all called methods are de-facto and liberally claimed, and
> that we keep the coverage limited to the subject class, it maintains
> the spirit and intent by listing the class explicitly instead.
>
> PHPUnit offers a more precise tool when you need it (i.e. when testing
> legacy monster/god classes), but for well-written code, the
> class-wide tag is exactly what you want.
>
> We lose useful coverage and waste valuable time on keeping tags
> accurate through refactors (or worse, forget to do so).
> Tracking tiny per-method details wastes time in realizing (and
> fixing) when people inevitably don't keep them in sync, and time
> lost in finding uncovered code to write tests to realize it was
> already covered but "not yet claimed".

Ref https://gerrit.wikimedia.org/r/q/owner:Krinkle+is:merged+message:Widen

Change-Id: I0fcbdb2936130b725000a899d733ec306e93b273
2024-06-11 22:47:42 +00:00

148 lines
3.6 KiB
PHP

<?php
namespace Wikimedia\Tests\Rdbms;
use MediaWikiUnitTestCase;
use Wikimedia\Rdbms\Platform\SQLPlatform;
use Wikimedia\Rdbms\QueryBuilderFromRawSql;
/**
* @covers \Wikimedia\Rdbms\QueryBuilderFromRawSql
*/
class QueryBuilderFromRawSqlTest extends MediaWikiUnitTestCase {
/**
* @dataProvider provideBuildQuery
*/
public function testBuildQuery( $sql, $expectedVerb, $expectedFlags ) {
$query = QueryBuilderFromRawSql::buildQuery( $sql, 0 );
$this->assertSame( $expectedVerb, $query->getVerb() );
$this->assertSame( $expectedFlags, $query->getFlags() );
}
public function provideBuildQuery() {
return [
[
'SELECT * FROM foo',
'SELECT', SQLPlatform::QUERY_CHANGE_NONE,
],
[
'SELECT * FROM foo LOCK IN SHARE MODE',
// should probably be QUERY_CHANGE_LOCKS but this is how we handle it today
'SELECT', SQLPlatform::QUERY_CHANGE_NONE,
],
[
'SELECT * FROM foo FOR UPDATE',
// should probably be QUERY_CHANGE_LOCKS but this is how we handle it today
'SELECT', SQLPlatform::QUERY_CHANGE_ROWS,
],
[
'INSERT INTO foo VALUES (1)',
'INSERT', SQLPlatform::QUERY_CHANGE_ROWS,
],
[
'INSERT INTO foo (SELECT * FROM bar)',
'INSERT', SQLPlatform::QUERY_CHANGE_ROWS,
],
[
'UPDATE foo SET bar = 1',
'UPDATE', SQLPlatform::QUERY_CHANGE_ROWS,
],
[
'DELETE FROM foo',
'DELETE', SQLPlatform::QUERY_CHANGE_ROWS,
],
[
'EXPLAIN INSERT INTO foo VALUES (1)',
'EXPLAIN', SQLPlatform::QUERY_CHANGE_NONE,
],
[
'BEGIN',
'BEGIN', SQLPlatform::QUERY_CHANGE_TRX,
],
[
'COMMIT',
'COMMIT', SQLPlatform::QUERY_CHANGE_TRX,
],
[
'ROLLBACK',
'ROLLBACK', SQLPlatform::QUERY_CHANGE_TRX,
],
[
'SAVEPOINT foo',
'SAVEPOINT', SQLPlatform::QUERY_CHANGE_TRX,
],
[
'RELEASE SAVEPOINT foo',
'RELEASE SAVEPOINT', SQLPlatform::QUERY_CHANGE_TRX,
],
[
'ROLLBACK TO SAVEPOINT foo',
'ROLLBACK TO SAVEPOINT', SQLPlatform::QUERY_CHANGE_TRX,
],
// Most DDL test cases don't match the documentation of Query::__construct() but
// they are accurate representation of the current logic.
[
'CREATE TABLE foo (id INT)',
'CREATE', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'CREATE TEMPORARY TABLE foo (id INT)',
'CREATE TEMPORARY', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'CREATE INDEX foo ON bar (baz)',
'CREATE INDEX', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'DROP TABLE foo',
'DROP', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'DROP INDEX foo ON bar',
'DROP INDEX', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'ALTER TABLE foo ADD COLUMN bar INT',
'ALTER', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'CREATE DATABASE foo',
'CREATE DATABASE', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'ALTER DATABASE foo',
'ALTER DATABASE', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
[
'DROP DATABASE foo',
'DROP DATABASE', SQLPlatform::QUERY_CHANGE_SCHEMA,
],
];
}
/**
* @param string $sql
* @param bool $res
* @dataProvider provideIsWriteQuery
*/
public function testIsWriteQuery( string $sql, bool $res ) {
$query = QueryBuilderFromRawSql::buildQuery( $sql, 0 );
$this->assertSame( $res, $query->isWriteQuery() );
}
public static function provideIsWriteQuery(): array {
return [
[ 'SELECT foo', false ],
[ ' SELECT foo FROM bar', false ],
[ 'BEGIN', false ],
[ 'SHOW EXPLAIN FOR 12;', false ],
[ 'USE foobar', false ],
[ '(SELECT 1)', false ],
[ 'INSERT INTO foo', true ],
[ 'TRUNCATE bar', true ],
[ 'DELETE FROM baz', true ],
[ 'CREATE TABLE foobar', true ]
];
}
}