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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\CoreConsole\Commands;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Matomo\Decompress\Tar;
use Piwik\Development;
use Piwik\Filesystem;
use Piwik\Http;
use Piwik\Plugin\ConsoleCommand;
class DevelopmentSyncProcessedSystemTests extends ConsoleCommand
{
public function isEnabled(): bool
{
return Development::isEnabled();
}
protected function configure()
{
$this->setName('development:sync-system-test-processed');
$this->setDescription('For Piwik core devs. Copies processed system tests from travis artifacts to local processed directories');
$this->addRequiredArgument('buildnumber', 'Travis build number you want to sync, eg "14820".');
$this->addNoValueOption('expected', 'e', 'If given file will be copied in expected directories instead of processed');
$this->addOptionalValueOption('repository', 'r', 'Repository name you want to sync screenshots for.', 'matomo-org/matomo');
$this->addOptionalValueOption('http-user', '', 'the HTTP AUTH username (for premium plugins where artifacts are protected)');
$this->addOptionalValueOption('http-password', '', 'the HTTP AUTH password (for premium plugins where artifacts are protected)');
$this->addOptionalValueOption('plugin', 'p', 'Name of the plugin the files shall be synced to');
}
protected function doExecute(): int
{
$this->updateCoreFiles();
if ($this->getInput()->getOption('repository') === 'matomo-org/matomo') {
$this->updatePluginsFiles();
}
return self::SUCCESS;
}
protected function updateCoreFiles()
{
$input = $this->getInput();
$output = $this->getOutput();
$buildNumber = $input->getArgument('buildnumber');
$expected = $input->getOption('expected');
$targetDir = sprintf(PIWIK_INCLUDE_PATH . '/tests/PHPUnit/System/%s', $expected ? 'expected' : 'processed');
$repository = $input->getOption('repository');
if ($input->getOption('plugin')) {
$targetDir = sprintf(MATOMO_PLUGINS_PATH . '/plugins/%s/tests/System/%s/', $input->getOption('plugin'), $expected ? 'expected' : 'processed');
} elseif (preg_match('/plugin-([a-z0-9]{3,40})$/i', $repository, $match)) {
$targetDir = sprintf(MATOMO_PLUGINS_PATH . '/plugins/%s/tests/System/%s/', $match[1], $expected ? 'expected' : 'processed');
}
$tmpDir = StaticContainer::get('path.tmp') . '/';
$this->validate($buildNumber, $targetDir, $tmpDir);
if (Common::stringEndsWith($buildNumber, '.1')) {
// eg make '14820.1' to '14820' to be backwards compatible
$buildNumber = substr($buildNumber, 0, -2);
}
$httpUser = $input->getOption('http-user');
$httpPassword = $input->getOption('http-password');
$filename = sprintf('system.%s.tar.bz2', $buildNumber);
$urlBase = sprintf('https://builds-artifacts.matomo.org/%s/%s', $repository, $filename);
$tests = Http::sendHttpRequest(
$urlBase,
$timeout = 120,
$userAgent = null,
$destinationPath = null,
$followDepth = 0,
$acceptLanguage = false,
$byteRange = false,
$getExtendedInfo = false,
$httpMethod = 'GET',
$httpUser,
$httpPassword
);
$tarFile = $tmpDir . $filename;
file_put_contents($tarFile, $tests);
$tar = new Tar($tarFile, 'bz2');
if ($tar->extract($targetDir)) {
$this->writeSuccessMessage(array(
'All processed system test results were copied to <comment>' . $targetDir . '</comment>',
'Compare them with the expected test results and commit them if needed.',
));
} else {
$output->write('<error>' . $tar->errorInfo() . '.</error>');
$output->writeln('<error> Check that you have the PHP bz2 extension installed and try again.');
}
unlink($tarFile);
}
protected function updatePluginsFiles()
{
$input = $this->getInput();
$output = $this->getOutput();
$buildNumber = $input->getArgument('buildnumber');
$expected = $input->getOption('expected');
$targetDir = sprintf(MATOMO_PLUGINS_PATH . '/plugins/%%s/tests/System/%s/', $expected ? 'expected' : 'processed');
$tmpDir = StaticContainer::get('path.tmp') . '/';
if (Common::stringEndsWith($buildNumber, '.1')) {
// eg make '14820.1' to '14820' to be backwards compatible
$buildNumber = substr($buildNumber, 0, -2);
}
$filename = sprintf('system.plugin.%s.tar.bz2', $buildNumber);
$urlBase = sprintf('https://builds-artifacts.matomo.org/matomo-org/matomo/%s', $filename);
$tests = Http::sendHttpRequest($urlBase, $timeout = 120);
$tarFile = $tmpDir . $filename;
file_put_contents($tarFile, $tests);
$tar = new Tar($tarFile, 'bz2');
$extractionTarget = $tmpDir . '/artifacts';
Filesystem::mkdir($extractionTarget);
$success = $tar->extract($extractionTarget);
if (! $success) {
$output->write('<error>' . $tar->errorInfo() . '.</error>');
$output->writeln('<error> Check that you have the PHP bz2 extension installed and try again.');
unlink($tarFile);
return;
}
$artifacts = Filesystem::globr($extractionTarget, '*~~*');
foreach ($artifacts as $artifact) {
$artifactName = basename($artifact);
[$plugin, $file] = explode('~~', $artifactName);
$pluginTargetDir = sprintf($targetDir, $plugin);
Filesystem::mkdir($pluginTargetDir);
Filesystem::copy($artifact, $pluginTargetDir . $file);
}
Filesystem::unlinkRecursive($extractionTarget, true);
$this->writeSuccessMessage(array(
'All processed plugin system test results were copied to <comment>' . $targetDir . '</comment>',
'Compare them with the expected test results and commit them if needed.',
));
unlink($tarFile);
}
private function validate($buildNumber, $targetDir, $tmpDir)
{
if (empty($buildNumber)) {
throw new \InvalidArgumentException('Missing build number.');
}
if (!is_writable($targetDir)) {
throw new \RuntimeException('Target dir is not writable: ' . $targetDir);
}
if (!is_writable($tmpDir)) {
throw new \RuntimeException('Tempdir is not writable: ' . $tmpDir);
}
}
}
|
