1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<?php
namespace MediaWiki\Tests\Storage;
use InvalidArgumentException;
use LogicException;
use MediaWiki\Storage\IncompleteRevisionException;
use MediaWiki\Storage\SlotRecord;
use MediaWiki\Storage\SuppressedDataException;
use MediaWikiTestCase;
use WikitextContent;
/**
* @covers \MediaWiki\Storage\SlotRecord
*/
class SlotRecordTest extends MediaWikiTestCase {
private function makeRow( $data = [] ) {
$data = $data + [
'slot_id' => 1234,
'slot_content_id' => 33,
'content_size' => '5',
'content_sha1' => 'someHash',
'content_address' => 'tt:456',
'model_name' => CONTENT_MODEL_WIKITEXT,
'format_name' => CONTENT_FORMAT_WIKITEXT,
'slot_revision_id' => '2',
'slot_origin' => '1',
'role_name' => 'myRole',
];
return (object)$data;
}
public function testCompleteConstruction() {
$row = $this->makeRow();
$record = new SlotRecord( $row, new WikitextContent( 'A' ) );
$this->assertTrue( $record->hasAddress() );
$this->assertTrue( $record->hasRevision() );
$this->assertTrue( $record->isInherited() );
$this->assertSame( 'A', $record->getContent()->getNativeData() );
$this->assertSame( 5, $record->getSize() );
$this->assertSame( 'someHash', $record->getSha1() );
$this->assertSame( CONTENT_MODEL_WIKITEXT, $record->getModel() );
$this->assertSame( 2, $record->getRevision() );
$this->assertSame( 1, $record->getOrigin() );
$this->assertSame( 'tt:456', $record->getAddress() );
$this->assertSame( 33, $record->getContentId() );
$this->assertSame( CONTENT_FORMAT_WIKITEXT, $record->getFormat() );
$this->assertSame( 'myRole', $record->getRole() );
}
public function testConstructionDeferred() {
$row = $this->makeRow( [
'content_size' => null, // to be computed
'content_sha1' => null, // to be computed
'format_name' => function () {
return CONTENT_FORMAT_WIKITEXT;
},
'slot_revision_id' => '2',
'slot_origin' => '2',
] );
$content = function () {
return new WikitextContent( 'A' );
};
$record = new SlotRecord( $row, $content );
$this->assertTrue( $record->hasAddress() );
$this->assertTrue( $record->hasRevision() );
$this->assertFalse( $record->isInherited() );
$this->assertSame( 'A', $record->getContent()->getNativeData() );
$this->assertSame( 1, $record->getSize() );
$this->assertNotNull( $record->getSha1() );
$this->assertSame( CONTENT_MODEL_WIKITEXT, $record->getModel() );
$this->assertSame( 2, $record->getRevision() );
$this->assertSame( 2, $record->getRevision() );
$this->assertSame( 'tt:456', $record->getAddress() );
$this->assertSame( 33, $record->getContentId() );
$this->assertSame( CONTENT_FORMAT_WIKITEXT, $record->getFormat() );
$this->assertSame( 'myRole', $record->getRole() );
}
public function testNewUnsaved() {
$record = SlotRecord::newUnsaved( 'myRole', new WikitextContent( 'A' ) );
$this->assertFalse( $record->hasAddress() );
$this->assertFalse( $record->hasRevision() );
$this->assertFalse( $record->isInherited() );
$this->assertSame( 'A', $record->getContent()->getNativeData() );
$this->assertSame( 1, $record->getSize() );
$this->assertNotNull( $record->getSha1() );
$this->assertSame( CONTENT_MODEL_WIKITEXT, $record->getModel() );
$this->assertSame( 'myRole', $record->getRole() );
}
public function provideInvalidConstruction() {
yield 'both null' => [ null, null ];
yield 'null row' => [ null, new WikitextContent( 'A' ) ];
yield 'array row' => [ [], new WikitextContent( 'A' ) ];
yield 'empty row' => [ (object)[], new WikitextContent( 'A' ) ];
yield 'null content' => [ (object)[], null ];
}
/**
* @dataProvider provideInvalidConstruction
*/
public function testInvalidConstruction( $row, $content ) {
$this->setExpectedException( InvalidArgumentException::class );
new SlotRecord( $row, $content );
}
public function testGetContentId_fails() {
$record = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
$this->setExpectedException( IncompleteRevisionException::class );
$record->getContentId();
}
public function testGetAddress_fails() {
$record = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
$this->setExpectedException( IncompleteRevisionException::class );
$record->getAddress();
}
public function provideIncomplete() {
$unsaved = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
yield 'unsaved' => [ $unsaved ];
$parent = new SlotRecord( $this->makeRow(), new WikitextContent( 'A' ) );
$inherited = SlotRecord::newInherited( $parent );
yield 'inherited' => [ $inherited ];
}
/**
* @dataProvider provideIncomplete
*/
public function testGetRevision_fails( SlotRecord $record ) {
$record = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
$this->setExpectedException( IncompleteRevisionException::class );
$record->getRevision();
}
/**
* @dataProvider provideIncomplete
*/
public function testGetOrigin_fails( SlotRecord $record ) {
$record = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
$this->setExpectedException( IncompleteRevisionException::class );
$record->getOrigin();
}
public function provideHashStability() {
yield [ '', 'phoiac9h4m842xq45sp7s6u21eteeq1' ];
yield [ 'Lorem ipsum', 'hcr5u40uxr81d3nx89nvwzclfz6r9c5' ];
}
/**
* @dataProvider provideHashStability
*/
public function testHashStability( $text, $hash ) {
// Changing the output of the hash function will break things horribly!
$this->assertSame( $hash, SlotRecord::base36Sha1( $text ) );
$record = SlotRecord::newUnsaved( 'main', new WikitextContent( $text ) );
$this->assertSame( $hash, $record->getSha1() );
}
public function testNewWithSuppressedContent() {
$input = new SlotRecord( $this->makeRow(), new WikitextContent( 'A' ) );
$output = SlotRecord::newWithSuppressedContent( $input );
$this->setExpectedException( SuppressedDataException::class );
$output->getContent();
}
public function testNewInherited() {
$row = $this->makeRow( [ 'slot_revision_id' => 7, 'slot_origin' => 7 ] );
$parent = new SlotRecord( $row, new WikitextContent( 'A' ) );
// This would happen while doing an edit, before saving revision meta-data.
$inherited = SlotRecord::newInherited( $parent );
$this->assertSame( $parent->getContentId(), $inherited->getContentId() );
$this->assertSame( $parent->getAddress(), $inherited->getAddress() );
$this->assertSame( $parent->getContent(), $inherited->getContent() );
$this->assertTrue( $inherited->isInherited() );
$this->assertFalse( $inherited->hasRevision() );
// make sure we didn't mess with the internal state of $parent
$this->assertFalse( $parent->isInherited() );
$this->assertSame( 7, $parent->getRevision() );
// This would happen while doing an edit, after saving the revision meta-data
// and content meta-data.
$saved = SlotRecord::newSaved(
10,
$inherited->getContentId(),
$inherited->getAddress(),
$inherited
);
$this->assertSame( $parent->getContentId(), $saved->getContentId() );
$this->assertSame( $parent->getAddress(), $saved->getAddress() );
$this->assertSame( $parent->getContent(), $saved->getContent() );
$this->assertTrue( $saved->isInherited() );
$this->assertTrue( $saved->hasRevision() );
$this->assertSame( 10, $saved->getRevision() );
// make sure we didn't mess with the internal state of $parent or $inherited
$this->assertSame( 7, $parent->getRevision() );
$this->assertFalse( $inherited->hasRevision() );
}
public function testNewSaved() {
// This would happen while doing an edit, before saving revision meta-data.
$unsaved = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
// This would happen while doing an edit, after saving the revision meta-data
// and content meta-data.
$saved = SlotRecord::newSaved( 10, 20, 'theNewAddress', $unsaved );
$this->assertFalse( $saved->isInherited() );
$this->assertTrue( $saved->hasRevision() );
$this->assertTrue( $saved->hasAddress() );
$this->assertSame( 'theNewAddress', $saved->getAddress() );
$this->assertSame( 20, $saved->getContentId() );
$this->assertSame( 'A', $saved->getContent()->getNativeData() );
$this->assertSame( 10, $saved->getRevision() );
$this->assertSame( 10, $saved->getOrigin() );
// make sure we didn't mess with the internal state of $unsaved
$this->assertFalse( $unsaved->hasAddress() );
$this->assertFalse( $unsaved->hasRevision() );
}
public function provideNewSaved_LogicException() {
$freshRow = $this->makeRow( [
'content_id' => 10,
'content_address' => 'address:1',
'slot_origin' => 1,
'slot_revision_id' => 1,
] );
$freshSlot = new SlotRecord( $freshRow, new WikitextContent( 'A' ) );
yield 'mismatching address' => [ 1, 10, 'address:BAD', $freshSlot ];
yield 'mismatching revision' => [ 5, 10, 'address:1', $freshSlot ];
yield 'mismatching content ID' => [ 1, 17, 'address:1', $freshSlot ];
$inheritedRow = $this->makeRow( [
'content_id' => null,
'content_address' => null,
'slot_origin' => 0,
'slot_revision_id' => 1,
] );
$inheritedSlot = new SlotRecord( $inheritedRow, new WikitextContent( 'A' ) );
yield 'inherited, but no address' => [ 1, 10, 'address:2', $inheritedSlot ];
}
/**
* @dataProvider provideNewSaved_LogicException
*/
public function testNewSaved_LogicException(
$revisionId,
$contentId,
$contentAddress,
SlotRecord $protoSlot
) {
$this->setExpectedException( LogicException::class );
SlotRecord::newSaved( $revisionId, $contentId, $contentAddress, $protoSlot );
}
public function provideNewSaved_InvalidArgumentException() {
$unsaved = SlotRecord::newUnsaved( 'main', new WikitextContent( 'A' ) );
yield 'bad revision id' => [ 'xyzzy', 5, 'address', $unsaved ];
yield 'bad content id' => [ 7, 'xyzzy', 'address', $unsaved ];
yield 'bad content address' => [ 7, 5, 77, $unsaved ];
}
/**
* @dataProvider provideNewSaved_InvalidArgumentException
*/
public function testNewSaved_InvalidArgumentException(
$revisionId,
$contentId,
$contentAddress,
SlotRecord $protoSlot
) {
$this->setExpectedException( InvalidArgumentException::class );
SlotRecord::newSaved( $revisionId, $contentId, $contentAddress, $protoSlot );
}
}
|
