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
|
<?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\Plugin\Manager;
/**
*/
class GenerateTest extends GeneratePluginBase
{
protected function configure()
{
$this->setName('generate:test')
->setDescription('Adds a test to an existing plugin')
->addRequiredValueOption('pluginname', null, 'The name of an existing plugin')
->addRequiredValueOption('testname', null, 'The name of the test to create')
->addRequiredValueOption('testtype', null, 'Whether you want to create a "unit", "integration", "system", or "ui" test');
}
protected function doExecute(): int
{
$pluginName = $this->getPluginName();
$testType = $this->getTestType();
$testName = $this->getTestName($testType);
$exampleFolder = Manager::getPluginDirectory('ExamplePlugin');
$replace = array(
'ExamplePlugin' => $pluginName,
'SimpleTest' => $testName,
'SimpleSystemTest' => $testName,
'SimpleUITest_spec.js' => $testName . '_spec.js',
'SimpleUITest' => $testName,
);
$whitelistFiles = $this->getTestFilesWhitelist($testType);
$this->copyTemplateToPlugin($exampleFolder, $pluginName, $replace, $whitelistFiles);
$messages = array(
sprintf('Test %s for plugin %s generated.', $testName, $pluginName),
);
if (strtolower($testType) === 'ui') {
$messages[] = 'To run this test execute the command: ';
$messages[] = '<comment>' . sprintf('./console tests:run-ui %s', $testName) . '</comment>';
} else {
$messages[] = 'To run all your plugin tests, execute the command: ';
$messages[] = '<comment>' . sprintf('./console tests:run %s', $pluginName) . '</comment>';
$messages[] = 'To run only this test: ';
$messages[] = '<comment>' . sprintf('./console tests:run %s', $testName) . '</comment>';
}
$messages[] = 'Enjoy!';
$this->writeSuccessMessage($messages);
return self::SUCCESS;
}
/**
* @return string
* @throws \RuntimeException
*/
private function getTestName($testType)
{
$testname = $this->getInput()->getOption('testname');
$validate = function ($testname) {
if (empty($testname)) {
throw new \InvalidArgumentException('You have to enter a valid test name ');
}
return $testname;
};
if (empty($testname)) {
$testname = $this->askAndValidate('Enter the name of the test: ', $validate);
} else {
$validate($testname);
}
if (strtolower($testType) !== 'ui' && !Common::stringEndsWith(strtolower($testname), 'test')) {
$testname = $testname . 'Test';
}
$testname = ucfirst($testname);
return $testname;
}
/**
* @return string
* @throws \RuntimeException
*/
protected function getPluginName()
{
$pluginNames = $this->getPluginNames();
$invalidName = 'You have to enter the name of an existing plugin';
return $this->askPluginNameAndValidate($pluginNames, $invalidName);
}
public function getValidTypes()
{
return array('unit', 'integration', 'system', 'ui');
}
/**
* @return string Unit, Integration, System
*/
private function getTestType()
{
$testtype = $this->getInput()->getOption('testtype');
$self = $this;
$validate = function ($testtype) use ($self) {
if (empty($testtype) || !in_array($testtype, $self->getValidTypes())) {
throw new \InvalidArgumentException('You have to enter a valid test type: ' . implode(" or ", $self->getValidTypes()));
}
return $testtype;
};
if (empty($testtype)) {
$testtype = $this->askAndValidate(
'Enter the type of the test to generate (' . implode(", ", $this->getValidTypes()) . '): ',
$validate,
null,
$this->getValidTypes()
);
} else {
$validate($testtype);
}
$testtype = ucfirst($testtype);
return $testtype;
}
/**
* @return array
*/
protected function getTestFilesWhitelist($testType)
{
if ('Ui' == $testType) {
return array(
'/tests',
'/tests/UI',
'/tests/UI/.gitignore',
'/tests/UI/expected-screenshots',
'/tests/UI/expected-screenshots/.gitkeep',
'/tests/UI/SimpleUITest_spec.js',
);
}
if ('System' == $testType) {
return array(
'/.gitignore',
'/tests',
'/tests/System',
'/tests/System/SimpleSystemTest.php',
'/tests/System/expected',
'/tests/System/expected/test___API.get_day.xml',
'/tests/System/expected/test___Goals.getItemsSku_day.xml',
'/tests/System/processed',
'/tests/System/processed/.gitignore',
'/tests/Fixtures',
'/tests/Fixtures/SimpleFixtureTrackFewVisits.php',
);
}
if ('Integration' == $testType) {
return array(
'/tests',
'/tests/Integration',
'/tests/Integration/SimpleTest.php',
);
}
return array(
'/tests',
'/tests/Unit',
'/tests/Unit/SimpleTest.php',
);
}
}
|
