/tests/core/ReleaseCheckList.test.php

<?php
if(!defined('PIWIK_CONFIG_TEST_INCLUDED'))
{
	require_once dirname(__FILE__)."/../../tests/config_test.php";
}

//Zend_Loader::loadClass('Piwik_');

class Test_Piwik_ReleaseCheckList extends UnitTestCase
{
    public function test_checkThatConfigurationValuesAreProductionValues()
    {
    	$this->globalConfig = _parse_ini_file(PIWIK_PATH_TEST_TO_ROOT . '/config/global.ini.php', true);
//    	var_dump($globalConfig);
    	$this->checkEqual(array('Debug' => 'always_archive_data_day'), '0');
    	$this->checkEqual(array('Debug' => 'always_archive_data_period'), '0');
    	$this->checkEqual(array('Debug' => 'enable_sql_profiler'), '0');
    	$this->checkEqual(array('General' => 'time_before_today_archive_considered_outdated'), '10');
    	$this->checkEqual(array('General' => 'enable_browser_archiving_triggering'), '1');
    	$this->checkEqual(array('General' => 'default_language'), 'en');
    	$this->checkEqual(array('Tracker' => 'record_statistics'), '1');
    	$this->checkEqual(array('Tracker' => 'visit_standard_length'), '1800');
    	$this->checkEqual(array('Tracker' => 'trust_visitors_cookies'), '0');
    	// logging messages are disabled
    	$this->checkEqual(array('log' => 'logger_message'), '');
    	$this->checkEqual(array('log' => 'logger_exception'), array('screen'));
    	$this->checkEqual(array('log' => 'logger_error'), array('screen'));
    	$this->checkEqual(array('log' => 'logger_api_call'), null);
    }
    
    public function test_templatesDontContainDebug()
    {
    	$patternFailIfFound = '{debug}';
    	$files = Piwik::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.tpl');
    	foreach($files as $file)
    	{
    		$content = file_get_contents($file);
    		$this->assertFalse(strpos($content, $patternFailIfFound), 'found in '.$file);
    	}
    }
    
    private function checkEqual($key, $valueExpected)
    {
    	$section = key($key);
    	$optionName = current($key);
    	$value = null;
    	if(isset($this->globalConfig[$section][$optionName]))
    	{
	    	$value = $this->globalConfig[$section][$optionName];
    	}
    	$this->assertEqual($value, $valueExpected, "$section -> $optionName was '".var_export($value, true)."', expected '".var_export($valueExpected, true)."'");
    }
    
    public function test_checkThatGivenPluginsAreDisabledByDefault()
    {
    	$pluginsShouldBeDisabled = array(
		'AnonymizeIP',
    		'DBStats',
		'SecurityInfo',
		'VisitorGenerator',
    	);
    	foreach($pluginsShouldBeDisabled as $pluginName)
    	{
	    	if(in_array($pluginName, $this->globalConfig['Plugins']['Plugins']))
	    	{
	    		throw new Exception("Plugin $pluginName is enabled by default but shouldn't.");
	    	}
    	}
    	
    }
    /**
     * test that the profiler is disabled (mandatory on a production server)
     */
    public function test_profilingDisabledInProduction()
    {
    	require_once 'Tracker/Db.php';
    	$this->assertTrue(Piwik_Tracker_Db::isProfilingEnabled() === false, 'SQL profiler should be disabled in production! See Piwik_Tracker_Db::$profiling');
    }
    

	function test_piwikTrackerDebugIsOff()
	{
		$this->assertTrue(!isset($GLOBALS['PIWIK_TRACKER_DEBUG']));

		// hiding echoed out message on empty request
		ob_start();
		include PIWIK_PATH_TEST_TO_ROOT . "/piwik.php";
		ob_end_clean();

		$this->assertTrue($GLOBALS['PIWIK_TRACKER_DEBUG'] === false);
	}

