summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Translate/tests/phpunit/MessageIndexTest.php
blob: 5d9136f0b004053d30eaa9a214fb62ccddbe36c6 (plain)
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
<?php
/**
 * Tests for different MessageIndex backends.
 *
 * @file
 * @author Niklas Laxström
 * @license GPL-2.0+
 */

/**
 * @group Database
 * @group large
 */
class MessageIndexTest extends MediaWikiTestCase {
	protected function setUp() {
		parent::setUp();
		$this->setMwGlobals( array(
			'wgTranslateCacheDirectory' => $this->getNewTempDirectory(),
			'wgTranslateTranslationServices' => array(),
		) );
	}

	/**
	 * @dataProvider provideTestGetArrayDiff
	 */
	public function testGetArrayDiff( $expected, $old, $new ) {
		$actual = MessageIndex::getArrayDiff( $old, $new );
		$this->assertEquals( $expected['keys'], $actual['keys'], 'key diff' );
		$this->assertEquals( $expected['values'], $actual['values'], 'value diff' );
	}

	public function provideTestGetArrayDiff() {
		$tests = array();

		// Addition
		$old = array();
		$new = array(
			'label' => 'carpet',
		);
		$expected = array(
			'keys' => array(
				'add' => array(
					'label' => array(
						array(),
						array( 'carpet' ),
					),
				),
				'del' => array(),
				'mod' => array(),
			),
			'values' => array( 'carpet' ),
		);
		$tests[] = array( $expected, $old, $new );

		// Deletion
		$old = array(
			'bath' => array( 'goal', 'morals', 'coronation' ),
		);
		$new = array();
		$expected = array(
			'keys' => array(
				'add' => array(),
				'del' => array(
					'bath' => array(
						array( 'goal', 'morals', 'coronation' ),
						array(),
					),
				),
				'mod' => array(),
			),
			'values' => array( 'goal', 'morals', 'coronation' ),
		);
		$tests[] = array( $expected, $old, $new );

		// No change
		$old = $new = array(
			'label' => 'carpet',
			'salt' => array( 'morals' ),
			'bath' => array( 'goal', 'morals', 'coronation' ),
		);
		$expected = array(
			'keys' => array(
				'add' => array(),
				'del' => array(),
				'mod' => array(),
			),
			'values' => array(),
		);
		$tests[] = array( $expected, $old, $new );

		// Modification
		$old = array(
			'bath' => array( 'goal', 'morals', 'coronation' ),
		);
		$new = array(
			'bath' => array( 'goal', 'beliefs', 'coronation', 'showcase' ),
		);
		$expected = array(
			'keys' => array(
				'add' => array(),
				'del' => array(),
				'mod' => array(
					'bath' => array(
						array( 'goal', 'morals', 'coronation' ),
						array( 'goal', 'beliefs', 'coronation', 'showcase' ),
					),
				),
			),
			'values' => array( 'morals', 'beliefs', 'showcase' ),
		);
		$tests[] = array( $expected, $old, $new );

		return $tests;
	}

	protected static function getTestData() {
		static $data = null;
		if ( $data === null ) {
			$data = unserialize( file_get_contents( __DIR__ . '/messageindexdata.ser' ) );
		}

		return $data;
	}

	/**
	 * @dataProvider provideMessageIndexImplementation
	 */
	public function testMessageIndexImplementation( $mi ) {
		$data = self::getTestData();
		/** @var TestableDatabaseMessageIndex|TestableCDBMessageIndex|TestableSerializedMessageIndex */
		$diff = MessageIndex::getArrayDiff( array(), $data );
		$mi->store( $data, $diff['keys'] );

		$tests = array_rand( $data, 10 );
		foreach ( $tests as $key ) {
			$this->assertSame(
				$data[$key],
				$mi->get( $key ),
				"Values are preserved for random key $key"
			);
		}

		$cached = $mi->retrieve();

		$tests = array_rand( $data, 10 );
		foreach ( $tests as $key ) {
			$this->assertSame(
				$data[$key],
				$mi->get( $key ),
				"Values are preserved after retrieve for random key $key"
			);
		}

		$this->assertEquals(
			count( $data ),
			count( $cached ),
			'Cache has same number of elements'
		);
		$this->assertEquals( $data, $cached, 'Cache is preserved' );
	}

	public static function provideMessageIndexImplementation() {
		return array(
			array( new TestableDatabaseMessageIndex() ),
			array( new TestableCDBMessageIndex() ),
			array( new TestableSerializedMessageIndex() ),
			array( new TestableHashMessageIndex() ),
			// Not testing CachedMessageIndex because there is no easy way to mockup those.
		);
	}
}

class TestableDatabaseMessageIndex extends DatabaseMessageIndex {
	// @codingStandardsIgnoreStart PHP CodeSniffer warns "Useless method overriding
	// detected", but store() and get() are protected in parent.
	public function store( array $a, array $diff ) {
		parent::store( $a, $diff );
	}

	public function get( $a ) {
		return parent::get( $a );
	} // @codingStandardsIgnoreEnd
}

class TestableCDBMessageIndex extends CDBMessageIndex {
	// @codingStandardsIgnoreStart PHP CodeSniffer warns "Useless method overriding
	// detected", but store() and get() are protected in parent.
	public function store( array $a, array $diff ) {
		parent::store( $a, $diff );
	}

	public function get( $a ) {
		return parent::get( $a );
	} // @codingStandardsIgnoreEnd
}

class TestableSerializedMessageIndex extends SerializedMessageIndex {
	// @codingStandardsIgnoreStart PHP CodeSniffer warns "Useless method overriding
	// detected", but store() and get() are protected in parent.
	public function store( array $a, array $diff ) {
		parent::store( $a, $diff );
	}

	public function get( $a ) {
		return parent::get( $a );
	} // @codingStandardsIgnoreEnd
}

class TestableHashMessageIndex extends HashMessageIndex {
	// @codingStandardsIgnoreStart PHP CodeSniffer warns "Useless method overriding
	// detected", but store() and get() are protected in parent.
	public function store( array $a, array $diff ) {
		parent::store( $a, $diff );
	}

	public function get( $a ) {
		return parent::get( $a );
	} // @codingStandardsIgnoreEnd
}