3 use Wikimedia\Rdbms\IDatabase
;
4 use Wikimedia\Rdbms\LikeMatch
;
5 use Wikimedia\Rdbms\Database
;
6 use Wikimedia\TestingAccessWrapper
;
7 use Wikimedia\Rdbms\DBTransactionStateError
;
8 use Wikimedia\Rdbms\DBUnexpectedError
;
9 use Wikimedia\Rdbms\DBTransactionError
;
12 * Test the parts of the Database abstract class that deal
13 * with creating SQL text.
15 class DatabaseSQLTest
extends PHPUnit\Framework\TestCase
{
17 use MediaWikiCoversValidator
;
18 use PHPUnit4And6Compat
;
20 /** @var DatabaseTestHelper|Database */
23 protected function setUp() {
25 $this->database
= new DatabaseTestHelper( __CLASS__
, [ 'cliMode' => true ] );
28 protected function assertLastSql( $sqlText ) {
31 $this->database
->getLastSqls()
35 protected function assertLastSqlDb( $sqlText, DatabaseTestHelper
$db ) {
36 $this->assertEquals( $sqlText, $db->getLastSqls() );
40 * @dataProvider provideSelect
41 * @covers Wikimedia\Rdbms\Database::select
42 * @covers Wikimedia\Rdbms\Database::selectSQLText
43 * @covers Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN
44 * @covers Wikimedia\Rdbms\Database::useIndexClause
45 * @covers Wikimedia\Rdbms\Database::ignoreIndexClause
46 * @covers Wikimedia\Rdbms\Database::makeSelectOptions
47 * @covers Wikimedia\Rdbms\Database::makeOrderBy
48 * @covers Wikimedia\Rdbms\Database::makeGroupByWithHaving
49 * @covers Wikimedia\Rdbms\Database::selectFieldsOrOptionsAggregate
50 * @covers Wikimedia\Rdbms\Database::selectOptionsIncludeLocking
52 public function testSelect( $sql, $sqlText ) {
53 $this->database
->select(
58 $sql['options'] ??
[],
59 $sql['join_conds'] ??
[]
61 $this->assertLastSql( $sqlText );
64 public static function provideSelect() {
69 'fields' => [ 'field', 'alias' => 'field2' ],
70 'conds' => [ 'alias' => 'text' ],
72 "SELECT field,field2 AS alias " .
74 "WHERE alias = 'text'"
79 'fields' => [ 'field', 'alias' => 'field2' ],
80 'conds' => 'alias = \'text\'',
82 "SELECT field,field2 AS alias " .
84 "WHERE alias = 'text'"
89 'fields' => [ 'field', 'alias' => 'field2' ],
92 "SELECT field,field2 AS alias " .
98 'fields' => [ 'field', 'alias' => 'field2' ],
101 "SELECT field,field2 AS alias " .
107 'fields' => [ 'field', 'alias' => 'field2' ],
108 'conds' => '0', // T188314
110 "SELECT field,field2 AS alias " .
116 // 'tables' with space prepended indicates pre-escaped table name
117 'tables' => ' table LEFT JOIN table2',
118 'fields' => [ 'field' ],
119 'conds' => [ 'field' => 'text' ],
121 "SELECT field FROM table LEFT JOIN table2 WHERE field = 'text'"
125 // Empty 'tables' is allowed
127 'fields' => [ 'SPECIAL_QUERY()' ],
129 "SELECT SPECIAL_QUERY()"
134 'fields' => [ 'field', 'alias' => 'field2' ],
135 'conds' => [ 'alias' => 'text' ],
136 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
138 "SELECT field,field2 AS alias " .
140 "WHERE alias = 'text' " .
146 'tables' => [ 'table', 't2' => 'table2' ],
147 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
148 'conds' => [ 'alias' => 'text' ],
149 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
150 'join_conds' => [ 't2' => [
151 'LEFT JOIN', 'tid = t2.id'
154 "SELECT tid,field,field2 AS alias,t2.id " .
155 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
156 "WHERE alias = 'text' " .
162 'tables' => [ 'table', 't2' => 'table2' ],
163 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
164 'conds' => [ 'alias' => 'text' ],
165 'options' => [ 'LIMIT' => 1, 'GROUP BY' => 'field', 'HAVING' => 'COUNT(*) > 1' ],
166 'join_conds' => [ 't2' => [
167 'LEFT JOIN', 'tid = t2.id'
170 "SELECT tid,field,field2 AS alias,t2.id " .
171 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
172 "WHERE alias = 'text' " .
173 "GROUP BY field HAVING COUNT(*) > 1 " .
178 'tables' => [ 'table', 't2' => 'table2' ],
179 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
180 'conds' => [ 'alias' => 'text' ],
183 'GROUP BY' => [ 'field', 'field2' ],
184 'HAVING' => [ 'COUNT(*) > 1', 'field' => 1 ]
186 'join_conds' => [ 't2' => [
187 'LEFT JOIN', 'tid = t2.id'
190 "SELECT tid,field,field2 AS alias,t2.id " .
191 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
192 "WHERE alias = 'text' " .
193 "GROUP BY field,field2 HAVING (COUNT(*) > 1) AND field = '1' " .
198 'tables' => [ 'table' ],
199 'fields' => [ 'alias' => 'field' ],
200 'conds' => [ 'alias' => [ 1, 2, 3, 4 ] ],
202 "SELECT field AS alias " .
204 "WHERE alias IN ('1','2','3','4')"
209 'fields' => [ 'field' ],
210 'options' => [ 'USE INDEX' => [ 'table' => 'X' ] ],
213 "SELECT field FROM table"
218 'fields' => [ 'field' ],
219 'options' => [ 'IGNORE INDEX' => [ 'table' => 'X' ] ],
222 "SELECT field FROM table"
227 'fields' => [ 'field' ],
228 'options' => [ 'DISTINCT' ],
230 "SELECT DISTINCT field FROM table"
235 'fields' => [ 'field' ],
236 'options' => [ 'LOCK IN SHARE MODE' ],
238 "SELECT field FROM table LOCK IN SHARE MODE"
243 'fields' => [ 'field' ],
244 'options' => [ 'EXPLAIN' => true ],
246 'EXPLAIN SELECT field FROM table'
251 'fields' => [ 'field' ],
252 'options' => [ 'FOR UPDATE' ],
254 "SELECT field FROM table FOR UPDATE"
260 * @dataProvider provideLockForUpdate
261 * @covers Wikimedia\Rdbms\Database::lockForUpdate
263 public function testLockForUpdate( $sql, $sqlText ) {
264 $this->database
->startAtomic( __METHOD__
);
265 $this->database
->lockForUpdate(
269 $sql['options'] ??
[],
270 $sql['join_conds'] ??
[]
272 $this->database
->endAtomic( __METHOD__
);
274 $this->assertLastSql( "BEGIN; $sqlText; COMMIT" );
277 public static function provideLockForUpdate() {
281 'tables' => [ 'table' ],
282 'conds' => [ 'field' => [ 1, 2, 3, 4 ] ],
284 "SELECT COUNT(*) AS rowcount FROM " .
285 "(SELECT 1 FROM table WHERE field IN ('1','2','3','4') " .
286 "FOR UPDATE) tmp_count"
290 'tables' => [ 'table', 't2' => 'table2' ],
291 'conds' => [ 'field' => 'text' ],
292 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
293 'join_conds' => [ 't2' => [
294 'LEFT JOIN', 'tid = t2.id'
297 "SELECT COUNT(*) AS rowcount FROM " .
298 "(SELECT 1 FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
299 "WHERE field = 'text' ORDER BY field LIMIT 1 FOR UPDATE) tmp_count"
305 "SELECT COUNT(*) AS rowcount FROM " .
306 "(SELECT 1 FROM table FOR UPDATE) tmp_count"
312 * @covers Wikimedia\Rdbms\Subquery
313 * @dataProvider provideSelectRowCount
315 * @param string $sqlText
317 public function testSelectRowCount( $sql, $sqlText ) {
318 $this->database
->selectRowCount(
323 $sql['options'] ??
[],
324 $sql['join_conds'] ??
[]
326 $this->assertLastSql( $sqlText );
329 public static function provideSelectRowCount() {
335 'conds' => [ 'field' => 'text' ],
337 "SELECT COUNT(*) AS rowcount FROM " .
338 "(SELECT 1 FROM table WHERE field = 'text' ) tmp_count"
343 'field' => [ 'column' ],
344 'conds' => [ 'field' => 'text' ],
346 "SELECT COUNT(*) AS rowcount FROM " .
347 "(SELECT 1 FROM table WHERE field = 'text' AND (column IS NOT NULL) ) tmp_count"
352 'field' => [ 'alias' => 'column' ],
353 'conds' => [ 'field' => 'text' ],
355 "SELECT COUNT(*) AS rowcount FROM " .
356 "(SELECT 1 FROM table WHERE field = 'text' AND (column IS NOT NULL) ) tmp_count"
361 'field' => [ 'alias' => 'column' ],
364 "SELECT COUNT(*) AS rowcount FROM " .
365 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
370 'field' => [ 'alias' => 'column' ],
373 "SELECT COUNT(*) AS rowcount FROM " .
374 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
379 'field' => [ 'alias' => 'column' ],
382 "SELECT COUNT(*) AS rowcount FROM " .
383 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
388 'field' => [ 'alias' => 'column' ],
391 "SELECT COUNT(*) AS rowcount FROM " .
392 "(SELECT 1 FROM table WHERE (1) AND (column IS NOT NULL) ) tmp_count"
397 'field' => [ 'alias' => 'column' ],
400 "SELECT COUNT(*) AS rowcount FROM " .
401 "(SELECT 1 FROM table WHERE (0) AND (column IS NOT NULL) ) tmp_count"
407 * @dataProvider provideUpdate
408 * @covers Wikimedia\Rdbms\Database::update
409 * @covers Wikimedia\Rdbms\Database::makeUpdateOptions
410 * @covers Wikimedia\Rdbms\Database::makeUpdateOptionsArray
412 public function testUpdate( $sql, $sqlText ) {
413 $this->database
->update(
418 $sql['options'] ??
[]
420 $this->assertLastSql( $sqlText );
423 public static function provideUpdate() {
428 'values' => [ 'field' => 'text', 'field2' => 'text2' ],
429 'conds' => [ 'alias' => 'text' ],
432 "SET field = 'text'" .
433 ",field2 = 'text2' " .
434 "WHERE alias = 'text'"
439 'values' => [ 'field = other', 'field2' => 'text2' ],
440 'conds' => [ 'id' => '1' ],
443 "SET field = other" .
444 ",field2 = 'text2' " .
450 'values' => [ 'field = other', 'field2' => 'text2' ],
454 "SET field = other" .
461 * @dataProvider provideDelete
462 * @covers Wikimedia\Rdbms\Database::delete
464 public function testDelete( $sql, $sqlText ) {
465 $this->database
->delete(
470 $this->assertLastSql( $sqlText );
473 public static function provideDelete() {
478 'conds' => [ 'alias' => 'text' ],
480 "DELETE FROM table " .
481 "WHERE alias = 'text'"
494 * @dataProvider provideUpsert
495 * @covers Wikimedia\Rdbms\Database::upsert
497 public function testUpsert( $sql, $sqlText ) {
498 $this->database
->upsert(
501 $sql['uniqueIndexes'],
505 $this->assertLastSql( $sqlText );
508 public static function provideUpsert() {
512 'table' => 'upsert_table',
513 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
514 'uniqueIndexes' => [ 'field' ],
515 'set' => [ 'field' => 'set' ],
518 "UPDATE upsert_table " .
519 "SET field = 'set' " .
520 "WHERE ((field = 'text')); " .
521 "INSERT IGNORE INTO upsert_table " .
523 "VALUES ('text','text2'); " .
530 * @dataProvider provideDeleteJoin
531 * @covers Wikimedia\Rdbms\Database::deleteJoin
533 public function testDeleteJoin( $sql, $sqlText ) {
534 $this->database
->deleteJoin(
542 $this->assertLastSql( $sqlText );
545 public static function provideDeleteJoin() {
549 'delTable' => 'table',
550 'joinTable' => 'table_join',
552 'joinVar' => 'field_join',
553 'conds' => [ 'alias' => 'text' ],
555 "DELETE FROM table " .
557 "SELECT field_join FROM table_join WHERE alias = 'text'" .
562 'delTable' => 'table',
563 'joinTable' => 'table_join',
565 'joinVar' => 'field_join',
568 "DELETE FROM table " .
570 "SELECT field_join FROM table_join " .
577 * @dataProvider provideInsert
578 * @covers Wikimedia\Rdbms\Database::insert
579 * @covers Wikimedia\Rdbms\Database::makeInsertOptions
581 public function testInsert( $sql, $sqlText ) {
582 $this->database
->insert(
586 $sql['options'] ??
[]
588 $this->assertLastSql( $sqlText );
591 public static function provideInsert() {
596 'rows' => [ 'field' => 'text', 'field2' => 2 ],
598 "INSERT INTO table " .
600 "VALUES ('text','2')"
605 'rows' => [ 'field' => 'text', 'field2' => 2 ],
606 'options' => 'IGNORE',
608 "INSERT IGNORE INTO table " .
610 "VALUES ('text','2')"
616 [ 'field' => 'text', 'field2' => 2 ],
617 [ 'field' => 'multi', 'field2' => 3 ],
619 'options' => 'IGNORE',
621 "INSERT IGNORE INTO table " .
631 * @dataProvider provideInsertSelect
632 * @covers Wikimedia\Rdbms\Database::insertSelect
633 * @covers Wikimedia\Rdbms\Database::nativeInsertSelect
635 public function testInsertSelect( $sql, $sqlTextNative, $sqlSelect, $sqlInsert ) {
636 $this->database
->insertSelect(
642 $sql['insertOptions'] ??
[],
643 $sql['selectOptions'] ??
[],
644 $sql['selectJoinConds'] ??
[]
646 $this->assertLastSql( $sqlTextNative );
648 $dbWeb = new DatabaseTestHelper( __CLASS__
, [ 'cliMode' => false ] );
649 $dbWeb->forceNextResult( [
650 array_flip( array_keys( $sql['varMap'] ) )
652 $dbWeb->insertSelect(
658 $sql['insertOptions'] ??
[],
659 $sql['selectOptions'] ??
[],
660 $sql['selectJoinConds'] ??
[]
662 $this->assertLastSqlDb( implode( '; ', [ $sqlSelect, 'BEGIN', $sqlInsert, 'COMMIT' ] ), $dbWeb );
665 public static function provideInsertSelect() {
669 'destTable' => 'insert_table',
670 'srcTable' => 'select_table',
671 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
674 "INSERT INTO insert_table " .
675 "(field_insert,field) " .
676 "SELECT field_select,field2 " .
678 "SELECT field_select AS field_insert,field2 AS field " .
679 "FROM select_table FOR UPDATE",
680 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
684 'destTable' => 'insert_table',
685 'srcTable' => 'select_table',
686 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
687 'conds' => [ 'field' => 2 ],
689 "INSERT INTO insert_table " .
690 "(field_insert,field) " .
691 "SELECT field_select,field2 " .
692 "FROM select_table " .
694 "SELECT field_select AS field_insert,field2 AS field FROM " .
695 "select_table WHERE field = '2' FOR UPDATE",
696 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
700 'destTable' => 'insert_table',
701 'srcTable' => 'select_table',
702 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
703 'conds' => [ 'field' => 2 ],
704 'insertOptions' => 'IGNORE',
705 'selectOptions' => [ 'ORDER BY' => 'field' ],
707 "INSERT IGNORE INTO insert_table " .
708 "(field_insert,field) " .
709 "SELECT field_select,field2 " .
710 "FROM select_table " .
711 "WHERE field = '2' " .
713 "SELECT field_select AS field_insert,field2 AS field " .
714 "FROM select_table WHERE field = '2' ORDER BY field FOR UPDATE",
715 "INSERT IGNORE INTO insert_table (field_insert,field) VALUES ('0','1')"
719 'destTable' => 'insert_table',
720 'srcTable' => [ 'select_table1', 'select_table2' ],
721 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
722 'conds' => [ 'field' => 2 ],
723 'insertOptions' => [ 'NO_AUTO_COLUMNS' ],
724 'selectOptions' => [ 'ORDER BY' => 'field', 'FORCE INDEX' => [ 'select_table1' => 'index1' ] ],
725 'selectJoinConds' => [
726 'select_table2' => [ 'LEFT JOIN', [ 'select_table1.foo = select_table2.bar' ] ],
729 "INSERT INTO insert_table " .
730 "(field_insert,field) " .
731 "SELECT field_select,field2 " .
732 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
733 "WHERE field = '2' " .
735 "SELECT field_select AS field_insert,field2 AS field " .
736 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
737 "WHERE field = '2' ORDER BY field FOR UPDATE",
738 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
744 * @covers Wikimedia\Rdbms\Database::insertSelect
745 * @covers Wikimedia\Rdbms\Database::nativeInsertSelect
747 public function testInsertSelectBatching() {
748 $dbWeb = new DatabaseTestHelper( __CLASS__
, [ 'cliMode' => false ] );
750 for ( $i = 0; $i <= 25000; $i++
) {
751 $rows[] = [ 'field' => $i ];
753 $dbWeb->forceNextResult( $rows );
754 $dbWeb->insertSelect(
757 [ 'field' => 'field2' ],
761 $this->assertLastSqlDb( implode( '; ', [
762 'SELECT field2 AS field FROM select_table FOR UPDATE',
764 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 0, 9999 ) ) . "')",
765 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 10000, 19999 ) ) . "')",
766 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 20000, 25000 ) ) . "')",
772 * @dataProvider provideReplace
773 * @covers Wikimedia\Rdbms\Database::replace
775 public function testReplace( $sql, $sqlText ) {
776 $this->database
->replace(
778 $sql['uniqueIndexes'],
782 $this->assertLastSql( $sqlText );
785 public static function provideReplace() {
789 'table' => 'replace_table',
790 'uniqueIndexes' => [ 'field' ],
791 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
793 "BEGIN; DELETE FROM replace_table " .
794 "WHERE (field = 'text'); " .
795 "INSERT INTO replace_table " .
797 "VALUES ('text','text2'); COMMIT"
801 'table' => 'module_deps',
802 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
804 'md_module' => 'module',
809 "BEGIN; DELETE FROM module_deps " .
810 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
811 "INSERT INTO module_deps " .
812 "(md_module,md_skin,md_deps) " .
813 "VALUES ('module','skin','deps'); COMMIT"
817 'table' => 'module_deps',
818 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
821 'md_module' => 'module',
825 'md_module' => 'module2',
826 'md_skin' => 'skin2',
827 'md_deps' => 'deps2',
831 "BEGIN; DELETE FROM module_deps " .
832 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
833 "INSERT INTO module_deps " .
834 "(md_module,md_skin,md_deps) " .
835 "VALUES ('module','skin','deps'); " .
836 "DELETE FROM module_deps " .
837 "WHERE (md_module = 'module2' AND md_skin = 'skin2'); " .
838 "INSERT INTO module_deps " .
839 "(md_module,md_skin,md_deps) " .
840 "VALUES ('module2','skin2','deps2'); COMMIT"
844 'table' => 'module_deps',
845 'uniqueIndexes' => [ 'md_module', 'md_skin' ],
848 'md_module' => 'module',
852 'md_module' => 'module2',
853 'md_skin' => 'skin2',
854 'md_deps' => 'deps2',
858 "BEGIN; DELETE FROM module_deps " .
859 "WHERE (md_module = 'module') OR (md_skin = 'skin'); " .
860 "INSERT INTO module_deps " .
861 "(md_module,md_skin,md_deps) " .
862 "VALUES ('module','skin','deps'); " .
863 "DELETE FROM module_deps " .
864 "WHERE (md_module = 'module2') OR (md_skin = 'skin2'); " .
865 "INSERT INTO module_deps " .
866 "(md_module,md_skin,md_deps) " .
867 "VALUES ('module2','skin2','deps2'); COMMIT"
871 'table' => 'module_deps',
872 'uniqueIndexes' => [],
874 'md_module' => 'module',
879 "BEGIN; INSERT INTO module_deps " .
880 "(md_module,md_skin,md_deps) " .
881 "VALUES ('module','skin','deps'); COMMIT"
887 * @dataProvider provideNativeReplace
888 * @covers Wikimedia\Rdbms\Database::nativeReplace
890 public function testNativeReplace( $sql, $sqlText ) {
891 $this->database
->nativeReplace(
896 $this->assertLastSql( $sqlText );
899 public static function provideNativeReplace() {
903 'table' => 'replace_table',
904 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
906 "REPLACE INTO replace_table " .
908 "VALUES ('text','text2')"
914 * @dataProvider provideConditional
915 * @covers Wikimedia\Rdbms\Database::conditional
917 public function testConditional( $sql, $sqlText ) {
918 $this->assertEquals( trim( $this->database
->conditional(
925 public static function provideConditional() {
929 'conds' => [ 'field' => 'text' ],
933 "(CASE WHEN field = 'text' THEN 1 ELSE NULL END)"
937 'conds' => [ 'field' => 'text', 'field2' => 'anothertext' ],
941 "(CASE WHEN field = 'text' AND field2 = 'anothertext' THEN 1 ELSE NULL END)"
945 'conds' => 'field=1',
949 "(CASE WHEN field=1 THEN 1 ELSE NULL END)"
955 * @dataProvider provideBuildConcat
956 * @covers Wikimedia\Rdbms\Database::buildConcat
958 public function testBuildConcat( $stringList, $sqlText ) {
959 $this->assertEquals( trim( $this->database
->buildConcat(
964 public static function provideBuildConcat() {
967 [ 'field', 'field2' ],
968 "CONCAT(field,field2)"
971 [ "'test'", 'field2' ],
972 "CONCAT('test',field2)"
978 * @dataProvider provideBuildLike
979 * @covers Wikimedia\Rdbms\Database::buildLike
980 * @covers Wikimedia\Rdbms\Database::escapeLikeInternal
982 public function testBuildLike( $array, $sqlText ) {
983 $this->assertEquals( trim( $this->database
->buildLike(
988 public static function provideBuildLike() {
992 "LIKE 'text' ESCAPE '`'"
995 [ 'text', new LikeMatch( '%' ) ],
996 "LIKE 'text%' ESCAPE '`'"
999 [ 'text', new LikeMatch( '%' ), 'text2' ],
1000 "LIKE 'text%text2' ESCAPE '`'"
1003 [ 'text', new LikeMatch( '_' ) ],
1004 "LIKE 'text_' ESCAPE '`'"
1008 "LIKE 'more`_text' ESCAPE '`'"
1011 [ 'C:\\Windows\\', new LikeMatch( '%' ) ],
1012 "LIKE 'C:\\Windows\\%' ESCAPE '`'"
1015 [ 'accent`_test`', new LikeMatch( '%' ) ],
1016 "LIKE 'accent```_test``%' ESCAPE '`'"
1022 * @dataProvider provideUnionQueries
1023 * @covers Wikimedia\Rdbms\Database::unionQueries
1025 public function testUnionQueries( $sql, $sqlText ) {
1026 $this->assertEquals( trim( $this->database
->unionQueries(
1032 public static function provideUnionQueries() {
1036 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
1039 "(RAW SQL) UNION ALL (RAW2SQL)"
1043 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
1046 "(RAW SQL) UNION (RAW2SQL)"
1050 'sqls' => [ 'RAW SQL', 'RAW2SQL', 'RAW3SQL' ],
1053 "(RAW SQL) UNION (RAW2SQL) UNION (RAW3SQL)"
1059 * @dataProvider provideUnionConditionPermutations
1060 * @covers Wikimedia\Rdbms\Database::unionConditionPermutations
1062 public function testUnionConditionPermutations( $params, $expect ) {
1063 if ( isset( $params['unionSupportsOrderAndLimit'] ) ) {
1064 $this->database
->setUnionSupportsOrderAndLimit( $params['unionSupportsOrderAndLimit'] );
1067 $sql = trim( $this->database
->unionConditionPermutations(
1070 $params['permute_conds'],
1071 $params['extra_conds'] ??
'',
1073 $params['options'] ??
[],
1074 $params['join_conds'] ??
[]
1076 $this->assertEquals( $expect, $sql );
1079 public static function provideUnionConditionPermutations() {
1080 // phpcs:disable Generic.Files.LineLength
1084 'table' => [ 'table1', 'table2' ],
1085 'vars' => [ 'field1', 'alias' => 'field2' ],
1086 'permute_conds' => [
1087 'field3' => [ 1, 2, 3 ],
1088 'duplicates' => [ 4, 5, 4 ],
1092 'extra_conds' => 'table2.bar > 23',
1094 'ORDER BY' => [ 'field1', 'alias' ],
1095 'INNER ORDER BY' => [ 'field1', 'field2' ],
1099 'table2' => [ 'JOIN', 'table1.foo_id = table2.foo_id' ],
1102 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '1' AND duplicates = '4' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1103 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '1' AND duplicates = '5' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1104 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '2' AND duplicates = '4' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1105 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '2' AND duplicates = '5' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1106 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '3' AND duplicates = '4' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1107 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '3' AND duplicates = '5' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) " .
1108 "ORDER BY field1,alias LIMIT 100"
1113 'vars' => [ 'foo_id' ],
1114 'permute_conds' => [
1115 'bar' => [ 1, 2, 3 ],
1117 'extra_conds' => [ 'baz' => null ],
1120 'ORDER BY' => [ 'foo_id' ],
1124 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
1125 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
1126 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) " .
1127 "ORDER BY foo_id LIMIT 25"
1132 'vars' => [ 'foo_id' ],
1133 'permute_conds' => [
1134 'bar' => [ 1, 2, 3 ],
1136 'extra_conds' => [ 'baz' => null ],
1139 'ORDER BY' => [ 'foo_id' ],
1142 'unionSupportsOrderAndLimit' => false,
1144 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ) UNION " .
1145 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ) UNION " .
1146 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ) " .
1147 "ORDER BY foo_id LIMIT 25"
1152 'vars' => [ 'foo_id' ],
1153 'permute_conds' => [],
1154 'extra_conds' => [ 'baz' => null ],
1156 'ORDER BY' => [ 'foo_id' ],
1160 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
1165 'vars' => [ 'foo_id' ],
1166 'permute_conds' => [
1169 'extra_conds' => [ 'baz' => null ],
1171 'ORDER BY' => [ 'foo_id' ],
1175 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
1180 'vars' => [ 'foo_id' ],
1181 'permute_conds' => [
1185 'ORDER BY' => [ 'foo_id' ],
1190 "SELECT foo_id FROM foo WHERE bar = '1' ORDER BY foo_id LIMIT 150,25"
1195 'vars' => [ 'foo_id' ],
1196 'permute_conds' => [],
1197 'extra_conds' => [ 'baz' => null ],
1199 'ORDER BY' => [ 'foo_id' ],
1202 'INNER ORDER BY' => [ 'bar_id' ],
1205 "(SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY bar_id LIMIT 175 ) ORDER BY foo_id LIMIT 150,25"
1210 'vars' => [ 'foo_id' ],
1211 'permute_conds' => [],
1212 'extra_conds' => [ 'baz' => null ],
1214 'ORDER BY' => [ 'foo_id' ],
1217 'INNER ORDER BY' => [ 'bar_id' ],
1219 'unionSupportsOrderAndLimit' => false,
1221 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 150,25"
1228 * @covers Wikimedia\Rdbms\Database::commit
1229 * @covers Wikimedia\Rdbms\Database::doCommit
1231 public function testTransactionCommit() {
1232 $this->database
->begin( __METHOD__
);
1233 $this->database
->commit( __METHOD__
);
1234 $this->assertLastSql( 'BEGIN; COMMIT' );
1238 * @covers Wikimedia\Rdbms\Database::rollback
1239 * @covers Wikimedia\Rdbms\Database::doRollback
1241 public function testTransactionRollback() {
1242 $this->database
->begin( __METHOD__
);
1243 $this->database
->rollback( __METHOD__
);
1244 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1248 * @covers Wikimedia\Rdbms\Database::dropTable
1250 public function testDropTable() {
1251 $this->database
->setExistingTables( [ 'table' ] );
1252 $this->database
->dropTable( 'table', __METHOD__
);
1253 $this->assertLastSql( 'DROP TABLE table CASCADE' );
1257 * @covers Wikimedia\Rdbms\Database::dropTable
1259 public function testDropNonExistingTable() {
1261 $this->database
->dropTable( 'non_existing', __METHOD__
)
1266 * @dataProvider provideMakeList
1267 * @covers Wikimedia\Rdbms\Database::makeList
1269 public function testMakeList( $list, $mode, $sqlText ) {
1270 $this->assertEquals( trim( $this->database
->makeList(
1275 public static function provideMakeList() {
1278 [ 'value', 'value2' ],
1283 [ 'field', 'field2' ],
1288 [ 'field' => 'value', 'field2' => 'value2' ],
1290 "field = 'value' AND field2 = 'value2'"
1293 [ 'field' => null, "field2 != 'value2'" ],
1295 "field IS NULL AND (field2 != 'value2')"
1298 [ 'field' => [ 'value', null, 'value2' ], 'field2' => 'value2' ],
1300 "(field IN ('value','value2') OR field IS NULL) AND field2 = 'value2'"
1303 [ 'field' => [ null ], 'field2' => null ],
1305 "field IS NULL AND field2 IS NULL"
1308 [ 'field' => 'value', 'field2' => 'value2' ],
1310 "field = 'value' OR field2 = 'value2'"
1313 [ 'field' => 'value', 'field2' => null ],
1315 "field = 'value' OR field2 IS NULL"
1318 [ 'field' => [ 'value', 'value2' ], 'field2' => [ 'value' ] ],
1320 "field IN ('value','value2') OR field2 = 'value'"
1323 [ 'field' => [ null, 'value', null, 'value2' ], "field2 != 'value2'" ],
1325 "(field IN ('value','value2') OR field IS NULL) OR (field2 != 'value2')"
1328 [ 'field' => 'value', 'field2' => 'value2' ],
1330 "field = 'value',field2 = 'value2'"
1333 [ 'field' => 'value', 'field2' => null ],
1335 "field = 'value',field2 = NULL"
1338 [ 'field' => 'value', "field2 != 'value2'" ],
1340 "field = 'value',field2 != 'value2'"
1346 * @covers Wikimedia\Rdbms\Database::registerTempTableWrite
1348 public function testSessionTempTables() {
1349 $temp1 = $this->database
->tableName( 'tmp_table_1' );
1350 $temp2 = $this->database
->tableName( 'tmp_table_2' );
1351 $temp3 = $this->database
->tableName( 'tmp_table_3' );
1353 $this->database
->query( "CREATE TEMPORARY TABLE $temp1 LIKE orig_tbl", __METHOD__
);
1354 $this->database
->query( "CREATE TEMPORARY TABLE $temp2 LIKE orig_tbl", __METHOD__
);
1355 $this->database
->query( "CREATE TEMPORARY TABLE $temp3 LIKE orig_tbl", __METHOD__
);
1357 $this->assertTrue( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1358 $this->assertTrue( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1359 $this->assertTrue( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1361 $this->database
->dropTable( 'tmp_table_1', __METHOD__
);
1362 $this->database
->dropTable( 'tmp_table_2', __METHOD__
);
1363 $this->database
->dropTable( 'tmp_table_3', __METHOD__
);
1365 $this->assertFalse( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1366 $this->assertFalse( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1367 $this->assertFalse( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1369 $this->database
->query( "CREATE TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__
);
1370 $this->database
->query( "CREATE TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__
);
1371 $this->database
->query( "CREATE TEMPORARY TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__
);
1373 $this->assertTrue( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1374 $this->assertTrue( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1375 $this->assertTrue( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1377 $this->database
->query( "DROP TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__
);
1378 $this->database
->query( "DROP TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__
);
1379 $this->database
->query( "DROP TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__
);
1381 $this->assertFalse( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1382 $this->assertFalse( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1383 $this->assertFalse( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1386 public function provideBuildSubstring() {
1387 yield
[ 'someField', 1, 2, 'SUBSTRING(someField FROM 1 FOR 2)' ];
1388 yield
[ 'someField', 1, null, 'SUBSTRING(someField FROM 1)' ];
1392 * @covers Wikimedia\Rdbms\Database::buildSubstring
1393 * @dataProvider provideBuildSubstring
1395 public function testBuildSubstring( $input, $start, $length, $expected ) {
1396 $output = $this->database
->buildSubstring( $input, $start, $length );
1397 $this->assertSame( $expected, $output );
1400 public function provideBuildSubstring_invalidParams() {
1410 * @covers Wikimedia\Rdbms\Database::buildSubstring
1411 * @covers Wikimedia\Rdbms\Database::assertBuildSubstringParams
1412 * @dataProvider provideBuildSubstring_invalidParams
1414 public function testBuildSubstring_invalidParams( $start, $length ) {
1415 $this->setExpectedException( InvalidArgumentException
::class );
1416 $this->database
->buildSubstring( 'foo', $start, $length );
1420 * @covers \Wikimedia\Rdbms\Database::buildIntegerCast
1422 public function testBuildIntegerCast() {
1423 $output = $this->database
->buildIntegerCast( 'fieldName' );
1424 $this->assertSame( 'CAST( fieldName AS INTEGER )', $output );
1428 * @covers \Wikimedia\Rdbms\Database::doSavepoint
1429 * @covers \Wikimedia\Rdbms\Database::doReleaseSavepoint
1430 * @covers \Wikimedia\Rdbms\Database::doRollbackToSavepoint
1431 * @covers \Wikimedia\Rdbms\Database::startAtomic
1432 * @covers \Wikimedia\Rdbms\Database::endAtomic
1433 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1434 * @covers \Wikimedia\Rdbms\Database::doAtomicSection
1436 public function testAtomicSections() {
1437 $this->database
->startAtomic( __METHOD__
);
1438 $this->database
->endAtomic( __METHOD__
);
1439 $this->assertLastSql( 'BEGIN; COMMIT' );
1441 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1442 $this->database
->cancelAtomic( __METHOD__
);
1443 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1445 $this->database
->begin( __METHOD__
);
1446 $this->database
->startAtomic( __METHOD__
);
1447 $this->database
->endAtomic( __METHOD__
);
1448 $this->database
->commit( __METHOD__
);
1449 $this->assertLastSql( 'BEGIN; COMMIT' );
1451 $this->database
->begin( __METHOD__
);
1452 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1453 $this->database
->endAtomic( __METHOD__
);
1454 $this->database
->commit( __METHOD__
);
1455 // phpcs:ignore Generic.Files.LineLength
1456 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1458 $this->database
->begin( __METHOD__
);
1459 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1460 $this->database
->cancelAtomic( __METHOD__
);
1461 $this->database
->commit( __METHOD__
);
1462 // phpcs:ignore Generic.Files.LineLength
1463 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1465 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1466 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1467 $this->database
->cancelAtomic( __METHOD__
);
1468 $this->database
->endAtomic( __METHOD__
);
1469 // phpcs:ignore Generic.Files.LineLength
1470 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1472 $noOpCallack = function () {
1475 $this->database
->doAtomicSection( __METHOD__
, $noOpCallack, IDatabase
::ATOMIC_CANCELABLE
);
1476 $this->assertLastSql( 'BEGIN; COMMIT' );
1478 $this->database
->doAtomicSection( __METHOD__
, $noOpCallack );
1479 $this->assertLastSql( 'BEGIN; COMMIT' );
1481 $this->database
->begin( __METHOD__
);
1482 $this->database
->doAtomicSection( __METHOD__
, $noOpCallack, IDatabase
::ATOMIC_CANCELABLE
);
1483 $this->database
->rollback( __METHOD__
);
1484 // phpcs:ignore Generic.Files.LineLength
1485 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK' );
1487 $fname = __METHOD__
;
1490 IDatabase
::TRIGGER_COMMIT
=> 'tCommit',
1491 IDatabase
::TRIGGER_ROLLBACK
=> 'tRollback',
1492 IDatabase
::TRIGGER_CANCEL
=> 'tCancel',
1494 $pcCallback = function ( IDatabase
$db ) use ( $fname ) {
1495 $this->database
->query( "SELECT 0", $fname );
1497 $callback1 = function ( $trigger = '-' ) use ( $fname, $triggerMap ) {
1498 $this->database
->query( "SELECT 1, {$triggerMap[$trigger]} AS t", $fname );
1500 $callback2 = function ( $trigger = '-' ) use ( $fname, $triggerMap ) {
1501 $this->database
->query( "SELECT 2, {$triggerMap[$trigger]} AS t", $fname );
1503 $callback3 = function ( $trigger = '-' ) use ( $fname, $triggerMap ) {
1504 $this->database
->query( "SELECT 3, {$triggerMap[$trigger]} AS t", $fname );
1507 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1508 $this->database
->onTransactionPreCommitOrIdle( $pcCallback, __METHOD__
);
1509 $this->database
->cancelAtomic( __METHOD__
);
1510 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1512 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1513 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1514 $this->database
->cancelAtomic( __METHOD__
);
1515 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1517 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1518 $this->database
->onTransactionResolution( $callback1, __METHOD__
);
1519 $this->database
->cancelAtomic( __METHOD__
);
1520 $this->assertLastSql( 'BEGIN; ROLLBACK; SELECT 1, tRollback AS t' );
1522 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1523 $this->database
->onAtomicSectionCancel( $callback1, __METHOD__
);
1524 $this->database
->cancelAtomic( __METHOD__
);
1525 $this->assertLastSql( 'BEGIN; ROLLBACK; SELECT 1, tRollback AS t' );
1527 $this->database
->startAtomic( __METHOD__
. '_outer' );
1528 $this->database
->onTransactionPreCommitOrIdle( $pcCallback, __METHOD__
);
1529 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1530 $this->database
->onTransactionPreCommitOrIdle( $pcCallback, __METHOD__
);
1531 $this->database
->cancelAtomic( __METHOD__
);
1532 $this->database
->onTransactionPreCommitOrIdle( $pcCallback, __METHOD__
);
1533 $this->database
->endAtomic( __METHOD__
. '_outer' );
1534 $this->assertLastSql( implode( "; ", [
1536 'SAVEPOINT wikimedia_rdbms_atomic1',
1537 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1543 $this->database
->startAtomic( __METHOD__
. '_outer' );
1544 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1545 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1546 $this->database
->onTransactionCommitOrIdle( $callback2, __METHOD__
);
1547 $this->database
->cancelAtomic( __METHOD__
);
1548 $this->database
->onTransactionCommitOrIdle( $callback3, __METHOD__
);
1549 $this->database
->endAtomic( __METHOD__
. '_outer' );
1550 $this->assertLastSql( implode( "; ", [
1552 'SAVEPOINT wikimedia_rdbms_atomic1',
1553 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1555 'SELECT 1, tCommit AS t',
1556 'SELECT 3, tCommit AS t'
1559 $this->database
->startAtomic( __METHOD__
. '_outer' );
1560 $this->database
->onTransactionResolution( $callback1, __METHOD__
);
1561 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1562 $this->database
->onTransactionResolution( $callback2, __METHOD__
);
1563 $this->database
->cancelAtomic( __METHOD__
);
1564 $this->database
->onTransactionResolution( $callback3, __METHOD__
);
1565 $this->database
->endAtomic( __METHOD__
. '_outer' );
1566 $this->assertLastSql( implode( "; ", [
1568 'SAVEPOINT wikimedia_rdbms_atomic1',
1569 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1571 'SELECT 1, tCommit AS t',
1572 'SELECT 2, tRollback AS t',
1573 'SELECT 3, tCommit AS t'
1576 $this->database
->startAtomic( __METHOD__
. '_outer' );
1577 $this->database
->onAtomicSectionCancel( $callback1, __METHOD__
);
1578 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1579 $this->database
->onAtomicSectionCancel( $callback2, __METHOD__
);
1580 $this->database
->cancelAtomic( __METHOD__
);
1581 $this->database
->onAtomicSectionCancel( $callback3, __METHOD__
);
1582 $this->database
->endAtomic( __METHOD__
. '_outer' );
1583 $this->assertLastSql( implode( "; ", [
1585 'SAVEPOINT wikimedia_rdbms_atomic1',
1586 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1587 'SELECT 2, tCancel AS t',
1591 $makeCallback = function ( $id ) use ( $fname, $triggerMap ) {
1592 return function ( $trigger = '-' ) use ( $id, $fname, $triggerMap ) {
1593 $this->database
->query( "SELECT $id, {$triggerMap[$trigger]} AS t", $fname );
1597 $this->database
->startAtomic( __METHOD__
. '_outer' );
1598 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1599 $this->database
->onTransactionResolution( $makeCallback( 1 ), __METHOD__
);
1600 $this->database
->cancelAtomic( __METHOD__
);
1601 $this->database
->endAtomic( __METHOD__
. '_outer' );
1602 $this->assertLastSql( implode( "; ", [
1604 'SAVEPOINT wikimedia_rdbms_atomic1',
1605 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1607 'SELECT 1, tRollback AS t'
1610 $this->database
->startAtomic( __METHOD__
. '_level1', IDatabase
::ATOMIC_CANCELABLE
);
1611 $this->database
->onTransactionResolution( $makeCallback( 1 ), __METHOD__
);
1612 $this->database
->startAtomic( __METHOD__
. '_level2' );
1613 $this->database
->startAtomic( __METHOD__
. '_level3', IDatabase
::ATOMIC_CANCELABLE
);
1614 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1615 $this->database
->onTransactionResolution( $makeCallback( 2 ), __METHOD__
);
1616 $this->database
->endAtomic( __METHOD__
);
1617 $this->database
->onTransactionResolution( $makeCallback( 3 ), __METHOD__
);
1618 $this->database
->cancelAtomic( __METHOD__
. '_level3' );
1619 $this->database
->endAtomic( __METHOD__
. '_level2' );
1620 $this->database
->onTransactionResolution( $makeCallback( 4 ), __METHOD__
);
1621 $this->database
->endAtomic( __METHOD__
. '_level1' );
1622 $this->assertLastSql( implode( "; ", [
1624 'SAVEPOINT wikimedia_rdbms_atomic1',
1625 'SAVEPOINT wikimedia_rdbms_atomic2',
1626 'RELEASE SAVEPOINT wikimedia_rdbms_atomic2',
1627 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1628 'COMMIT; SELECT 1, tCommit AS t',
1629 'SELECT 2, tRollback AS t',
1630 'SELECT 3, tRollback AS t',
1631 'SELECT 4, tCommit AS t'
1634 $this->database
->startAtomic( __METHOD__
. '_level1', IDatabase
::ATOMIC_CANCELABLE
);
1635 $this->database
->onAtomicSectionCancel( $makeCallback( 1 ), __METHOD__
);
1636 $this->database
->startAtomic( __METHOD__
. '_level2' );
1637 $this->database
->startAtomic( __METHOD__
. '_level3', IDatabase
::ATOMIC_CANCELABLE
);
1638 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1639 $this->database
->onAtomicSectionCancel( $makeCallback( 2 ), __METHOD__
);
1640 $this->database
->endAtomic( __METHOD__
);
1641 $this->database
->onAtomicSectionCancel( $makeCallback( 3 ), __METHOD__
);
1642 $this->database
->cancelAtomic( __METHOD__
. '_level3' );
1643 $this->database
->endAtomic( __METHOD__
. '_level2' );
1644 $this->database
->onAtomicSectionCancel( $makeCallback( 4 ), __METHOD__
);
1645 $this->database
->endAtomic( __METHOD__
. '_level1' );
1646 $this->assertLastSql( implode( "; ", [
1648 'SAVEPOINT wikimedia_rdbms_atomic1',
1649 'SAVEPOINT wikimedia_rdbms_atomic2',
1650 'RELEASE SAVEPOINT wikimedia_rdbms_atomic2',
1651 'ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1',
1652 'SELECT 2, tCancel AS t',
1653 'SELECT 3, tCancel AS t',
1659 * @covers \Wikimedia\Rdbms\Database::doSavepoint
1660 * @covers \Wikimedia\Rdbms\Database::doReleaseSavepoint
1661 * @covers \Wikimedia\Rdbms\Database::doRollbackToSavepoint
1662 * @covers \Wikimedia\Rdbms\Database::startAtomic
1663 * @covers \Wikimedia\Rdbms\Database::endAtomic
1664 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1665 * @covers \Wikimedia\Rdbms\Database::doAtomicSection
1667 public function testAtomicSectionsRecovery() {
1668 $this->database
->begin( __METHOD__
);
1670 $this->database
->doAtomicSection(
1673 $this->database
->startAtomic( 'inner_func1' );
1674 $this->database
->startAtomic( 'inner_func2' );
1676 throw new RuntimeException( 'Test exception' );
1678 IDatabase
::ATOMIC_CANCELABLE
1680 $this->fail( 'Expected exception not thrown' );
1681 } catch ( RuntimeException
$ex ) {
1682 $this->assertSame( 'Test exception', $ex->getMessage() );
1684 $this->database
->commit( __METHOD__
);
1685 // phpcs:ignore Generic.Files.LineLength
1686 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1688 $this->database
->begin( __METHOD__
);
1690 $this->database
->doAtomicSection(
1693 throw new RuntimeException( 'Test exception' );
1696 $this->fail( 'Test exception not thrown' );
1697 } catch ( RuntimeException
$ex ) {
1698 $this->assertSame( 'Test exception', $ex->getMessage() );
1701 $this->database
->commit( __METHOD__
);
1702 $this->fail( 'Test exception not thrown' );
1703 } catch ( DBTransactionError
$ex ) {
1705 'Cannot execute query from ' . __METHOD__
. ' while transaction status is ERROR.',
1709 $this->database
->rollback( __METHOD__
);
1710 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1714 * @covers \Wikimedia\Rdbms\Database::doSavepoint
1715 * @covers \Wikimedia\Rdbms\Database::doReleaseSavepoint
1716 * @covers \Wikimedia\Rdbms\Database::doRollbackToSavepoint
1717 * @covers \Wikimedia\Rdbms\Database::startAtomic
1718 * @covers \Wikimedia\Rdbms\Database::endAtomic
1719 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1720 * @covers \Wikimedia\Rdbms\Database::doAtomicSection
1722 public function testAtomicSectionsCallbackCancellation() {
1723 $fname = __METHOD__
;
1724 $callback1Called = null;
1725 $callback1 = function ( $trigger = '-' ) use ( $fname, &$callback1Called ) {
1726 $callback1Called = $trigger;
1727 $this->database
->query( "SELECT 1", $fname );
1729 $callback2Called = null;
1730 $callback2 = function ( $trigger = '-' ) use ( $fname, &$callback2Called ) {
1731 $callback2Called = $trigger;
1732 $this->database
->query( "SELECT 2", $fname );
1734 $callback3Called = null;
1735 $callback3 = function ( $trigger = '-' ) use ( $fname, &$callback3Called ) {
1736 $callback3Called = $trigger;
1737 $this->database
->query( "SELECT 3", $fname );
1739 $callback4Called = 0;
1740 $callback4 = function () use ( $fname, &$callback4Called ) {
1742 $this->database
->query( "SELECT 4", $fname );
1744 $callback5Called = 0;
1745 $callback5 = function () use ( $fname, &$callback5Called ) {
1747 $this->database
->query( "SELECT 5", $fname );
1750 $this->database
->startAtomic( __METHOD__
. '_outer' );
1751 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1752 $this->database
->startAtomic( __METHOD__
. '_inner' );
1753 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1754 $this->database
->onTransactionPreCommitOrIdle( $callback2, __METHOD__
);
1755 $this->database
->onTransactionResolution( $callback3, __METHOD__
);
1756 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1757 $this->database
->endAtomic( __METHOD__
. '_inner' );
1758 $this->database
->cancelAtomic( __METHOD__
);
1759 $this->database
->endAtomic( __METHOD__
. '_outer' );
1760 $this->assertNull( $callback1Called );
1761 $this->assertNull( $callback2Called );
1762 $this->assertEquals( IDatabase
::TRIGGER_ROLLBACK
, $callback3Called );
1763 $this->assertEquals( 1, $callback4Called );
1764 // phpcs:ignore Generic.Files.LineLength
1765 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; SELECT 4; COMMIT; SELECT 3' );
1767 $callback1Called = null;
1768 $callback2Called = null;
1769 $callback3Called = null;
1770 $callback4Called = 0;
1771 $this->database
->startAtomic( __METHOD__
. '_outer' );
1772 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1773 $this->database
->startAtomic( __METHOD__
. '_inner', IDatabase
::ATOMIC_CANCELABLE
);
1774 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1775 $this->database
->onTransactionPreCommitOrIdle( $callback2, __METHOD__
);
1776 $this->database
->onTransactionResolution( $callback3, __METHOD__
);
1777 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1778 $this->database
->endAtomic( __METHOD__
. '_inner' );
1779 $this->database
->cancelAtomic( __METHOD__
);
1780 $this->database
->endAtomic( __METHOD__
. '_outer' );
1781 $this->assertNull( $callback1Called );
1782 $this->assertNull( $callback2Called );
1783 $this->assertEquals( IDatabase
::TRIGGER_ROLLBACK
, $callback3Called );
1784 $this->assertEquals( 1, $callback4Called );
1785 // phpcs:ignore Generic.Files.LineLength
1786 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; SAVEPOINT wikimedia_rdbms_atomic2; RELEASE SAVEPOINT wikimedia_rdbms_atomic2; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; SELECT 4; COMMIT; SELECT 3' );
1788 $callback1Called = null;
1789 $callback2Called = null;
1790 $callback3Called = null;
1791 $callback4Called = 0;
1792 $this->database
->startAtomic( __METHOD__
. '_outer' );
1793 $atomicId = $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1794 $this->database
->startAtomic( __METHOD__
. '_inner' );
1795 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1796 $this->database
->onTransactionPreCommitOrIdle( $callback2, __METHOD__
);
1797 $this->database
->onTransactionResolution( $callback3, __METHOD__
);
1798 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1799 $this->database
->cancelAtomic( __METHOD__
, $atomicId );
1800 $this->database
->endAtomic( __METHOD__
. '_outer' );
1801 $this->assertNull( $callback1Called );
1802 $this->assertNull( $callback2Called );
1803 $this->assertEquals( IDatabase
::TRIGGER_ROLLBACK
, $callback3Called );
1804 $this->assertEquals( 1, $callback4Called );
1806 $callback1Called = null;
1807 $callback2Called = null;
1808 $callback3Called = null;
1809 $callback4Called = 0;
1810 $this->database
->startAtomic( __METHOD__
. '_outer' );
1811 $atomicId = $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1812 $this->database
->startAtomic( __METHOD__
. '_inner' );
1813 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1814 $this->database
->onTransactionPreCommitOrIdle( $callback2, __METHOD__
);
1815 $this->database
->onTransactionResolution( $callback3, __METHOD__
);
1816 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1818 $this->database
->cancelAtomic( __METHOD__
. '_X', $atomicId );
1819 } catch ( DBUnexpectedError
$e ) {
1822 "Invalid atomic section ended (got {$m}_X but expected {$m}).",
1826 $this->database
->cancelAtomic( __METHOD__
);
1827 $this->database
->endAtomic( __METHOD__
. '_outer' );
1828 $this->assertNull( $callback1Called );
1829 $this->assertNull( $callback2Called );
1830 $this->assertEquals( IDatabase
::TRIGGER_ROLLBACK
, $callback3Called );
1831 $this->assertEquals( 1, $callback4Called );
1833 $callback4Called = 0;
1834 $callback5Called = 0;
1835 $this->database
->getLastSqls(); // flush
1836 $this->database
->startAtomic( __METHOD__
. '_outer' );
1837 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1838 $this->database
->onAtomicSectionCancel( $callback5, __METHOD__
);
1839 $this->database
->startAtomic( __METHOD__
. '_inner', IDatabase
::ATOMIC_CANCELABLE
);
1840 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1841 $this->database
->cancelAtomic( __METHOD__
. '_inner' );
1842 $this->database
->cancelAtomic( __METHOD__
);
1843 $this->database
->endAtomic( __METHOD__
. '_outer' );
1844 // phpcs:ignore Generic.Files.LineLength
1845 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; SAVEPOINT wikimedia_rdbms_atomic2; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic2; SELECT 4; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; SELECT 5; COMMIT' );
1846 $this->assertEquals( 1, $callback4Called );
1847 $this->assertEquals( 1, $callback5Called );
1849 $callback4Called = 0;
1850 $callback5Called = 0;
1851 $this->database
->startAtomic( __METHOD__
. '_outer' );
1852 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1853 $this->database
->onAtomicSectionCancel( $callback5, __METHOD__
);
1854 $this->database
->startAtomic( __METHOD__
. '_inner', IDatabase
::ATOMIC_CANCELABLE
);
1855 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1856 $this->database
->endAtomic( __METHOD__
. '_inner' );
1857 $this->database
->cancelAtomic( __METHOD__
);
1858 $this->database
->endAtomic( __METHOD__
. '_outer' );
1859 // phpcs:ignore Generic.Files.LineLength
1860 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; SAVEPOINT wikimedia_rdbms_atomic2; RELEASE SAVEPOINT wikimedia_rdbms_atomic2; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; SELECT 5; SELECT 4; COMMIT' );
1861 $this->assertEquals( 1, $callback4Called );
1862 $this->assertEquals( 1, $callback5Called );
1864 $callback4Called = 0;
1865 $callback5Called = 0;
1866 $this->database
->startAtomic( __METHOD__
. '_outer' );
1867 $sectionId = $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1868 $this->database
->onAtomicSectionCancel( $callback5, __METHOD__
);
1869 $this->database
->startAtomic( __METHOD__
. '_inner', IDatabase
::ATOMIC_CANCELABLE
);
1870 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1871 $this->database
->cancelAtomic( __METHOD__
, $sectionId );
1872 $this->database
->endAtomic( __METHOD__
. '_outer' );
1873 // phpcs:ignore Generic.Files.LineLength
1874 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; SAVEPOINT wikimedia_rdbms_atomic2; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; SELECT 5; SELECT 4; COMMIT' );
1875 $this->assertEquals( 1, $callback4Called );
1876 $this->assertEquals( 1, $callback5Called );
1878 $wrapper = TestingAccessWrapper
::newFromObject( $this->database
);
1879 $callback1Called = null;
1880 $callback2Called = null;
1881 $callback3Called = null;
1882 $callback4Called = 0;
1883 $this->database
->startAtomic( __METHOD__
. '_outer' );
1884 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1885 $this->database
->startAtomic( __METHOD__
. '_inner' );
1886 $this->database
->onTransactionCommitOrIdle( $callback1, __METHOD__
);
1887 $this->database
->onTransactionPreCommitOrIdle( $callback2, __METHOD__
);
1888 $this->database
->onTransactionResolution( $callback3, __METHOD__
);
1889 $this->database
->onAtomicSectionCancel( $callback4, __METHOD__
);
1890 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
1891 $this->database
->cancelAtomic( __METHOD__
. '_inner' );
1892 $this->database
->cancelAtomic( __METHOD__
);
1893 $this->database
->endAtomic( __METHOD__
. '_outer' );
1894 $this->assertNull( $callback1Called );
1895 $this->assertNull( $callback2Called );
1896 $this->assertEquals( IDatabase
::TRIGGER_ROLLBACK
, $callback3Called );
1897 $this->assertEquals( 1, $callback4Called );
1901 * @covers \Wikimedia\Rdbms\Database::doSavepoint
1902 * @covers \Wikimedia\Rdbms\Database::doReleaseSavepoint
1903 * @covers \Wikimedia\Rdbms\Database::doRollbackToSavepoint
1904 * @covers \Wikimedia\Rdbms\Database::startAtomic
1905 * @covers \Wikimedia\Rdbms\Database::endAtomic
1906 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1907 * @covers \Wikimedia\Rdbms\Database::doAtomicSection
1909 public function testAtomicSectionsTrxRound() {
1910 $this->database
->setFlag( IDatabase
::DBO_TRX
);
1911 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1912 $this->database
->query( 'SELECT 1', __METHOD__
);
1913 $this->database
->endAtomic( __METHOD__
);
1914 $this->database
->commit( __METHOD__
, IDatabase
::FLUSHING_ALL_PEERS
);
1915 // phpcs:ignore Generic.Files.LineLength
1916 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; SELECT 1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1919 public static function provideAtomicSectionMethodsForErrors() {
1927 * @dataProvider provideAtomicSectionMethodsForErrors
1928 * @covers \Wikimedia\Rdbms\Database::endAtomic
1929 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1931 public function testNoAtomicSection( $method ) {
1933 $this->database
->$method( __METHOD__
);
1934 $this->fail( 'Expected exception not thrown' );
1935 } catch ( DBUnexpectedError
$ex ) {
1937 'No atomic section is open (got ' . __METHOD__
. ').',
1944 * @dataProvider provideAtomicSectionMethodsForErrors
1945 * @covers \Wikimedia\Rdbms\Database::endAtomic
1946 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1948 public function testInvalidAtomicSectionEnded( $method ) {
1949 $this->database
->startAtomic( __METHOD__
. 'X' );
1951 $this->database
->$method( __METHOD__
);
1952 $this->fail( 'Expected exception not thrown' );
1953 } catch ( DBUnexpectedError
$ex ) {
1955 'Invalid atomic section ended (got ' . __METHOD__
. ' but expected ' .
1963 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1965 public function testUncancellableAtomicSection() {
1966 $this->database
->startAtomic( __METHOD__
);
1968 $this->database
->cancelAtomic( __METHOD__
);
1969 $this->database
->select( 'test', '1', [], __METHOD__
);
1970 $this->fail( 'Expected exception not thrown' );
1971 } catch ( DBTransactionError
$ex ) {
1973 'Cannot execute query from ' . __METHOD__
. ' while transaction status is ERROR.',
1980 * @covers \Wikimedia\Rdbms\Database::onAtomicSectionCancel
1982 public function testNoAtomicSectionForCallback() {
1984 $this->database
->onAtomicSectionCancel( function () {
1986 $this->fail( 'Expected exception not thrown' );
1987 } catch ( DBUnexpectedError
$ex ) {
1989 'No atomic section is open (got ' . __METHOD__
. ').',
1996 * @expectedException \Wikimedia\Rdbms\DBTransactionStateError
1997 * @covers \Wikimedia\Rdbms\Database::assertQueryIsCurrentlyAllowed
1999 public function testTransactionErrorState1() {
2000 $wrapper = TestingAccessWrapper
::newFromObject( $this->database
);
2002 $this->database
->begin( __METHOD__
);
2003 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
2004 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
2005 $this->database
->commit( __METHOD__
);
2009 * @covers \Wikimedia\Rdbms\Database::query
2011 public function testTransactionErrorState2() {
2012 $wrapper = TestingAccessWrapper
::newFromObject( $this->database
);
2014 $this->database
->startAtomic( __METHOD__
);
2015 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
2016 $this->database
->rollback( __METHOD__
);
2017 $this->assertEquals( 0, $this->database
->trxLevel() );
2018 $this->assertEquals( Database
::STATUS_TRX_NONE
, $wrapper->trxStatus() );
2019 $this->assertLastSql( 'BEGIN; ROLLBACK' );
2021 $this->database
->startAtomic( __METHOD__
);
2022 $this->assertEquals( Database
::STATUS_TRX_OK
, $wrapper->trxStatus() );
2023 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2024 $this->database
->endAtomic( __METHOD__
);
2025 $this->assertEquals( Database
::STATUS_TRX_NONE
, $wrapper->trxStatus() );
2026 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'1\'; COMMIT' );
2027 $this->assertEquals( 0, $this->database
->trxLevel(), 'Use after rollback()' );
2029 $this->database
->begin( __METHOD__
);
2030 $this->database
->startAtomic( __METHOD__
, Database
::ATOMIC_CANCELABLE
);
2031 $this->database
->update( 'y', [ 'a' => 1 ], [ 'field' => 1 ], __METHOD__
);
2032 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
2033 $this->database
->cancelAtomic( __METHOD__
);
2034 $this->assertEquals( Database
::STATUS_TRX_OK
, $wrapper->trxStatus() );
2035 $this->database
->startAtomic( __METHOD__
);
2036 $this->database
->delete( 'y', [ 'field' => 1 ], __METHOD__
);
2037 $this->database
->endAtomic( __METHOD__
);
2038 $this->database
->commit( __METHOD__
);
2039 // phpcs:ignore Generic.Files.LineLength
2040 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; UPDATE y SET a = \'1\' WHERE field = \'1\'; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; DELETE FROM y WHERE field = \'1\'; COMMIT' );
2041 $this->assertEquals( 0, $this->database
->trxLevel(), 'Use after rollback()' );
2044 $this->database
->startAtomic( __METHOD__
);
2045 $this->assertEquals( Database
::STATUS_TRX_OK
, $wrapper->trxStatus() );
2046 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
2047 $this->database
->endAtomic( __METHOD__
);
2048 $this->assertEquals( Database
::STATUS_TRX_NONE
, $wrapper->trxStatus() );
2049 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; COMMIT' );
2050 $this->assertEquals( 0, $this->database
->trxLevel() );
2054 * @covers \Wikimedia\Rdbms\Database::query
2056 public function testImplicitTransactionRollback() {
2057 $doError = function () {
2058 $this->database
->forceNextQueryError( 666, 'Evilness' );
2060 $this->database
->delete( 'error', '1', __CLASS__
. '::SomeCaller' );
2061 $this->fail( 'Expected exception not thrown' );
2062 } catch ( DBError
$e ) {
2063 $this->assertSame( 666, $e->errno
);
2067 $this->database
->setFlag( Database
::DBO_TRX
);
2069 // Implicit transaction does not get silently rolled back
2070 $this->database
->begin( __METHOD__
, Database
::TRANSACTION_INTERNAL
);
2071 call_user_func( $doError );
2073 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2074 $this->fail( 'Expected exception not thrown' );
2075 } catch ( DBTransactionError
$e ) {
2076 $this->assertEquals(
2077 'Cannot execute query from ' . __METHOD__
. ' while transaction status is ERROR.',
2082 $this->database
->commit( __METHOD__
, Database
::FLUSHING_INTERNAL
);
2083 $this->fail( 'Expected exception not thrown' );
2084 } catch ( DBTransactionError
$e ) {
2085 $this->assertEquals(
2086 'Cannot execute query from ' . __METHOD__
. ' while transaction status is ERROR.',
2090 $this->database
->rollback( __METHOD__
, Database
::FLUSHING_INTERNAL
);
2091 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; ROLLBACK' );
2093 // Likewise if there were prior writes
2094 $this->database
->begin( __METHOD__
, Database
::TRANSACTION_INTERNAL
);
2095 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2096 call_user_func( $doError );
2098 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2099 $this->fail( 'Expected exception not thrown' );
2100 } catch ( DBTransactionStateError
$e ) {
2102 $this->database
->rollback( __METHOD__
, Database
::FLUSHING_INTERNAL
);
2104 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'1\'; DELETE FROM error WHERE 1; ROLLBACK' );
2108 * @covers \Wikimedia\Rdbms\Database::query
2110 public function testTransactionStatementRollbackIgnoring() {
2111 $wrapper = TestingAccessWrapper
::newFromObject( $this->database
);
2113 $wrapper->deprecationLogger
= function ( $msg ) use ( &$warning ) {
2117 $doError = function () {
2118 $this->database
->forceNextQueryError( 666, 'Evilness', [
2119 'wasKnownStatementRollbackError' => true,
2122 $this->database
->delete( 'error', '1', __CLASS__
. '::SomeCaller' );
2123 $this->fail( 'Expected exception not thrown' );
2124 } catch ( DBError
$e ) {
2125 $this->assertSame( 666, $e->errno
);
2128 $expectWarning = 'Caller from ' . __METHOD__
.
2129 ' ignored an error originally raised from ' . __CLASS__
. '::SomeCaller: [666] Evilness';
2131 // Rollback doesn't raise a warning
2133 $this->database
->startAtomic( __METHOD__
);
2134 call_user_func( $doError );
2135 $this->database
->rollback( __METHOD__
);
2136 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2137 $this->assertSame( [], $warning );
2139 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; ROLLBACK; DELETE FROM x WHERE field = \'1\'' );
2141 // cancelAtomic() doesn't raise a warning
2143 $this->database
->begin( __METHOD__
);
2144 $this->database
->startAtomic( __METHOD__
, Database
::ATOMIC_CANCELABLE
);
2145 call_user_func( $doError );
2146 $this->database
->cancelAtomic( __METHOD__
);
2147 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2148 $this->database
->commit( __METHOD__
);
2149 $this->assertSame( [], $warning );
2151 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; DELETE FROM error WHERE 1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; DELETE FROM x WHERE field = \'1\'; COMMIT' );
2153 // Commit does raise a warning
2155 $this->database
->begin( __METHOD__
);
2156 call_user_func( $doError );
2157 $this->database
->commit( __METHOD__
);
2158 $this->assertSame( [ $expectWarning ], $warning );
2159 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; COMMIT' );
2161 // Deprecation only gets raised once
2163 $this->database
->begin( __METHOD__
);
2164 call_user_func( $doError );
2165 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
2166 $this->database
->commit( __METHOD__
);
2167 $this->assertSame( [ $expectWarning ], $warning );
2169 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; DELETE FROM x WHERE field = \'1\'; COMMIT' );
2173 * @covers \Wikimedia\Rdbms\Database::close
2175 public function testPrematureClose1() {
2176 $fname = __METHOD__
;
2177 $this->database
->begin( __METHOD__
);
2178 $this->database
->onTransactionCommitOrIdle( function () use ( $fname ) {
2179 $this->database
->query( 'SELECT 1', $fname );
2181 $this->database
->onTransactionResolution( function () use ( $fname ) {
2182 $this->database
->query( 'SELECT 2', $fname );
2184 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
2186 $this->database
->close();
2187 $this->fail( 'Expected exception not thrown' );
2188 } catch ( DBUnexpectedError
$ex ) {
2190 "Wikimedia\Rdbms\Database::close: transaction is still open (from $fname).",
2195 $this->assertFalse( $this->database
->isOpen() );
2196 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; ROLLBACK; SELECT 2' );
2197 $this->assertEquals( 0, $this->database
->trxLevel() );
2201 * @covers \Wikimedia\Rdbms\Database::close
2203 public function testPrematureClose2() {
2205 $fname = __METHOD__
;
2206 $this->database
->startAtomic( __METHOD__
);
2207 $this->database
->onTransactionCommitOrIdle( function () use ( $fname ) {
2208 $this->database
->query( 'SELECT 1', $fname );
2210 $this->database
->onAtomicSectionCancel( function () use ( $fname ) {
2211 $this->database
->query( 'SELECT 2', $fname );
2213 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
2214 $this->database
->close();
2215 $this->fail( 'Expected exception not thrown' );
2216 } catch ( DBUnexpectedError
$ex ) {
2218 'Wikimedia\Rdbms\Database::close: atomic sections ' .
2219 'DatabaseSQLTest::testPrematureClose2 are still open.',
2224 $this->assertFalse( $this->database
->isOpen() );
2225 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; ROLLBACK; SELECT 2' );
2226 $this->assertEquals( 0, $this->database
->trxLevel() );
2230 * @covers \Wikimedia\Rdbms\Database::close
2232 public function testPrematureClose3() {
2234 $this->database
->setFlag( IDatabase
::DBO_TRX
);
2235 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
2236 $this->assertEquals( 1, $this->database
->trxLevel() );
2237 $this->database
->close();
2238 $this->fail( 'Expected exception not thrown' );
2239 } catch ( DBUnexpectedError
$ex ) {
2241 'Wikimedia\Rdbms\Database::close: ' .
2242 'mass commit/rollback of peer transaction required (DBO_TRX set).',
2247 $this->assertFalse( $this->database
->isOpen() );
2248 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; ROLLBACK' );
2249 $this->assertEquals( 0, $this->database
->trxLevel() );
2253 * @covers \Wikimedia\Rdbms\Database::close
2255 public function testPrematureClose4() {
2256 $this->database
->setFlag( IDatabase
::DBO_TRX
);
2257 $this->database
->query( 'SELECT 1', __METHOD__
);
2258 $this->assertEquals( 1, $this->database
->trxLevel() );
2259 $this->database
->close();
2260 $this->database
->clearFlag( IDatabase
::DBO_TRX
);
2262 $this->assertFalse( $this->database
->isOpen() );
2263 $this->assertLastSql( 'BEGIN; SELECT 1; ROLLBACK' );
2264 $this->assertEquals( 0, $this->database
->trxLevel() );
2268 * @covers Wikimedia\Rdbms\Database::selectFieldValues()
2270 public function testSelectFieldValues() {
2271 $this->database
->forceNextResult( [
2272 (object)[ 'value' => 'row1' ],
2273 (object)[ 'value' => 'row2' ],
2274 (object)[ 'value' => 'row3' ],
2278 [ 'row1', 'row2', 'row3' ],
2279 $this->database
->selectFieldValues( 'table', 'table.field', 'conds', __METHOD__
)
2281 $this->assertLastSql( 'SELECT table.field AS value FROM table WHERE conds' );