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
|
<?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\Plugins\TestRunner\Commands;
use Piwik\Plugin;
use Piwik\Profiler;
use Piwik\Plugin\ConsoleCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
* Executes PHP tests.
*/
class TestsRun extends ConsoleCommand
{
private $returnVar = 0;
protected function configure()
{
$this->setName('tests:run');
$this->setDescription('Run Piwik PHPUnit tests one testsuite after the other');
$this->addArgument('variables', InputArgument::IS_ARRAY, 'Eg a path to a file or directory, the name of a testsuite, the name of a plugin, ... We will try to detect what you meant. You can define multiple values', array());
$this->addOption('options', 'o', InputOption::VALUE_OPTIONAL, 'All options will be forwarded to phpunit', '');
$this->addOption('xhprof', null, InputOption::VALUE_NONE, 'Profile using xhprof.');
$this->addOption('group', null, InputOption::VALUE_REQUIRED, 'Run only a specific test group. Separate multiple groups by comma, for instance core,plugins', '');
$this->addOption('file', null, InputOption::VALUE_REQUIRED, 'Execute tests within this file. Should be a path relative to the tests/PHPUnit directory.');
$this->addOption('testsuite', null, InputOption::VALUE_REQUIRED, 'Execute tests of a specific test suite, for instance unit, integration or system.');
$this->addOption('enable-logging', null, InputOption::VALUE_NONE, 'Enable logging to the configured log file during tests.');
}
protected function execute(InputInterface $input, OutputInterface $output)
{
$options = $input->getOption('options');
$groups = $input->getOption('group');
$magics = $input->getArgument('variables');
// @todo remove piwik-domain fallback in Matomo 4
$matomoDomain = $input->getOption('matomo-domain') ?: $input->getOption('piwik-domain');
$enableLogging = $input->getOption('enable-logging');
$groups = $this->getGroupsFromString($groups);
// bin is the composer executeable directory, where all vendors (should) place their executables
$command = PIWIK_VENDOR_PATH . '/bin/phpunit';
if (!$this->isCoverageEnabled($options) && $this->isXdebugLoaded()) {
$message = 'Did you know? You can run tests faster by disabling xdebug';
if($this->isXdebugCodeCoverageEnabled()) {
$message .= ' (if you need xdebug, speed up tests by setting xdebug.coverage_enable=0)</comment>';
}
$output->writeln('<comment>' . $message .'</comment>');
}
// force xdebug usage for coverage options
if ($this->isCoverageEnabled($options) && !$this->isXdebugLoaded()) {
$output->writeln('<info>xdebug extension required for code coverage.</info>');
$output->writeln('<info>searching for xdebug extension...</info>');
$extensionDir = shell_exec('php-config --extension-dir');
$xdebugFile = trim($extensionDir) . DIRECTORY_SEPARATOR . 'xdebug.so';
if (!file_exists($xdebugFile)) {
$dialog = $this->getHelperSet()->get('dialog');
$xdebugFile = $dialog->askAndValidate($output, 'xdebug not found. Please provide path to xdebug.so', function($xdebugFile) {
return file_exists($xdebugFile);
});
} else {
$output->writeln('<info>xdebug extension found in extension path.</info>');
}
$output->writeln("<info>using $xdebugFile as xdebug extension.</info>");
$phpunitPath = trim(shell_exec('which phpunit'));
$command = sprintf('php -d zend_extension=%s %s', $xdebugFile, $phpunitPath);
}
if ($input->getOption('xhprof')) {
Profiler::setupProfilerXHProf($isMainRun = true);
putenv('PIWIK_USE_XHPROF=1');
}
$suite = $this->getTestsuite($input);
$testFile = $this->getTestFile($input);
if (!empty($magics)) {
foreach ($magics as $magic) {
if (empty($suite) && (in_array($magic, $this->getTestsSuites()))) {
$suite = $this->buildTestSuiteName($magic);
} elseif (empty($testFile) && 'core' === $magic) {
$testFile = $this->fixPathToTestFileOrDirectory('tests/PHPUnit');
} elseif (empty($testFile) && 'plugins' === $magic) {
$testFile = $this->fixPathToTestFileOrDirectory('plugins');
} elseif (empty($testFile) && file_exists($magic)) {
$testFile = $this->fixPathToTestFileOrDirectory($magic);
} elseif (empty($testFile) && $this->getPluginTestFolderName($magic)) {
$testFile = $this->getPluginTestFolderName($magic);
} elseif (empty($groups)) {
$groups = $this->getGroupsFromString($magic);
} else {
$groups[] = $magic;
}
}
}
$this->executeTests($matomoDomain, $suite, $testFile, $groups, $options, $command, $output, $enableLogging);
return $this->returnVar;
}
private function getPluginTestFolderName($name)
{
$pluginName = $this->getPluginName($name);
$folder = '';
if (!empty($pluginName)) {
$path = PIWIK_INCLUDE_PATH . '/plugins/' . $pluginName;
if (is_dir($path . '/tests')) {
$folder = $this->fixPathToTestFileOrDirectory($path . '/tests');
} elseif (is_dir($path . '/Tests')) {
$folder = $this->fixPathToTestFileOrDirectory($path . '/Tests');
}
}
return $folder;
}
private function getPluginName($name)
{
$pluginNames = Plugin\Manager::getInstance()->getAllPluginsNames();
foreach ($pluginNames as $pluginName) {
if (strtolower($pluginName) === strtolower($name)) {
return $pluginName;
}
}
}
private function getTestFile(InputInterface $input)
{
$testFile = $input->getOption('file');
if (empty($testFile)) {
return '';
}
return $this->fixPathToTestFileOrDirectory($testFile);
}
private function executeTests($piwikDomain, $suite, $testFile, $groups, $options, $command, OutputInterface $output, $enableLogging)
{
if (empty($suite) && empty($groups) && empty($testFile)) {
foreach ($this->getTestsSuites() as $suite) {
$suite = $this->buildTestSuiteName($suite);
$this->executeTests($piwikDomain, $suite, $testFile, $groups, $options, $command, $output, $enableLogging);
}
return;
}
$params = $this->buildPhpUnitCliParams($suite, $groups, $options);
if (!empty($testFile)) {
$params = $params . " " . $testFile;
}
$this->executeTestRun($piwikDomain, $command, $params, $output, $enableLogging);
}
private function executeTestRun($piwikDomain, $command, $params, OutputInterface $output, $enableLogging)
{
$envVars = '';
if (!empty($piwikDomain)) {
$envVars .= "PIWIK_DOMAIN=$piwikDomain";
}
if (!empty($enableLogging)) {
$envVars .= " MATOMO_TESTS_ENABLE_LOGGING=1";
}
$cmd = $this->getCommand($envVars, $command, $params);
$output->writeln('Executing command: <info>' . $cmd . '</info>');
passthru($cmd, $returnVar);
$output->writeln("");
$this->returnVar += $returnVar;
}
private function getTestsSuites()
{
return array('unit', 'integration', 'system', 'plugin');
}
/**
* @param $command
* @param $params
* @return string
*/
private function getCommand($envVars, $command, $params)
{
return sprintf('cd %s/tests/PHPUnit && %s %s %s', PIWIK_DOCUMENT_ROOT, $envVars, $command, $params);
}
private function buildPhpUnitCliParams($suite, $groups, $options)
{
$params = $options . " ";
if (!empty($groups)) {
$groups = implode(',', $groups);
$params .= '--group ' . $groups . ' ';
} else {
$groups = '';
}
if (!empty($suite)) {
$params .= ' --testsuite ' . $suite;
} else {
$suite = '';
}
$params = str_replace('%suite%', $suite, $params);
$params = str_replace('%group%', $groups, $params);
return $params;
}
private function getTestsuite(InputInterface $input)
{
$suite = $input->getOption('testsuite');
if (empty($suite)) {
return;
}
$availableSuites = $this->getTestsSuites();
if (!in_array($suite, $availableSuites)) {
throw new \InvalidArgumentException('Invalid testsuite specified. Use one of: ' . implode(', ', $availableSuites));
}
$suite = $this->buildTestSuiteName($suite);
return $suite;
}
private function buildTestSuiteName($suite)
{
return ucfirst($suite) . 'Tests';
}
private function isCoverageEnabled($options)
{
return false !== strpos($options, '--coverage');
}
private function isXdebugLoaded()
{
return extension_loaded('xdebug');
}
private function isXdebugCodeCoverageEnabled()
{
return (bool)ini_get('xdebug.coverage_enable');
}
private function fixPathToTestFileOrDirectory($testFile)
{
if ('/' !== substr($testFile, 0, 1)) {
$testFile = '../../' . $testFile;
}
return $testFile;
}
private function getGroupsFromString($groups)
{
$groups = explode(",", $groups);
$groups = array_filter($groups, 'strlen');
return $groups;
}
}
|