Merge "Add semantic tags to license info text"
[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, $sqlInsert ] ), $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 /**
541 * @dataProvider provideReplace
542 * @covers Wikimedia\Rdbms\Database::replace
543 */
544 public function testReplace( $sql, $sqlText ) {
545 $this->database->replace(
546 $sql['table'],
547 $sql['uniqueIndexes'],
548 $sql['rows'],
549 __METHOD__
550 );
551 $this->assertLastSql( $sqlText );
552 }
553
554 public static function provideReplace() {
555 return [
556 [
557 [
558 'table' => 'replace_table',
559 'uniqueIndexes' => [ 'field' ],
560 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
561 ],
562 "DELETE FROM replace_table " .
563 "WHERE ( field='text' ); " .
564 "INSERT INTO replace_table " .
565 "(field,field2) " .
566 "VALUES ('text','text2')"
567 ],
568 [
569 [
570 'table' => 'module_deps',
571 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
572 'rows' => [
573 'md_module' => 'module',
574 'md_skin' => 'skin',
575 'md_deps' => 'deps',
576 ],
577 ],
578 "DELETE FROM module_deps " .
579 "WHERE ( md_module='module' AND md_skin='skin' ); " .
580 "INSERT INTO module_deps " .
581 "(md_module,md_skin,md_deps) " .
582 "VALUES ('module','skin','deps')"
583 ],
584 [
585 [
586 'table' => 'module_deps',
587 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
588 'rows' => [
589 [
590 'md_module' => 'module',
591 'md_skin' => 'skin',
592 'md_deps' => 'deps',
593 ], [
594 'md_module' => 'module2',
595 'md_skin' => 'skin2',
596 'md_deps' => 'deps2',
597 ],
598 ],
599 ],
600 "DELETE FROM module_deps " .
601 "WHERE ( md_module='module' AND md_skin='skin' ); " .
602 "INSERT INTO module_deps " .
603 "(md_module,md_skin,md_deps) " .
604 "VALUES ('module','skin','deps'); " .
605 "DELETE FROM module_deps " .
606 "WHERE ( md_module='module2' AND md_skin='skin2' ); " .
607 "INSERT INTO module_deps " .
608 "(md_module,md_skin,md_deps) " .
609 "VALUES ('module2','skin2','deps2')"
610 ],
611 [
612 [
613 'table' => 'module_deps',
614 'uniqueIndexes' => [ 'md_module', 'md_skin' ],
615 'rows' => [
616 [
617 'md_module' => 'module',
618 'md_skin' => 'skin',
619 'md_deps' => 'deps',
620 ], [
621 'md_module' => 'module2',
622 'md_skin' => 'skin2',
623 'md_deps' => 'deps2',
624 ],
625 ],
626 ],
627 "DELETE FROM module_deps " .
628 "WHERE ( md_module='module' ) OR ( md_skin='skin' ); " .
629 "INSERT INTO module_deps " .
630 "(md_module,md_skin,md_deps) " .
631 "VALUES ('module','skin','deps'); " .
632 "DELETE FROM module_deps " .
633 "WHERE ( md_module='module2' ) OR ( md_skin='skin2' ); " .
634 "INSERT INTO module_deps " .
635 "(md_module,md_skin,md_deps) " .
636 "VALUES ('module2','skin2','deps2')"
637 ],
638 [
639 [
640 'table' => 'module_deps',
641 'uniqueIndexes' => [],
642 'rows' => [
643 'md_module' => 'module',
644 'md_skin' => 'skin',
645 'md_deps' => 'deps',
646 ],
647 ],
648 "INSERT INTO module_deps " .
649 "(md_module,md_skin,md_deps) " .
650 "VALUES ('module','skin','deps')"
651 ],
652 ];
653 }
654
655 /**
656 * @dataProvider provideNativeReplace
657 * @covers Wikimedia\Rdbms\Database::nativeReplace
658 */
659 public function testNativeReplace( $sql, $sqlText ) {
660 $this->database->nativeReplace(
661 $sql['table'],
662 $sql['rows'],
663 __METHOD__
664 );
665 $this->assertLastSql( $sqlText );
666 }
667
668 public static function provideNativeReplace() {
669 return [
670 [
671 [
672 'table' => 'replace_table',
673 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
674 ],
675 "REPLACE INTO replace_table " .
676 "(field,field2) " .
677 "VALUES ('text','text2')"
678 ],
679 ];
680 }
681
682 /**
683 * @dataProvider provideConditional
684 * @covers Wikimedia\Rdbms\Database::conditional
685 */
686 public function testConditional( $sql, $sqlText ) {
687 $this->assertEquals( trim( $this->database->conditional(
688 $sql['conds'],
689 $sql['true'],
690 $sql['false']
691 ) ), $sqlText );
692 }
693
694 public static function provideConditional() {
695 return [
696 [
697 [
698 'conds' => [ 'field' => 'text' ],
699 'true' => 1,
700 'false' => 'NULL',
701 ],
702 "(CASE WHEN field = 'text' THEN 1 ELSE NULL END)"
703 ],
704 [
705 [
706 'conds' => [ 'field' => 'text', 'field2' => 'anothertext' ],
707 'true' => 1,
708 'false' => 'NULL',
709 ],
710 "(CASE WHEN field = 'text' AND field2 = 'anothertext' THEN 1 ELSE NULL END)"
711 ],
712 [
713 [
714 'conds' => 'field=1',
715 'true' => 1,
716 'false' => 'NULL',
717 ],
718 "(CASE WHEN field=1 THEN 1 ELSE NULL END)"
719 ],
720 ];
721 }
722
723 /**
724 * @dataProvider provideBuildConcat
725 * @covers Wikimedia\Rdbms\Database::buildConcat
726 */
727 public function testBuildConcat( $stringList, $sqlText ) {
728 $this->assertEquals( trim( $this->database->buildConcat(
729 $stringList
730 ) ), $sqlText );
731 }
732
733 public static function provideBuildConcat() {
734 return [
735 [
736 [ 'field', 'field2' ],
737 "CONCAT(field,field2)"
738 ],
739 [
740 [ "'test'", 'field2' ],
741 "CONCAT('test',field2)"
742 ],
743 ];
744 }
745
746 /**
747 * @dataProvider provideBuildLike
748 * @covers Wikimedia\Rdbms\Database::buildLike
749 * @covers Wikimedia\Rdbms\Database::escapeLikeInternal
750 */
751 public function testBuildLike( $array, $sqlText ) {
752 $this->assertEquals( trim( $this->database->buildLike(
753 $array
754 ) ), $sqlText );
755 }
756
757 public static function provideBuildLike() {
758 return [
759 [
760 'text',
761 "LIKE 'text' ESCAPE '`'"
762 ],
763 [
764 [ 'text', new LikeMatch( '%' ) ],
765 "LIKE 'text%' ESCAPE '`'"
766 ],
767 [
768 [ 'text', new LikeMatch( '%' ), 'text2' ],
769 "LIKE 'text%text2' ESCAPE '`'"
770 ],
771 [
772 [ 'text', new LikeMatch( '_' ) ],
773 "LIKE 'text_' ESCAPE '`'"
774 ],
775 [
776 'more_text',
777 "LIKE 'more`_text' ESCAPE '`'"
778 ],
779 [
780 [ 'C:\\Windows\\', new LikeMatch( '%' ) ],
781 "LIKE 'C:\\Windows\\%' ESCAPE '`'"
782 ],
783 [
784 [ 'accent`_test`', new LikeMatch( '%' ) ],
785 "LIKE 'accent```_test``%' ESCAPE '`'"
786 ],
787 ];
788 }
789
790 /**
791 * @dataProvider provideUnionQueries
792 * @covers Wikimedia\Rdbms\Database::unionQueries
793 */
794 public function testUnionQueries( $sql, $sqlText ) {
795 $this->assertEquals( trim( $this->database->unionQueries(
796 $sql['sqls'],
797 $sql['all']
798 ) ), $sqlText );
799 }
800
801 public static function provideUnionQueries() {
802 return [
803 [
804 [
805 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
806 'all' => true,
807 ],
808 "(RAW SQL) UNION ALL (RAW2SQL)"
809 ],
810 [
811 [
812 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
813 'all' => false,
814 ],
815 "(RAW SQL) UNION (RAW2SQL)"
816 ],
817 [
818 [
819 'sqls' => [ 'RAW SQL', 'RAW2SQL', 'RAW3SQL' ],
820 'all' => false,
821 ],
822 "(RAW SQL) UNION (RAW2SQL) UNION (RAW3SQL)"
823 ],
824 ];
825 }
826
827 /**
828 * @dataProvider provideUnionConditionPermutations
829 * @covers Wikimedia\Rdbms\Database::unionConditionPermutations
830 */
831 public function testUnionConditionPermutations( $params, $expect ) {
832 if ( isset( $params['unionSupportsOrderAndLimit'] ) ) {
833 $this->database->setUnionSupportsOrderAndLimit( $params['unionSupportsOrderAndLimit'] );
834 }
835
836 $sql = trim( $this->database->unionConditionPermutations(
837 $params['table'],
838 $params['vars'],
839 $params['permute_conds'],
840 isset( $params['extra_conds'] ) ? $params['extra_conds'] : '',
841 'FNAME',
842 isset( $params['options'] ) ? $params['options'] : [],
843 isset( $params['join_conds'] ) ? $params['join_conds'] : []
844 ) );
845 $this->assertEquals( $expect, $sql );
846 }
847
848 public static function provideUnionConditionPermutations() {
849 // phpcs:disable Generic.Files.LineLength
850 return [
851 [
852 [
853 'table' => [ 'table1', 'table2' ],
854 'vars' => [ 'field1', 'alias' => 'field2' ],
855 'permute_conds' => [
856 'field3' => [ 1, 2, 3 ],
857 'duplicates' => [ 4, 5, 4 ],
858 'empty' => [],
859 'single' => [ 0 ],
860 ],
861 'extra_conds' => 'table2.bar > 23',
862 'options' => [
863 'ORDER BY' => [ 'field1', 'alias' ],
864 'INNER ORDER BY' => [ 'field1', 'field2' ],
865 'LIMIT' => 100,
866 ],
867 'join_conds' => [
868 'table2' => [ 'JOIN', 'table1.foo_id = table2.foo_id' ],
869 ],
870 ],
871 "(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 " .
872 "(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 " .
873 "(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 " .
874 "(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 " .
875 "(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 " .
876 "(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 ) " .
877 "ORDER BY field1,alias LIMIT 100"
878 ],
879 [
880 [
881 'table' => 'foo',
882 'vars' => [ 'foo_id' ],
883 'permute_conds' => [
884 'bar' => [ 1, 2, 3 ],
885 ],
886 'extra_conds' => [ 'baz' => null ],
887 'options' => [
888 'NOTALL',
889 'ORDER BY' => [ 'foo_id' ],
890 'LIMIT' => 25,
891 ],
892 ],
893 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
894 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
895 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) " .
896 "ORDER BY foo_id LIMIT 25"
897 ],
898 [
899 [
900 'table' => 'foo',
901 'vars' => [ 'foo_id' ],
902 'permute_conds' => [
903 'bar' => [ 1, 2, 3 ],
904 ],
905 'extra_conds' => [ 'baz' => null ],
906 'options' => [
907 'NOTALL' => true,
908 'ORDER BY' => [ 'foo_id' ],
909 'LIMIT' => 25,
910 ],
911 'unionSupportsOrderAndLimit' => false,
912 ],
913 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ) UNION " .
914 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ) UNION " .
915 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ) " .
916 "ORDER BY foo_id LIMIT 25"
917 ],
918 [
919 [
920 'table' => 'foo',
921 'vars' => [ 'foo_id' ],
922 'permute_conds' => [],
923 'extra_conds' => [ 'baz' => null ],
924 'options' => [
925 'ORDER BY' => [ 'foo_id' ],
926 'LIMIT' => 25,
927 ],
928 ],
929 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
930 ],
931 [
932 [
933 'table' => 'foo',
934 'vars' => [ 'foo_id' ],
935 'permute_conds' => [
936 'bar' => [],
937 ],
938 'extra_conds' => [ 'baz' => null ],
939 'options' => [
940 'ORDER BY' => [ 'foo_id' ],
941 'LIMIT' => 25,
942 ],
943 ],
944 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
945 ],
946 [
947 [
948 'table' => 'foo',
949 'vars' => [ 'foo_id' ],
950 'permute_conds' => [
951 'bar' => [ 1 ],
952 ],
953 'options' => [
954 'ORDER BY' => [ 'foo_id' ],
955 'LIMIT' => 25,
956 'OFFSET' => 150,
957 ],
958 ],
959 "SELECT foo_id FROM foo WHERE bar = '1' ORDER BY foo_id LIMIT 150,25"
960 ],
961 [
962 [
963 'table' => 'foo',
964 'vars' => [ 'foo_id' ],
965 'permute_conds' => [],
966 'extra_conds' => [ 'baz' => null ],
967 'options' => [
968 'ORDER BY' => [ 'foo_id' ],
969 'LIMIT' => 25,
970 'OFFSET' => 150,
971 'INNER ORDER BY' => [ 'bar_id' ],
972 ],
973 ],
974 "(SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY bar_id LIMIT 175 ) ORDER BY foo_id LIMIT 150,25"
975 ],
976 [
977 [
978 'table' => 'foo',
979 'vars' => [ 'foo_id' ],
980 'permute_conds' => [],
981 'extra_conds' => [ 'baz' => null ],
982 'options' => [
983 'ORDER BY' => [ 'foo_id' ],
984 'LIMIT' => 25,
985 'OFFSET' => 150,
986 'INNER ORDER BY' => [ 'bar_id' ],
987 ],
988 'unionSupportsOrderAndLimit' => false,
989 ],
990 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 150,25"
991 ],
992 ];
993 // phpcs:enable
994 }
995
996 /**
997 * @covers Wikimedia\Rdbms\Database::commit
998 * @covers Wikimedia\Rdbms\Database::doCommit
999 */
1000 public function testTransactionCommit() {
1001 $this->database->begin( __METHOD__ );
1002 $this->database->commit( __METHOD__ );
1003 $this->assertLastSql( 'BEGIN; COMMIT' );
1004 }
1005
1006 /**
1007 * @covers Wikimedia\Rdbms\Database::rollback
1008 * @covers Wikimedia\Rdbms\Database::doRollback
1009 */
1010 public function testTransactionRollback() {
1011 $this->database->begin( __METHOD__ );
1012 $this->database->rollback( __METHOD__ );
1013 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1014 }
1015
1016 /**
1017 * @covers Wikimedia\Rdbms\Database::dropTable
1018 */
1019 public function testDropTable() {
1020 $this->database->setExistingTables( [ 'table' ] );
1021 $this->database->dropTable( 'table', __METHOD__ );
1022 $this->assertLastSql( 'DROP TABLE table CASCADE' );
1023 }
1024
1025 /**
1026 * @covers Wikimedia\Rdbms\Database::dropTable
1027 */
1028 public function testDropNonExistingTable() {
1029 $this->assertFalse(
1030 $this->database->dropTable( 'non_existing', __METHOD__ )
1031 );
1032 }
1033
1034 /**
1035 * @dataProvider provideMakeList
1036 * @covers Wikimedia\Rdbms\Database::makeList
1037 */
1038 public function testMakeList( $list, $mode, $sqlText ) {
1039 $this->assertEquals( trim( $this->database->makeList(
1040 $list, $mode
1041 ) ), $sqlText );
1042 }
1043
1044 public static function provideMakeList() {
1045 return [
1046 [
1047 [ 'value', 'value2' ],
1048 LIST_COMMA,
1049 "'value','value2'"
1050 ],
1051 [
1052 [ 'field', 'field2' ],
1053 LIST_NAMES,
1054 "field,field2"
1055 ],
1056 [
1057 [ 'field' => 'value', 'field2' => 'value2' ],
1058 LIST_AND,
1059 "field = 'value' AND field2 = 'value2'"
1060 ],
1061 [
1062 [ 'field' => null, "field2 != 'value2'" ],
1063 LIST_AND,
1064 "field IS NULL AND (field2 != 'value2')"
1065 ],
1066 [
1067 [ 'field' => [ 'value', null, 'value2' ], 'field2' => 'value2' ],
1068 LIST_AND,
1069 "(field IN ('value','value2') OR field IS NULL) AND field2 = 'value2'"
1070 ],
1071 [
1072 [ 'field' => [ null ], 'field2' => null ],
1073 LIST_AND,
1074 "field IS NULL AND field2 IS NULL"
1075 ],
1076 [
1077 [ 'field' => 'value', 'field2' => 'value2' ],
1078 LIST_OR,
1079 "field = 'value' OR field2 = 'value2'"
1080 ],
1081 [
1082 [ 'field' => 'value', 'field2' => null ],
1083 LIST_OR,
1084 "field = 'value' OR field2 IS NULL"
1085 ],
1086 [
1087 [ 'field' => [ 'value', 'value2' ], 'field2' => [ 'value' ] ],
1088 LIST_OR,
1089 "field IN ('value','value2') OR field2 = 'value'"
1090 ],
1091 [
1092 [ 'field' => [ null, 'value', null, 'value2' ], "field2 != 'value2'" ],
1093 LIST_OR,
1094 "(field IN ('value','value2') OR field IS NULL) OR (field2 != 'value2')"
1095 ],
1096 [
1097 [ 'field' => 'value', 'field2' => 'value2' ],
1098 LIST_SET,
1099 "field = 'value',field2 = 'value2'"
1100 ],
1101 [
1102 [ 'field' => 'value', 'field2' => null ],
1103 LIST_SET,
1104 "field = 'value',field2 = NULL"
1105 ],
1106 [
1107 [ 'field' => 'value', "field2 != 'value2'" ],
1108 LIST_SET,
1109 "field = 'value',field2 != 'value2'"
1110 ],
1111 ];
1112 }
1113
1114 /**
1115 * @covers Wikimedia\Rdbms\Database::registerTempTableOperation
1116 */
1117 public function testSessionTempTables() {
1118 $temp1 = $this->database->tableName( 'tmp_table_1' );
1119 $temp2 = $this->database->tableName( 'tmp_table_2' );
1120 $temp3 = $this->database->tableName( 'tmp_table_3' );
1121
1122 $this->database->query( "CREATE TEMPORARY TABLE $temp1 LIKE orig_tbl", __METHOD__ );
1123 $this->database->query( "CREATE TEMPORARY TABLE $temp2 LIKE orig_tbl", __METHOD__ );
1124 $this->database->query( "CREATE TEMPORARY TABLE $temp3 LIKE orig_tbl", __METHOD__ );
1125
1126 $this->assertTrue( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1127 $this->assertTrue( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1128 $this->assertTrue( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1129
1130 $this->database->dropTable( 'tmp_table_1', __METHOD__ );
1131 $this->database->dropTable( 'tmp_table_2', __METHOD__ );
1132 $this->database->dropTable( 'tmp_table_3', __METHOD__ );
1133
1134 $this->assertFalse( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1135 $this->assertFalse( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1136 $this->assertFalse( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1137
1138 $this->database->query( "CREATE TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__ );
1139 $this->database->query( "CREATE TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__ );
1140 $this->database->query( "CREATE TEMPORARY TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__ );
1141
1142 $this->assertTrue( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1143 $this->assertTrue( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1144 $this->assertTrue( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1145
1146 $this->database->query( "DROP TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__ );
1147 $this->database->query( "DROP TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__ );
1148 $this->database->query( "DROP TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__ );
1149
1150 $this->assertFalse( $this->database->tableExists( "tmp_table_1", __METHOD__ ) );
1151 $this->assertFalse( $this->database->tableExists( "tmp_table_2", __METHOD__ ) );
1152 $this->assertFalse( $this->database->tableExists( "tmp_table_3", __METHOD__ ) );
1153 }
1154 }