X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/tests/phpunit/includes/config/EtcdConfigTest.php

diff --git a/tests/phpunit/includes/config/EtcdConfigTest.php b/tests/phpunit/includes/config/EtcdConfigTest.php
new file mode 100644
index 00000000..ebe19725
--- /dev/null
+++ b/tests/phpunit/includes/config/EtcdConfigTest.php
@@ -0,0 +1,581 @@
+<?php
+
+use Wikimedia\TestingAccessWrapper;
+
+class EtcConfigTest extends PHPUnit_Framework_TestCase {
+
+	private function createConfigMock( array $options = [] ) {
+		return $this->getMockBuilder( EtcdConfig::class )
+			->setConstructorArgs( [ $options + [
+				'host' => 'etcd-tcp.example.net',
+				'directory' => '/',
+				'timeout' => 0.1,
+			] ] )
+			->setMethods( [ 'fetchAllFromEtcd' ] )
+			->getMock();
+	}
+
+	private function createSimpleConfigMock( array $config ) {
+		$mock = $this->createConfigMock();
+		$mock->expects( $this->once() )->method( 'fetchAllFromEtcd' )
+			->willReturn( [
+				$config,
+				null, // error
+				false // retry?
+			] );
+		return $mock;
+	}
+
+	/**
+	 * @covers EtcdConfig::has
+	 */
+	public function testHasKnown() {
+		$config = $this->createSimpleConfigMock( [
+			'known' => 'value'
+		] );
+		$this->assertSame( true, $config->has( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::__construct
+	 * @covers EtcdConfig::get
+	 */
+	public function testGetKnown() {
+		$config = $this->createSimpleConfigMock( [
+			'known' => 'value'
+		] );
+		$this->assertSame( 'value', $config->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::has
+	 */
+	public function testHasUnknown() {
+		$config = $this->createSimpleConfigMock( [
+			'known' => 'value'
+		] );
+		$this->assertSame( false, $config->has( 'unknown' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::get
+	 */
+	public function testGetUnknown() {
+		$config = $this->createSimpleConfigMock( [
+			'known' => 'value'
+		] );
+		$this->setExpectedException( ConfigException::class );
+		$config->get( 'unknown' );
+	}
+
+	/**
+	 * @covers EtcdConfig::__construct
+	 */
+	public function testConstructCacheObj() {
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get' ] )
+			->getMock();
+		$cache->expects( $this->once() )->method( 'get' )
+			->willReturn( [
+				'config' => [ 'known' => 'from-cache' ],
+				'expires' => INF,
+			] );
+		$config = $this->createConfigMock( [ 'cache' => $cache ] );
+
+		$this->assertSame( 'from-cache', $config->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::__construct
+	 */
+	public function testConstructCacheSpec() {
+		$config = $this->createConfigMock( [ 'cache' => [
+			'class' => HashBagOStuff::class
+		] ] );
+		$config->expects( $this->once() )->method( 'fetchAllFromEtcd' )
+			->willReturn( [
+				[ 'known' => 'from-fetch' ],
+				null, // error
+				false // retry?
+			] );
+
+		$this->assertSame( 'from-fetch', $config->get( 'known' ) );
+	}
+
+	/**
+	 * Test matrix
+	 *
+	 * - [x] Cache miss
+	 *       Result: Fetched value
+	 *       > cache miss | gets lock | backend succeeds
+	 *
+	 * - [x] Cache miss with backend error
+	 *       Result: ConfigException
+	 *       > cache miss | gets lock | backend error (no retry)
+	 *
+	 * - [x] Cache hit after retry
+	 *       Result: Cached value (populated by process holding lock)
+	 *       > cache miss | no lock | cache retry
+	 *
+	 * - [x] Cache hit
+	 *       Result: Cached value
+	 *       > cache hit
+	 *
+	 * - [x] Process cache hit
+	 *       Result: Cached value
+	 *       > process cache hit
+	 *
+	 * - [x] Cache expired
+	 *       Result: Fetched value
+	 *       > cache expired | gets lock | backend succeeds
+	 *
+	 * - [x] Cache expired with backend failure
+	 *       Result: Cached value (stale)
+	 *       > cache expired | gets lock | backend fails (allows retry)
+	 *
+	 * - [x] Cache expired and no lock
+	 *       Result: Cached value (stale)
+	 *       > cache expired | no lock
+	 *
+	 * Other notable scenarios:
+	 *
+	 * - [ ] Cache miss with backend retry
+	 *       Result: Fetched value
+	 *       > cache expired | gets lock | backend failure (allows retry)
+	 */
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheMiss() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		// .. misses cache
+		$cache->expects( $this->once() )->method( 'get' )
+			->willReturn( false );
+		// .. gets lock
+		$cache->expects( $this->once() )->method( 'lock' )
+			->willReturn( true );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->once() )->method( 'fetchAllFromEtcd' )
+			->willReturn( [ [ 'known' => 'from-fetch' ], null, false ] );
+
+		$this->assertSame( 'from-fetch', $mock->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheMissBackendError() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		// .. misses cache
+		$cache->expects( $this->once() )->method( 'get' )
+			->willReturn( false );
+		// .. gets lock
+		$cache->expects( $this->once() )->method( 'lock' )
+			->willReturn( true );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->once() )->method( 'fetchAllFromEtcd' )
+			->willReturn( [ null, 'Fake error', false ] );
+
+		$this->setExpectedException( ConfigException::class );
+		$mock->get( 'key' );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheMissWithoutLock() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		$cache->expects( $this->exactly( 2 ) )->method( 'get' )
+			->will( $this->onConsecutiveCalls(
+				// .. misses cache first time
+				false,
+				// .. hits cache on retry
+				[
+					'config' => [ 'known' => 'from-cache' ],
+					'expires' => INF,
+				]
+			) );
+		// .. misses lock
+		$cache->expects( $this->once() )->method( 'lock' )
+			->willReturn( false );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->never() )->method( 'fetchAllFromEtcd' );
+
+		$this->assertSame( 'from-cache', $mock->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheHit() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		$cache->expects( $this->once() )->method( 'get' )
+			// .. hits cache
+			->willReturn( [
+				'config' => [ 'known' => 'from-cache' ],
+				'expires' => INF,
+			] );
+		$cache->expects( $this->never() )->method( 'lock' );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->never() )->method( 'fetchAllFromEtcd' );
+
+		$this->assertSame( 'from-cache', $mock->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadProcessCacheHit() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		$cache->expects( $this->once() )->method( 'get' )
+			// .. hits cache
+			->willReturn( [
+				'config' => [ 'known' => 'from-cache' ],
+				'expires' => INF,
+			] );
+		$cache->expects( $this->never() )->method( 'lock' );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->never() )->method( 'fetchAllFromEtcd' );
+
+		$this->assertSame( 'from-cache', $mock->get( 'known' ), 'Cache hit' );
+		$this->assertSame( 'from-cache', $mock->get( 'known' ), 'Process cache hit' );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheExpiredLockFetchSucceeded() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		$cache->expects( $this->once() )->method( 'get' )->willReturn(
+			// .. stale cache
+			[
+				'config' => [ 'known' => 'from-cache-expired' ],
+				'expires' => -INF,
+			]
+		);
+		// .. gets lock
+		$cache->expects( $this->once() )->method( 'lock' )
+			->willReturn( true );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->once() )->method( 'fetchAllFromEtcd' )
+			->willReturn( [ [ 'known' => 'from-fetch' ], null, false ] );
+
+		$this->assertSame( 'from-fetch', $mock->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheExpiredLockFetchFails() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		$cache->expects( $this->once() )->method( 'get' )->willReturn(
+			// .. stale cache
+			[
+				'config' => [ 'known' => 'from-cache-expired' ],
+				'expires' => -INF,
+			]
+		);
+		// .. gets lock
+		$cache->expects( $this->once() )->method( 'lock' )
+			->willReturn( true );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->once() )->method( 'fetchAllFromEtcd' )
+			->willReturn( [ null, 'Fake failure', true ] );
+
+		$this->assertSame( 'from-cache-expired', $mock->get( 'known' ) );
+	}
+
+	/**
+	 * @covers EtcdConfig::load
+	 */
+	public function testLoadCacheExpiredNoLock() {
+		// Create cache mock
+		$cache = $this->getMockBuilder( HashBagOStuff::class )
+			->setMethods( [ 'get', 'lock' ] )
+			->getMock();
+		$cache->expects( $this->once() )->method( 'get' )
+			// .. hits cache (expired value)
+			->willReturn( [
+				'config' => [ 'known' => 'from-cache-expired' ],
+				'expires' => -INF,
+			] );
+		// .. misses lock
+		$cache->expects( $this->once() )->method( 'lock' )
+			->willReturn( false );
+
+		// Create config mock
+		$mock = $this->createConfigMock( [
+			'cache' => $cache,
+		] );
+		$mock->expects( $this->never() )->method( 'fetchAllFromEtcd' );
+
+		$this->assertSame( 'from-cache-expired', $mock->get( 'known' ) );
+	}
+
+	public static function provideFetchFromServer() {
+		return [
+			'200 OK - Success' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => json_encode( [ 'node' => [ 'nodes' => [
+						[
+							'key' => '/example/foo',
+							'value' => json_encode( [ 'val' => true ] )
+						],
+					] ] ] ),
+					'error' => '',
+				],
+				'expect' => [
+					[ 'foo' => true ], // data
+					null,
+					false // retry
+				],
+			],
+			'200 OK - Empty dir' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => json_encode( [ 'node' => [ 'nodes' => [
+						[
+							'key' => '/example/foo',
+							'value' => json_encode( [ 'val' => true ] )
+						],
+						[
+							'key' => '/example/sub',
+							'dir' => true,
+							'nodes' => [],
+						],
+						[
+							'key' => '/example/bar',
+							'value' => json_encode( [ 'val' => false ] )
+						],
+					] ] ] ),
+					'error' => '',
+				],
+				'expect' => [
+					[ 'foo' => true, 'bar' => false ], // data
+					null,
+					false // retry
+				],
+			],
+			'200 OK - Recursive' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => json_encode( [ 'node' => [ 'nodes' => [
+						[
+							'key' => '/example/a',
+							'dir' => true,
+							'nodes' => [
+								[
+									'key' => 'b',
+									'value' => json_encode( [ 'val' => true ] ),
+								],
+								[
+									'key' => 'c',
+									'value' => json_encode( [ 'val' => false ] ),
+								],
+							],
+						],
+					] ] ] ),
+					'error' => '',
+				],
+				'expect' => [
+					[ 'a/b' => true, 'a/c' => false ], // data
+					null,
+					false // retry
+				],
+			],
+			'200 OK - Missing nodes at second level' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => json_encode( [ 'node' => [ 'nodes' => [
+						[
+							'key' => '/example/a',
+							'dir' => true,
+						],
+					] ] ] ),
+					'error' => '',
+				],
+				'expect' => [
+					null,
+					"Unexpected JSON response in dir 'a'; missing 'nodes' list.",
+					false // retry
+				],
+			],
+			'200 OK - Correctly encoded garbage response' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => json_encode( [ 'foo' => 'bar' ] ),
+					'error' => '',
+				],
+				'expect' => [
+					null,
+					"Unexpected JSON response: Missing or invalid node at top level.",
+					false // retry
+				],
+			],
+			'200 OK - Bad value' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => json_encode( [ 'node' => [ 'nodes' => [
+						[
+							'key' => '/example/foo',
+							'value' => ';"broken{value'
+						]
+					] ] ] ),
+					'error' => '',
+				],
+				'expect' => [
+					null, // data
+					"Failed to parse value for 'foo'.",
+					false // retry
+				],
+			],
+			'200 OK - Empty node list' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [],
+					'body' => '{"node":{"nodes":[]}}',
+					'error' => '',
+				],
+				'expect' => [
+					[], // data
+					null,
+					false // retry
+				],
+			],
+			'200 OK - Invalid JSON' => [
+				'http' => [
+					'code' => 200,
+					'reason' => 'OK',
+					'headers' => [ 'content-length' => 0 ],
+					'body' => '',
+					'error' => '(curl error: no status set)',
+				],
+				'expect' => [
+					null, // data
+					"Error unserializing JSON response.",
+					false // retry
+				],
+			],
+			'404 Not Found' => [
+				'http' => [
+					'code' => 404,
+					'reason' => 'Not Found',
+					'headers' => [ 'content-length' => 0 ],
+					'body' => '',
+					'error' => '',
+				],
+				'expect' => [
+					null, // data
+					'HTTP 404 (Not Found)',
+					false // retry
+				],
+			],
+			'400 Bad Request - custom error' => [
+				'http' => [
+					'code' => 400,
+					'reason' => 'Bad Request',
+					'headers' => [ 'content-length' => 0 ],
+					'body' => '',
+					'error' => 'No good reason',
+				],
+				'expect' => [
+					null, // data
+					'No good reason',
+					true // retry
+				],
+			],
+		];
+	}
+
+	/**
+	 * @covers EtcdConfig::fetchAllFromEtcdServer
+	 * @covers EtcdConfig::unserialize
+	 * @covers EtcdConfig::parseResponse
+	 * @covers EtcdConfig::parseDirectory
+	 * @covers EtcdConfigParseError
+	 * @dataProvider provideFetchFromServer
+	 */
+	public function testFetchFromServer( array $httpResponse, array $expected ) {
+		$http = $this->getMockBuilder( MultiHttpClient::class )
+			->disableOriginalConstructor()
+			->getMock();
+		$http->expects( $this->once() )->method( 'run' )
+			->willReturn( array_values( $httpResponse ) );
+
+		$conf = $this->getMockBuilder( EtcdConfig::class )
+			->disableOriginalConstructor()
+			->getMock();
+		// Access for protected member and method
+		$conf = TestingAccessWrapper::newFromObject( $conf );
+		$conf->http = $http;
+
+		$this->assertSame(
+			$expected,
+			$conf->fetchAllFromEtcdServer( 'etcd-tcp.example.net' )
+		);
+	}
+}