File: WikiFarmSettingsLoaderTest.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 (159 lines) | stat: -rw-r--r-- 4,059 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
<?php

namespace MediaWiki\Tests\Unit\Settings;

use MediaWiki\Config\HashConfig;
use MediaWiki\MainConfigNames;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\Settings\Config\ArrayConfigBuilder;
use MediaWiki\Settings\Config\PhpIniSink;
use MediaWiki\Settings\SettingsBuilder;
use MediaWiki\Settings\WikiFarmSettingsLoader;
use MediaWikiUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @covers \MediaWiki\Settings\WikiFarmSettingsLoader
 */
class WikiFarmSettingsLoaderTest extends MediaWikiUnitTestCase {

	/** @var array|null */
	private $originalServerVars = null;

	/**
	 * @before
	 */
	public function serverVarsSetUp() {
		$this->originalServerVars = $_SERVER;
	}

	/**
	 * @after
	 */
	public function serverVarsTearDown() {
		$_SERVER = $this->originalServerVars;
	}

	/**
	 * @param array $params
	 * @return SettingsBuilder
	 */
	private function newSettingsBuilder( $params = [] ): SettingsBuilder {
		return new SettingsBuilder(
			__DIR__,
			$params['extensionRegistry'] ?? $this->createMock( ExtensionRegistry::class ),
			$params['configBuilder'] ?? new ArrayConfigBuilder(),
			$params['phpIniSink'] ?? $this->createMock( PhpIniSink::class ),
			$params['cache'] ?? null
		);
	}

	/**
	 * @return SettingsBuilder|MockObject
	 */
	private function fakeSettingsBuilder(): SettingsBuilder {
		$config = [
			MainConfigNames::WikiFarmSettingsDirectory => 'test',
			MainConfigNames::WikiFarmSettingsExtension => 'yaml',
		];
		$mock = $this->createMock( SettingsBuilder::class );
		$mock->method( 'getConfig' )->willReturn( new HashConfig( $config ) );
		$mock->method( 'fileExists' )->willReturn( true );

		return $mock;
	}

	public static function provideWikiFarmSettings() {
		yield [
			[
				'WikiFarmSettingsDirectory' => __DIR__ . '/fixtures/sites',
				'WikiFarmSettingsExtension' => 'yaml',
			],
			'alpha',
			[ 'SiteName' => 'Alpha Wiki' ]
		];
		yield [
			[
				'WikiFarmSettingsDirectory' => __DIR__ . '/fixtures/sites',
				'WikiFarmSettingsExtension' => 'json',
			],
			'beta',
			[ 'SiteName' => 'Beta Wiki' ]
		];
	}

	/**
	 * @param array $config
	 * @param string $detect
	 * @param array $expected
	 *
	 * @dataProvider provideWikiFarmSettings
	 */
	public function testLoadWikiFarmSettings( $config, $detect, $expected ) {
		$settings = $this->newSettingsBuilder();

		$settings->putConfigValues( $config );

		$_SERVER['MW_WIKI_NAME'] = $detect;

		$loader = $this->newLoader( $settings );
		$loader->loadWikiFarmSettings();

		$config = $settings->getConfig();

		foreach ( $expected as $name => $value ) {
			$this->assertSame( $value, $config->get( $name ) );
		}
	}

	public function testDetectSettingsFileFromConstant() {
		$settings = $this->fakeSettingsBuilder();

		$settings->expects( $this->once() )
			->method( 'loadFile' )
			->with( 'test/AcmeWiki123.yaml' );

		$loader = $this->newLoader( $settings, 'AcmeWiki123' );
		$loader->loadWikiFarmSettings();
	}

	public function testDetectSettingsFileFromLegacyVar() {
		$settings = $this->fakeSettingsBuilder();

		$_SERVER['WIKI_NAME'] = 'test/FooBarWiki.yaml';

		$this->expectPHPError(
			E_USER_NOTICE,
			function () use ( $settings ) {
				// TODO: Assert that the file is actually loaded after the notice is triggered
				$loader = $this->newLoader( $settings );
				$loader->loadWikiFarmSettings();
			},
			'The WIKI_NAME server variable has been deprecated'
		);
	}

	/**
	 * @param SettingsBuilder $settings
	 * @param ?string $wikiNameConstantValue
	 *
	 * @return WikiFarmSettingsLoader
	 */
	private function newLoader( SettingsBuilder $settings, ?string $wikiNameConstantValue = null ) {
		$loader = new class( $settings, $wikiNameConstantValue ) extends WikiFarmSettingsLoader {
			private $wikiNameConstantValue;

			public function __construct( $settings, $wikiNameConstantValue ) {
				parent::__construct( $settings );
				$this->wikiNameConstantValue = $wikiNameConstantValue;
			}

			protected function getWikiNameConstant() {
				return $this->wikiNameConstantValue;
			}
		};

		return $loader;
	}

}