3 * @author Antoine Musso
4 * @copyright Copyright © 2011, Antoine Musso
9 * Test class for MWNamespace.
11 * @todo FIXME: this test file is a mess
13 class MWNamespaceTest
extends MediaWikiTestCase
{
14 protected function setUp() {
17 $this->setMwGlobals( [
18 'wgContentNamespaces' => [ NS_MAIN
],
19 'wgNamespacesWithSubpages' => [
24 'wgCapitalLinks' => true,
25 'wgCapitalLinkOverrides' => [],
26 'wgNonincludableNamespaces' => [],
30 # ### START OF TESTS #########################################################
33 * @todo Write more texts, handle $wgAllowImageMoving setting
34 * @covers MWNamespace::isMovable
36 public function testIsMovable() {
37 $this->assertFalse( MWNamespace
::isMovable( NS_SPECIAL
) );
38 # @todo FIXME: Write more tests!!
42 * Please make sure to change testIsTalk() if you change the assertions below
43 * @covers MWNamespace::isSubject
45 public function testIsSubject() {
47 $this->assertIsSubject( NS_MEDIA
);
48 $this->assertIsSubject( NS_SPECIAL
);
51 $this->assertIsSubject( NS_MAIN
);
52 $this->assertIsSubject( NS_USER
);
53 $this->assertIsSubject( 100 ); # user defined
56 $this->assertIsNotSubject( NS_TALK
);
57 $this->assertIsNotSubject( NS_USER_TALK
);
58 $this->assertIsNotSubject( 101 ); # user defined
62 * Reverse of testIsSubject().
63 * Please update testIsSubject() if you change assertions below
64 * @covers MWNamespace::isTalk
66 public function testIsTalk() {
68 $this->assertIsNotTalk( NS_MEDIA
);
69 $this->assertIsNotTalk( NS_SPECIAL
);
72 $this->assertIsNotTalk( NS_MAIN
);
73 $this->assertIsNotTalk( NS_USER
);
74 $this->assertIsNotTalk( 100 ); # user defined
77 $this->assertIsTalk( NS_TALK
);
78 $this->assertIsTalk( NS_USER_TALK
);
79 $this->assertIsTalk( 101 ); # user defined
83 * @covers MWNamespace::getSubject
85 public function testGetSubject() {
86 // Special namespaces are their own subjects
87 $this->assertEquals( NS_MEDIA
, MWNamespace
::getSubject( NS_MEDIA
) );
88 $this->assertEquals( NS_SPECIAL
, MWNamespace
::getSubject( NS_SPECIAL
) );
90 $this->assertEquals( NS_MAIN
, MWNamespace
::getSubject( NS_TALK
) );
91 $this->assertEquals( NS_USER
, MWNamespace
::getSubject( NS_USER_TALK
) );
95 * Regular getTalk() calls
96 * Namespaces without a talk page (NS_MEDIA, NS_SPECIAL) are tested in
97 * the function testGetTalkExceptions()
98 * @covers MWNamespace::getTalk
100 public function testGetTalk() {
101 $this->assertEquals( NS_TALK
, MWNamespace
::getTalk( NS_MAIN
) );
102 $this->assertEquals( NS_TALK
, MWNamespace
::getTalk( NS_TALK
) );
103 $this->assertEquals( NS_USER_TALK
, MWNamespace
::getTalk( NS_USER
) );
104 $this->assertEquals( NS_USER_TALK
, MWNamespace
::getTalk( NS_USER_TALK
) );
108 * Exceptions with getTalk()
109 * NS_MEDIA does not have talk pages. MediaWiki raise an exception for them.
110 * @expectedException MWException
111 * @covers MWNamespace::getTalk
113 public function testGetTalkExceptionsForNsMedia() {
114 $this->assertNull( MWNamespace
::getTalk( NS_MEDIA
) );
118 * Exceptions with getTalk()
119 * NS_SPECIAL does not have talk pages. MediaWiki raise an exception for them.
120 * @expectedException MWException
121 * @covers MWNamespace::getTalk
123 public function testGetTalkExceptionsForNsSpecial() {
124 $this->assertNull( MWNamespace
::getTalk( NS_SPECIAL
) );
128 * Regular getAssociated() calls
129 * Namespaces without an associated page (NS_MEDIA, NS_SPECIAL) are tested in
130 * the function testGetAssociatedExceptions()
131 * @covers MWNamespace::getAssociated
133 public function testGetAssociated() {
134 $this->assertEquals( NS_TALK
, MWNamespace
::getAssociated( NS_MAIN
) );
135 $this->assertEquals( NS_MAIN
, MWNamespace
::getAssociated( NS_TALK
) );
138 # ## Exceptions with getAssociated()
139 # ## NS_MEDIA and NS_SPECIAL do not have talk pages. MediaWiki raises
140 # ## an exception for them.
142 * @expectedException MWException
143 * @covers MWNamespace::getAssociated
145 public function testGetAssociatedExceptionsForNsMedia() {
146 $this->assertNull( MWNamespace
::getAssociated( NS_MEDIA
) );
150 * @expectedException MWException
151 * @covers MWNamespace::getAssociated
153 public function testGetAssociatedExceptionsForNsSpecial() {
154 $this->assertNull( MWNamespace
::getAssociated( NS_SPECIAL
) );
158 * @todo Implement testExists().
161 public function testExists() {
162 // Remove the following lines when you implement this test.
163 $this->markTestIncomplete(
164 'This test has not been implemented yet. Rely on $wgCanonicalNamespaces.'
170 * Test MWNamespace::equals
171 * Note if we add a namespace registration system with keys like 'MAIN'
172 * we should add tests here for equivilance on things like 'MAIN' == 0
173 * and 'MAIN' == NS_MAIN.
174 * @covers MWNamespace::equals
176 public function testEquals() {
177 $this->assertTrue( MWNamespace
::equals( NS_MAIN
, NS_MAIN
) );
178 $this->assertTrue( MWNamespace
::equals( NS_MAIN
, 0 ) ); // In case we make NS_MAIN 'MAIN'
179 $this->assertTrue( MWNamespace
::equals( NS_USER
, NS_USER
) );
180 $this->assertTrue( MWNamespace
::equals( NS_USER
, 2 ) );
181 $this->assertTrue( MWNamespace
::equals( NS_USER_TALK
, NS_USER_TALK
) );
182 $this->assertTrue( MWNamespace
::equals( NS_SPECIAL
, NS_SPECIAL
) );
183 $this->assertFalse( MWNamespace
::equals( NS_MAIN
, NS_TALK
) );
184 $this->assertFalse( MWNamespace
::equals( NS_USER
, NS_USER_TALK
) );
185 $this->assertFalse( MWNamespace
::equals( NS_PROJECT
, NS_TEMPLATE
) );
189 * @covers MWNamespace::subjectEquals
191 public function testSubjectEquals() {
192 $this->assertSameSubject( NS_MAIN
, NS_MAIN
);
193 $this->assertSameSubject( NS_MAIN
, 0 ); // In case we make NS_MAIN 'MAIN'
194 $this->assertSameSubject( NS_USER
, NS_USER
);
195 $this->assertSameSubject( NS_USER
, 2 );
196 $this->assertSameSubject( NS_USER_TALK
, NS_USER_TALK
);
197 $this->assertSameSubject( NS_SPECIAL
, NS_SPECIAL
);
198 $this->assertSameSubject( NS_MAIN
, NS_TALK
);
199 $this->assertSameSubject( NS_USER
, NS_USER_TALK
);
201 $this->assertDifferentSubject( NS_PROJECT
, NS_TEMPLATE
);
202 $this->assertDifferentSubject( NS_SPECIAL
, NS_MAIN
);
206 * @covers MWNamespace::subjectEquals
208 public function testSpecialAndMediaAreDifferentSubjects() {
209 $this->assertDifferentSubject(
210 NS_MEDIA
, NS_SPECIAL
,
211 "NS_MEDIA and NS_SPECIAL are different subject namespaces"
213 $this->assertDifferentSubject(
214 NS_SPECIAL
, NS_MEDIA
,
215 "NS_SPECIAL and NS_MEDIA are different subject namespaces"
220 * @todo Implement testGetCanonicalNamespaces().
223 public function testGetCanonicalNamespaces() {
224 // Remove the following lines when you implement this test.
225 $this->markTestIncomplete(
226 'This test has not been implemented yet. Rely on $wgCanonicalNamespaces.'
231 * @todo Implement testGetCanonicalName().
234 public function testGetCanonicalName() {
235 // Remove the following lines when you implement this test.
236 $this->markTestIncomplete(
237 'This test has not been implemented yet. Rely on $wgCanonicalNamespaces.'
242 * @todo Implement testGetCanonicalIndex().
245 public function testGetCanonicalIndex() {
246 // Remove the following lines when you implement this test.
247 $this->markTestIncomplete(
248 'This test has not been implemented yet. Rely on $wgCanonicalNamespaces.'
254 * @todo Implement testGetValidNamespaces().
257 public function testGetValidNamespaces() {
258 // Remove the following lines when you implement this test.
259 $this->markTestIncomplete(
260 'This test has not been implemented yet. Rely on $wgCanonicalNamespaces.'
265 public function provideHasTalkNamespace() {
268 [ NS_SPECIAL
, false ],
273 [ NS_USER_TALK
, true ],
281 * @dataProvider provideHasTalkNamespace
282 * @covers MWNamespace::hasTalkNamespace
285 * @param bool $expected
287 public function testHasTalkNamespace( $index, $expected ) {
288 $actual = MWNamespace
::hasTalkNamespace( $index );
289 $this->assertSame( $actual, $expected, "NS $index" );
293 * @dataProvider provideHasTalkNamespace
294 * @covers MWNamespace::canTalk
297 * @param bool $expected
299 public function testCanTalk( $index, $expected ) {
300 $actual = MWNamespace
::canTalk( $index );
301 $this->assertSame( $actual, $expected, "NS $index" );
305 * @covers MWNamespace::isContent
307 public function testIsContent() {
308 // NS_MAIN is a content namespace per DefaultSettings.php
309 // and per function definition.
311 $this->assertIsContent( NS_MAIN
);
313 // Other namespaces which are not expected to be content
315 $this->assertIsNotContent( NS_MEDIA
);
316 $this->assertIsNotContent( NS_SPECIAL
);
317 $this->assertIsNotContent( NS_TALK
);
318 $this->assertIsNotContent( NS_USER
);
319 $this->assertIsNotContent( NS_CATEGORY
);
320 $this->assertIsNotContent( 100 );
324 * Similar to testIsContent() but alters the $wgContentNamespaces
326 * @covers MWNamespace::isContent
328 public function testIsContentAdvanced() {
329 global $wgContentNamespaces;
331 // Test that user defined namespace #252 is not content
332 $this->assertIsNotContent( 252 );
334 // Bless namespace # 252 as a content namespace
335 $wgContentNamespaces[] = 252;
337 $this->assertIsContent( 252 );
339 // Makes sure NS_MAIN was not impacted
340 $this->assertIsContent( NS_MAIN
);
344 * @covers MWNamespace::isWatchable
346 public function testIsWatchable() {
347 // Specials namespaces are not watchable
348 $this->assertIsNotWatchable( NS_MEDIA
);
349 $this->assertIsNotWatchable( NS_SPECIAL
);
351 // Core defined namespaces are watchables
352 $this->assertIsWatchable( NS_MAIN
);
353 $this->assertIsWatchable( NS_TALK
);
355 // Additional, user defined namespaces are watchables
356 $this->assertIsWatchable( 100 );
357 $this->assertIsWatchable( 101 );
361 * @covers MWNamespace::hasSubpages
363 public function testHasSubpages() {
364 global $wgNamespacesWithSubpages;
366 // Special namespaces:
367 $this->assertHasNotSubpages( NS_MEDIA
);
368 $this->assertHasNotSubpages( NS_SPECIAL
);
370 // Namespaces without subpages
371 $this->assertHasNotSubpages( NS_MAIN
);
373 $wgNamespacesWithSubpages[NS_MAIN
] = true;
374 $this->assertHasSubpages( NS_MAIN
);
376 $wgNamespacesWithSubpages[NS_MAIN
] = false;
377 $this->assertHasNotSubpages( NS_MAIN
);
379 // Some namespaces with subpages
380 $this->assertHasSubpages( NS_TALK
);
381 $this->assertHasSubpages( NS_USER
);
382 $this->assertHasSubpages( NS_USER_TALK
);
386 * @covers MWNamespace::getContentNamespaces
388 public function testGetContentNamespaces() {
389 global $wgContentNamespaces;
393 MWNamespace
::getContentNamespaces(),
394 '$wgContentNamespaces is an array with only NS_MAIN by default'
397 # test !is_array( $wgcontentNamespaces )
398 $wgContentNamespaces = '';
399 $this->assertEquals( [ NS_MAIN
], MWNamespace
::getContentNamespaces() );
401 $wgContentNamespaces = false;
402 $this->assertEquals( [ NS_MAIN
], MWNamespace
::getContentNamespaces() );
404 $wgContentNamespaces = null;
405 $this->assertEquals( [ NS_MAIN
], MWNamespace
::getContentNamespaces() );
407 $wgContentNamespaces = 5;
408 $this->assertEquals( [ NS_MAIN
], MWNamespace
::getContentNamespaces() );
410 # test $wgContentNamespaces === []
411 $wgContentNamespaces = [];
412 $this->assertEquals( [ NS_MAIN
], MWNamespace
::getContentNamespaces() );
414 # test !in_array( NS_MAIN, $wgContentNamespaces )
415 $wgContentNamespaces = [ NS_USER
, NS_CATEGORY
];
417 [ NS_MAIN
, NS_USER
, NS_CATEGORY
],
418 MWNamespace
::getContentNamespaces(),
419 'NS_MAIN is forced in $wgContentNamespaces even if unwanted'
422 # test other cases, return $wgcontentNamespaces as is
423 $wgContentNamespaces = [ NS_MAIN
];
426 MWNamespace
::getContentNamespaces()
429 $wgContentNamespaces = [ NS_MAIN
, NS_USER
, NS_CATEGORY
];
431 [ NS_MAIN
, NS_USER
, NS_CATEGORY
],
432 MWNamespace
::getContentNamespaces()
437 * @covers MWNamespace::getSubjectNamespaces
439 public function testGetSubjectNamespaces() {
440 $subjectsNS = MWNamespace
::getSubjectNamespaces();
441 $this->assertContains( NS_MAIN
, $subjectsNS,
442 "Talk namespaces should have NS_MAIN" );
443 $this->assertNotContains( NS_TALK
, $subjectsNS,
444 "Talk namespaces should have NS_TALK" );
446 $this->assertNotContains( NS_MEDIA
, $subjectsNS,
447 "Talk namespaces should not have NS_MEDIA" );
448 $this->assertNotContains( NS_SPECIAL
, $subjectsNS,
449 "Talk namespaces should not have NS_SPECIAL" );
453 * @covers MWNamespace::getTalkNamespaces
455 public function testGetTalkNamespaces() {
456 $talkNS = MWNamespace
::getTalkNamespaces();
457 $this->assertContains( NS_TALK
, $talkNS,
458 "Subject namespaces should have NS_TALK" );
459 $this->assertNotContains( NS_MAIN
, $talkNS,
460 "Subject namespaces should not have NS_MAIN" );
462 $this->assertNotContains( NS_MEDIA
, $talkNS,
463 "Subject namespaces should not have NS_MEDIA" );
464 $this->assertNotContains( NS_SPECIAL
, $talkNS,
465 "Subject namespaces should not have NS_SPECIAL" );
469 * Some namespaces are always capitalized per code definition
470 * in MWNamespace::$alwaysCapitalizedNamespaces
471 * @covers MWNamespace::isCapitalized
473 public function testIsCapitalizedHardcodedAssertions() {
474 // NS_MEDIA and NS_FILE are treated the same
476 MWNamespace
::isCapitalized( NS_MEDIA
),
477 MWNamespace
::isCapitalized( NS_FILE
),
478 'NS_MEDIA and NS_FILE have same capitalization rendering'
481 // Boths are capitalized by default
482 $this->assertIsCapitalized( NS_MEDIA
);
483 $this->assertIsCapitalized( NS_FILE
);
485 // Always capitalized namespaces
486 // @see MWNamespace::$alwaysCapitalizedNamespaces
487 $this->assertIsCapitalized( NS_SPECIAL
);
488 $this->assertIsCapitalized( NS_USER
);
489 $this->assertIsCapitalized( NS_MEDIAWIKI
);
493 * Follows up for testIsCapitalizedHardcodedAssertions() but alter the
494 * global $wgCapitalLink setting to have extended coverage.
496 * MWNamespace::isCapitalized() rely on two global settings:
497 * $wgCapitalLinkOverrides = []; by default
498 * $wgCapitalLinks = true; by default
499 * This function test $wgCapitalLinks
501 * Global setting correctness is tested against the NS_PROJECT and
502 * NS_PROJECT_TALK namespaces since they are not hardcoded nor specials
503 * @covers MWNamespace::isCapitalized
505 public function testIsCapitalizedWithWgCapitalLinks() {
506 global $wgCapitalLinks;
508 $this->assertIsCapitalized( NS_PROJECT
);
509 $this->assertIsCapitalized( NS_PROJECT_TALK
);
511 $wgCapitalLinks = false;
513 // hardcoded namespaces (see above function) are still capitalized:
514 $this->assertIsCapitalized( NS_SPECIAL
);
515 $this->assertIsCapitalized( NS_USER
);
516 $this->assertIsCapitalized( NS_MEDIAWIKI
);
518 // setting is correctly applied
519 $this->assertIsNotCapitalized( NS_PROJECT
);
520 $this->assertIsNotCapitalized( NS_PROJECT_TALK
);
524 * Counter part for MWNamespace::testIsCapitalizedWithWgCapitalLinks() now
525 * testing the $wgCapitalLinkOverrides global.
527 * @todo split groups of assertions in autonomous testing functions
528 * @covers MWNamespace::isCapitalized
530 public function testIsCapitalizedWithWgCapitalLinkOverrides() {
531 global $wgCapitalLinkOverrides;
533 // Test default settings
534 $this->assertIsCapitalized( NS_PROJECT
);
535 $this->assertIsCapitalized( NS_PROJECT_TALK
);
537 // hardcoded namespaces (see above function) are capitalized:
538 $this->assertIsCapitalized( NS_SPECIAL
);
539 $this->assertIsCapitalized( NS_USER
);
540 $this->assertIsCapitalized( NS_MEDIAWIKI
);
542 // Hardcoded namespaces remains capitalized
543 $wgCapitalLinkOverrides[NS_SPECIAL
] = false;
544 $wgCapitalLinkOverrides[NS_USER
] = false;
545 $wgCapitalLinkOverrides[NS_MEDIAWIKI
] = false;
547 $this->assertIsCapitalized( NS_SPECIAL
);
548 $this->assertIsCapitalized( NS_USER
);
549 $this->assertIsCapitalized( NS_MEDIAWIKI
);
551 $wgCapitalLinkOverrides[NS_PROJECT
] = false;
552 $this->assertIsNotCapitalized( NS_PROJECT
);
554 $wgCapitalLinkOverrides[NS_PROJECT
] = true;
555 $this->assertIsCapitalized( NS_PROJECT
);
557 unset( $wgCapitalLinkOverrides[NS_PROJECT
] );
558 $this->assertIsCapitalized( NS_PROJECT
);
562 * @covers MWNamespace::hasGenderDistinction
564 public function testHasGenderDistinction() {
565 // Namespaces with gender distinctions
566 $this->assertTrue( MWNamespace
::hasGenderDistinction( NS_USER
) );
567 $this->assertTrue( MWNamespace
::hasGenderDistinction( NS_USER_TALK
) );
569 // Other ones, "genderless"
570 $this->assertFalse( MWNamespace
::hasGenderDistinction( NS_MEDIA
) );
571 $this->assertFalse( MWNamespace
::hasGenderDistinction( NS_SPECIAL
) );
572 $this->assertFalse( MWNamespace
::hasGenderDistinction( NS_MAIN
) );
573 $this->assertFalse( MWNamespace
::hasGenderDistinction( NS_TALK
) );
577 * @covers MWNamespace::isNonincludable
579 public function testIsNonincludable() {
580 global $wgNonincludableNamespaces;
582 $wgNonincludableNamespaces = [ NS_USER
];
584 $this->assertTrue( MWNamespace
::isNonincludable( NS_USER
) );
585 $this->assertFalse( MWNamespace
::isNonincludable( NS_TEMPLATE
) );
588 # ###### HELPERS ###########################################################
589 function __call( $method, $args ) {
590 // Call the real method if it exists
591 if ( method_exists( $this, $method ) ) {
592 return $this->$method( $args );
596 '/^assert(Has|Is|Can)(Not|)(Subject|Talk|Watchable|Content|Subpages|Capitalized)$/',
600 # Interprets arguments:
602 $msg = isset( $args[1] ) ?
$args[1] : " dummy message";
604 # Forge the namespace constant name:
606 $ns_name = "NS_MAIN";
608 $ns_name = "NS_" . strtoupper( MWNamespace
::getCanonicalName( $ns ) );
610 # ... and the MWNamespace method name
611 $nsMethod = strtolower( $m[1] ) . $m[3];
613 $expect = ( $m[2] === '' );
614 $expect_name = $expect ?
'TRUE' : 'FALSE';
616 return $this->assertEquals( $expect,
617 MWNamespace
::$nsMethod( $ns, $msg ),
618 "MWNamespace::$nsMethod( $ns_name ) should returns $expect_name"
622 throw new Exception( __METHOD__
. " could not find a method named $method\n" );
625 function assertSameSubject( $ns1, $ns2, $msg = '' ) {
626 $this->assertTrue( MWNamespace
::subjectEquals( $ns1, $ns2, $msg ) );
629 function assertDifferentSubject( $ns1, $ns2, $msg = '' ) {
630 $this->assertFalse( MWNamespace
::subjectEquals( $ns1, $ns2, $msg ) );