File: EditTest.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (200 lines) | stat: -rw-r--r-- 6,582 bytes parent folder | download
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
<?php

namespace MediaWiki\Tests\Maintenance;

use EditCLI;
use MediaWiki\Context\RequestContext;
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use PHPUnit\Framework\ExpectationFailedException;
use WikiPage;

/**
 * Mock for the input/output of EditCLI
 *
 * EditCLI internally tries to access stdin and stdout. We mock those aspects
 * for testing.
 */
class SemiMockedEditCLI extends EditCLI {

	/**
	 * @var string|null Text to pass as stdin
	 */
	private ?string $mockStdinText = null;

	/**
	 * Data for the fake stdin
	 *
	 * @param string $stdin The string to be used instead of stdin
	 */
	public function mockStdin( $stdin ) {
		$this->mockStdinText = $stdin;
	}

	public function getStdin( $len = null ) {
		if ( $len !== Maintenance::STDIN_ALL ) {
			throw new ExpectationFailedException( "Tried to get stdin without using Maintenance::STDIN_ALL" );
		}

		return file_get_contents( 'data://text/plain,' . $this->mockStdinText );
	}
}

/**
 * @covers \EditCLI
 * @group Database
 * @author Dreamy Jazz
 */
class EditTest extends MaintenanceBaseTestCase {

	protected function getMaintenanceClass() {
		return SemiMockedEditCLI::class;
	}

	private function commonTextExecute(
		array $options, string $title, WikiPage $wikiPage, string $stdin, string $expectedWikitextContent
	) {
		$this->maintenance->mockStdin( $stdin );
		$this->maintenance->setArg( 'title', $title );
		foreach ( $options as $name => $value ) {
			$this->maintenance->setOption( $name, $value );
		}
		$this->maintenance->execute();
		$wikiPage->clear();
		$actualWikitextContent = $wikiPage->getContent()->getWikitextForTransclusion();
		$this->assertSame( $expectedWikitextContent, $actualWikitextContent );
	}

	/** @dataProvider provideExecute */
	public function testExecute(
		$options, $content, $expectedUserName, $expectedComment, $shouldBeAMinorEdit, $shouldBeSentToRecentChanges
	) {
		$testPage = $this->getExistingTestPage();
		$this->commonTextExecute( $options, $testPage->getTitle()->getPrefixedText(), $testPage, $content, $content );
		$lastRevision = $testPage->getRevisionRecord();
		$this->assertSame( $expectedUserName, $lastRevision->getUser()->getName() );
		$this->assertSame( $expectedComment, $lastRevision->getComment()->text );
		$this->assertSame( $shouldBeAMinorEdit, $lastRevision->isMinor() );
		$this->newSelectQueryBuilder()
			->select( 'COUNT(*)' )
			->from( 'recentchanges' )
			->where( [ 'rc_this_oldid' => $lastRevision->getId() ] )
			->assertFieldValue( (int)$shouldBeSentToRecentChanges );
		$this->expectOutputRegex( '/Saving.*done/' );
	}

	public static function provideExecute() {
		return [
			'No options provided' => [ [], "testcontent\ntest", User::MAINTENANCE_SCRIPT_USER, '', false, true ],
			'Summary provided, minor edit, not sent to recentchanges' => [
				[ 'summary' => 'test', 'minor' => 1, 'no-rc' => 1 ], "testcontent", User::MAINTENANCE_SCRIPT_USER,
				'test', true, false,
			],
			'Autosummary enabled' => [
				// TODO: Don't hard code the output of the autosummary?
				[ 'autosummary' => 1 ], "#REDIRECT [[Test]]", User::MAINTENANCE_SCRIPT_USER,
				'Redirected page to [[Test]]', false, true,
			],
		];
	}

	public function testExecuteWithBotFlagAndAutosummaryForRedirect() {
		$testPage = $this->getExistingTestPage();
		$oldContent = $testPage->getContent();
		$this->commonTextExecute(
			[ 'bot' => 1, 'autosummary' => 1 ],
			$testPage->getTitle()->getPrefixedText(),
			$testPage,
			"#REDIRECT [[Test]]",
			"#REDIRECT [[Test]]"
		);
		$lastRevision = $testPage->getRevisionRecord();
		$newContent = $lastRevision->getContent( SlotRecord::MAIN );
		$this->assertSame(
			$testPage->getContentHandler()->getAutosummary( $oldContent, $newContent ),
			$lastRevision->getComment()->text
		);
		$this->newSelectQueryBuilder()
			->select( 'rc_bot' )
			->from( 'recentchanges' )
			->where( [ 'rc_this_oldid' => $lastRevision->getId() ] )
			->assertFieldValue( 1 );
		$this->expectOutputRegex( '/Saving.*done/' );
	}

	public function testExecuteForParseTitle() {
		$wikiPage = $this->getServiceContainer()->getWikiPageFactory()
			->newFromTitle( Title::newFromText( RequestContext::getMain()->msg( 'mainpage' )->text() ) );
		$this->commonTextExecute(
			[ 'parse-title' => 1 ], '{{int:mainpage}}', $wikiPage,
			"* testing1234abc", "* testing1234abc"
		);
		$this->expectOutputRegex( '/Saving.*done/' );
	}

	public function testExecuteWithUserProvided() {
		$testUser = $this->getTestUser()->getUser();
		$testPage = $this->getExistingTestPage();
		$this->commonTextExecute(
			[ 'user' => $testUser->getName() ],
			$testPage->getTitle()->getPrefixedText(),
			$testPage,
			"test",
			"test"
		);
		$lastRevision = $testPage->getRevisionRecord();
		$this->assertSame( $testUser->getName(), $lastRevision->getUser()->getName() );
		$this->expectOutputRegex( '/Saving.*done/' );
	}

	public function testExecuteForFailedEdit() {
		$testUser = $this->getTestUser()->getUser();
		$testPage = $this->getExistingTestPage();
		// Prevent all edits using a hook.
		$this->setTemporaryHook( 'MultiContentSave', static function () {
			return false;
		} );
		$this->commonTextExecute(
			[ 'user' => $testUser->getName() ],
			$testPage->getTitle()->getPrefixedText(),
			$testPage,
			"test",
			$testPage->getContent()->getWikitextForTransclusion()
		);
		$this->expectOutputRegex( '/Saving.*failed/' );
	}

	/** @dataProvider provideExecuteForFatalError */
	public function testExecuteForFatalError( $options, $expectedOutputRegex, $title = null ) {
		$this->expectCallToFatalError();
		$this->maintenance->setArg( 'title', $title ?? 'test' );
		foreach ( $options as $name => $value ) {
			$this->maintenance->setOption( $name, $value );
		}
		$this->maintenance->execute();
		$this->expectOutputRegex( $expectedOutputRegex );
	}

	public static function provideExecuteForFatalError() {
		return [
			'Invalid username' => [ [ 'user' => 'Template:Testing#test' ], '/Invalid username/' ],
			'Invalid title' => [ [], '/Invalid title/', ':::' ],
			'Title does not exist and nocreate is set' => [
				[ 'nocreate' => 1 ], '/Page does not exist/', 'Non-existing-test-page-1234',
			],
			'Attempts to remove the main slot' => [
				[ 'remove' => 1, 'slot' => SlotRecord::MAIN ], '/Cannot remove main slot/',
			],
		];
	}

	public function testExecuteForCreateOnlyWhenPageExists() {
		$this->testExecuteForFatalError(
			[ 'createonly' => 1 ],
			'/Page already exists/',
			$this->getExistingTestPage()->getTitle()->getPrefixedText()
		);
	}
}