aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/includes/parser/BeforeParserFetchTemplateRevisionRecordTest.php
blob: 9185b61002dd15bfa6a7f82f8a52fc027f0acbf1 (plain) (blame)
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
<?php

namespace MediaWiki\Tests\Parser;

use MediaWiki\Content\WikitextContent;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Parser\Parser;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Revision\MutableRevisionRecord;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWikiLangTestCase;
use MockTitleTrait;

/**
 * @group Database
 * @covers \MediaWiki\Parser\Parser
 */
class BeforeParserFetchTemplateRevisionRecordTest extends MediaWikiLangTestCase {
	use MockTitleTrait;

	private function checkResult( $expected, $actual ) {
		if ( ( $expected['revision-record'] ?? true ) === false ) {
			$this->assertSame( false, $actual['revision-record'] );
		} else {
			$this->assertNotNull( $actual['revision-record'] );
		}
		$this->assertSame( $expected['text'], $actual['text'] );
		$this->assertSame( $expected['finalTitle'], $actual['finalTitle']->getPrefixedText() );
		// Simplify 'deps'
		$simpleActualDeps = array_map(
			fn ( $dep ) => $dep['title']->getPrefixedText(),
			$actual['deps']
		);
		$this->assertArrayEquals( $expected['deps'], $simpleActualDeps );
	}

	public static function provideWithParser() {
		yield "Without \$parser" => [ false ];
		yield "With \$parser" => [ true ];
	}

	private function commonSetup( $suffix = null ) {
		$suffix ??= $this->getCallerName();
		$parser = $this->getServiceContainer()->getParserFactory()->create();
		$parser->setOptions( ParserOptions::newFromAnon() );

		$page = $this->getNonexistingTestPage( "Base $suffix" );
		$this->editPage( $page, 'Base page content', 'Make testing content' );

		$redirectPage = $this->getNonexistingTestPage( "Redirect $suffix" );
		$this->editPage(
			$redirectPage,
			'#REDIRECT [[' . $page->getTitle()->getPrefixedText() . ']]',
			"Make redirect link for testing"
		);

		return [ $parser, $page, $redirectPage ];
	}

	/**
	 * @covers \MediaWiki\Parser\Parser::statelessFetchTemplate
	 * @dataProvider provideWithParser
	 */
	public function testStatelessFetchTemplateBasic( bool $withParser ) {
		[ $parser, $page, $redirectPage ] = $this->commonSetup( __FUNCTION__ );

		// Basic redirect test
		$ret = Parser::statelessFetchTemplate(
			$redirectPage->getTitle(), $withParser ? $parser : null
		);
		$this->checkResult( [
			'text' => 'Base page content',
			'finalTitle' => 'Base ' . __FUNCTION__,
			'deps' => [
				'Base ' . __FUNCTION__,
				'Redirect ' . __FUNCTION__,
			],
		], $ret );
	}

	/**
	 * @covers \MediaWiki\Parser\Parser::statelessFetchTemplate
	 * @dataProvider provideWithParser
	 */
	public function testStatelessFetchTemplateSkip( bool $withParser ) {
		[ $parser, $page, $redirectPage ] = $this->commonSetup( __FUNCTION__ );

		// Create a hook to prevent resolution of the redirect
		$this->setTemporaryHook(
			'BeforeParserFetchTemplateRevisionRecord',
			static function ( ?LinkTarget $contextTitle, LinkTarget $title, bool &$skip, ?RevisionRecord &$revRecord ) {
				$skip = true;
			}
		);

		$ret = Parser::statelessFetchTemplate(
			$redirectPage->getTitle(), $withParser ? $parser : null
		);
		$this->checkResult( [
			'text' => false,
			'finalTitle' => 'Redirect ' . __FUNCTION__,
			'deps' => [
				'Redirect ' . __FUNCTION__,
			],
		], $ret );
	}

	/**
	 * @covers \MediaWiki\Parser\Parser::statelessFetchTemplate
	 * @dataProvider provideWithParser
	 */
	public function testStatelessFetchTemplateMissing( bool $withParser ) {
		[ $parser, $page, $redirectPage ] = $this->commonSetup( __FUNCTION__ );

		// Create a hook to redirect to a non-existing page
		$baseTitle = 'Base ' . __FUNCTION__;
		$missing = $this->getNonexistingTestPage( 'Missing ' . __FUNCTION__ );
		$this->setTemporaryHook(
			'BeforeParserFetchTemplateRevisionRecord',
			static function ( ?LinkTarget $contextTitle, LinkTarget $title, bool &$skip, ?RevisionRecord &$revRecord ) use ( $baseTitle, $missing ) {
				if ( $title->getPrefixedText() === $baseTitle ) {
					$revRecord = new MutableRevisionRecord( $missing->getTitle() );
				}
			}
		);
		$ret = Parser::statelessFetchTemplate(
			$redirectPage->getTitle(), $withParser ? $parser : null
		);
		$this->checkResult( [
			'text' => false,
			'finalTitle' => 'Missing ' . __FUNCTION__,
			'deps' => [
				'Base ' . __FUNCTION__,
				# The $missing page is duplicated in the deps here, but that's
				# harmless.
				'Missing ' . __FUNCTION__,
				'Missing ' . __FUNCTION__,
				'Redirect ' . __FUNCTION__,
			],
		], $ret );
	}

	/**
	 * @covers \MediaWiki\Parser\Parser::statelessFetchTemplate
	 * @dataProvider provideWithParser
	 */
	public function testStatelessFetchTemplateSubstituted( bool $withParser ) {
		[ $parser, $page, $redirectPage ] = $this->commonSetup( __FUNCTION__ );

		// Create a hook to redirect to a non-existing page
		$baseTitle = 'Base ' . __FUNCTION__;
		$subst = $this->getNonexistingTestPage( 'Subst ' . __FUNCTION__ );
		$this->setTemporaryHook(
			'BeforeParserFetchTemplateRevisionRecord',
			static function ( ?LinkTarget $contextTitle, LinkTarget $title, bool &$skip, ?RevisionRecord &$revRecord ) use ( $baseTitle, $subst ) {
				if ( $title->getPrefixedText() === $baseTitle ) {
					$revRecord = new MutableRevisionRecord( $subst->getTitle() );
					$revRecord->setContent( SlotRecord::MAIN, new WikitextContent( 'foo' ) );
				}
			}
		);
		$ret = Parser::statelessFetchTemplate(
			$redirectPage->getTitle(), $withParser ? $parser : null
		);
		$this->checkResult( [
			'text' => 'foo',
			'finalTitle' => 'Subst ' . __FUNCTION__,
			'deps' => [
				'Base ' . __FUNCTION__,
				'Subst ' . __FUNCTION__,
				'Redirect ' . __FUNCTION__,
			],
		], $ret );
	}
}