rss-bridge/tests/BridgeImplementationTest.php

<?php

require_once('lib/Bridge.php');

/*
	This class will check all bridges for proper implementation
*/
class BridgeImplementationTest extends PHPUnit_Framework_TestCase {

	// Returns an array of all bridge files (file names without file type)
	private function ListBridges(){
		$listBridge = array();
		$dirFiles = scandir('bridges/');

		if( $dirFiles !== false ){

			foreach( $dirFiles as $fileName ) {
				if( preg_match('@([^.]+)\.php$@U', $fileName, $out) ){
						$listBridge[] = $out[1];
				}
			}
		}
		return $listBridge;
	}

	// Checks if the bridge implements additional public functions (should not be!)
	private function CheckBridgePublicFunctions($bridgeName){
		$parent_methods = array();

		if(in_array('BridgeInterface', class_parents($bridgeName)))
			$parent_methods = array_merge($parent_methods, get_class_methods('BridgeInterface'));

		if(in_array('BridgeAbstract', class_parents($bridgeName)))
			$parent_methods = array_merge($parent_methods, get_class_methods('BridgeAbstract'));

		if(in_array('HttpCachingBridgeAbstract', class_parents($bridgeName)))
			$parent_methods = array_merge($parent_methods, get_class_methods('HttpCachingBridgeAbstract'));

		if(in_array('RssExpander', class_parents($bridgeName)))
			$parent_methods = array_merge($parent_methods, get_class_methods('RssExpander'));

		// Receive all non abstract methods
		$methods = array_diff(get_class_methods($bridgeName), $parent_methods);

		$method_names = '';
		foreach($methods as $method){
			if($method_names === '')
				$method_names .= $method;
			else
				$method_names .= ', ' . $method;
		}

		$parent_names = '';
		foreach(class_parents($bridgeName) as $parent){
			if($parent_names === '')
				$parent_names .= $parent;
			else
				$parent_names .= ', ' . $parent;
		}

	}

	// Checks if the bridge returns the default value for 'getCacheDuration()'
	private function CheckBridgeGetCacheDurationDefaultValue($bridgeName){
		// We only care for bridges that don't implement BridgeInterface directly
		// (using one of the abstract classes)
		// This is why we got the 'BridgeAbstractTest' class below!!!
		if(in_array('BridgeAbstract', class_parents($bridgeName))){

			// Let's check if the bridge actually implements 'getCacheDuration'
			$bridgeReflector = new ReflectionClass($bridgeName);
			$bridgeMethods = $bridgeReflector->GetMethods();
			$bridgeHasMethod = false;

			foreach($bridgeMethods as $method){
				if($method->name === 'getCacheDuration' && $method->class === $bridgeReflector->name){
					$bridgeHasMethod = true;
					//break;
				}
			}

			if(!$bridgeHasMethod)
				return;

			$bridge = new $bridgeName();

			$abstract = new BridgeAbstractTest();

			$this->assertNotEquals($bridge->getCacheDuration(), $abstract->getCacheDuration(), $bridgeName . ' seems to implement \'getCacheDuration\' with default values, so you might safely remove it');
			$this->assertNotEquals($bridge->getCacheDuration(), 0, $bridgeName . ' seems to implement \'getCacheDuration\' with value 0, which should not be allowed.');
		}
	}

	public function testBridgeImplementation($bridgeName){
		require_once('bridges/' . $bridgeName . '.php');

		$this->CheckBridgePublicFunctions($bridgeName);
		$this->CheckBridgeGetCacheDurationDefaultValue($bridgeName);
	}

	public function count()
	{
		return count($this->ListBridges());
	}

	public function run(PHPUnit_Framework_TestResult $result = NULL)
	{
		if ($result === NULL) {
			$result = new PHPUnit_Framework_TestResult;
		}

		foreach ($this->ListBridges() as $bridge) {
			$result->startTest($this);
			PHP_Timer::start();
			$stopTime = NULL;

			//list($expected, $actual) = explode(';', $bridge);

			try {
				$this->testBridgeImplementation($bridge);
			}

			catch (PHPUnit_Framework_AssertionFailedError $e) {
				$stopTime = PHP_Timer::stop();
				$result->addFailure($this, $e, $stopTime);
			}

			catch (Exception $e) {
				$stopTime = PHP_Timer::stop();
				$result->addError($this, $e, $stopTime);
			}

			if ($stopTime === NULL) {
				$stopTime = PHP_Timer::stop();
			}

			$result->endTest($this, $stopTime);
		}

		return $result;
	}
}

/*
	This class is used for testing default values of 'getCacheDuration'!

	It must not return any values, just implement all abstract functions!
*/
class BridgeAbstractTest extends BridgeAbstract{
	public function loadMetadatas(){}
	public function collectData(array $params){}
	public function getName(){return '';}
	public function getURI(){return '';}
}