4 * Tests for MediaWiki api.php?action=edit.
6 * @author Daniel Kinzler
11 class ApiEditPageTest
extends ApiTestCase
{
13 public function setup() {
14 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
18 $wgExtraNamespaces[12312] = 'Dummy';
19 $wgExtraNamespaces[12313] = 'Dummy_talk';
21 $wgNamespaceContentModels[12312] = "testing";
22 $wgContentHandlers["testing"] = 'DummyContentHandlerForTesting';
24 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
25 $wgContLang->resetNamespaces(); # reset namespace cache
30 public function teardown() {
31 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
33 unset( $wgExtraNamespaces[12312] );
34 unset( $wgExtraNamespaces[12313] );
36 unset( $wgNamespaceContentModels[12312] );
37 unset( $wgContentHandlers["testing"] );
39 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
40 $wgContLang->resetNamespaces(); # reset namespace cache
45 function testEdit( ) {
46 $name = 'Help:ApiEditPageTest_testEdit'; // assume Help namespace to default to wikitext
48 // -- test new page --------------------------------------------
49 $apiResult = $this->doApiRequestWithToken( array(
52 'text' => 'some text', ) );
53 $apiResult = $apiResult[0];
55 // Validate API result data
56 $this->assertArrayHasKey( 'edit', $apiResult );
57 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
58 $this->assertEquals( 'Success', $apiResult['edit']['result'] );
60 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
61 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
63 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
65 // -- test existing page, no change ----------------------------
66 $data = $this->doApiRequestWithToken( array(
69 'text' => 'some text', ) );
71 $this->assertEquals( 'Success', $data[0]['edit']['result'] );
73 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
74 $this->assertArrayHasKey( 'nochange', $data[0]['edit'] );
76 // -- test existing page, with change --------------------------
77 $data = $this->doApiRequestWithToken( array(
80 'text' => 'different text' ) );
82 $this->assertEquals( 'Success', $data[0]['edit']['result'] );
84 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
85 $this->assertArrayNotHasKey( 'nochange', $data[0]['edit'] );
87 $this->assertArrayHasKey( 'oldrevid', $data[0]['edit'] );
88 $this->assertArrayHasKey( 'newrevid', $data[0]['edit'] );
89 $this->assertNotEquals(
90 $data[0]['edit']['newrevid'],
91 $data[0]['edit']['oldrevid'],
92 "revision id should change after edit"
96 function testNonTextEdit( ) {
97 $name = 'Dummy:ApiEditPageTest_testNonTextEdit';
98 $data = serialize( 'some bla bla text' );
100 // -- test new page --------------------------------------------
101 $apiResult = $this->doApiRequestWithToken( array(
104 'text' => $data, ) );
105 $apiResult = $apiResult[0];
107 // Validate API result data
108 $this->assertArrayHasKey( 'edit', $apiResult );
109 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
110 $this->assertEquals( 'Success', $apiResult['edit']['result'] );
112 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
113 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
115 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
117 // validate resulting revision
118 $page = WikiPage
::factory( Title
::newFromText( $name ) );
119 $this->assertEquals( "testing", $page->getContentModel() );
120 $this->assertEquals( $data, $page->getContent()->serialize() );
123 static function provideEditAppend() {
126 'foo', 'append', 'bar', "foobar"
129 'foo', 'prepend', 'bar', "barfoo"
131 array( #2: append to empty page
132 '', 'append', 'foo', "foo"
134 array( #3: prepend to empty page
135 '', 'prepend', 'foo', "foo"
137 array( #4: append to non-existing page
138 null, 'append', 'foo', "foo"
140 array( #5: prepend to non-existing page
141 null, 'prepend', 'foo', "foo"
147 * @dataProvider provideEditAppend
149 function testEditAppend( $text, $op, $append, $expected ) {
153 // assume NS_HELP defaults to wikitext
154 $name = "Help:ApiEditPageTest_testEditAppend_$count";
156 // -- create page (or not) -----------------------------------------
157 if ( $text !== null ) {
158 if ( $text === '' ) {
159 // can't create an empty page, so create it with some content
160 list( $re,, ) = $this->doApiRequestWithToken( array(
163 'text' => '(dummy)', ) );
166 list( $re,, ) = $this->doApiRequestWithToken( array(
169 'text' => $text, ) );
171 $this->assertEquals( 'Success', $re['edit']['result'] ); // sanity
174 // -- try append/prepend --------------------------------------------
175 list( $re,, ) = $this->doApiRequestWithToken( array(
178 $op . 'text' => $append, ) );
180 $this->assertEquals( 'Success', $re['edit']['result'] );
182 // -- validate -----------------------------------------------------
183 $page = new WikiPage( Title
::newFromText( $name ) );
184 $content = $page->getContent();
185 $this->assertNotNull( $content, 'Page should have been created' );
187 $text = $content->getNativeData();
189 $this->assertEquals( $expected, $text );
192 function testEditSection() {
193 $this->markTestIncomplete( "not yet implemented" );
196 function testUndo() {
197 $this->markTestIncomplete( "not yet implemented" );
200 function testEditConflict() {
204 // assume NS_HELP defaults to wikitext
205 $name = "Help:ApiEditPageTest_testEditConflict_$count";
206 $title = Title
::newFromText( $name );
208 $page = WikiPage
::factory( $title );
211 $page->doEditContent( new WikitextContent( "Foo" ),
212 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
213 $this->forceRevisionDate( $page, '20120101000000' );
214 $baseTime = $page->getRevision()->getTimestamp();
217 $page->doEditContent( new WikitextContent( "Foo bar" ),
218 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
219 $this->forceRevisionDate( $page, '20120101020202' );
221 // try to save edit, expect conflict
223 list( $re,, ) = $this->doApiRequestWithToken( array(
226 'text' => 'nix bar!',
227 'basetimestamp' => $baseTime,
228 ), null, self
::$users['sysop']->user
);
230 $this->fail( 'edit conflict expected' );
231 } catch ( UsageException
$ex ) {
232 $this->assertEquals( 'editconflict', $ex->getCodeString() );
236 function testEditConflict_redirect() {
240 // assume NS_HELP defaults to wikitext
241 $name = "Help:ApiEditPageTest_testEditConflict_redirect_$count";
242 $title = Title
::newFromText( $name );
243 $page = WikiPage
::factory( $title );
245 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_r$count";
246 $rtitle = Title
::newFromText( $rname );
247 $rpage = WikiPage
::factory( $rtitle );
249 // base edit for content
250 $page->doEditContent( new WikitextContent( "Foo" ),
251 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
252 $this->forceRevisionDate( $page, '20120101000000' );
253 $baseTime = $page->getRevision()->getTimestamp();
255 // base edit for redirect
256 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
257 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
258 $this->forceRevisionDate( $rpage, '20120101000000' );
260 // conflicting edit to redirect
261 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]\n\n[[Category:Test]]" ),
262 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
263 $this->forceRevisionDate( $rpage, '20120101020202' );
265 // try to save edit; should work, because we follow the redirect
266 list( $re,, ) = $this->doApiRequestWithToken( array(
269 'text' => 'nix bar!',
270 'basetimestamp' => $baseTime,
272 ), null, self
::$users['sysop']->user
);
274 $this->assertEquals( 'Success', $re['edit']['result'],
275 "no edit conflict expected when following redirect" );
277 // try again, without following the redirect. Should fail.
279 list( $re,, ) = $this->doApiRequestWithToken( array(
282 'text' => 'nix bar!',
283 'basetimestamp' => $baseTime,
284 ), null, self
::$users['sysop']->user
);
286 $this->fail( 'edit conflict expected' );
287 } catch ( UsageException
$ex ) {
288 $this->assertEquals( 'editconflict', $ex->getCodeString() );
292 function testEditConflict_bug41990() {
297 * bug 41990: if the target page has a newer revision than the redirect, then editing the
298 * redirect while specifying 'redirect' and *not* specifying 'basetimestamp' erronously
299 * caused an edit conflict to be detected.
302 // assume NS_HELP defaults to wikitext
303 $name = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_$count";
304 $title = Title
::newFromText( $name );
305 $page = WikiPage
::factory( $title );
307 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_r$count";
308 $rtitle = Title
::newFromText( $rname );
309 $rpage = WikiPage
::factory( $rtitle );
311 // base edit for content
312 $page->doEditContent( new WikitextContent( "Foo" ),
313 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
314 $this->forceRevisionDate( $page, '20120101000000' );
316 // base edit for redirect
317 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
318 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
319 $this->forceRevisionDate( $rpage, '20120101000000' );
320 $baseTime = $rpage->getRevision()->getTimestamp();
322 // new edit to content
323 $page->doEditContent( new WikitextContent( "Foo bar" ),
324 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
325 $this->forceRevisionDate( $rpage, '20120101020202' );
327 // try to save edit; should work, following the redirect.
328 list( $re,, ) = $this->doApiRequestWithToken( array(
331 'text' => 'nix bar!',
333 ), null, self
::$users['sysop']->user
);
335 $this->assertEquals( 'Success', $re['edit']['result'],
336 "no edit conflict expected here" );
339 protected function forceRevisionDate( WikiPage
$page, $timestamp ) {
340 $dbw = wfGetDB( DB_MASTER
);
342 $dbw->update( 'revision',
343 array( 'rev_timestamp' => $timestamp ),
344 array( 'rev_id' => $page->getLatest() ) );