MediaWiki  master
MutableRevisionRecordTest.php
Go to the documentation of this file.
1 <?php
2 
4 
16 use Title;
17 use User;
19 
25 
27 
28  function setUp() {
30  parent::setUp();
31  }
32 
38  protected function newRevision( array $rowOverrides = [] ) {
39  $title = Title::newFromText( 'Dummy' );
40  $title->resetArticleID( 17 );
41 
42  $user = new UserIdentityValue( 11, 'Tester', 0 );
43  $comment = CommentStoreComment::newUnsavedComment( 'Hello World' );
44 
45  $record = new MutableRevisionRecord( $title );
46 
47  if ( isset( $rowOverrides['rev_deleted'] ) ) {
48  $record->setVisibility( $rowOverrides['rev_deleted'] );
49  }
50 
51  if ( isset( $rowOverrides['rev_id'] ) ) {
52  $record->setId( $rowOverrides['rev_id'] );
53  }
54 
55  if ( isset( $rowOverrides['rev_page'] ) ) {
56  $record->setPageId( $rowOverrides['rev_page'] );
57  }
58 
59  $record->setContent( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
60  $record->setComment( $comment );
61  $record->setUser( $user );
62  $record->setTimestamp( '20101010000000' );
63 
64  return $record;
65  }
66 
67  public function provideConstructor() {
68  $title = Title::newFromText( 'Dummy' );
69  $title->resetArticleID( 17 );
70 
71  yield [
72  $title,
73  'acmewiki'
74  ];
75  }
76 
83  public function testConstructorAndGetters(
84  Title $title,
85  $wikiId = false
86  ) {
87  $rec = new MutableRevisionRecord( $title, $wikiId );
88 
89  $this->assertSame( $title, $rec->getPageAsLinkTarget(), 'getPageAsLinkTarget' );
90  $this->assertSame( $wikiId, $rec->getWikiId(), 'getWikiId' );
91  }
92 
93  public function provideConstructorFailure() {
94  $title = Title::newFromText( 'Dummy' );
95  $title->resetArticleID( 17 );
96 
97  yield 'not a wiki id' => [
98  $title,
99  null
100  ];
101  }
102 
109  public function testConstructorFailure(
110  Title $title,
111  $wikiId = false
112  ) {
113  $this->setExpectedException( InvalidArgumentException::class );
114  new MutableRevisionRecord( $title, $wikiId );
115  }
116 
117  public function testSetGetId() {
118  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
119  $this->assertNull( $record->getId() );
120  $record->setId( 888 );
121  $this->assertSame( 888, $record->getId() );
122  }
123 
124  public function testSetGetUser() {
125  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
126  $user = $this->getTestSysop()->getUser();
127  $this->assertNull( $record->getUser() );
128  $record->setUser( $user );
129  $this->assertSame( $user, $record->getUser() );
130  }
131 
132  public function testSetGetPageId() {
133  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
134  $this->assertSame( 0, $record->getPageId() );
135  $record->setPageId( 999 );
136  $this->assertSame( 999, $record->getPageId() );
137  }
138 
139  public function testSetGetParentId() {
140  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
141  $this->assertNull( $record->getParentId() );
142  $record->setParentId( 100 );
143  $this->assertSame( 100, $record->getParentId() );
144  }
145 
146  public function testGetMainContentWhenEmpty() {
147  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
148  $this->setExpectedException( RevisionAccessException::class );
149  $this->assertNull( $record->getContent( SlotRecord::MAIN ) );
150  }
151 
152  public function testSetGetMainContent() {
153  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
154  $content = new WikitextContent( 'Badger' );
155  $record->setContent( SlotRecord::MAIN, $content );
156  $this->assertSame( $content, $record->getContent( SlotRecord::MAIN ) );
157  }
158 
159  public function testGetSlotWhenEmpty() {
160  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
161  $this->assertFalse( $record->hasSlot( SlotRecord::MAIN ) );
162 
163  $this->setExpectedException( RevisionAccessException::class );
164  $record->getSlot( SlotRecord::MAIN );
165  }
166 
167  public function testSetGetSlot() {
168  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
169  $slot = SlotRecord::newUnsaved(
171  new WikitextContent( 'x' )
172  );
173  $record->setSlot( $slot );
174  $this->assertTrue( $record->hasSlot( SlotRecord::MAIN ) );
175  $this->assertSame( $slot, $record->getSlot( SlotRecord::MAIN ) );
176  }
177 
178  public function testSetGetMinor() {
179  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
180  $this->assertFalse( $record->isMinor() );
181  $record->setMinorEdit( true );
182  $this->assertSame( true, $record->isMinor() );
183  }
184 
185  public function testSetGetTimestamp() {
186  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
187  $this->assertNull( $record->getTimestamp() );
188  $record->setTimestamp( '20180101010101' );
189  $this->assertSame( '20180101010101', $record->getTimestamp() );
190  }
191 
192  public function testSetGetVisibility() {
193  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
194  $this->assertSame( 0, $record->getVisibility() );
195  $record->setVisibility( RevisionRecord::DELETED_USER );
196  $this->assertSame( RevisionRecord::DELETED_USER, $record->getVisibility() );
197  }
198 
199  public function testSetGetSha1() {
200  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
201  $this->assertSame( 'phoiac9h4m842xq45sp7s6u21eteeq1', $record->getSha1() );
202  $record->setSha1( 'someHash' );
203  $this->assertSame( 'someHash', $record->getSha1() );
204  }
205 
206  public function testGetSlots() {
207  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
208  $this->assertInstanceOf( MutableRevisionSlots::class, $record->getSlots() );
209  }
210 
211  public function testSetGetSize() {
212  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
213  $this->assertSame( 0, $record->getSize() );
214  $record->setSize( 775 );
215  $this->assertSame( 775, $record->getSize() );
216  }
217 
218  public function testSetGetComment() {
219  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
220  $comment = new CommentStoreComment( 1, 'foo' );
221  $this->assertNull( $record->getComment() );
222  $record->setComment( $comment );
223  $this->assertSame( $comment, $record->getComment() );
224  }
225 
227  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
228  $mainSlot = new SlotRecord(
229  (object)[
230  'slot_id' => 1,
231  'slot_revision_id' => null, // unsaved
232  'slot_content_id' => 1,
233  'content_address' => null, // touched
234  'model_name' => 'x',
235  'role_name' => 'main',
236  'slot_origin' => null // touched
237  ],
238  new WikitextContent( 'main' )
239  );
240  $auxSlot = new SlotRecord(
241  (object)[
242  'slot_id' => 2,
243  'slot_revision_id' => null, // unsaved
244  'slot_content_id' => 1,
245  'content_address' => 'foo', // inherited
246  'model_name' => 'x',
247  'role_name' => 'aux',
248  'slot_origin' => 1 // inherited
249  ],
250  new WikitextContent( 'aux' )
251  );
252 
253  $record->setSlot( $mainSlot );
254  $record->setSlot( $auxSlot );
255 
256  $this->assertSame( [ 'main' ], $record->getOriginalSlots()->getSlotRoles() );
257  $this->assertSame( $mainSlot, $record->getOriginalSlots()->getSlot( SlotRecord::MAIN ) );
258 
259  $this->assertSame( [ 'aux' ], $record->getInheritedSlots()->getSlotRoles() );
260  $this->assertSame( $auxSlot, $record->getInheritedSlots()->getSlot( 'aux' ) );
261  }
262 
263  public function testSimpleremoveSlot() {
264  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
265 
266  $a = new WikitextContent( 'a' );
267  $b = new WikitextContent( 'b' );
268 
269  $record->inheritSlot( SlotRecord::newSaved( 7, 3, 'a', SlotRecord::newUnsaved( 'a', $a ) ) );
270  $record->inheritSlot( SlotRecord::newSaved( 7, 4, 'b', SlotRecord::newUnsaved( 'b', $b ) ) );
271 
272  $record->removeSlot( 'b' );
273 
274  $this->assertTrue( $record->hasSlot( 'a' ) );
275  $this->assertFalse( $record->hasSlot( 'b' ) );
276  }
277 
278  public function testApplyUpdate() {
279  $update = new RevisionSlotsUpdate();
280 
281  $a = new WikitextContent( 'a' );
282  $b = new WikitextContent( 'b' );
283  $c = new WikitextContent( 'c' );
284  $x = new WikitextContent( 'x' );
285 
286  $update->modifyContent( 'b', $x );
287  $update->modifyContent( 'c', $x );
288  $update->removeSlot( 'c' );
289  $update->removeSlot( 'd' );
290 
291  $record = new MutableRevisionRecord( Title::newFromText( 'Foo' ) );
292  $record->inheritSlot( SlotRecord::newSaved( 7, 3, 'a', SlotRecord::newUnsaved( 'a', $a ) ) );
293  $record->inheritSlot( SlotRecord::newSaved( 7, 4, 'b', SlotRecord::newUnsaved( 'b', $b ) ) );
294  $record->inheritSlot( SlotRecord::newSaved( 7, 5, 'c', SlotRecord::newUnsaved( 'c', $c ) ) );
295 
296  $record->applyUpdate( $update );
297 
298  $this->assertEquals( [ 'b' ], array_keys( $record->getOriginalSlots()->getSlots() ) );
299  $this->assertEquals( $a, $record->getSlot( 'a' )->getContent() );
300  $this->assertEquals( $x, $record->getSlot( 'b' )->getContent() );
301  $this->assertFalse( $record->hasSlot( 'c' ) );
302  }
303 
304  public function provideNotReadyForInsertion() {
306  $title = $this->getMock( Title::class );
307 
309  $user = $this->getMock( User::class );
310 
312  $comment = $this->getMockBuilder( CommentStoreComment::class )
313  ->disableOriginalConstructor()
314  ->getMock();
315 
316  $content = new TextContent( 'Test' );
317 
319  yield 'empty' => [ $rev ];
320 
322  $rev->setContent( SlotRecord::MAIN, $content );
323  $rev->setUser( $user );
324  $rev->setComment( $comment );
325  yield 'no timestamp' => [ $rev ];
326 
328  $rev->setUser( $user );
329  $rev->setComment( $comment );
330  $rev->setTimestamp( '20101010000000' );
331  yield 'no content' => [ $rev ];
332 
334  $rev->setContent( SlotRecord::MAIN, $content );
335  $rev->setComment( $comment );
336  $rev->setTimestamp( '20101010000000' );
337  yield 'no user' => [ $rev ];
338 
340  $rev->setUser( $user );
341  $rev->setContent( SlotRecord::MAIN, $content );
342  $rev->setTimestamp( '20101010000000' );
343  yield 'no comment' => [ $rev ];
344  }
345 
349  public function testNotReadyForInsertion( $rev ) {
350  $this->assertFalse( $rev->isReadyForInsertion() );
351  }
352 }
static newSaved( $revisionId, $contentId, $contentAddress, SlotRecord $protoSlot)
Constructs a complete SlotRecord for a newly saved revision, based on the incomplete proto-slot...
Definition: SlotRecord.php:164
static clearCaches()
Definition: Title.php:3166
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
testConstructorFailure(Title $title, $wikiId=false)
provideConstructorFailure
Value object representing a modification of revision slots.
Value object representing a content slot associated with a page revision.
Definition: SlotRecord.php:39
static newUnsavedComment( $comment, array $data=null)
Create a new, unsaved CommentStoreComment.
Mutable RevisionRecord implementation, for building new revision entries programmatically.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
Value object representing a user&#39;s identity.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1747
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
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
trait RevisionRecordTests
\MediaWiki\Revision\RevisionRecord
testConstructorAndGetters(Title $title, $wikiId=false)
provideConstructor
static newUnsaved( $role, Content $content)
Constructs a new Slot from a Content object for a new revision.
Definition: SlotRecord.php:129
\MediaWiki\Revision\MutableRevisionRecord \MediaWiki\Revision\RevisionRecord
$content
Definition: pageupdater.txt:72
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:320