Test ApiUserrights
[lhc/web/wiklou.git] / tests / phpunit / includes / libs / rdbms / database / DatabaseSQLTest.php
1 <?php
2
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
10 /**
11 * Test the parts of the Database abstract class that deal
12 * with creating SQL text.
13 */
14 class DatabaseSQLTest extends PHPUnit\Framework\TestCase {
15
16 use MediaWikiCoversValidator;
17 use PHPUnit4And6Compat;
18
19 /** @var DatabaseTestHelper|Database */
20 private $database;
21
22 protected function setUp() {
23 parent::setUp();
24 $this->database = new DatabaseTestHelper( __CLASS__, [ 'cliMode' => true ] );
25 }
26
27 protected function assertLastSql( $sqlText ) {
28 $this->assertEquals(
29 $sqlText,
30 $this->database->getLastSqls()
31 );
32 }
33
34 protected function assertLastSqlDb( $sqlText, DatabaseTestHelper $db ) {
35 $this->assertEquals( $sqlText, $db->getLastSqls() );
36 }
37
38 /**
39 * @dataProvider provideSelect
40 * @covers Wikimedia\Rdbms\Database::select
41 * @covers Wikimedia\Rdbms\Database::selectSQLText
42 * @covers Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN
43 * @covers Wikimedia\Rdbms\Database::useIndexClause
44 * @covers Wikimedia\Rdbms\Database::ignoreIndexClause
45 * @covers Wikimedia\Rdbms\Database::makeSelectOptions
46 * @covers Wikimedia\Rdbms\Database::makeOrderBy
47 * @covers Wikimedia\Rdbms\Database::makeGroupByWithHaving
48 */
49 public function testSelect( $sql, $sqlText ) {
50 $this->database->select(
51 $sql['tables'],
52 $sql['fields'],
53 isset( $sql['conds'] ) ? $sql['conds'] : [],
54 __METHOD__,
55 isset( $sql['options'] ) ? $sql['options'] : [],
56 isset( $sql['join_conds'] ) ? $sql['join_conds'] : []
57 );
58 $this->assertLastSql( $sqlText );
59 }
60
61 public static function provideSelect() {
62 return [
63 [
64 [
65 'tables' => 'table',
66 'fields' => [ 'field', 'alias' => 'field2' ],
67 'conds' => [ 'alias' => 'text' ],
68 ],
69 "SELECT field,field2 AS alias " .
70 "FROM table " .
71 "WHERE alias = 'text'"
72 ],
73 [
74 [
75 'tables' => 'table',
76 'fields' => [ 'field', 'alias' => 'field2' ],
77 'conds' => 'alias = \'text\'',
78 ],
79 "SELECT field,field2 AS alias " .
80 "FROM table " .
81 "WHERE alias = 'text'"
82 ],
83 [
84 [
85 'tables' => 'table',
86 'fields' => [ 'field', 'alias' => 'field2' ],
87 'conds' => [],
88 ],
89 "SELECT field,field2 AS alias " .
90 "FROM table"
91 ],
92 [
93 [
94 'tables' => 'table',
95 'fields' => [ 'field', 'alias' => 'field2' ],
96 'conds' => '',
97 ],
98 "SELECT field,field2 AS alias " .
99 "FROM table"
100 ],
101 [
102 [
103 'tables' => 'table',
104 'fields' => [ 'field', 'alias' => 'field2' ],
105 'conds' => '0', // T188314
106 ],
107 "SELECT field,field2 AS alias " .
108 "FROM table " .
109 "WHERE 0"
110 ],
111 [
112 [
113 // 'tables' with space prepended indicates pre-escaped table name
114 'tables' => ' table LEFT JOIN table2',
115 'fields' => [ 'field' ],
116 'conds' => [ 'field' => 'text' ],
117 ],
118 "SELECT field FROM table LEFT JOIN table2 WHERE field = 'text'"
119 ],
120 [
121 [
122 // Empty 'tables' is allowed
123 'tables' => '',
124 'fields' => [ 'SPECIAL_QUERY()' ],
125 ],
126 "SELECT SPECIAL_QUERY()"
127 ],
128 [
129 [
130 'tables' => 'table',
131 'fields' => [ 'field', 'alias' => 'field2' ],
132 'conds' => [ 'alias' => 'text' ],
133 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
134 ],
135 "SELECT field,field2 AS alias " .
136 "FROM table " .
137 "WHERE alias = 'text' " .
138 "ORDER BY field " .
139 "LIMIT 1"
140 ],
141 [
142 [
143 'tables' => [ 'table', 't2' => 'table2' ],
144 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
145 'conds' => [ 'alias' => 'text' ],
146 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
147 'join_conds' => [ 't2' => [
148 'LEFT JOIN', 'tid = t2.id'
149 ] ],
150 ],
151 "SELECT tid,field,field2 AS alias,t2.id " .
152 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
153 "WHERE alias = 'text' " .
154 "ORDER BY field " .
155 "LIMIT 1"
156 ],
157 [
158 [
159 'tables' => [ 'table', 't2' => 'table2' ],
160 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
161 'conds' => [ 'alias' => 'text' ],
162 'options' => [ 'LIMIT' => 1, 'GROUP BY' => 'field', 'HAVING' => 'COUNT(*) > 1' ],
163 'join_conds' => [ 't2' => [
164 'LEFT JOIN', 'tid = t2.id'
165 ] ],
166 ],
167 "SELECT tid,field,field2 AS alias,t2.id " .
168 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
169 "WHERE alias = 'text' " .
170 "GROUP BY field HAVING COUNT(*) > 1 " .
171 "LIMIT 1"
172 ],
173 [
174 [
175 'tables' => [ 'table', 't2' => 'table2' ],
176 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
177 'conds' => [ 'alias' => 'text' ],
178 'options' => [
179 'LIMIT' => 1,
180 'GROUP BY' => [ 'field', 'field2' ],
181 'HAVING' => [ 'COUNT(*) > 1', 'field' => 1 ]
182 ],
183 'join_conds' => [ 't2' => [
184 'LEFT JOIN', 'tid = t2.id'
185 ] ],
186 ],
187 "SELECT tid,field,field2 AS alias,t2.id " .
188 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
189 "WHERE alias = 'text' " .
190 "GROUP BY field,field2 HAVING (COUNT(*) > 1) AND field = '1' " .
191 "LIMIT 1"
192 ],
193 [
194 [
195 'tables' => [ 'table' ],
196 'fields' => [ 'alias' => 'field' ],
197 'conds' => [ 'alias' => [ 1, 2, 3, 4 ] ],
198 ],
199 "SELECT field AS alias " .
200 "FROM table " .
201 "WHERE alias IN ('1','2','3','4')"
202 ],
203 [
204 [
205 'tables' => 'table',
206 'fields' => [ 'field' ],
207 'options' => [ 'USE INDEX' => [ 'table' => 'X' ] ],
208 ],
209 // No-op by default
210 "SELECT field FROM table"
211 ],
212 [
213 [
214 'tables' => 'table',
215 'fields' => [ 'field' ],
216 'options' => [ 'IGNORE INDEX' => [ 'table' => 'X' ] ],
217 ],
218 // No-op by default
219 "SELECT field FROM table"
220 ],
221 [
222 [
223 'tables' => 'table',
224 'fields' => [ 'field' ],
225 'options' => [ 'DISTINCT', 'LOCK IN SHARE MODE' ],
226 ],
227 "SELECT DISTINCT field FROM table LOCK IN SHARE MODE"
228 ],
229 [
230 [
231 'tables' => 'table',
232 'fields' => [ 'field' ],
233 'options' => [ 'EXPLAIN' => true ],
234 ],
235 'EXPLAIN SELECT field FROM table'
236 ],
237 [
238 [
239 'tables' => 'table',
240 'fields' => [ 'field' ],
241 'options' => [ 'FOR UPDATE' ],
242 ],
243 "SELECT field FROM table FOR UPDATE"
244 ],
245 ];
246 }
247
248 /**
249 * @covers Wikimedia\Rdbms\Subquery
250 * @dataProvider provideSelectRowCount
251 * @param $sql
252 * @param $sqlText
253 */
254 public function testSelectRowCount( $sql, $sqlText ) {
255 $this->database->selectRowCount(
256 $sql['tables'],
257 $sql['field'],
258 isset( $sql['conds'] ) ? $sql['conds'] : [],
259 __METHOD__,
260 isset( $sql['options'] ) ? $sql['options'] : [],
261 isset( $sql['join_conds'] ) ? $sql['join_conds'] : []
262 );
263 $this->assertLastSql( $sqlText );
264 }
265
266 public static function provideSelectRowCount() {
267 return [
268 [
269 [
270 'tables' => 'table',
271 'field' => [ '*' ],
272 'conds' => [ 'field' => 'text' ],
273 ],
274 "SELECT COUNT(*) AS rowcount FROM " .
275 "(SELECT 1 FROM table WHERE field = 'text' ) tmp_count"
276 ],
277 [
278 [
279 'tables' => 'table',
280 'field' => [ 'column' ],
281 'conds' => [ 'field' => 'text' ],
282 ],
283 "SELECT COUNT(*) AS rowcount FROM " .
284 "(SELECT 1 FROM table WHERE field = 'text' AND (column IS NOT NULL) ) tmp_count"
285 ],
286 [
287 [
288 'tables' => 'table',
289 'field' => [ 'alias' => 'column' ],
290 'conds' => [ 'field' => 'text' ],
291 ],
292 "SELECT COUNT(*) AS rowcount FROM " .
293 "(SELECT 1 FROM table WHERE field = 'text' AND (column IS NOT NULL) ) tmp_count"
294 ],
295 [
296 [
297 'tables' => 'table',
298 'field' => [ 'alias' => 'column' ],
299 'conds' => '',
300 ],
301 "SELECT COUNT(*) AS rowcount FROM " .
302 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
303 ],
304 [
305 [
306 'tables' => 'table',
307 'field' => [ 'alias' => 'column' ],
308 'conds' => false,
309 ],
310 "SELECT COUNT(*) AS rowcount FROM " .
311 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
312 ],
313 [
314 [
315 'tables' => 'table',
316 'field' => [ 'alias' => 'column' ],
317 'conds' => null,
318 ],
319 "SELECT COUNT(*) AS rowcount FROM " .
320 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
321 ],
322 [
323 [
324 'tables' => 'table',
325 'field' => [ 'alias' => 'column' ],
326 'conds' => '1',
327 ],
328 "SELECT COUNT(*) AS rowcount FROM " .
329 "(SELECT 1 FROM table WHERE (1) AND (column IS NOT NULL) ) tmp_count"
330 ],
331 [
332 [
333 'tables' => 'table',
334 'field' => [ 'alias' => 'column' ],
335 'conds' => '0',
336 ],
337 "SELECT COUNT(*) AS rowcount FROM " .
338 "(SELECT 1 FROM table WHERE (0) AND (column IS NOT NULL) ) tmp_count"
339 ],
340 ];
341 }
342
343 /**
344 * @dataProvider provideUpdate
345 * @covers Wikimedia\Rdbms\Database::update
346 * @covers Wikimedia\Rdbms\Database::makeUpdateOptions
347 * @covers Wikimedia\Rdbms\Database::makeUpdateOptionsArray
348 */
349 public function testUpdate( $sql, $sqlText ) {
350 $this->database->update(
351 $sql['table'],
352 $sql['values'],
353 $sql['conds'],
354 __METHOD__,
355 isset( $sql['options'] ) ? $sql['options'] : []
356 );
357 $this->assertLastSql( $sqlText );
358 }
359
360 public static function provideUpdate() {
361 return [
362 [
363 [
364 'table' => 'table',
365 'values' => [ 'field' => 'text', 'field2' => 'text2' ],
366 'conds' => [ 'alias' => 'text' ],
367 ],
368 "UPDATE table " .
369 "SET field = 'text'" .
370 ",field2 = 'text2' " .
371 "WHERE alias = 'text'"
372 ],
373 [
374 [
375 'table' => 'table',
376 'values' => [ 'field = other', 'field2' => 'text2' ],
377 'conds' => [ 'id' => '1' ],
378 ],
379 "UPDATE table " .
380 "SET field = other" .
381 ",field2 = 'text2' " .
382 "WHERE id = '1'"
383 ],
384 [
385 [
386 'table' => 'table',
387 'values' => [ 'field = other', 'field2' => 'text2' ],
388 'conds' => '*',
389 ],
390 "UPDATE table " .
391 "SET field = other" .
392 ",field2 = 'text2'"
393 ],
394 ];
395 }
396
397 /**
398 * @dataProvider provideDelete
399 * @covers Wikimedia\Rdbms\Database::delete
400 */
401 public function testDelete( $sql, $sqlText ) {
402 $this->database->delete(
403 $sql['table'],
404 $sql['conds'],
405 __METHOD__
406 );
407 $this->assertLastSql( $sqlText );
408 }
409
410 public static function provideDelete() {
411 return [
412 [
413 [
414 'table' => 'table',
415 'conds' => [ 'alias' => 'text' ],
416 ],
417 "DELETE FROM table " .
418 "WHERE alias = 'text'"
419 ],
420 [
421 [
422 'table' => 'table',
423 'conds' => '*',
424 ],
425 "DELETE FROM table"
426 ],
427 ];
428 }
429
430 /**
431 * @dataProvider provideUpsert
432 * @covers Wikimedia\Rdbms\Database::upsert
433 */
434 public function testUpsert( $sql, $sqlText ) {
435 $this->database->upsert(
436 $sql['table'],
437 $sql['rows'],
438 $sql['uniqueIndexes'],
439 $sql['set'],
440 __METHOD__
441 );
442 $this->assertLastSql( $sqlText );
443 }
444
445 public static function provideUpsert() {
446 return [
447 [
448 [
449 'table' => 'upsert_table',
450 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
451 'uniqueIndexes' => [ 'field' ],
452 'set' => [ 'field' => 'set' ],
453 ],
454 "BEGIN; " .
455 "UPDATE upsert_table " .
456 "SET field = 'set' " .
457 "WHERE ((field = 'text')); " .
458 "INSERT IGNORE INTO upsert_table " .
459 "(field,field2) " .
460 "VALUES ('text','text2'); " .
461 "COMMIT"
462 ],
463 ];
464 }
465
466 /**
467 * @dataProvider provideDeleteJoin
468 * @covers Wikimedia\Rdbms\Database::deleteJoin
469 */
470 public function testDeleteJoin( $sql, $sqlText ) {
471 $this->database->deleteJoin(
472 $sql['delTable'],
473 $sql['joinTable'],
474 $sql['delVar'],
475 $sql['joinVar'],
476 $sql['conds'],
477 __METHOD__
478 );
479 $this->assertLastSql( $sqlText );
480 }
481
482 public static function provideDeleteJoin() {
483 return [
484 [
485 [
486 'delTable' => 'table',
487 'joinTable' => 'table_join',
488 'delVar' => 'field',
489 'joinVar' => 'field_join',
490 'conds' => [ 'alias' => 'text' ],
491 ],
492 "DELETE FROM table " .
493 "WHERE field IN (" .
494 "SELECT field_join FROM table_join WHERE alias = 'text'" .
495 ")"
496 ],
497 [
498 [
499 'delTable' => 'table',
500 'joinTable' => 'table_join',
501 'delVar' => 'field',
502 'joinVar' => 'field_join',
503 'conds' => '*',
504 ],
505 "DELETE FROM table " .
506 "WHERE field IN (" .
507 "SELECT field_join FROM table_join " .
508 ")"
509 ],
510 ];
511 }
512
513 /**
514 * @dataProvider provideInsert
515 * @covers Wikimedia\Rdbms\Database::insert
516 * @covers Wikimedia\Rdbms\Database::makeInsertOptions
517 */
518 public function testInsert( $sql, $sqlText ) {
519 $this->database->insert(
520 $sql['table'],
521 $sql['rows'],
522 __METHOD__,
523 isset( $sql['options'] ) ? $sql['options'] : []
524 );
525 $this->assertLastSql( $sqlText );
526 }
527
528 public static function provideInsert() {
529 return [
530 [
531 [
532 'table' => 'table',
533 'rows' => [ 'field' => 'text', 'field2' => 2 ],
534 ],
535 "INSERT INTO table " .
536 "(field,field2) " .
537 "VALUES ('text','2')"
538 ],
539 [
540 [
541 'table' => 'table',
542 'rows' => [ 'field' => 'text', 'field2' => 2 ],
543 'options' => 'IGNORE',
544 ],
545 "INSERT IGNORE INTO table " .
546 "(field,field2) " .
547 "VALUES ('text','2')"
548 ],
549 [
550 [
551 'table' => 'table',
552 'rows' => [
553 [ 'field' => 'text', 'field2' => 2 ],
554 [ 'field' => 'multi', 'field2' => 3 ],
555 ],
556 'options' => 'IGNORE',
557 ],
558 "INSERT IGNORE INTO table " .
559 "(field,field2) " .
560 "VALUES " .
561 "('text','2')," .
562 "('multi','3')"
563 ],
564 ];
565 }
566
567 /**
568 * @dataProvider provideInsertSelect
569 * @covers Wikimedia\Rdbms\Database::insertSelect
570 * @covers Wikimedia\Rdbms\Database::nativeInsertSelect
571 */
572 public function testInsertSelect( $sql, $sqlTextNative, $sqlSelect, $sqlInsert ) {
573 $this->database->insertSelect(
574 $sql['destTable'],
575 $sql['srcTable'],
576 $sql['varMap'],
577 $sql['conds'],
578 __METHOD__,
579 isset( $sql['insertOptions'] ) ? $sql['insertOptions'] : [],
580 isset( $sql['selectOptions'] ) ? $sql['selectOptions'] : [],
581 isset( $sql['selectJoinConds'] ) ? $sql['selectJoinConds'] : []
582 );
583 $this->assertLastSql( $sqlTextNative );
584
585 $dbWeb = new DatabaseTestHelper( __CLASS__, [ 'cliMode' => false ] );
586 $dbWeb->forceNextResult( [
587 array_flip( array_keys( $sql['varMap'] ) )
588 ] );
589 $dbWeb->insertSelect(
590 $sql['destTable'],
591 $sql['srcTable'],
592 $sql['varMap'],
593 $sql['conds'],
594 __METHOD__,
595 isset( $sql['insertOptions'] ) ? $sql['insertOptions'] : [],
596 isset( $sql['selectOptions'] ) ? $sql['selectOptions'] : [],
597 isset( $sql['selectJoinConds'] ) ? $sql['selectJoinConds'] : []
598 );
599 $this->assertLastSqlDb( implode( '; ', [ $sqlSelect, 'BEGIN', $sqlInsert, 'COMMIT' ] ), $dbWeb );
600 }
601
602 public static function provideInsertSelect() {
603 return [
604 [
605 [
606 'destTable' => 'insert_table',
607 'srcTable' => 'select_table',
608 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
609 'conds' => '*',
610 ],
611 "INSERT INTO insert_table " .
612 "(field_insert,field) " .
613 "SELECT field_select,field2 " .
614 "FROM select_table WHERE *",
615 "SELECT field_select AS field_insert,field2 AS field " .
616 "FROM select_table WHERE * FOR UPDATE",
617 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
618 ],
619 [
620 [
621 'destTable' => 'insert_table',
622 'srcTable' => 'select_table',
623 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
624 'conds' => [ 'field' => 2 ],
625 ],
626 "INSERT INTO insert_table " .
627 "(field_insert,field) " .
628 "SELECT field_select,field2 " .
629 "FROM select_table " .
630 "WHERE field = '2'",
631 "SELECT field_select AS field_insert,field2 AS field FROM " .
632 "select_table WHERE field = '2' FOR UPDATE",
633 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
634 ],
635 [
636 [
637 'destTable' => 'insert_table',
638 'srcTable' => 'select_table',
639 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
640 'conds' => [ 'field' => 2 ],
641 'insertOptions' => 'IGNORE',
642 'selectOptions' => [ 'ORDER BY' => 'field' ],
643 ],
644 "INSERT IGNORE INTO insert_table " .
645 "(field_insert,field) " .
646 "SELECT field_select,field2 " .
647 "FROM select_table " .
648 "WHERE field = '2' " .
649 "ORDER BY field",
650 "SELECT field_select AS field_insert,field2 AS field " .
651 "FROM select_table WHERE field = '2' ORDER BY field FOR UPDATE",
652 "INSERT IGNORE INTO insert_table (field_insert,field) VALUES ('0','1')"
653 ],
654 [
655 [
656 'destTable' => 'insert_table',
657 'srcTable' => [ 'select_table1', 'select_table2' ],
658 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
659 'conds' => [ 'field' => 2 ],
660 'insertOptions' => [ 'NO_AUTO_COLUMNS' ],
661 'selectOptions' => [ 'ORDER BY' => 'field', 'FORCE INDEX' => [ 'select_table1' => 'index1' ] ],
662 'selectJoinConds' => [
663 'select_table2' => [ 'LEFT JOIN', [ 'select_table1.foo = select_table2.bar' ] ],
664 ],
665 ],
666 "INSERT INTO insert_table " .
667 "(field_insert,field) " .
668 "SELECT field_select,field2 " .
669 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
670 "WHERE field = '2' " .
671 "ORDER BY field",
672 "SELECT field_select AS field_insert,field2 AS field " .
673 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
674 "WHERE field = '2' ORDER BY field FOR UPDATE",
675 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
676 ],
677 ];
678 }
679
680 public function testInsertSelectBatching() {
681 $dbWeb = new DatabaseTestHelper( __CLASS__, [ 'cliMode' => false ] );
682 $rows = [];
683 for ( $i = 0; $i <= 25000; $i++ ) {
684 $rows[] = [ 'field' => $i ];
685 }
686 $dbWeb->forceNextResult( $rows );
687 $dbWeb->insertSelect(
688 'insert_table',
689 'select_table',
690 [ 'field' => 'field2' ],
691 '*',
692 __METHOD__
693 );
694 $this->assertLastSqlDb( implode( '; ', [
695 'SELECT field2 AS field FROM select_table WHERE * FOR UPDATE',
696 'BEGIN',
697 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 0, 9999 ) ) . "')",
698 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 10000, 19999 ) ) . "')",
699 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 20000, 25000 ) ) . "')",
700 'COMMIT'
701 ] ), $dbWeb );
702 }
703
704 /**
705 * @dataProvider provideReplace
706 * @covers Wikimedia\Rdbms\Database::replace
707 */
708 public function testReplace( $sql, $sqlText ) {
709 $this->database->replace(
710 $sql['table'],
711 $sql['uniqueIndexes'],
712 $sql['rows'],
713 __METHOD__
714 );
715 $this->assertLastSql( $sqlText );
716 }
717
718 public static function provideReplace() {
719 return [
720 [
721 [
722 'table' => 'replace_table',
723 'uniqueIndexes' => [ 'field' ],
724 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
725 ],
726 "BEGIN; DELETE FROM replace_table " .
727 "WHERE (field = 'text'); " .
728 "INSERT INTO replace_table " .
729 "(field,field2) " .
730 "VALUES ('text','text2'); COMMIT"
731 ],
732 [
733 [
734 'table' => 'module_deps',
735 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
736 'rows' => [
737 'md_module' => 'module',
738 'md_skin' => 'skin',
739 'md_deps' => 'deps',
740 ],
741 ],
742 "BEGIN; DELETE FROM module_deps " .
743 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
744 "INSERT INTO module_deps " .
745 "(md_module,md_skin,md_deps) " .
746 "VALUES ('module','skin','deps'); COMMIT"
747 ],
748 [
749 [
750 'table' => 'module_deps',
751 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
752 'rows' => [
753 [
754 'md_module' => 'module',
755 'md_skin' => 'skin',
756 'md_deps' => 'deps',
757 ], [
758 'md_module' => 'module2',
759 'md_skin' => 'skin2',
760 'md_deps' => 'deps2',
761 ],
762 ],
763 ],
764 "BEGIN; DELETE FROM module_deps " .
765 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
766 "INSERT INTO module_deps " .
767 "(md_module,md_skin,md_deps) " .
768 "VALUES ('module','skin','deps'); " .
769 "DELETE FROM module_deps " .
770 "WHERE (md_module = 'module2' AND md_skin = 'skin2'); " .
771 "INSERT INTO module_deps " .
772 "(md_module,md_skin,md_deps) " .
773 "VALUES ('module2','skin2','deps2'); COMMIT"
774 ],
775 [
776 [
777 'table' => 'module_deps',
778 'uniqueIndexes' => [ 'md_module', 'md_skin' ],
779 'rows' => [
780 [
781 'md_module' => 'module',
782 'md_skin' => 'skin',
783 'md_deps' => 'deps',
784 ], [
785 'md_module' => 'module2',
786 'md_skin' => 'skin2',
787 'md_deps' => 'deps2',
788 ],
789 ],
790 ],
791 "BEGIN; DELETE FROM module_deps " .
792 "WHERE (md_module = 'module') OR (md_skin = 'skin'); " .
793 "INSERT INTO module_deps " .
794 "(md_module,md_skin,md_deps) " .
795 "VALUES ('module','skin','deps'); " .
796 "DELETE FROM module_deps " .
797 "WHERE (md_module = 'module2') OR (md_skin = 'skin2'); " .
798 "INSERT INTO module_deps " .
799 "(md_module,md_skin,md_deps) " .
800 "VALUES ('module2','skin2','deps2'); COMMIT"
801 ],
802 [
803 [
804 'table' => 'module_deps',
805 'uniqueIndexes' => [],
806 'rows' => [
807 'md_module' => 'module',
808 'md_skin' => 'skin',
809 'md_deps' => 'deps',
810 ],
811 ],
812 "BEGIN; INSERT INTO module_deps " .
813 "(md_module,md_skin,md_deps) " .
814 "VALUES ('module','skin','deps'); COMMIT"
815 ],
816 ];
817 }
818
819 /**
820 * @dataProvider provideNativeReplace
821 * @covers Wikimedia\Rdbms\Database::nativeReplace
822 */
823 public function testNativeReplace( $sql, $sqlText ) {
824 $this->database->nativeReplace(
825 $sql['table'],
826 $sql['rows'],
827 __METHOD__
828 );
829 $this->assertLastSql( $sqlText );
830 }
831
832 public static function provideNativeReplace() {
833 return [
834 [
835 [
836 'table' => 'replace_table',
837 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
838 ],
839 "REPLACE INTO replace_table " .
840 "(field,field2) " .
841 "VALUES ('text','text2')"
842 ],
843 ];
844 }
845
846 /**
847 * @dataProvider provideConditional
848 * @covers Wikimedia\Rdbms\Database::conditional
849 */
850 public function testConditional( $sql, $sqlText ) {
851 $this->assertEquals( trim( $this->database->conditional(
852 $sql['conds'],
853 $sql['true'],
854 $sql['false']
855 ) ), $sqlText );
856 }
857
858 public static function provideConditional() {
859 return [
860 [
861 [
862 'conds' => [ 'field' => 'text' ],
863 'true' => 1,
864 'false' => 'NULL',
865 ],
866 "(CASE WHEN field = 'text' THEN 1 ELSE NULL END)"
867 ],
868 [
869 [
870 'conds' => [ 'field' => 'text', 'field2' => 'anothertext' ],
871 'true' => 1,
872 'false' => 'NULL',
873 ],
874 "(CASE WHEN field = 'text' AND field2 = 'anothertext' THEN 1 ELSE NULL END)"
875 ],
876 [
877 [
878 'conds' => 'field=1',
879 'true' => 1,
880 'false' => 'NULL',
881 ],
882 "(CASE WHEN field=1 THEN 1 ELSE NULL END)"
883 ],
884 ];
885 }
886
887 /**
888 * @dataProvider provideBuildConcat
889 * @covers Wikimedia\Rdbms\Database::buildConcat
890 */
891 public function testBuildConcat( $stringList, $sqlText ) {
892 $this->assertEquals( trim( $this->database->buildConcat(
893 $stringList
894 ) ), $sqlText );
895 }
896
897 public static function provideBuildConcat() {
898 return [
899 [
900 [ 'field', 'field2' ],
901 "CONCAT(field,field2)"
902 ],
903 [
904 [ "'test'", 'field2' ],
905 "CONCAT('test',field2)"
906 ],
907 ];
908 }
909
910 /**
911 * @dataProvider provideBuildLike
912 * @covers Wikimedia\Rdbms\Database::buildLike
913 * @covers Wikimedia\Rdbms\Database::escapeLikeInternal
914 */
915 public function testBuildLike( $array, $sqlText ) {
916 $this->assertEquals( trim( $this->database->buildLike(
917 $array
918 ) ), $sqlText );
919 }
920
921 public static function provideBuildLike() {
922 return [
923 [
924 'text',
925 "LIKE 'text' ESCAPE '`'"
926 ],
927 [
928 [ 'text', new LikeMatch( '%' ) ],
929 "LIKE 'text%' ESCAPE '`'"
930 ],
931 [
932 [ 'text', new LikeMatch( '%' ), 'text2' ],
933 "LIKE 'text%text2' ESCAPE '`'"
934 ],
935 [
936 [ 'text', new LikeMatch( '_' ) ],
937 "LIKE 'text_' ESCAPE '`'"
938 ],
939 [
940 'more_text',
941 "LIKE 'more`_text' ESCAPE '`'"
942 ],
943 [
944 [ 'C:\\Windows\\', new LikeMatch( '%' ) ],
945 "LIKE 'C:\\Windows\\%' ESCAPE '`'"
946 ],
947 [
948 [ 'accent`_test`', new LikeMatch( '%' ) ],
949 "LIKE 'accent```_test``%' ESCAPE '`'"
950 ],
951 ];
952 }
953
954 /**
955 * @dataProvider provideUnionQueries
956 * @covers Wikimedia\Rdbms\Database::unionQueries
957 */
958 public function testUnionQueries( $sql, $sqlText ) {
959 $this->assertEquals( trim( $this->database->unionQueries(
960 $sql['sqls'],
961 $sql['all']
962 ) ), $sqlText );
963 }
964
965 public static function provideUnionQueries() {
966 return [
967 [
968 [
969 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
970 'all' => true,
971 ],
972 "(RAW SQL) UNION ALL (RAW2SQL)"
973 ],
974 [
975 [
976 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
977 'all' => false,
978 ],
979 "(RAW SQL) UNION (RAW2SQL)"
980 ],
981 [
982 [
983 'sqls' => [ 'RAW SQL', 'RAW2SQL', 'RAW3SQL' ],
984 'all' => false,
985 ],
986 "(RAW SQL) UNION (RAW2SQL) UNION (RAW3SQL)"
987 ],
988 ];
989 }
990
991 /**
992 * @dataProvider provideUnionConditionPermutations
993 * @covers Wikimedia\Rdbms\Database::unionConditionPermutations
994 */
995 public function testUnionConditionPermutations( $params, $expect ) {
996 if ( isset( $params['unionSupportsOrderAndLimit'] ) ) {
997 $this->database->setUnionSupportsOrderAndLimit( $params['unionSupportsOrderAndLimit'] );
998 }
999
1000 $sql = trim( $this->database->unionConditionPermutations(
1001 $params['table'],
1002 $params['vars'],
1003 $params['permute_conds'],
1004 isset( $params['extra_conds'] ) ? $params['extra_conds'] : '',
1005 'FNAME',
1006 isset( $params['options'] ) ? $params['options'] : [],
1007 isset( $params['join_conds'] ) ? $params['join_conds'] : []
1008 ) );
1009 $this->assertEquals( $expect, $sql );
1010 }
1011
1012 public static function provideUnionConditionPermutations() {
1013 // phpcs:disable Generic.Files.LineLength
1014 return [
1015 [
1016 [
1017 'table' => [ 'table1', 'table2' ],
1018 'vars' => [ 'field1', 'alias' => 'field2' ],
1019 'permute_conds' => [
1020 'field3' => [ 1, 2, 3 ],
1021 'duplicates' => [ 4, 5, 4 ],
1022 'empty' => [],
1023 'single' => [ 0 ],
1024 ],
1025 'extra_conds' => 'table2.bar > 23',
1026 'options' => [
1027 'ORDER BY' => [ 'field1', 'alias' ],
1028 'INNER ORDER BY' => [ 'field1', 'field2' ],
1029 'LIMIT' => 100,
1030 ],
1031 'join_conds' => [
1032 'table2' => [ 'JOIN', 'table1.foo_id = table2.foo_id' ],
1033 ],
1034 ],
1035 "(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 " .
1036 "(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 " .
1037 "(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 " .
1038 "(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 " .
1039 "(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 " .
1040 "(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 ) " .
1041 "ORDER BY field1,alias LIMIT 100"
1042 ],
1043 [
1044 [
1045 'table' => 'foo',
1046 'vars' => [ 'foo_id' ],
1047 'permute_conds' => [
1048 'bar' => [ 1, 2, 3 ],
1049 ],
1050 'extra_conds' => [ 'baz' => null ],
1051 'options' => [
1052 'NOTALL',
1053 'ORDER BY' => [ 'foo_id' ],
1054 'LIMIT' => 25,
1055 ],
1056 ],
1057 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
1058 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
1059 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) " .
1060 "ORDER BY foo_id LIMIT 25"
1061 ],
1062 [
1063 [
1064 'table' => 'foo',
1065 'vars' => [ 'foo_id' ],
1066 'permute_conds' => [
1067 'bar' => [ 1, 2, 3 ],
1068 ],
1069 'extra_conds' => [ 'baz' => null ],
1070 'options' => [
1071 'NOTALL' => true,
1072 'ORDER BY' => [ 'foo_id' ],
1073 'LIMIT' => 25,
1074 ],
1075 'unionSupportsOrderAndLimit' => false,
1076 ],
1077 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ) UNION " .
1078 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ) UNION " .
1079 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ) " .
1080 "ORDER BY foo_id LIMIT 25"
1081 ],
1082 [
1083 [
1084 'table' => 'foo',
1085 'vars' => [ 'foo_id' ],
1086 'permute_conds' => [],
1087 'extra_conds' => [ 'baz' => null ],
1088 'options' => [
1089 'ORDER BY' => [ 'foo_id' ],
1090 'LIMIT' => 25,
1091 ],
1092 ],
1093 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
1094 ],
1095 [
1096 [
1097 'table' => 'foo',
1098 'vars' => [ 'foo_id' ],
1099 'permute_conds' => [
1100 'bar' => [],
1101 ],
1102 'extra_conds' => [ 'baz' => null ],
1103 'options' => [
1104 'ORDER BY' => [ 'foo_id' ],
1105 'LIMIT' => 25,
1106 ],
1107 ],
1108 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
1109 ],
1110 [
1111 [
1112 'table' => 'foo',
1113 'vars' => [ 'foo_id' ],
1114 'permute_conds' => [
1115 'bar' => [ 1 ],
1116 ],
1117 'options' => [
1118 'ORDER BY' => [ 'foo_id' ],
1119 'LIMIT' => 25,
1120 'OFFSET' => 150,
1121 ],
1122 ],
1123 "SELECT foo_id FROM foo WHERE bar = '1' ORDER BY foo_id LIMIT 150,25"
1124 ],
1125 [
1126 [
1127 'table' => 'foo',
1128 'vars' => [ 'foo_id' ],
1129 'permute_conds' => [],
1130 'extra_conds' => [ 'baz' => null ],
1131 'options' => [
1132 'ORDER BY' => [ 'foo_id' ],
1133 'LIMIT' => 25,
1134 'OFFSET' => 150,
1135 'INNER ORDER BY' => [ 'bar_id' ],
1136 ],
1137 ],
1138 "(SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY bar_id LIMIT 175 ) ORDER BY foo_id LIMIT 150,25"
1139 ],
1140 [
1141 [
1142 'table' => 'foo',
1143 'vars' => [ 'foo_id' ],
1144 'permute_conds' => [],
1145 'extra_conds' => [ 'baz' => null ],
1146 'options' => [
1147 'ORDER BY' => [ 'foo_id' ],
1148 'LIMIT' => 25,
1149 'OFFSET' => 150,
1150 'INNER ORDER BY' => [ 'bar_id' ],
1151 ],
1152 'unionSupportsOrderAndLimit' => false,
1153 ],
1154 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 150,25"
1155 ],
1156 ];
1157 // phpcs:enable
1158 }
1159
1160 /**
1161 * @covers Wikimedia\Rdbms\Database::commit
1162 * @covers Wikimedia\Rdbms\Database::doCommit
1163 */
1164 public function testTransactionCommit() {
1165 $this->database->begin( __METHOD__ );
1166 $this->database->commit( __METHOD__ );
1167 $this->assertLastSql( 'BEGIN; COMMIT' );
1168 }
1169
1170 /**
1171 * @covers Wikimedia\Rdbms\Database::rollback
1172 * @covers Wikimedia\Rdbms\Database::doRollback
1173 */
1174 public function testTransactionRollback() {
1175 $this->database->begin( __METHOD__ );
1176 $this->database->rollback( __METHOD__ );
1177 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1178 }
1179
1180 /**
1181 * @covers Wikimedia\Rdbms\Database::dropTable
1182 */
1183 public function testDropTable() {
1184 $this->database->setExistingTables( [ 'table' ] );
1185 $this->database->dropTable( 'table', __METHOD__ );
1186 $this->assertLastSql( 'DROP TABLE table CASCADE' );
1187 }
1188
1189 /**
1190 * @covers Wikimedia\Rdbms\Database::dropTable
1191 */
1192 public function testDropNonExistingTable() {
1193 $this->assertFalse(
1194 $this->database->dropTable( 'non_existing', __METHOD__ )
1195 );
1196 }
1197
1198 /**
1199 * @dataProvider provideMakeList
1200 * @covers Wikimedia\Rdbms\Database::makeList
1201 */
1202 public function testMakeList( $list, $mode, $sqlText ) {
1203 $this->assertEquals( trim( $this->database->makeList(
1204 $list, $mode
1205 ) ), $sqlText );
1206 }
1207
1208 public static function provideMakeList() {
1209 return [
1210 [
1211 [ 'value', 'value2' ],
1212 LIST_COMMA,
1213 "'value','value2'"
1214 ],
1215 [
1216 [ 'field', 'field2' ],
1217 LIST_NAMES,
1218 "field,field2"
1219 ],
1220 [
1221 [ 'field' => 'value', 'field2' => 'value2' ],
1222 LIST_AND,
1223 "field = 'value' AND field2 = 'value2'"
1224 ],
1225 [
1226 [ 'field' => null, "field2 != 'value2'" ],
1227 LIST_AND,
1228 "field IS NULL AND (field2 != 'value2')"
1229 ],
1230 [
1231 [ 'field' => [ 'value', null, 'value2' ], 'field2' => 'value2' ],
1232 LIST_AND,
1233 "(field IN ('value','value2') OR field IS NULL) AND field2 = 'value2'"
1234 ],
1235 [
1236 [ 'field' => [ null ], 'field2' => null ],
1237 LIST_AND,
1238 "field IS NULL AND field2 IS NULL"
1239 ],
1240 [
1241 [ 'field' => 'value', 'field2' => 'value2' ],
1242 LIST_OR,
1243 "field = 'value' OR field2 = 'value2'"
1244 ],
1245 [
1246 [ 'field' => 'value', 'field2' => null ],
1247 LIST_OR,
1248 "field = 'value' OR field2 IS NULL"
1249 ],
1250 [
1251 [ 'field' => [ 'value', 'value2' ], 'field2' => [ 'value' ] ],
1252 LIST_OR,
1253 "field IN ('value','value2') OR field2 = 'value'"
1254 ],
1255 [
1256 [ 'field' => [ null, 'value', null, 'value2' ], "field2 != 'value2'" ],
1257 LIST_OR,
1258 "(field IN ('value','value2') OR field IS NULL) OR (field2 != 'value2')"
1259 ],
1260 [
1261 [ 'field' => 'value', 'field2' => 'value2' ],
1262 LIST_SET,
1263 "field = 'value',field2 = 'value2'"
1264 ],
1265 [
1266 [ 'field' => 'value', 'field2' => null ],
1267 LIST_SET,
1268 "field = 'value',field2 = NULL"
1269 ],
1270 [
1271 [ 'field' => 'value', "field2 != 'value2'" ],
1272 LIST_SET,
1273 "field = 'value',field2 != 'value2'"
1274 ],
1275 ];
1276 }
1277
1278 /**
1279 * @covers Wikimedia\Rdbms\Database::registerTempTableOperation
1280 */
1281 public function testSessionTempTables() {
1282 $temp1 = $this->database->tableName( 'tmp_table_1' );
1283 $temp2 = $this->database->tableName( 'tmp_table_2' );
1284 $temp3 = $this->database->tableName( 'tmp_table_3' );
1285
1286 $this->database->query( "CREATE TEMPORARY TABLE $temp1 LIKE orig_tbl", __METHOD__ );
1287 $this->database->query( "CREATE TEMPORARY TABLE $temp2 LIKE orig_tbl", __METHOD__ );
1288 $this->database->query( "CREATE TEMPORARY TABLE $temp3 LIKE orig_tbl", __METHOD__ );
1289
1290 $this->assertTrue( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1291 $this->assertTrue( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1292 $this->assertTrue( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1293
1294 $this->database->dropTable( 'tmp_table_1', __METHOD__ );
1295 $this->database->dropTable( 'tmp_table_2', __METHOD__ );
1296 $this->database->dropTable( 'tmp_table_3', __METHOD__ );
1297
1298 $this->assertFalse( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1299 $this->assertFalse( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1300 $this->assertFalse( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1301
1302 $this->database->query( "CREATE TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__ );
1303 $this->database->query( "CREATE TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__ );
1304 $this->database->query( "CREATE TEMPORARY TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__ );
1305
1306 $this->assertTrue( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1307 $this->assertTrue( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1308 $this->assertTrue( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1309
1310 $this->database->query( "DROP TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__ );
1311 $this->database->query( "DROP TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__ );
1312 $this->database->query( "DROP TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__ );
1313
1314 $this->assertFalse( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1315 $this->assertFalse( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1316 $this->assertFalse( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1317 }
1318
1319 public function provideBuildSubstring() {
1320 yield [ 'someField', 1, 2, 'SUBSTRING(someField FROM 1 FOR 2)' ];
1321 yield [ 'someField', 1, null, 'SUBSTRING(someField FROM 1)' ];
1322 }
1323
1324 /**
1325 * @covers Wikimedia\Rdbms\Database::buildSubstring
1326 * @dataProvider provideBuildSubstring
1327 */
1328 public function testBuildSubstring( $input, $start, $length, $expected ) {
1329 $output = $this->database->buildSubstring( $input, $start, $length );
1330 $this->assertSame( $expected, $output );
1331 }
1332
1333 public function provideBuildSubstring_invalidParams() {
1334 yield [ -1, 1 ];
1335 yield [ 1, -1 ];
1336 yield [ 1, 'foo' ];
1337 yield [ 'foo', 1 ];
1338 yield [ null, 1 ];
1339 yield [ 0, 1 ];
1340 }
1341
1342 /**
1343 * @covers Wikimedia\Rdbms\Database::buildSubstring
1344 * @covers Wikimedia\Rdbms\Database::assertBuildSubstringParams
1345 * @dataProvider provideBuildSubstring_invalidParams
1346 */
1347 public function testBuildSubstring_invalidParams( $start, $length ) {
1348 $this->setExpectedException( InvalidArgumentException::class );
1349 $this->database->buildSubstring( 'foo', $start, $length );
1350 }
1351
1352 /**
1353 * @covers \Wikimedia\Rdbms\Database::buildIntegerCast
1354 */
1355 public function testBuildIntegerCast() {
1356 $output = $this->database->buildIntegerCast( 'fieldName' );
1357 $this->assertSame( 'CAST( fieldName AS INTEGER )', $output );
1358 }
1359
1360 /**
1361 * @covers \Wikimedia\Rdbms\Database::doSavepoint
1362 * @covers \Wikimedia\Rdbms\Database::doReleaseSavepoint
1363 * @covers \Wikimedia\Rdbms\Database::doRollbackToSavepoint
1364 * @covers \Wikimedia\Rdbms\Database::startAtomic
1365 * @covers \Wikimedia\Rdbms\Database::endAtomic
1366 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1367 * @covers \Wikimedia\Rdbms\Database::doAtomicSection
1368 */
1369 public function testAtomicSections() {
1370 $this->database->startAtomic( __METHOD__ );
1371 $this->database->endAtomic( __METHOD__ );
1372 $this->assertLastSql( 'BEGIN; COMMIT' );
1373
1374 $this->database->startAtomic( __METHOD__, IDatabase::ATOMIC_CANCELABLE );
1375 $this->database->cancelAtomic( __METHOD__ );
1376 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1377
1378 $this->database->begin( __METHOD__ );
1379 $this->database->startAtomic( __METHOD__ );
1380 $this->database->endAtomic( __METHOD__ );
1381 $this->database->commit( __METHOD__ );
1382 $this->assertLastSql( 'BEGIN; COMMIT' );
1383
1384 $this->database->begin( __METHOD__ );
1385 $this->database->startAtomic( __METHOD__, IDatabase::ATOMIC_CANCELABLE );
1386 $this->database->endAtomic( __METHOD__ );
1387 $this->database->commit( __METHOD__ );
1388 // phpcs:ignore Generic.Files.LineLength
1389 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1390
1391 $this->database->begin( __METHOD__ );
1392 $this->database->startAtomic( __METHOD__, IDatabase::ATOMIC_CANCELABLE );
1393 $this->database->cancelAtomic( __METHOD__ );
1394 $this->database->commit( __METHOD__ );
1395 // phpcs:ignore Generic.Files.LineLength
1396 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1397
1398 $this->database->startAtomic( __METHOD__, IDatabase::ATOMIC_CANCELABLE );
1399 $this->database->startAtomic( __METHOD__, IDatabase::ATOMIC_CANCELABLE );
1400 $this->database->cancelAtomic( __METHOD__ );
1401 $this->database->endAtomic( __METHOD__ );
1402 // phpcs:ignore Generic.Files.LineLength
1403 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1404
1405 $this->database->doAtomicSection( __METHOD__, function () {
1406 } );
1407 $this->assertLastSql( 'BEGIN; COMMIT' );
1408
1409 $this->database->begin( __METHOD__ );
1410 $this->database->doAtomicSection( __METHOD__, function () {
1411 } );
1412 $this->database->rollback( __METHOD__ );
1413 // phpcs:ignore Generic.Files.LineLength
1414 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK' );
1415
1416 $this->database->begin( __METHOD__ );
1417 try {
1418 $this->database->doAtomicSection( __METHOD__, function () {
1419 throw new RuntimeException( 'Test exception' );
1420 } );
1421 $this->fail( 'Expected exception not thrown' );
1422 } catch ( RuntimeException $ex ) {
1423 $this->assertSame( 'Test exception', $ex->getMessage() );
1424 }
1425 $this->database->commit( __METHOD__ );
1426 // phpcs:ignore Generic.Files.LineLength
1427 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1428 }
1429
1430 public static function provideAtomicSectionMethodsForErrors() {
1431 return [
1432 [ 'endAtomic' ],
1433 [ 'cancelAtomic' ],
1434 ];
1435 }
1436
1437 /**
1438 * @dataProvider provideAtomicSectionMethodsForErrors
1439 * @covers \Wikimedia\Rdbms\Database::endAtomic
1440 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1441 */
1442 public function testNoAtomicSection( $method ) {
1443 try {
1444 $this->database->$method( __METHOD__ );
1445 $this->fail( 'Expected exception not thrown' );
1446 } catch ( DBUnexpectedError $ex ) {
1447 $this->assertSame(
1448 'No atomic transaction is open (got ' . __METHOD__ . ').',
1449 $ex->getMessage()
1450 );
1451 }
1452 }
1453
1454 /**
1455 * @dataProvider provideAtomicSectionMethodsForErrors
1456 * @covers \Wikimedia\Rdbms\Database::endAtomic
1457 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1458 */
1459 public function testInvalidAtomicSectionEnded( $method ) {
1460 $this->database->startAtomic( __METHOD__ . 'X' );
1461 try {
1462 $this->database->$method( __METHOD__ );
1463 $this->fail( 'Expected exception not thrown' );
1464 } catch ( DBUnexpectedError $ex ) {
1465 $this->assertSame(
1466 'Invalid atomic section ended (got ' . __METHOD__ . ').',
1467 $ex->getMessage()
1468 );
1469 }
1470 }
1471
1472 /**
1473 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1474 */
1475 public function testUncancellableAtomicSection() {
1476 $this->database->startAtomic( __METHOD__ );
1477 try {
1478 $this->database->cancelAtomic( __METHOD__ );
1479 $this->fail( 'Expected exception not thrown' );
1480 } catch ( DBUnexpectedError $ex ) {
1481 $this->assertSame(
1482 'Uncancelable atomic section canceled (got ' . __METHOD__ . ').',
1483 $ex->getMessage()
1484 );
1485 }
1486 }
1487
1488 /**
1489 * @expectedException \Wikimedia\Rdbms\DBTransactionStateError
1490 */
1491 public function testTransactionErrorState1() {
1492 $wrapper = TestingAccessWrapper::newFromObject( $this->database );
1493
1494 $this->database->begin( __METHOD__ );
1495 $wrapper->trxStatus = Database::STATUS_TRX_ERROR;
1496 $this->database->delete( 'x', [ 'field' => 3 ], __METHOD__ );
1497 $this->database->commit( __METHOD__ );
1498 }
1499
1500 /**
1501 * @covers \Wikimedia\Rdbms\Database::query
1502 */
1503 public function testTransactionErrorState2() {
1504 $wrapper = TestingAccessWrapper::newFromObject( $this->database );
1505
1506 $this->database->startAtomic( __METHOD__ );
1507 $wrapper->trxStatus = Database::STATUS_TRX_ERROR;
1508 $this->database->rollback( __METHOD__ );
1509 $this->assertEquals( 0, $this->database->trxLevel() );
1510 $this->assertEquals( Database::STATUS_TRX_NONE, $wrapper->trxStatus() );
1511 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1512
1513 $this->database->startAtomic( __METHOD__ );
1514 $this->assertEquals( Database::STATUS_TRX_OK, $wrapper->trxStatus() );
1515 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1516 $this->database->endAtomic( __METHOD__ );
1517 $this->assertEquals( Database::STATUS_TRX_NONE, $wrapper->trxStatus() );
1518 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'1\'; COMMIT' );
1519 $this->assertEquals( 0, $this->database->trxLevel(), 'Use after rollback()' );
1520
1521 $this->database->begin( __METHOD__ );
1522 $this->database->startAtomic( __METHOD__, Database::ATOMIC_CANCELABLE );
1523 $this->database->update( 'y', [ 'a' => 1 ], [ 'field' => 1 ], __METHOD__ );
1524 $wrapper->trxStatus = Database::STATUS_TRX_ERROR;
1525 $this->database->cancelAtomic( __METHOD__ );
1526 $this->assertEquals( Database::STATUS_TRX_OK, $wrapper->trxStatus() );
1527 $this->database->startAtomic( __METHOD__ );
1528 $this->database->delete( 'y', [ 'field' => 1 ], __METHOD__ );
1529 $this->database->endAtomic( __METHOD__ );
1530 $this->database->commit( __METHOD__ );
1531 // phpcs:ignore Generic.Files.LineLength
1532 $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' );
1533 $this->assertEquals( 0, $this->database->trxLevel(), 'Use after rollback()' );
1534
1535 // Next transaction
1536 $this->database->startAtomic( __METHOD__ );
1537 $this->assertEquals( Database::STATUS_TRX_OK, $wrapper->trxStatus() );
1538 $this->database->delete( 'x', [ 'field' => 3 ], __METHOD__ );
1539 $this->database->endAtomic( __METHOD__ );
1540 $this->assertEquals( Database::STATUS_TRX_NONE, $wrapper->trxStatus() );
1541 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; COMMIT' );
1542 $this->assertEquals( 0, $this->database->trxLevel() );
1543 }
1544
1545 /**
1546 * @covers \Wikimedia\Rdbms\Database::query
1547 */
1548 public function testImplicitTransactionRollback() {
1549 $doError = function () {
1550 $this->database->forceNextQueryError( 666, 'Evilness' );
1551 try {
1552 $this->database->delete( 'error', '1', __CLASS__ . '::SomeCaller' );
1553 $this->fail( 'Expected exception not thrown' );
1554 } catch ( DBError $e ) {
1555 $this->assertSame( 666, $e->errno );
1556 }
1557 };
1558
1559 $this->database->setFlag( Database::DBO_TRX );
1560
1561 // Implicit transaction gets silently rolled back
1562 $this->database->begin( __METHOD__, Database::TRANSACTION_INTERNAL );
1563 call_user_func( $doError );
1564 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1565 $this->database->commit( __METHOD__, Database::FLUSHING_INTERNAL );
1566 // phpcs:ignore
1567 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; ROLLBACK; BEGIN; DELETE FROM x WHERE field = \'1\'; COMMIT' );
1568
1569 // ... unless there were prior writes
1570 $this->database->begin( __METHOD__, Database::TRANSACTION_INTERNAL );
1571 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1572 call_user_func( $doError );
1573 try {
1574 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1575 $this->fail( 'Expected exception not thrown' );
1576 } catch ( DBTransactionStateError $e ) {
1577 }
1578 $this->database->rollback( __METHOD__, Database::FLUSHING_INTERNAL );
1579 // phpcs:ignore
1580 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'1\'; DELETE FROM error WHERE 1; ROLLBACK' );
1581 }
1582
1583 /**
1584 * @covers \Wikimedia\Rdbms\Database::query
1585 */
1586 public function testTransactionStatementRollbackIgnoring() {
1587 $wrapper = TestingAccessWrapper::newFromObject( $this->database );
1588 $warning = [];
1589 $wrapper->deprecationLogger = function ( $msg ) use ( &$warning ) {
1590 $warning[] = $msg;
1591 };
1592
1593 $doError = function () {
1594 $this->database->forceNextQueryError( 666, 'Evilness', [
1595 'wasKnownStatementRollbackError' => true,
1596 ] );
1597 try {
1598 $this->database->delete( 'error', '1', __CLASS__ . '::SomeCaller' );
1599 $this->fail( 'Expected exception not thrown' );
1600 } catch ( DBError $e ) {
1601 $this->assertSame( 666, $e->errno );
1602 }
1603 };
1604 $expectWarning = 'Caller from ' . __METHOD__ .
1605 ' ignored an error originally raised from ' . __CLASS__ . '::SomeCaller: [666] Evilness';
1606
1607 // Rollback doesn't raise a warning
1608 $warning = [];
1609 $this->database->startAtomic( __METHOD__ );
1610 call_user_func( $doError );
1611 $this->database->rollback( __METHOD__ );
1612 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1613 $this->assertSame( [], $warning );
1614 // phpcs:ignore
1615 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; ROLLBACK; DELETE FROM x WHERE field = \'1\'' );
1616
1617 // cancelAtomic() doesn't raise a warning
1618 $warning = [];
1619 $this->database->begin( __METHOD__ );
1620 $this->database->startAtomic( __METHOD__, Database::ATOMIC_CANCELABLE );
1621 call_user_func( $doError );
1622 $this->database->cancelAtomic( __METHOD__ );
1623 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1624 $this->database->commit( __METHOD__ );
1625 $this->assertSame( [], $warning );
1626 // phpcs:ignore
1627 $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' );
1628
1629 // Commit does raise a warning
1630 $warning = [];
1631 $this->database->begin( __METHOD__ );
1632 call_user_func( $doError );
1633 $this->database->commit( __METHOD__ );
1634 $this->assertSame( [ $expectWarning ], $warning );
1635 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; COMMIT' );
1636
1637 // Deprecation only gets raised once
1638 $warning = [];
1639 $this->database->begin( __METHOD__ );
1640 call_user_func( $doError );
1641 $this->database->delete( 'x', [ 'field' => 1 ], __METHOD__ );
1642 $this->database->commit( __METHOD__ );
1643 $this->assertSame( [ $expectWarning ], $warning );
1644 // phpcs:ignore
1645 $this->assertLastSql( 'BEGIN; DELETE FROM error WHERE 1; DELETE FROM x WHERE field = \'1\'; COMMIT' );
1646 }
1647
1648 /**
1649 * @covers \Wikimedia\Rdbms\Database::close
1650 */
1651 public function testPrematureClose1() {
1652 $fname = __METHOD__;
1653 $this->database->begin( __METHOD__ );
1654 $this->database->onTransactionIdle( function () use ( $fname ) {
1655 $this->database->query( 'SELECT 1', $fname );
1656 } );
1657 $this->database->delete( 'x', [ 'field' => 3 ], __METHOD__ );
1658 $this->database->close();
1659
1660 $this->assertFalse( $this->database->isOpen() );
1661 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; COMMIT; SELECT 1' );
1662 $this->assertEquals( 0, $this->database->trxLevel() );
1663 }
1664
1665 /**
1666 * @covers \Wikimedia\Rdbms\Database::close
1667 */
1668 public function testPrematureClose2() {
1669 try {
1670 $fname = __METHOD__;
1671 $this->database->startAtomic( __METHOD__ );
1672 $this->database->onTransactionIdle( function () use ( $fname ) {
1673 $this->database->query( 'SELECT 1', $fname );
1674 } );
1675 $this->database->delete( 'x', [ 'field' => 3 ], __METHOD__ );
1676 $this->database->close();
1677 $this->fail( 'Expected exception not thrown' );
1678 } catch ( DBUnexpectedError $ex ) {
1679 $this->assertSame(
1680 'Wikimedia\Rdbms\Database::close: atomic sections ' .
1681 'DatabaseSQLTest::testPrematureClose2 are still open.',
1682 $ex->getMessage()
1683 );
1684 }
1685
1686 $this->assertFalse( $this->database->isOpen() );
1687 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; ROLLBACK' );
1688 $this->assertEquals( 0, $this->database->trxLevel() );
1689 }
1690 }