Newer
Older
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
* @version $Id$
*/
class ReleaseCheckListTest extends PHPUnit_Framework_TestCase
{
public function setUp()
{
$this->globalConfig = _parse_ini_file(PIWIK_PATH_TEST_TO_ROOT . '/config/global.ini.php', true);
parent::setUp();
}
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
/**
* @group Core
* @group ReleaseCheckList
*/
public function testCheckThatConfigurationValuesAreProductionValues()
{
$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);
}
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->assertEquals($valueExpected, $value, "$section -> $optionName was '$value', expected '$valueExpected'");
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testTemplatesDontContainDebug()
{
$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);
}
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testCheckThatGivenPluginsAreDisabledByDefault()
{
$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)
* @group Core
* @group ReleaseCheckList
*/
public function testProfilingDisabledInProduction()
{
require_once 'Tracker/Db.php';
$this->assertTrue(Piwik_Tracker_Db::isProfilingEnabled() === false, 'SQL profiler should be disabled in production! See Piwik_Tracker_Db::$profiling');
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testPiwikTrackerDebugIsOff()
{
$this->assertTrue(!isset($GLOBALS['PIWIK_TRACKER_DEBUG']));
$oldGet = $_GET;
$_GET = array('idsite' => 1);
// hiding echoed out message on empty request
ob_start();
include PIWIK_PATH_TEST_TO_ROOT . "/piwik.php";
ob_end_clean();
$_GET = $oldGet;
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
$this->assertTrue($GLOBALS['PIWIK_TRACKER_DEBUG'] === false);
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testAjaxLibraryVersions()
{
Piwik::createConfigObject();
Piwik_Config::getInstance()->setTestEnvironment();
$jqueryJs = file_get_contents( PIWIK_DOCUMENT_ROOT . '/libs/jquery/jquery.js', false, NULL, 0, 512 );
$this->assertTrue( (boolean)preg_match('/jQuery (?:JavaScript Library )?v?([0-9.]+)/', $jqueryJs, $matches) );
$this->assertEquals( Piwik_Config::getInstance()->General['jquery_version'], $matches[1] );
$jqueryuiJs = file_get_contents( PIWIK_DOCUMENT_ROOT . '/libs/jquery/jquery-ui.js', false, NULL, 0, 512 );
$this->assertTrue( (boolean)preg_match('/jQuery UI (?:- v)?([0-9.]+)/', $jqueryuiJs, $matches) );
$this->assertEquals( Piwik_Config::getInstance()->General['jqueryui_version'], $matches[1] );
$swfobjectJs = file_get_contents( PIWIK_DOCUMENT_ROOT . '/libs/swfobject/swfobject.js', false, NULL, 0, 512 );
$this->assertTrue( (boolean)preg_match('/SWFObject v([0-9.]+)/', $swfobjectJs, $matches) );
$this->assertEquals( Piwik_Config::getInstance()->General['swfobject_version'], $matches[1] );
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testSvnEolStyle()
{
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|so)$/', $file))
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
{
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, 'Incorrect line endings in '.$file);
}
else
{
// expect native
$this->assertTrue(strpos($contents, "\r\n") === false, $file, 'Incorrect line endings in '.$file);
}
}
}
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testSvnKeywords()
{
/*
* Piwik's .php files have $ Id $
*/
$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/index.php');
$this->assertTrue(strpos($contents, '$I'.'d: '.basename($file).' ') !== false, $file);
$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/piwik.php');
$this->assertTrue(strpos($contents, '$I'.'d: '.basename($file).' ') !== false, $file);
foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/core', '*.php') as $file)
{
$contents = file_get_contents($file);
$this->assertTrue(strpos($contents, '$I'.'d: '.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, '/config/') !== false
|| strpos($file, 'tcpdf_config.php') !== false)
{
continue;
}
$this->assertTrue(strpos($contents, '$I'.'d: ') !== false, $file ." Please add '@version \$I"."d: \$' in the file header comments");
* Piwik's .js files don't have $ Id $ (information disclosure)
*/
$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/piwik.js');
$this->assertTrue(strpos($contents, '$I'.'d') === false, $file);
$contents = file_get_contents($file = PIWIK_DOCUMENT_ROOT . '/js/piwik.js');
$this->assertTrue(strpos($contents, '$I'.'d') === false, $file);
foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/plugins', '*.js') as $file)
{
$contents = file_get_contents($file);
$found = strpos($contents, '$I'.'d') !== false;
$this->assertTrue(!$found, $file, "Please Remove the string \$I"."d from the JS files");
}
foreach(Piwik::globr(PIWIK_DOCUMENT_ROOT . '/themes', '*.js') as $file)
{
$contents = file_get_contents($file);
$this->assertTrue(strpos($contents, '$I'.'d') === false, $file);
}
}
/**
* @group Core
* @group ReleaseCheckList
*/
public function testPiwikJavaScript()
{
// 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 );
}
}