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