	function test_ajaxLibraryVersions()
	{
		Piwik::createConfigObject();
		Zend_Registry::get('config')->setTestEnvironment();	

		$jqueryJs = file_get_contents( PIWIK_DOCUMENT_ROOT . '/libs/jquery/jquery.js', false, NULL, 0, 512 );
		$this->assertTrue( preg_match('/jQuery (?:JavaScript Library )?v?([0-9.]+)/', $jqueryJs, $matches) );
		$this->assertEqual( $matches[1], Zend_Registry::get('config')->General->jquery_version );

		$jqueryuiJs = file_get_contents( PIWIK_DOCUMENT_ROOT . '/libs/jquery/jquery-ui.js', false, NULL, 0, 512 );
		$this->assertTrue( preg_match('/jQuery UI ([0-9.]+)/', $jqueryuiJs, $matches) );
		$this->assertEqual( $matches[1], Zend_Registry::get('config')->General->jqueryui_version );


		$swfobjectJs = file_get_contents( PIWIK_DOCUMENT_ROOT . '/libs/swfobject/swfobject.js', false, NULL, 0, 512 );
		$this->assertTrue( preg_match('/SWFObject v([0-9.]+)/', $swfobjectJs, $matches) );
		$this->assertEqual( $matches[1], Zend_Registry::get('config')->General->swfobject_version );
	}

	function test_svnEolStyle()
	{
		if(Piwik_Common::isWindows()) {
			// SVN native does not make this work on windows
			return;
		}
		foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT, '*') as $file)
		{
			// skip files in these folders
			if(strpos($file, '/.svn/') !== false ||
				strpos($file, '/documentation/') !== false ||
				strpos($file, '/tests/') !== false ||
				strpos($file, '/tmp/') !== false)
			{
				continue;
			}

			// skip files with these file extensions
			if(preg_match('/\.(bmp|fdf|gif|deflate|gz|ico|jar|jpg|p12|pdf|png|rar|swf|vsd|z|zip|ttf)$/', $file))
			{
				continue;
			}

			if(!is_dir($file))
			{
				$contents = file_get_contents($file);

				// expect CRLF
				if(preg_match('/\.(bat|ps1)$/', $file))
				{
					$contents = str_replace("\r\n", '', $contents);
					$this->assertTrue(strpos($contents, "\n") === false, $file);
				}
				else
				{
				// expect native
					$this->assertTrue(strpos($contents, "\r\n") === false, $file);
				}
			}
		}
	}

	function test_svnKeywords()
	{
		/*
		 * Piwik's .php files have $Id$
		 */
		$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/index.php');
		$this->assertTrue(strpos($contents, '$Id: '.basename($file).' ') !== false, $file);

		$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/piwik.php');
		$this->assertTrue(strpos($contents, '$Id: '.basename($file).' ') !== false, $file);

		foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/core', '*.php') as $file)
		{
			$contents = file_get_contents($file);
			$this->assertTrue(strpos($contents, '$Id: '.basename($file).' ') !== false, $file);
		}

		foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/plugins', '*.php') as $file)
		{
			if(strpos($file, '/tests/') !== false 
				|| strpos($file, '/PhpSecInfo/') !== false
				|| strpos($file, 'tcpdf_config.php') !== false)
			{
				continue;
			}
			
			$contents = file_get_contents($file);
			$this->assertTrue(strpos($contents, '$Id: ') !== false, $file ." no Id: keyword");
		}

		/*
		 * Piwik's .js files don't have $Id$
		 */
		$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/piwik.js');
		$this->assertTrue(strpos($contents, '$Id') === false, $file);

		$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/js/piwik.js');
		$this->assertTrue(strpos($contents, '$Id') === false, $file);

		foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/plugins', '*.js') as $file)
		{
			$contents = file_get_contents($file);
			$this->assertTrue(strpos($contents, '$Id') === false, $file);
		}

		foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/themes', '*.js') as $file)
		{
			$contents = file_get_contents($file);
			$this->assertTrue(strpos($contents, '$Id') === false, $file);
		}
	}

	function test_piwikJavaScript()
	{
		// check source against Snort rule 8443
		// @see http://dev.piwik.org/trac/ticket/2203
		$pattern = '/\x5b\x5c{2}.*\x5c{2}[\x22\x27]/';
		$contents = file_get_contents( PIWIK_DOCUMENT_ROOT . '/js/piwik.js' );

		$this->assertTrue( preg_match($pattern, $contents) == 0 );

		$contents = file_get_contents( PIWIK_DOCUMENT_ROOT . '/piwik.js' );
		$this->assertTrue( preg_match($pattern, $contents) == 0 );

	}
}