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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Tests\Integration;
use Exception;
use Piwik\Config;
use Piwik\Filesystem;
use Piwik\Plugin\Manager;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
/**
* @group Core
* @group ReleaseCheckListTest
*/
class ReleaseCheckListTest extends \PHPUnit_Framework_TestCase
{
private $globalConfig;
public function setUp()
{
$this->globalConfig = _parse_ini_file(PIWIK_PATH_TEST_TO_ROOT . '/config/global.ini.php', true);
parent::setUp();
}
public function test_icoFilesIconsShouldBeInPngFormat()
{
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.ico');
$this->checkFilesAreInPngFormat($files);
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/core', '*.ico');
$this->checkFilesAreInPngFormat($files);
}
public function test_pngFilesIconsShouldBeInPngFormat()
{
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.png');
$this->checkFilesAreInPngFormat($files);
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/core', '*.png');
$this->checkFilesAreInPngFormat($files);
}
public function test_gifFilesIconsShouldBeInGifFormat()
{
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.gif');
$this->checkFilesAreInGifFormat($files);
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/core', '*.gif');
$this->checkFilesAreInGifFormat($files);
}
public function test_jpgImagesShouldBeInJpgFormat()
{
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.jpg');
$this->checkFilesAreInJpgFormat($files);
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/core', '*.jpg');
$this->checkFilesAreInJpgFormat($files);
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.jpeg');
$this->checkFilesAreInJpgFormat($files);
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/core', '*.jpeg');
$this->checkFilesAreInJpgFormat($files);
}
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'), '150');
$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' => 'log_level'), 'ERROR');
$this->_checkEqual(array('log' => 'log_writers'), array('screen'));
$this->_checkEqual(array('log' => 'logger_api_call'), null);
require_once PIWIK_INCLUDE_PATH . "/core/TaskScheduler.php";
$this->assertFalse(defined('DEBUG_FORCE_SCHEDULED_TASKS'));
// Check the index.php has "backtrace disabled"
$content = file_get_contents(PIWIK_INCLUDE_PATH . "/index.php");
$expected = "define('PIWIK_PRINT_ERROR_BACKTRACE', false);";
$this->assertTrue( false !== strpos($content, $expected), 'index.php should contain: ' . $expected);
}
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 '" . var_export($value, true) . "', expected '" . var_export($valueExpected, true) . "'");
}
public function testTemplatesDontContainDebug()
{
$patternFailIfFound = 'dump(';
$files = Filesystem::globr(PIWIK_INCLUDE_PATH . '/plugins', '*.twig');
foreach ($files as $file) {
if ($file == PIWIK_INCLUDE_PATH . '/plugins/TestRunner/templates/travis.yml.twig') {
continue;
}
$content = file_get_contents($file);
$this->assertFalse(strpos($content, $patternFailIfFound), 'found in ' . $file);
}
}
public function testCheckThatGivenPluginsAreDisabledByDefault()
{
$pluginsShouldBeDisabled = array(
'DBStats'
);
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 testProfilingDisabledInProduction()
{
require_once 'Tracker/Db.php';
$this->assertTrue(\Piwik\Tracker\Db::isProfilingEnabled() === false, 'SQL profiler should be disabled in production! See Db::$profiling');
}
public function testPiwikTrackerDebugIsOff()
{
$this->assertTrue(!isset($GLOBALS['PIWIK_TRACKER_DEBUG']));
$this->assertEquals(0, $this->globalConfig['Tracker']['debug']);
}
/**
* This tests that all PHP files start with <?php
* This would help detect errors such as a php file starting with spaces
*/
public function test_phpFilesStartWithRightCharacter()
{
$files = Filesystem::globr(PIWIK_INCLUDE_PATH, '*.php');
foreach($files as $file) {
$handle = fopen($file, "r");
$expectedStart = "<?php";
$isIniFile = strpos($file, ".ini.php") !== false || strpos($file, ".ini.travis.php") !== false;
if($isIniFile) {
$expectedStart = "; <?php exit;";
}
$skipStartFileTest = $this->isSkipPhpFileStartWithPhpBlock($file, $isIniFile);
if($skipStartFileTest) {
continue;
}
$start = fgets($handle, strlen($expectedStart) + 1 );
$this->assertEquals($start, $expectedStart, "File $file does not start with $expectedStart");
}
}
public function test_directoriesShouldBeChmod755()
{
$pluginsPath = realpath(PIWIK_INCLUDE_PATH . '/plugins/');
$objects = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($pluginsPath), RecursiveIteratorIterator::SELF_FIRST);
$paths = array();
foreach($objects as $name => $object){
if (is_dir($name)
&& strpos($name, "/.") === false) {
$paths[] = $name;
}
}
$this->assertGreaterThan(50, count($paths), 'test at latest 50 directories, got ' . count($paths));
// to prevent errors with un-readable assets,
// we ensure all directories in plugins/* are added to git with CHMOD 755
foreach($paths as $pathToTest) {
$chmod = substr(decoct(fileperms($pathToTest)), -3);
$valid = array('777', '775', '755');
$command = "find $pluginsPath -type d -exec chmod 755 {} +";
$this->assertTrue(in_array($chmod, $valid),
"Some directories within plugins/ are not chmod 755 \n\nGot: $chmod for : $pathToTest \n\n".
"Run this command to set all directories to 755: \n$command\n");;
}
}
/**
* Check that directories in plugins/ folder are specifically either enabled or disabled.
*
* This fails when a new folder is added to plugins/* and forgot to enable or mark as disabled in Manager.php.
*/
public function test_DirectoriesInPluginsFolder_areKnown()
{
$pluginsBundledWithPiwik = Config::getInstance()->getFromGlobalConfig('Plugins');
$pluginsBundledWithPiwik = $pluginsBundledWithPiwik['Plugins'];
$magicPlugins = 42;
$this->assertTrue(count($pluginsBundledWithPiwik) > $magicPlugins);
$plugins = _glob(Manager::getPluginsDirectory() . '*', GLOB_ONLYDIR);
$count = 1;
foreach($plugins as $pluginPath) {
$pluginName = basename($pluginPath);
$addedToGit = $this->isPathAddedToGit($pluginPath);
if(!$addedToGit) {
// if not added to git, then it is not part of the release checklist.
continue;
}
$manager = Manager::getInstance();
$isGitSubmodule = $manager->isPluginOfficialAndNotBundledWithCore($pluginName);
$disabled = in_array($pluginName, $manager->getCorePluginsDisabledByDefault()) || $isGitSubmodule;
$enabled = in_array($pluginName, $pluginsBundledWithPiwik);
$this->assertTrue( $enabled + $disabled === 1,
"Plugin $pluginName should be either enabled (in global.ini.php) or disabled (in Piwik\\Plugin\\Manager).
It is currently (enabled=".(int)$enabled. ", disabled=" . (int)$disabled . ")"
);
$count++;
}
$this->assertTrue($count > $magicPlugins);
}
public function testEndOfLines()
{
foreach (Filesystem::globr(PIWIK_DOCUMENT_ROOT, '*') as $file) {
// skip files in these folders
if (strpos($file, '/.git/') !== false ||
strpos($file, '/documentation/') !== false ||
strpos($file, '/tests/') !== false ||
strpos($file, '/lang/') !== false ||
strpos($file, 'yuicompressor') !== false ||
strpos($file, '/libs/bower_components') !== false ||
(strpos($file, '/vendor') !== false && strpos($file, '/vendor/piwik') === false) ||
strpos($file, '/tmp/') !== false
) {
continue;
}
// skip files with these file extensions
if (preg_match('/\.(bmp|fdf|gif|deb|deflate|exe|gz|ico|jar|jpg|p12|pdf|png|rar|swf|vsd|z|zip|ttf|so|dat|eps|phar|pyc|gzip)$/', $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, 'Incorrect line endings in ' . $file);
} else {
// expect native
$hasWindowsEOL = strpos($contents, "\r\n");
// overwrite translations files with incorrect line endings
$this->assertTrue($hasWindowsEOL === false, 'Incorrect line endings \r\n found in ' . $file);
}
}
}
}
public function testPiwikJavaScript()
{
// check source against Snort rule 8443
// @see https://github.com/piwik/piwik/issues/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);
}
private function checkFilesAreInPngFormat($files)
{
$this->checkFilesAreInFormat($files, "png");
}
private function checkFilesAreInJpgFormat($files)
{
$this->checkFilesAreInFormat($files, "jpeg");
}
private function checkFilesAreInGifFormat($files)
{
$this->checkFilesAreInFormat($files, "gif");
}
private function checkFilesAreInFormat($files, $format)
{
$errors = array();
foreach ($files as $file) {
$function = "imagecreatefrom" . $format;
if (!function_exists($function)) {
throw new \Exception("Unexpected error: $function function does not exist!");
}
$handle = @$function($file);
if (empty($handle)) {
$errors[] = $file;
}
}
if (!empty($errors)) {
$icons = "gimp " . implode(" ", $errors);
$this->fail("$format format failed for following icons $icons \n");
}
}
/**
* @return bool
*/
protected function isSkipPhpFileStartWithPhpBlock($file, $isIniFile)
{
$isIniFileInTests = strpos($file, "/tests/") !== false;
$isTestResultFile = strpos($file, "/System/expected") !== false
|| strpos($file, "tests/resources/Updater/") !== false
|| strpos($file, "Twig/Tests/") !== false
|| strpos($file, "processed/") !== false
|| strpos($file, "/vendor/") !== false;
$isLib = strpos($file, "lib/xhprof") !== false || strpos($file, "phpunit/phpunit") !== false;
return ($isIniFile && $isIniFileInTests) || $isTestResultFile || $isLib;
}
/**
* @return bool
*/
protected function isPathAddedToGit($pluginPath)
{
$gitOutput = shell_exec('git ls-files ' . $pluginPath . ' --error-unmatch 2>&1');
$addedToGit = (strlen($gitOutput) > 0) && strpos($gitOutput, 'error: pathspec') === false;
return $addedToGit;
}
}
|