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
|
<?php
namespace MediaWiki\Tests\Maintenance;
use DumpBackup;
use Exception;
use ManualLogEntry;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use WikiExporter;
/**
* Tests for log dumps of BackupDumper
*
* Some of these tests use the old constuctor for TextPassDumper
* and the dump() function, while others use the new loadWithArgv( $args )
* function and execute(). This is to ensure both the old and new methods
* work properly.
*
* @group Database
* @group Dump
* @covers \MediaWiki\Maintenance\BackupDumper
*/
class BackupDumperLoggerTest extends DumpTestCase {
// We'll add several log entries and users for this test. The following
// variables hold the corresponding ids.
// phpcs:ignore MediaWiki.Commenting.PropertyDocumentation.WrongStyle
private int $userId1;
private int $userId2;
private int $logId1;
private int $logId2;
private int $logId3;
/**
* adds a log entry to the database.
*
* @param string $type Type of the log entry
* @param string $subtype Subtype of the log entry
* @param User $user User that performs the logged operation
* @param int $ns Number of the namespace for the entry's target's title
* @param string $title Title of the entry's target
* @param string|null $comment Comment of the log entry
* @param array|null $parameters accompanying data that is attached to the entry
*
* @return int Id of the added log entry
*/
private function addLogEntry( $type, $subtype, User $user, $ns, $title,
$comment = null, $parameters = null
) {
$logEntry = new ManualLogEntry( $type, $subtype );
$logEntry->setPerformer( $user );
$logEntry->setTarget( Title::newFromText( $title, $ns ) );
if ( $comment !== null ) {
$logEntry->setComment( $comment );
}
if ( $parameters !== null ) {
$logEntry->setParameters( $parameters );
}
return $logEntry->insert();
}
public function addDBData() {
try {
$user1 = User::newFromName( 'BackupDumperLogUserA' );
$this->userId1 = $user1->getId();
if ( $this->userId1 === 0 ) {
$user1->addToDatabase();
$this->userId1 = $user1->getId();
}
$this->assertGreaterThan( 0, $this->userId1 );
$user2 = User::newFromName( 'BackupDumperLogUserB' );
$this->userId2 = $user2->getId();
if ( $this->userId2 === 0 ) {
$user2->addToDatabase();
$this->userId2 = $user2->getId();
}
$this->assertGreaterThan( 0, $this->userId2 );
$this->logId1 = $this->addLogEntry( 'type', 'subtype',
$user1, NS_MAIN, "PageA" );
$this->assertGreaterThan( 0, $this->logId1 );
$this->logId2 = $this->addLogEntry( 'supress', 'delete',
$user2, NS_TALK, "PageB", "SomeComment" );
$this->assertGreaterThan( 0, $this->logId2 );
$this->logId3 = $this->addLogEntry( 'move', 'delete',
$user2, NS_MAIN, "PageA", "SomeOtherComment",
[ 'key1' => 1, 3 => 'value3' ] );
$this->assertGreaterThan( 0, $this->logId3 );
} catch ( Exception $e ) {
// We'd love to pass $e directly. However, ... see
// documentation of exceptionFromAddDBData in
// DumpTestCase
$this->exceptionFromAddDBData = $e;
}
}
public function testPlain() {
// Preparing the dump
$fname = $this->getNewTempFile();
$dumper = new DumpBackup( [ '--output=file:' . $fname ] );
$dumper->startId = $this->logId1;
$dumper->endId = $this->logId3 + 1;
$dumper->reporting = false;
$dumper->setDB( $this->getDb() );
// Performing the dump
$dumper->dump( WikiExporter::LOGS, WikiExporter::TEXT );
// Analyzing the dumped data
$this->assertDumpSchema( $fname, $this->getXmlSchemaPath() );
$asserter = $this->getDumpAsserter();
$asserter->assertDumpStart( $fname );
$asserter->assertLogItem( $this->logId1, "BackupDumperLogUserA",
$this->userId1, null, "type", "subtype", "PageA" );
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$this->assertNotNull( $contLang, "Content language object validation" );
$namespace = $contLang->getNsText( NS_TALK );
$this->assertIsString( $namespace );
$this->assertGreaterThan( 0, strlen( $namespace ) );
$asserter->assertLogItem( $this->logId2, "BackupDumperLogUserB",
$this->userId2, "SomeComment", "supress", "delete",
$namespace . ":PageB" );
$asserter->assertLogItem( $this->logId3, "BackupDumperLogUserB",
$this->userId2, "SomeOtherComment", "move", "delete",
"PageA", [ 'key1' => 1, 3 => 'value3' ] );
$asserter->assertDumpEnd();
}
public function testXmlDumpsBackupUseCaseLogging() {
$this->checkHasGzip();
// Preparing the dump
$fname = $this->getNewTempFile();
$dumper = new DumpBackup();
$dumper->loadWithArgv( [ '--logs', '--output=gzip:' . $fname,
'--reporting=2' ] );
$dumper->startId = $this->logId1;
$dumper->endId = $this->logId3 + 1;
$dumper->setDB( $this->getDb() );
// xmldumps-backup demands reporting, although this is currently not
// implemented in BackupDumper, when dumping logging data. We
// nevertheless capture the output of the dump process already now,
// to be able to alert (once dumping produces reports) that this test
// needs updates.
$dumper->stderr = fopen( 'php://output', 'a' );
if ( $dumper->stderr === false ) {
$this->fail( "Could not open stream for stderr" );
}
// Performing the dump
$dumper->execute();
$this->assertTrue( fclose( $dumper->stderr ), "Closing stderr handle" );
// Analyzing the dumped data
$this->gunzip( $fname );
$this->assertDumpSchema( $fname, $this->getXmlSchemaPath() );
$asserter = $this->getDumpAsserter();
$asserter->assertDumpStart( $fname );
$asserter->assertLogItem( $this->logId1, "BackupDumperLogUserA",
$this->userId1, null, "type", "subtype", "PageA" );
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$this->assertNotNull( $contLang, "Content language object validation" );
$namespace = $contLang->getNsText( NS_TALK );
$this->assertIsString( $namespace );
$this->assertGreaterThan( 0, strlen( $namespace ) );
$asserter->assertLogItem( $this->logId2, "BackupDumperLogUserB",
$this->userId2, "SomeComment", "supress", "delete",
$namespace . ":PageB" );
$asserter->assertLogItem( $this->logId3, "BackupDumperLogUserB",
$this->userId2, "SomeOtherComment", "move", "delete",
"PageA", [ 'key1' => 1, 3 => 'value3' ] );
$asserter->assertDumpEnd();
// Currently, no reporting is implemented. Alert via failure, once
// this changes.
// If reporting for log dumps has been implemented, please update
// the following statement to catch good output
$this->expectOutputString( '' );
}
}
|
