MediaWiki  1.29.1
MWRestrictionsTest.php
Go to the documentation of this file.
1 <?php
2 class MWRestrictionsTest extends PHPUnit_Framework_TestCase {
3 
4  protected static $restrictionsForChecks;
5 
6  public static function setUpBeforeClass() {
7  self::$restrictionsForChecks = MWRestrictions::newFromArray( [
8  'IPAddresses' => [
9  '10.0.0.0/8',
10  '172.16.0.0/12',
11  '2001:db8::/33',
12  ]
13  ] );
14  }
15 
20  public function testNewDefault() {
22  $this->assertInstanceOf( 'MWRestrictions', $ret );
23  $this->assertSame(
24  '{"IPAddresses":["0.0.0.0/0","::/0"]}',
25  $ret->toJson()
26  );
27  }
28 
39  public function testArray( $data, $expect ) {
40  if ( $expect === true ) {
42  $this->assertInstanceOf( 'MWRestrictions', $ret );
43  $this->assertSame( $data, $ret->toArray() );
44  } else {
45  try {
47  $this->fail( 'Expected exception not thrown' );
48  } catch ( InvalidArgumentException $ex ) {
49  $this->assertEquals( $expect, $ex );
50  }
51  }
52  }
53 
54  public static function provideArray() {
55  return [
56  [ [ 'IPAddresses' => [] ], true ],
57  [ [ 'IPAddresses' => [ '127.0.0.1/32' ] ], true ],
58  [
59  [ 'IPAddresses' => [ '256.0.0.1/32' ] ],
60  new InvalidArgumentException( 'Invalid IP address: 256.0.0.1/32' )
61  ],
62  [
63  [ 'IPAddresses' => '127.0.0.1/32' ],
64  new InvalidArgumentException( 'IPAddresses is not an array' )
65  ],
66  [
67  [],
68  new InvalidArgumentException( 'Array is missing required keys: IPAddresses' )
69  ],
70  [
71  [ 'foo' => 'bar', 'bar' => 42 ],
72  new InvalidArgumentException( 'Array contains invalid keys: foo, bar' )
73  ],
74  ];
75  }
76 
87  public function testJson( $json, $expect ) {
88  if ( is_array( $expect ) ) {
90  $this->assertInstanceOf( 'MWRestrictions', $ret );
91  $this->assertSame( $expect, $ret->toArray() );
92 
93  $this->assertSame( $json, $ret->toJson( false ) );
94  $this->assertSame( $json, (string)$ret );
95 
96  $this->assertSame(
97  FormatJson::encode( $expect, true, FormatJson::ALL_OK ),
98  $ret->toJson( true )
99  );
100  } else {
101  try {
103  $this->fail( 'Expected exception not thrown' );
104  } catch ( InvalidArgumentException $ex ) {
105  $this->assertTrue( true );
106  }
107  }
108  }
109 
110  public static function provideJson() {
111  return [
112  [
113  '{"IPAddresses":[]}',
114  [ 'IPAddresses' => [] ]
115  ],
116  [
117  '{"IPAddresses":["127.0.0.1/32"]}',
118  [ 'IPAddresses' => [ '127.0.0.1/32' ] ]
119  ],
120  [
121  '{"IPAddresses":["256.0.0.1/32"]}',
122  new InvalidArgumentException( 'Invalid IP address: 256.0.0.1/32' )
123  ],
124  [
125  '{"IPAddresses":"127.0.0.1/32"}',
126  new InvalidArgumentException( 'IPAddresses is not an array' )
127  ],
128  [
129  '{}',
130  new InvalidArgumentException( 'Array is missing required keys: IPAddresses' )
131  ],
132  [
133  '{"foo":"bar","bar":42}',
134  new InvalidArgumentException( 'Array contains invalid keys: foo, bar' )
135  ],
136  [
137  '{"IPAddresses":[]',
138  new InvalidArgumentException( 'Invalid restrictions JSON' )
139  ],
140  [
141  '"IPAddresses"',
142  new InvalidArgumentException( 'Invalid restrictions JSON' )
143  ],
144  ];
145  }
146 
153  public function testCheckIP( $ip, $pass ) {
154  $this->assertSame( $pass, self::$restrictionsForChecks->checkIP( $ip ) );
155  }
156 
157  public static function provideCheckIP() {
158  return [
159  [ '10.0.0.1', true ],
160  [ '172.16.0.0', true ],
161  [ '192.0.2.1', false ],
162  [ '2001:db8:1::', true ],
163  [ '2001:0db8:0000:0000:0000:0000:0000:0000', true ],
164  [ '2001:0DB8:8000::', false ],
165  ];
166  }
167 
174  public function testCheck( $request, $expect ) {
175  $this->assertEquals( $expect, self::$restrictionsForChecks->check( $request ) );
176  }
177 
178  public function provideCheck() {
179  $ret = [];
180 
181  $mockBuilder = $this->getMockBuilder( 'FauxRequest' )
182  ->setMethods( [ 'getIP' ] );
183 
184  foreach ( self::provideCheckIP() as $checkIP ) {
185  $ok = [];
186  $request = $mockBuilder->getMock();
187 
188  $request->expects( $this->any() )->method( 'getIP' )
189  ->will( $this->returnValue( $checkIP[0] ) );
190  $ok['ip'] = $checkIP[1];
191 
192  /* If we ever add more restrictions, add nested for loops here:
193  * foreach ( self::provideCheckFoo() as $checkFoo ) {
194  * $request->expects( $this->any() )->method( 'getFoo' )
195  * ->will( $this->returnValue( $checkFoo[0] );
196  * $ok['foo'] = $checkFoo[1];
197  *
198  * foreach ( self::provideCheckBar() as $checkBar ) {
199  * $request->expects( $this->any() )->method( 'getBar' )
200  * ->will( $this->returnValue( $checkBar[0] );
201  * $ok['bar'] = $checkBar[1];
202  *
203  * // etc.
204  * }
205  * }
206  */
207 
209  $status->setResult( $ok === array_filter( $ok ), $ok );
210  $ret[] = [ $request, $status ];
211  }
212 
213  return $ret;
214  }
215 }
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
MWRestrictionsTest\provideCheck
provideCheck()
Definition: MWRestrictionsTest.php:178
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
MWRestrictionsTest\$restrictionsForChecks
static $restrictionsForChecks
Definition: MWRestrictionsTest.php:4
MWRestrictionsTest
Definition: MWRestrictionsTest.php:2
FormatJson\ALL_OK
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
MWRestrictionsTest\provideJson
static provideJson()
Definition: MWRestrictionsTest.php:110
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
MWRestrictionsTest\provideArray
static provideArray()
Definition: MWRestrictionsTest.php:54
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
MWRestrictionsTest\testCheck
testCheck( $request, $expect)
MWRestrictions::check provideCheck.
Definition: MWRestrictionsTest.php:174
check
in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff or overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary such as anonymity and the real check
Definition: hooks.txt:1398
MWRestrictions\newDefault
static newDefault()
Definition: MWRestrictions.php:41
any
they could even be mouse clicks or menu items whatever suits your program You should also get your if any
Definition: COPYING.txt:326
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
MWRestrictionsTest\setUpBeforeClass
static setUpBeforeClass()
Definition: MWRestrictionsTest.php:6
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1956
MWRestrictionsTest\provideCheckIP
static provideCheckIP()
Definition: MWRestrictionsTest.php:157
MWRestrictions\newFromJson
static newFromJson( $json)
Definition: MWRestrictions.php:59
MWRestrictions\newFromArray
static newFromArray(array $restrictions)
Definition: MWRestrictions.php:50
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
MWRestrictionsTest\testNewDefault
testNewDefault()
MWRestrictions::newDefault MWRestrictions::__construct.
Definition: MWRestrictionsTest.php:20
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1956
MWRestrictionsTest\testJson
testJson( $json, $expect)
MWRestrictions::newFromJson MWRestrictions::__construct MWRestrictions::loadFromArray MWRestrictions:...
Definition: MWRestrictionsTest.php:87
MWRestrictionsTest\testCheckIP
testCheckIP( $ip, $pass)
MWRestrictions::checkIP provideCheckIP.
Definition: MWRestrictionsTest.php:153
MWRestrictionsTest\testArray
testArray( $data, $expect)
MWRestrictions::newFromArray MWRestrictions::__construct MWRestrictions::loadFromArray MWRestrictions...
Definition: MWRestrictionsTest.php:39