MediaWiki  1.33.0
ApiDeleteTest.php
Go to the documentation of this file.
1 <?php
2 
14 class ApiDeleteTest extends ApiTestCase {
15 
16  protected function setUp() {
17  parent::setUp();
18  $this->tablesUsed = array_merge(
19  $this->tablesUsed,
20  [ 'change_tag', 'change_tag_def', 'logging' ]
21  );
22  }
23 
24  public function testDelete() {
25  $name = 'Help:' . ucfirst( __FUNCTION__ );
26 
27  // create new page
28  $this->editPage( $name, 'Some text' );
29 
30  // test deletion
31  $apiResult = $this->doApiRequestWithToken( [
32  'action' => 'delete',
33  'title' => $name,
34  ] )[0];
35 
36  $this->assertArrayHasKey( 'delete', $apiResult );
37  $this->assertArrayHasKey( 'title', $apiResult['delete'] );
38  $this->assertSame( $name, $apiResult['delete']['title'] );
39  $this->assertArrayHasKey( 'logid', $apiResult['delete'] );
40 
41  $this->assertFalse( Title::newFromText( $name )->exists() );
42  }
43 
44  public function testBatchedDelete() {
45  $this->setMwGlobals( 'wgDeleteRevisionsBatchSize', 1 );
46 
47  $name = 'Help:' . ucfirst( __FUNCTION__ );
48  for ( $i = 1; $i <= 3; $i++ ) {
49  $this->editPage( $name, "Revision $i" );
50  }
51 
52  $apiResult = $this->doApiRequestWithToken( [
53  'action' => 'delete',
54  'title' => $name,
55  ] )[0];
56 
57  $this->assertArrayHasKey( 'delete', $apiResult );
58  $this->assertArrayHasKey( 'title', $apiResult['delete'] );
59  $this->assertSame( $name, $apiResult['delete']['title'] );
60  $this->assertArrayHasKey( 'scheduled', $apiResult['delete'] );
61  $this->assertTrue( $apiResult['delete']['scheduled'] );
62  $this->assertArrayNotHasKey( 'logid', $apiResult['delete'] );
63 
64  // Run the jobs
66  $jobs = new RunJobs;
67  $jobs->loadParamsAndArgs( null, [ 'quiet' => true ], null );
68  $jobs->execute();
69 
70  $this->assertFalse( Title::newFromText( $name )->exists( Title::GAID_FOR_UPDATE ) );
71  }
72 
73  public function testDeleteNonexistent() {
74  $this->setExpectedException( ApiUsageException::class,
75  "The page you specified doesn't exist." );
76 
77  $this->doApiRequestWithToken( [
78  'action' => 'delete',
79  'title' => 'This page deliberately left nonexistent',
80  ] );
81  }
82 
83  public function testDeletionWithoutPermission() {
84  $this->setExpectedException( ApiUsageException::class,
85  'The action you have requested is limited to users in the group:' );
86 
87  $name = 'Help:' . ucfirst( __FUNCTION__ );
88 
89  // create new page
90  $this->editPage( $name, 'Some text' );
91 
92  // test deletion without permission
93  try {
94  $user = new User();
95  $apiResult = $this->doApiRequest( [
96  'action' => 'delete',
97  'title' => $name,
98  'token' => $user->getEditToken(),
99  ], null, null, $user );
100  } finally {
101  $this->assertTrue( Title::newFromText( $name )->exists() );
102  }
103  }
104 
105  public function testDeleteWithTag() {
106  $name = 'Help:' . ucfirst( __FUNCTION__ );
107 
108  ChangeTags::defineTag( 'custom tag' );
109 
110  $this->editPage( $name, 'Some text' );
111 
112  $this->doApiRequestWithToken( [
113  'action' => 'delete',
114  'title' => $name,
115  'tags' => 'custom tag',
116  ] );
117 
118  $this->assertFalse( Title::newFromText( $name )->exists() );
119 
120  $dbw = wfGetDB( DB_MASTER );
121  $this->assertSame( 'custom tag', $dbw->selectField(
122  [ 'change_tag', 'logging', 'change_tag_def' ],
123  'ctd_name',
124  [
125  'log_namespace' => NS_HELP,
126  'log_title' => ucfirst( __FUNCTION__ ),
127  ],
128  __METHOD__,
129  [],
130  [
131  'change_tag' => [ 'JOIN', 'ct_log_id = log_id' ],
132  'change_tag_def' => [ 'JOIN', 'ctd_id = ct_tag_id' ]
133  ]
134  ) );
135  }
136 
137  public function testDeleteWithoutTagPermission() {
138  $this->setExpectedException( ApiUsageException::class,
139  'You do not have permission to apply change tags along with your changes.' );
140 
141  $name = 'Help:' . ucfirst( __FUNCTION__ );
142 
143  ChangeTags::defineTag( 'custom tag' );
144  $this->setMwGlobals( 'wgRevokePermissions',
145  [ 'user' => [ 'applychangetags' => true ] ] );
146 
147  $this->editPage( $name, 'Some text' );
148 
149  try {
150  $this->doApiRequestWithToken( [
151  'action' => 'delete',
152  'title' => $name,
153  'tags' => 'custom tag',
154  ] );
155  } finally {
156  $this->assertTrue( Title::newFromText( $name )->exists() );
157  }
158  }
159 
160  public function testDeleteAbortedByHook() {
161  $this->setExpectedException( ApiUsageException::class,
162  'Deletion aborted by hook. It gave no explanation.' );
163 
164  $name = 'Help:' . ucfirst( __FUNCTION__ );
165 
166  $this->editPage( $name, 'Some text' );
167 
168  $this->setTemporaryHook( 'ArticleDelete',
169  function () {
170  return false;
171  }
172  );
173 
174  try {
175  $this->doApiRequestWithToken( [ 'action' => 'delete', 'title' => $name ] );
176  } finally {
177  $this->assertTrue( Title::newFromText( $name )->exists() );
178  }
179  }
180 
181  public function testDeleteWatch() {
182  $name = 'Help:' . ucfirst( __FUNCTION__ );
183  $user = self::$users['sysop']->getUser();
184 
185  $this->editPage( $name, 'Some text' );
186  $this->assertTrue( Title::newFromText( $name )->exists() );
187  $this->assertFalse( $user->isWatched( Title::newFromText( $name ) ) );
188 
189  $this->doApiRequestWithToken( [ 'action' => 'delete', 'title' => $name, 'watch' => '' ] );
190 
191  $this->assertFalse( Title::newFromText( $name )->exists() );
192  $this->assertTrue( $user->isWatched( Title::newFromText( $name ) ) );
193  }
194 
195  public function testDeleteUnwatch() {
196  $name = 'Help:' . ucfirst( __FUNCTION__ );
197  $user = self::$users['sysop']->getUser();
198 
199  $this->editPage( $name, 'Some text' );
200  $this->assertTrue( Title::newFromText( $name )->exists() );
201  $user->addWatch( Title::newFromText( $name ) );
202  $this->assertTrue( $user->isWatched( Title::newFromText( $name ) ) );
203 
204  $this->doApiRequestWithToken( [ 'action' => 'delete', 'title' => $name, 'unwatch' => '' ] );
205 
206  $this->assertFalse( Title::newFromText( $name )->exists() );
207  $this->assertFalse( $user->isWatched( Title::newFromText( $name ) ) );
208  }
209 }
RunJobs
Maintenance script that runs pending jobs.
Definition: runJobs.php:36
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
NS_HELP
const NS_HELP
Definition: Defines.php:76
ApiDeleteTest\testDeleteUnwatch
testDeleteUnwatch()
Definition: ApiDeleteTest.php:195
ApiDeleteTest\testDeleteWithTag
testDeleteWithTag()
Definition: ApiDeleteTest.php:105
Maintenance\loadParamsAndArgs
loadParamsAndArgs( $self=null, $opts=null, $args=null)
Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs be...
Definition: Maintenance.php:960
JobQueueGroup\destroySingletons
static destroySingletons()
Destroy the singleton instances.
Definition: JobQueueGroup.php:98
User
User
Definition: All_system_messages.txt:425
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
ApiTestCase\doApiRequest
doApiRequest(array $params, array $session=null, $appendModule=false, User $user=null, $tokenType=null)
Does the API request and returns the result.
Definition: ApiTestCase.php:62
ApiDeleteTest
Tests for MediaWiki api.php?action=delete.
Definition: ApiDeleteTest.php:14
ApiDeleteTest\testBatchedDelete
testBatchedDelete()
Definition: ApiDeleteTest.php:44
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2636
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:709
ApiTestCase\doApiRequestWithToken
doApiRequestWithToken(array $params, array $session=null, User $user=null, $tokenType='auto')
Convenience function to access the token parameter of doApiRequest() more succinctly.
Definition: ApiTestCase.php:132
ChangeTags\defineTag
static defineTag( $tag)
Set ctd_user_defined = 1 in change_tag_def without checking that the tag name is valid.
Definition: ChangeTags.php:877
DB_MASTER
const DB_MASTER
Definition: defines.php:26
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
MediaWikiTestCase\editPage
editPage( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
Edits or creates a page/revision.
Definition: MediaWikiTestCase.php:2367
ApiTestCase
Definition: ApiTestCase.php:5
ApiDeleteTest\testDeleteNonexistent
testDeleteNonexistent()
Definition: ApiDeleteTest.php:73
Title\GAID_FOR_UPDATE
const GAID_FOR_UPDATE
Used to be GAID_FOR_UPDATE define.
Definition: Title.php:55
ApiDeleteTest\testDeleteWithoutTagPermission
testDeleteWithoutTagPermission()
Definition: ApiDeleteTest.php:137
ApiDeleteTest\testDeleteAbortedByHook
testDeleteAbortedByHook()
Definition: ApiDeleteTest.php:160
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
MediaWikiTestCase\setTemporaryHook
setTemporaryHook( $hookName, $handler)
Create a temporary hook handler which will be reset by tearDown.
Definition: MediaWikiTestCase.php:2325
ApiDeleteTest\setUp
setUp()
Definition: ApiDeleteTest.php:16
ApiDeleteTest\testDeleteWatch
testDeleteWatch()
Definition: ApiDeleteTest.php:181
ApiDeleteTest\testDeletionWithoutPermission
testDeletionWithoutPermission()
Definition: ApiDeleteTest.php:83
ApiDeleteTest\testDelete
testDelete()
Definition: ApiDeleteTest.php:24