Merge "Database: Add batching to non-native insertSelect()"
[lhc/web/wiklou.git] / tests / phpunit / includes / libs / rdbms / database / DatabaseSQLTest.php
1 <?php
2
3 use Wikimedia\Rdbms\LikeMatch;
4
5 /**
6 * Test the parts of the Database abstract class that deal
7 * with creating SQL text.
8 */
9 class DatabaseSQLTest extends PHPUnit\Framework\TestCase {
10
11 use MediaWikiCoversValidator;
12
13 /** @var DatabaseTestHelper */
14 private $database;
15
16 protected function setUp() {
17 parent::setUp();
18 $this->database = new DatabaseTestHelper( __CLASS__, [ 'cliMode' => true ] );
19 }
20
21 protected function assertLastSql( $sqlText ) {
22 $this->assertEquals(
23 $sqlText,
24 $this->database->getLastSqls()
25 );
26 }
27
28 protected function assertLastSqlDb( $sqlText, DatabaseTestHelper $db ) {
29 $this->assertEquals( $sqlText, $db->getLastSqls() );
30 }
31
32 /**
33 * @dataProvider provideSelect
34 * @covers Wikimedia\Rdbms\Database::select
35 * @covers Wikimedia\Rdbms\Database::selectSQLText
36 * @covers Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN
37 * @covers Wikimedia\Rdbms\Database::useIndexClause
38 * @covers Wikimedia\Rdbms\Database::ignoreIndexClause
39 * @covers Wikimedia\Rdbms\Database::makeSelectOptions
40 * @covers Wikimedia\Rdbms\Database::makeOrderBy
41 * @covers Wikimedia\Rdbms\Database::makeGroupByWithHaving
42 */
43 public function testSelect( $sql, $sqlText ) {
44 $this->database->select(
45 $sql['tables'],
46 $sql['fields'],
47 isset( $sql['conds'] ) ? $sql['conds'] : [],
48 __METHOD__,
49 isset( $sql['options'] ) ? $sql['options'] : [],
50 isset( $sql['join_conds'] ) ? $sql['join_conds'] : []
51 );
52 $this->assertLastSql( $sqlText );
53 }
54
55 public static function provideSelect() {
56 return [
57 [
58 [
59 'tables' => 'table',
60 'fields' => [ 'field', 'alias' => 'field2' ],
61 'conds' => [ 'alias' => 'text' ],
62 ],
63 "SELECT field,field2 AS alias " .
64 "FROM table " .
65 "WHERE alias = 'text'"
66 ],
67 [
68 [
69 // 'tables' with space prepended indicates pre-escaped table name
70 'tables' => ' table LEFT JOIN table2',
71 'fields' => [ 'field' ],
72 'conds' => [ 'field' => 'text' ],
73 ],
74 "SELECT field FROM table LEFT JOIN table2 WHERE field = 'text'"
75 ],
76 [
77 [
78 // Empty 'tables' is allowed
79 'tables' => '',
80 'fields' => [ 'SPECIAL_QUERY()' ],
81 ],
82 "SELECT SPECIAL_QUERY()"
83 ],
84 [
85 [
86 'tables' => 'table',
87 'fields' => [ 'field', 'alias' => 'field2' ],
88 'conds' => [ 'alias' => 'text' ],
89 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
90 ],
91 "SELECT field,field2 AS alias " .
92 "FROM table " .
93 "WHERE alias = 'text' " .
94 "ORDER BY field " .
95 "LIMIT 1"
96 ],
97 [
98 [
99 'tables' => [ 'table', 't2' => 'table2' ],
100 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
101 'conds' => [ 'alias' => 'text' ],
102 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
103 'join_conds' => [ 't2' => [
104 'LEFT JOIN', 'tid = t2.id'
105 ] ],
106 ],
107 "SELECT tid,field,field2 AS alias,t2.id " .
108 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
109 "WHERE alias = 'text' " .
110 "ORDER BY field " .
111 "LIMIT 1"
112 ],
113 [
114 [
115 'tables' => [ 'table', 't2' => 'table2' ],
116 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
117 'conds' => [ 'alias' => 'text' ],
118 'options' => [ 'LIMIT' => 1, 'GROUP BY' => 'field', 'HAVING' => 'COUNT(*) > 1' ],
119 'join_conds' => [ 't2' => [
120 'LEFT JOIN', 'tid = t2.id'
121 ] ],
122 ],
123 "SELECT tid,field,field2 AS alias,t2.id " .
124 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
125 "WHERE alias = 'text' " .
126 "GROUP BY field HAVING COUNT(*) > 1 " .
127 "LIMIT 1"
128 ],
129 [
130 [
131 'tables' => [ 'table', 't2' => 'table2' ],
132 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
133 'conds' => [ 'alias' => 'text' ],
134 'options' => [
135 'LIMIT' => 1,
136 'GROUP BY' => [ 'field', 'field2' ],
137 'HAVING' => [ 'COUNT(*) > 1', 'field' => 1 ]
138 ],
139 'join_conds' => [ 't2' => [
140 'LEFT JOIN', 'tid = t2.id'
141 ] ],
142 ],
143 "SELECT tid,field,field2 AS alias,t2.id " .
144 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
145 "WHERE alias = 'text' " .
146 "GROUP BY field,field2 HAVING (COUNT(*) > 1) AND field = '1' " .
147 "LIMIT 1"
148 ],
149 [
150 [
151 'tables' => [ 'table' ],
152 'fields' => [ 'alias' => 'field' ],
153 'conds' => [ 'alias' => [ 1, 2, 3, 4 ] ],
154 ],
155 "SELECT field AS alias " .
156 "FROM table " .
157 "WHERE alias IN ('1','2','3','4')"
158 ],
159 [
160 [
161 'tables' => 'table',
162 'fields' => [ 'field' ],
163 'options' => [ 'USE INDEX' => [ 'table' => 'X' ] ],
164 ],
165 // No-op by default
166 "SELECT field FROM table"
167 ],
168 [
169 [
170 'tables' => 'table',
171 'fields' => [ 'field' ],
172 'options' => [ 'IGNORE INDEX' => [ 'table' => 'X' ] ],
173 ],
174 // No-op by default
175 "SELECT field FROM table"
176 ],
177 [
178 [
179 'tables' => 'table',
180 'fields' => [ 'field' ],
181 'options' => [ 'DISTINCT', 'LOCK IN SHARE MODE' ],
182 ],
183 "SELECT DISTINCT field FROM table LOCK IN SHARE MODE"
184 ],
185 [
186 [
187 'tables' => 'table',
188 'fields' => [ 'field' ],
189 'options' => [ 'EXPLAIN' => true ],
190 ],
191 'EXPLAIN SELECT field FROM table'
192 ],
193 [
194 [
195 'tables' => 'table',
196 'fields' => [ 'field' ],
197 'options' => [ 'FOR UPDATE' ],
198 ],
199 "SELECT field FROM table FOR UPDATE"
200 ],
201 ];
202 }
203
204 /**
205 * @dataProvider provideUpdate
206 * @covers Wikimedia\Rdbms\Database::update
207 * @covers Wikimedia\Rdbms\Database::makeUpdateOptions
208 * @covers Wikimedia\Rdbms\Database::makeUpdateOptionsArray
209 */
210 public function testUpdate( $sql, $sqlText ) {
211 $this->database->update(
212 $sql['table'],
213 $sql['values'],
214 $sql['conds'],
215 __METHOD__,
216 isset( $sql['options'] ) ? $sql['options'] : []
217 );
218 $this->assertLastSql( $sqlText );
219 }
220
221 public static function provideUpdate() {
222 return [
223 [
224 [
225 'table' => 'table',
226 'values' => [ 'field' => 'text', 'field2' => 'text2' ],
227 'conds' => [ 'alias' => 'text' ],
228 ],
229 "UPDATE table " .
230 "SET field = 'text'" .
231 ",field2 = 'text2' " .
232 "WHERE alias = 'text'"
233 ],
234 [
235 [
236 'table' => 'table',
237 'values' => [ 'field = other', 'field2' => 'text2' ],
238 'conds' => [ 'id' => '1' ],
239 ],
240 "UPDATE table " .
241 "SET field = other" .
242 ",field2 = 'text2' " .
243 "WHERE id = '1'"
244 ],
245 [
246 [
247 'table' => 'table',
248 'values' => [ 'field = other', 'field2' => 'text2' ],
249 'conds' => '*',
250 ],
251 "UPDATE table " .
252 "SET field = other" .
253 ",field2 = 'text2'"
254 ],
255 ];
256 }
257
258 /**
259 * @dataProvider provideDelete
260 * @covers Wikimedia\Rdbms\Database::delete
261 */
262 public function testDelete( $sql, $sqlText ) {
263 $this->database->delete(
264 $sql['table'],
265 $sql['conds'],
266 __METHOD__
267 );
268 $this->assertLastSql( $sqlText );
269 }
270
271 public static function provideDelete() {
272 return [
273 [
274 [
275 'table' => 'table',
276 'conds' => [ 'alias' => 'text' ],
277 ],
278 "DELETE FROM table " .
279 "WHERE alias = 'text'"
280 ],
281 [
282 [
283 'table' => 'table',
284 'conds' => '*',
285 ],
286 "DELETE FROM table"
287 ],
288 ];
289 }
290
291 /**
292 * @dataProvider provideUpsert
293 * @covers Wikimedia\Rdbms\Database::upsert
294 */
295 public function testUpsert( $sql, $sqlText ) {
296 $this->database->upsert(
297 $sql['table'],
298 $sql['rows'],
299 $sql['uniqueIndexes'],
300 $sql['set'],
301 __METHOD__
302 );
303 $this->assertLastSql( $sqlText );
304 }
305
306 public static function provideUpsert() {
307 return [
308 [
309 [
310 'table' => 'upsert_table',
311 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
312 'uniqueIndexes' => [ 'field' ],
313 'set' => [ 'field' => 'set' ],
314 ],
315 "BEGIN; " .
316 "UPDATE upsert_table " .
317 "SET field = 'set' " .
318 "WHERE ((field = 'text')); " .
319 "INSERT IGNORE INTO upsert_table " .
320 "(field,field2) " .
321 "VALUES ('text','text2'); " .
322 "COMMIT"
323 ],
324 ];
325 }
326
327 /**
328 * @dataProvider provideDeleteJoin
329 * @covers Wikimedia\Rdbms\Database::deleteJoin
330 */
331 public function testDeleteJoin( $sql, $sqlText ) {
332 $this->database->deleteJoin(
333 $sql['delTable'],
334 $sql['joinTable'],
335 $sql['delVar'],
336 $sql['joinVar'],
337 $sql['conds'],
338 __METHOD__
339 );
340 $this->assertLastSql( $sqlText );
341 }
342
343 public static function provideDeleteJoin() {
344 return [
345 [
346 [
347 'delTable' => 'table',
348 'joinTable' => 'table_join',
349 'delVar' => 'field',
350 'joinVar' => 'field_join',
351 'conds' => [ 'alias' => 'text' ],
352 ],
353 "DELETE FROM table " .
354 "WHERE field IN (" .
355 "SELECT field_join FROM table_join WHERE alias = 'text'" .
356 ")"
357 ],
358 [
359 [
360 'delTable' => 'table',
361 'joinTable' => 'table_join',
362 'delVar' => 'field',
363 'joinVar' => 'field_join',
364 'conds' => '*',
365 ],
366 "DELETE FROM table " .
367 "WHERE field IN (" .
368 "SELECT field_join FROM table_join " .
369 ")"
370 ],
371 ];
372 }
373
374 /**
375 * @dataProvider provideInsert
376 * @covers Wikimedia\Rdbms\Database::insert
377 * @covers Wikimedia\Rdbms\Database::makeInsertOptions
378 */
379 public function testInsert( $sql, $sqlText ) {
380 $this->database->insert(
381 $sql['table'],
382 $sql['rows'],
383 __METHOD__,
384 isset( $sql['options'] ) ? $sql['options'] : []
385 );
386 $this->assertLastSql( $sqlText );
387 }
388
389 public static function provideInsert() {
390 return [
391 [
392 [
393 'table' => 'table',
394 'rows' => [ 'field' => 'text', 'field2' => 2 ],
395 ],
396 "INSERT INTO table " .
397 "(field,field2) " .
398 "VALUES ('text','2')"
399 ],
400 [
401 [
402 'table' => 'table',
403 'rows' => [ 'field' => 'text', 'field2' => 2 ],
404 'options' => 'IGNORE',
405 ],
406 "INSERT IGNORE INTO table " .
407 "(field,field2) " .
408 "VALUES ('text','2')"
409 ],
410 [
411 [
412 'table' => 'table',
413 'rows' => [
414 [ 'field' => 'text', 'field2' => 2 ],
415 [ 'field' => 'multi', 'field2' => 3 ],
416 ],
417 'options' => 'IGNORE',
418 ],
419 "INSERT IGNORE INTO table " .
420 "(field,field2) " .
421 "VALUES " .
422 "('text','2')," .
423 "('multi','3')"
424 ],
425 ];
426 }
427
428 /**
429 * @dataProvider provideInsertSelect
430 * @covers Wikimedia\Rdbms\Database::insertSelect
431 * @covers Wikimedia\Rdbms\Database::nativeInsertSelect
432 */
433 public function testInsertSelect( $sql, $sqlTextNative, $sqlSelect, $sqlInsert ) {
434 $this->database->insertSelect(
435 $sql['destTable'],
436 $sql['srcTable'],
437 $sql['varMap'],
438 $sql['conds'],
439 __METHOD__,
440 isset( $sql['insertOptions'] ) ? $sql['insertOptions'] : [],
441 isset( $sql['selectOptions'] ) ? $sql['selectOptions'] : [],
442 isset( $sql['selectJoinConds'] ) ? $sql['selectJoinConds'] : []
443 );
444 $this->assertLastSql( $sqlTextNative );
445
446 $dbWeb = new DatabaseTestHelper( __CLASS__, [ 'cliMode' => false ] );
447 $dbWeb->forceNextResult( [
448 array_flip( array_keys( $sql['varMap'] ) )
449 ] );
450 $dbWeb->insertSelect(
451 $sql['destTable'],
452 $sql['srcTable'],
453 $sql['varMap'],
454 $sql['conds'],
455 __METHOD__,
456 isset( $sql['insertOptions'] ) ? $sql['insertOptions'] : [],
457 isset( $sql['selectOptions'] ) ? $sql['selectOptions'] : [],
458 isset( $sql['selectJoinConds'] ) ? $sql['selectJoinConds'] : []
459 );
460 $this->assertLastSqlDb( implode( '; ', [ $sqlSelect, 'BEGIN', $sqlInsert, 'COMMIT' ] ), $dbWeb );
461 }
462
463 public static function provideInsertSelect() {
464 return [
465 [
466 [
467 'destTable' => 'insert_table',
468 'srcTable' => 'select_table',
469 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
470 'conds' => '*',
471 ],
472 "INSERT INTO insert_table " .
473 "(field_insert,field) " .
474 "SELECT field_select,field2 " .
475 "FROM select_table WHERE *",
476 "SELECT field_select AS field_insert,field2 AS field " .
477 "FROM select_table WHERE * FOR UPDATE",
478 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
479 ],
480 [
481 [
482 'destTable' => 'insert_table',
483 'srcTable' => 'select_table',
484 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
485 'conds' => [ 'field' => 2 ],
486 ],
487 "INSERT INTO insert_table " .
488 "(field_insert,field) " .
489 "SELECT field_select,field2 " .
490 "FROM select_table " .
491 "WHERE field = '2'",
492 "SELECT field_select AS field_insert,field2 AS field FROM " .
493 "select_table WHERE field = '2' FOR UPDATE",
494 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
495 ],
496 [
497 [
498 'destTable' => 'insert_table',
499 'srcTable' => 'select_table',
500 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
501 'conds' => [ 'field' => 2 ],
502 'insertOptions' => 'IGNORE',
503 'selectOptions' => [ 'ORDER BY' => 'field' ],
504 ],
505 "INSERT IGNORE INTO insert_table " .
506 "(field_insert,field) " .
507 "SELECT field_select,field2 " .
508 "FROM select_table " .
509 "WHERE field = '2' " .
510 "ORDER BY field",
511 "SELECT field_select AS field_insert,field2 AS field " .
512 "FROM select_table WHERE field = '2' ORDER BY field FOR UPDATE",
513 "INSERT IGNORE INTO insert_table (field_insert,field) VALUES ('0','1')"
514 ],
515 [
516 [
517 'destTable' => 'insert_table',
518 'srcTable' => [ 'select_table1', 'select_table2' ],
519 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
520 'conds' => [ 'field' => 2 ],
521 'selectOptions' => [ 'ORDER BY' => 'field', 'FORCE INDEX' => [ 'select_table1' => 'index1' ] ],
522 'selectJoinConds' => [
523 'select_table2' => [ 'LEFT JOIN', [ 'select_table1.foo = select_table2.bar' ] ],
524 ],
525 ],
526 "INSERT INTO insert_table " .
527 "(field_insert,field) " .
528 "SELECT field_select,field2 " .
529 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
530 "WHERE field = '2' " .
531 "ORDER BY field",
532 "SELECT field_select AS field_insert,field2 AS field " .
533 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
534 "WHERE field = '2' ORDER BY field FOR UPDATE",
535 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
536 ],
537 ];
538 }
539
540 public function testInsertSelectBatching() {
541 $dbWeb = new DatabaseTestHelper( __CLASS__, [ 'cliMode' => false ] );
542 $rows = [];
543 for ( $i = 0; $i <= 25000; $i++ ) {
544 $rows[] = [ 'field' => $i ];
545 }
546 $dbWeb->forceNextResult( $rows );
547 $dbWeb->insertSelect(
548 'insert_table',
549 'select_table',
550 [ 'field' => 'field2' ],
551 '*',
552 __METHOD__
553 );
554 $this->assertLastSqlDb( implode( '; ', [
555 'SELECT field2 AS field FROM select_table WHERE * FOR UPDATE',
556 'BEGIN',
557 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 0, 9999 ) ) . "')",
558 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 10000, 19999 ) ) . "')",
559 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 20000, 25000 ) ) . "')",
560 'COMMIT'
561 ] ), $dbWeb );
562 }
563
564 /**
565 * @dataProvider provideReplace
566 * @covers Wikimedia\Rdbms\Database::replace
567 */
568 public function testReplace( $sql, $sqlText ) {
569 $this->database->replace(
570 $sql['table'],
571 $sql['uniqueIndexes'],
572 $sql['rows'],
573 __METHOD__
574 );
575 $this->assertLastSql( $sqlText );
576 }
577
578 public static function provideReplace() {
579 return [
580 [
581 [
582 'table' => 'replace_table',
583 'uniqueIndexes' => [ 'field' ],
584 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
585 ],
586 "BEGIN; DELETE FROM replace_table " .
587 "WHERE (field = 'text'); " .
588 "INSERT INTO replace_table " .
589 "(field,field2) " .
590 "VALUES ('text','text2'); COMMIT"
591 ],
592 [
593 [
594 'table' => 'module_deps',
595 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
596 'rows' => [
597 'md_module' => 'module',
598 'md_skin' => 'skin',
599 'md_deps' => 'deps',
600 ],
601 ],
602 "BEGIN; DELETE FROM module_deps " .
603 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
604 "INSERT INTO module_deps " .
605 "(md_module,md_skin,md_deps) " .
606 "VALUES ('module','skin','deps'); COMMIT"
607 ],
608 [
609 [
610 'table' => 'module_deps',
611 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
612 'rows' => [
613 [
614 'md_module' => 'module',
615 'md_skin' => 'skin',
616 'md_deps' => 'deps',
617 ], [
618 'md_module' => 'module2',
619 'md_skin' => 'skin2',
620 'md_deps' => 'deps2',
621 ],
622 ],
623 ],
624 "BEGIN; DELETE FROM module_deps " .
625 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
626 "INSERT INTO module_deps " .
627 "(md_module,md_skin,md_deps) " .
628 "VALUES ('module','skin','deps'); " .
629 "DELETE FROM module_deps " .
630 "WHERE (md_module = 'module2' AND md_skin = 'skin2'); " .
631 "INSERT INTO module_deps " .
632 "(md_module,md_skin,md_deps) " .
633 "VALUES ('module2','skin2','deps2'); COMMIT"
634 ],
635 [
636 [
637 'table' => 'module_deps',
638 'uniqueIndexes' => [ 'md_module', 'md_skin' ],
639 'rows' => [
640 [
641 'md_module' => 'module',
642 'md_skin' => 'skin',
643 'md_deps' => 'deps',
644 ], [
645 'md_module' => 'module2',
646 'md_skin' => 'skin2',
647 'md_deps' => 'deps2',
648 ],
649 ],
650 ],
651 "BEGIN; DELETE FROM module_deps " .
652 "WHERE (md_module = 'module') OR (md_skin = 'skin'); " .
653 "INSERT INTO module_deps " .
654 "(md_module,md_skin,md_deps) " .
655 "VALUES ('module','skin','deps'); " .
656 "DELETE FROM module_deps " .
657 "WHERE (md_module = 'module2') OR (md_skin = 'skin2'); " .
658 "INSERT INTO module_deps " .
659 "(md_module,md_skin,md_deps) " .
660 "VALUES ('module2','skin2','deps2'); COMMIT"
661 ],
662 [
663 [
664 'table' => 'module_deps',
665 'uniqueIndexes' => [],
666 'rows' => [
667 'md_module' => 'module',
668 'md_skin' => 'skin',
669 'md_deps' => 'deps',
670 ],
671 ],
672 "BEGIN; INSERT INTO module_deps " .
673 "(md_module,md_skin,md_deps) " .
674 "VALUES ('module','skin','deps'); COMMIT"
675 ],
676 ];
677 }
678
679 /**
680 * @dataProvider provideNativeReplace
681 * @covers Wikimedia\Rdbms\Database::nativeReplace
682 */
683 public function testNativeReplace( $sql, $sqlText ) {
684 $this->database->nativeReplace(
685 $sql['table'],
686 $sql['rows'],
687 __METHOD__
688 );
689 $this->assertLastSql( $sqlText );
690 }
691
692 public static function provideNativeReplace() {
693 return [
694 [
695 [
696 'table' => 'replace_table',
697 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
698 ],
699 "REPLACE INTO replace_table " .
700 "(field,field2) " .
701 "VALUES ('text','text2')"
702 ],
703 ];
704 }
705
706 /**
707 * @dataProvider provideConditional
708 * @covers Wikimedia\Rdbms\Database::conditional
709 */
710 public function testConditional( $sql, $sqlText ) {
711 $this->assertEquals( trim( $this->database->conditional(
712 $sql['conds'],
713 $sql['true'],
714 $sql['false']
715 ) ), $sqlText );
716 }
717
718 public static function provideConditional() {
719 return [
720 [
721 [
722 'conds' => [ 'field' => 'text' ],
723 'true' => 1,
724 'false' => 'NULL',
725 ],
726 "(CASE WHEN field = 'text' THEN 1 ELSE NULL END)"
727 ],
728 [
729 [
730 'conds' => [ 'field' => 'text', 'field2' => 'anothertext' ],
731 'true' => 1,
732 'false' => 'NULL',
733 ],
734 "(CASE WHEN field = 'text' AND field2 = 'anothertext' THEN 1 ELSE NULL END)"
735 ],
736 [
737 [
738 'conds' => 'field=1',
739 'true' => 1,
740 'false' => 'NULL',
741 ],
742 "(CASE WHEN field=1 THEN 1 ELSE NULL END)"
743 ],
744 ];
745 }
746
747 /**
748 * @dataProvider provideBuildConcat
749 * @covers Wikimedia\Rdbms\Database::buildConcat
750 */
751 public function testBuildConcat( $stringList, $sqlText ) {
752 $this->assertEquals( trim( $this->database->buildConcat(
753 $stringList
754 ) ), $sqlText );
755 }
756
757 public static function provideBuildConcat() {
758 return [
759 [
760 [ 'field', 'field2' ],
761 "CONCAT(field,field2)"
762 ],
763 [
764 [ "'test'", 'field2' ],
765 "CONCAT('test',field2)"
766 ],
767 ];
768 }
769
770 /**
771 * @dataProvider provideBuildLike
772 * @covers Wikimedia\Rdbms\Database::buildLike
773 * @covers Wikimedia\Rdbms\Database::escapeLikeInternal
774 */
775 public function testBuildLike( $array, $sqlText ) {
776 $this->assertEquals( trim( $this->database->buildLike(
777 $array
778 ) ), $sqlText );
779 }
780
781 public static function provideBuildLike() {
782 return [
783 [
784 'text',
785 "LIKE 'text' ESCAPE '`'"
786 ],
787 [
788 [ 'text', new LikeMatch( '%' ) ],
789 "LIKE 'text%' ESCAPE '`'"
790 ],
791 [
792 [ 'text', new LikeMatch( '%' ), 'text2' ],
793 "LIKE 'text%text2' ESCAPE '`'"
794 ],
795 [
796 [ 'text', new LikeMatch( '_' ) ],
797 "LIKE 'text_' ESCAPE '`'"
798 ],
799 [
800 'more_text',
801 "LIKE 'more`_text' ESCAPE '`'"
802 ],
803 [
804 [ 'C:\\Windows\\', new LikeMatch( '%' ) ],
805 "LIKE 'C:\\Windows\\%' ESCAPE '`'"
806 ],
807 [
808 [ 'accent`_test`', new LikeMatch( '%' ) ],
809 "LIKE 'accent```_test``%' ESCAPE '`'"
810 ],
811 ];
812 }
813
814 /**
815 * @dataProvider provideUnionQueries
816 * @covers Wikimedia\Rdbms\Database::unionQueries
817 */
818 public function testUnionQueries( $sql, $sqlText ) {
819 $this->assertEquals( trim( $this->database->unionQueries(
820 $sql['sqls'],
821 $sql['all']
822 ) ), $sqlText );
823 }
824
825 public static function provideUnionQueries() {
826 return [
827 [
828 [
829 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
830 'all' => true,
831 ],
832 "(RAW SQL) UNION ALL (RAW2SQL)"
833 ],
834 [
835 [
836 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
837 'all' => false,
838 ],
839 "(RAW SQL) UNION (RAW2SQL)"
840 ],
841 [
842 [
843 'sqls' => [ 'RAW SQL', 'RAW2SQL', 'RAW3SQL' ],
844 'all' => false,
845 ],
846 "(RAW SQL) UNION (RAW2SQL) UNION (RAW3SQL)"
847 ],
848 ];
849 }
850
851 /**
852 * @dataProvider provideUnionConditionPermutations
853 * @covers Wikimedia\Rdbms\Database::unionConditionPermutations
854 */
855 public function testUnionConditionPermutations( $params, $expect ) {
856 if ( isset( $params['unionSupportsOrderAndLimit'] ) ) {
857 $this->database->setUnionSupportsOrderAndLimit( $params['unionSupportsOrderAndLimit'] );
858 }
859
860 $sql = trim( $this->database->unionConditionPermutations(
861 $params['table'],
862 $params['vars'],
863 $params['permute_conds'],
864 isset( $params['extra_conds'] ) ? $params['extra_conds'] : '',
865 'FNAME',
866 isset( $params['options'] ) ? $params['options'] : [],
867 isset( $params['join_conds'] ) ? $params['join_conds'] : []
868 ) );
869 $this->assertEquals( $expect, $sql );
870 }
871
872 public static function provideUnionConditionPermutations() {
873 // phpcs:disable Generic.Files.LineLength
874 return [
875 [
876 [
877 'table' => [ 'table1', 'table2' ],
878 'vars' => [ 'field1', 'alias' => 'field2' ],
879 'permute_conds' => [
880 'field3' => [ 1, 2, 3 ],
881 'duplicates' => [ 4, 5, 4 ],
882 'empty' => [],
883 'single' => [ 0 ],
884 ],
885 'extra_conds' => 'table2.bar > 23',
886 'options' => [
887 'ORDER BY' => [ 'field1', 'alias' ],
888 'INNER ORDER BY' => [ 'field1', 'field2' ],
889 'LIMIT' => 100,
890 ],
891 'join_conds' => [
892 'table2' => [ 'JOIN', 'table1.foo_id = table2.foo_id' ],
893 ],
894 ],
895 "(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 " .
896 "(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 " .
897 "(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 " .
898 "(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 " .
899 "(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 " .
900 "(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 ) " .
901 "ORDER BY field1,alias LIMIT 100"
902 ],
903 [
904 [
905 'table' => 'foo',
906 'vars' => [ 'foo_id' ],
907 'permute_conds' => [
908 'bar' => [ 1, 2, 3 ],
909 ],
910 'extra_conds' => [ 'baz' => null ],
911 'options' => [
912 'NOTALL',
913 'ORDER BY' => [ 'foo_id' ],
914 'LIMIT' => 25,
915 ],
916 ],
917 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
918 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
919 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) " .
920 "ORDER BY foo_id LIMIT 25"
921 ],
922 [
923 [
924 'table' => 'foo',
925 'vars' => [ 'foo_id' ],
926 'permute_conds' => [
927 'bar' => [ 1, 2, 3 ],
928 ],
929 'extra_conds' => [ 'baz' => null ],
930 'options' => [
931 'NOTALL' => true,
932 'ORDER BY' => [ 'foo_id' ],
933 'LIMIT' => 25,
934 ],
935 'unionSupportsOrderAndLimit' => false,
936 ],
937 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ) UNION " .
938 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ) UNION " .
939 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ) " .
940 "ORDER BY foo_id LIMIT 25"
941 ],
942 [
943 [
944 'table' => 'foo',
945 'vars' => [ 'foo_id' ],
946 'permute_conds' => [],
947 'extra_conds' => [ 'baz' => null ],
948 'options' => [
949 'ORDER BY' => [ 'foo_id' ],
950 'LIMIT' => 25,
951 ],
952 ],
953 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
954 ],
955 [
956 [
957 'table' => 'foo',
958 'vars' => [ 'foo_id' ],
959 'permute_conds' => [
960 'bar' => [],
961 ],
962 'extra_conds' => [ 'baz' => null ],
963 'options' => [
964 'ORDER BY' => [ 'foo_id' ],
965 'LIMIT' => 25,
966 ],
967 ],
968 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
969 ],
970 [
971 [
972 'table' => 'foo',
973 'vars' => [ 'foo_id' ],
974 'permute_conds' => [
975 'bar' => [ 1 ],
976 ],
977 'options' => [
978 'ORDER BY' => [ 'foo_id' ],
979 'LIMIT' => 25,
980 'OFFSET' => 150,
981 ],
982 ],
983 "SELECT foo_id FROM foo WHERE bar = '1' ORDER BY foo_id LIMIT 150,25"
984 ],
985 [
986 [
987 'table' => 'foo',
988 'vars' => [ 'foo_id' ],
989 'permute_conds' => [],
990 'extra_conds' => [ 'baz' => null ],
991 'options' => [
992 'ORDER BY' => [ 'foo_id' ],
993 'LIMIT' => 25,
994 'OFFSET' => 150,
995 'INNER ORDER BY' => [ 'bar_id' ],
996 ],
997 ],
998 "(SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY bar_id LIMIT 175 ) ORDER BY foo_id LIMIT 150,25"
999 ],
1000 [
1001 [
1002 'table' => 'foo',
1003 'vars' => [ 'foo_id' ],
1004 'permute_conds' => [],
1005 'extra_conds' => [ 'baz' => null ],
1006 'options' => [
1007 'ORDER BY' => [ 'foo_id' ],
1008 'LIMIT' => 25,
1009 'OFFSET' => 150,
1010 'INNER ORDER BY' => [ 'bar_id' ],
1011 ],
1012 'unionSupportsOrderAndLimit' => false,
1013 ],
1014 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 150,25"
1015 ],
1016 ];
1017 // phpcs:enable
1018 }
1019
1020 /**
1021 * @covers Wikimedia\Rdbms\Database::commit
1022 * @covers Wikimedia\Rdbms\Database::doCommit
1023 */
1024 public function testTransactionCommit() {
1025 $this->database->begin( __METHOD__ );
1026 $this->database->commit( __METHOD__ );
1027 $this->assertLastSql( 'BEGIN; COMMIT' );
1028 }
1029
1030 /**
1031 * @covers Wikimedia\Rdbms\Database::rollback
1032 * @covers Wikimedia\Rdbms\Database::doRollback
1033 */
1034 public function testTransactionRollback() {
1035 $this->database->begin( __METHOD__ );
1036 $this->database->rollback( __METHOD__ );
1037 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1038 }
1039
1040 /**
1041 * @covers Wikimedia\Rdbms\Database::dropTable
1042 */
1043 public function testDropTable() {
1044 $this->database->setExistingTables( [ 'table' ] );
1045 $this->database->dropTable( 'table', __METHOD__ );
1046 $this->assertLastSql( 'DROP TABLE table CASCADE' );
1047 }
1048
1049 /**
1050 * @covers Wikimedia\Rdbms\Database::dropTable
1051 */
1052 public function testDropNonExistingTable() {
1053 $this->assertFalse(
1054 $this->database->dropTable( 'non_existing', __METHOD__ )
1055 );
1056 }
1057
1058 /**
1059 * @dataProvider provideMakeList
1060 * @covers Wikimedia\Rdbms\Database::makeList
1061 */
1062 public function testMakeList( $list, $mode, $sqlText ) {
1063 $this->assertEquals( trim( $this->database->makeList(
1064 $list, $mode
1065 ) ), $sqlText );
1066 }
1067
1068 public static function provideMakeList() {
1069 return [
1070 [
1071 [ 'value', 'value2' ],
1072 LIST_COMMA,
1073 "'value','value2'"
1074 ],
1075 [
1076 [ 'field', 'field2' ],
1077 LIST_NAMES,
1078 "field,field2"
1079 ],
1080 [
1081 [ 'field' => 'value', 'field2' => 'value2' ],
1082 LIST_AND,
1083 "field = 'value' AND field2 = 'value2'"
1084 ],
1085 [
1086 [ 'field' => null, "field2 != 'value2'" ],
1087 LIST_AND,
1088 "field IS NULL AND (field2 != 'value2')"
1089 ],
1090 [
1091 [ 'field' => [ 'value', null, 'value2' ], 'field2' => 'value2' ],
1092 LIST_AND,
1093 "(field IN ('value','value2') OR field IS NULL) AND field2 = 'value2'"
1094 ],
1095 [
1096 [ 'field' => [ null ], 'field2' => null ],
1097 LIST_AND,
1098 "field IS NULL AND field2 IS NULL"
1099 ],
1100 [
1101 [ 'field' => 'value', 'field2' => 'value2' ],
1102 LIST_OR,
1103 "field = 'value' OR field2 = 'value2'"
1104 ],
1105 [
1106 [ 'field' => 'value', 'field2' => null ],
1107 LIST_OR,
1108 "field = 'value' OR field2 IS NULL"
1109 ],
1110 [
1111 [ 'field' => [ 'value', 'value2' ], 'field2' => [ 'value' ] ],
1112 LIST_OR,
1113 "field IN ('value','value2') OR field2 = 'value'"
1114 ],
1115 [
1116 [ 'field' => [ null, 'value', null, 'value2' ], "field2 != 'value2'" ],
1117 LIST_OR,
1118 "(field IN ('value','value2') OR field IS NULL) OR (field2 != 'value2')"
1119 ],
1120 [
1121 [ 'field' => 'value', 'field2' => 'value2' ],
1122 LIST_SET,
1123 "field = 'value',field2 = 'value2'"
1124 ],
1125 [
1126 [ 'field' => 'value', 'field2' => null ],
1127 LIST_SET,
1128 "field = 'value',field2 = NULL"
1129 ],
1130 [
1131 [ 'field' => 'value', "field2 != 'value2'" ],
1132 LIST_SET,
1133 "field = 'value',field2 != 'value2'"
1134 ],
1135 ];
1136 }
1137
1138 /**
1139 * @covers Wikimedia\Rdbms\Database::registerTempTableOperation
1140 */
1141 public function testSessionTempTables() {
1142 $temp1 = $this->database->tableName( 'tmp_table_1' );
1143 $temp2 = $this->database->tableName( 'tmp_table_2' );
1144 $temp3 = $this->database->tableName( 'tmp_table_3' );
1145
1146 $this->database->query( "CREATE TEMPORARY TABLE $temp1 LIKE orig_tbl", __METHOD__ );
1147 $this->database->query( "CREATE TEMPORARY TABLE $temp2 LIKE orig_tbl", __METHOD__ );
1148 $this->database->query( "CREATE TEMPORARY TABLE $temp3 LIKE orig_tbl", __METHOD__ );
1149
1150 $this->assertTrue( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1151 $this->assertTrue( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1152 $this->assertTrue( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1153
1154 $this->database->dropTable( 'tmp_table_1', __METHOD__ );
1155 $this->database->dropTable( 'tmp_table_2', __METHOD__ );
1156 $this->database->dropTable( 'tmp_table_3', __METHOD__ );
1157
1158 $this->assertFalse( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1159 $this->assertFalse( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1160 $this->assertFalse( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1161
1162 $this->database->query( "CREATE TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__ );
1163 $this->database->query( "CREATE TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__ );
1164 $this->database->query( "CREATE TEMPORARY TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__ );
1165
1166 $this->assertTrue( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1167 $this->assertTrue( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1168 $this->assertTrue( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1169
1170 $this->database->query( "DROP TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__ );
1171 $this->database->query( "DROP TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__ );
1172 $this->database->query( "DROP TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__ );
1173
1174 $this->assertFalse( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1175 $this->assertFalse( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1176 $this->assertFalse( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1177 }
1178 }