-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCodeception.php
More file actions
209 lines (174 loc) · 5.69 KB
/
Copy pathCodeception.php
File metadata and controls
209 lines (174 loc) · 5.69 KB
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
<?php
declare(strict_types=1);
namespace PHPCensor\Plugins\Testing;
use PHPCensor\Common\Build\BuildInterface;
use PHPCensor\Common\Build\BuildMetaInterface;
use PHPCensor\Common\Exception\Exception;
use PHPCensor\Common\Plugin\Plugin;
use PHPCensor\Common\Plugin\ZeroConfigPluginInterface;
use PHPCensor\Plugins\Testing\Codeception\Parser as CodeceptionParser;
use Symfony\Component\Yaml\Parser as YamlParser;
/**
* Codeception Plugin - Enables full acceptance, unit, and functional testing.
*
* @package PHP Censor
* @subpackage Plugins
*
* @author Dmitry Khomutov <poisoncorpsee@gmail.com>
* @author Don Gilbert <don@dongilbert.net>
* @author Igor Timoshenko <contact@igortimoshenko.com>
* @author Adam Cooper <adam@networkpie.co.uk>
*/
class Codeception extends Plugin implements ZeroConfigPluginInterface
{
private string $args = '';
/**
* @var string $ymlConfigFile The path of a yml config for Parser
*/
private string $ymlConfigFile = '';
/**
* default sub-path for report.xml file
*
* @var array $path The path to the report.xml file
*/
private array $outputPath = [
'tests/_output',
'tests/_log',
];
private string $executable;
/**
* {@inheritDoc}
*/
public static function getName(): string
{
return 'codeception';
}
/**
* {@inheritDoc}
*/
public function execute(): bool
{
$this->executable = $this->commandExecutor->findBinary($this->binaryNames, $this->binaryPath);
if (empty($this->ymlConfigFile)) {
throw new Exception("No configuration file found");
}
// Run any config files first. This can be either a single value or an array.
return $this->runConfigFile();
}
/**
* {@inheritDoc}
*/
public static function canExecute(string $stage, BuildInterface $build): bool
{
if (
(BuildInterface::STAGE_TEST === $stage) &&
!\is_null(self::findConfigFile((string)$build->getBuildPath()))
) {
return true;
}
return false;
}
/**
* {@inheritDoc}
*/
protected function initPluginSettings(): void
{
$config = $this->options->get('config');
if (empty($config)) {
$this->ymlConfigFile = self::findConfigFile($this->directory);
} else {
$this->ymlConfigFile = $this->directory . $config;
}
$this->args = (string)$this->options->get('args', $this->args);
$outputPath = $this->options->get('output_path');
if ($outputPath) {
\array_unshift($this->outputPath, $outputPath);
}
}
/**
* {@inheritDoc}
*/
protected function getPluginDefaultBinaryNames(): array
{
return [
'codecept',
'codecept.phar',
];
}
/**
* Try and find the codeception YML config file.
*/
public static function findConfigFile(string $buildPath): string
{
if (\file_exists($buildPath . 'codeception.yml')) {
return $buildPath . 'codeception.yml';
}
if (\file_exists($buildPath . 'codeception.dist.yml')) {
return $buildPath . 'codeception.dist.yml';
}
return '';
}
/**
* Run tests from a Parser config file.
*/
private function runConfigFile(): bool
{
if (!$this->executable) {
$this->buildLogger->logFailure(\sprintf('Could not find "%s" binary', 'codecept'));
return false;
}
$cmd = 'cd "%s" && ' . $this->executable . ' run -c "%s" ' . $this->args . ' --xml';
$success = $this->commandExecutor->executeCommand($cmd, $this->directory, $this->ymlConfigFile);
if (!$success) {
return false;
}
$parser = new YamlParser();
$yaml = \file_get_contents($this->ymlConfigFile);
$config = (array)$parser->parse($yaml);
$trueReportXmlPath = null;
if ($config && isset($config['paths']['log'])) {
$trueReportXmlPath = \rtrim((string)$config['paths']['log'], '/\\') . '/';
}
if (!\file_exists($trueReportXmlPath . 'report.xml')) {
foreach ($this->outputPath as $outputPath) {
$trueReportXmlPath = \rtrim((string)$outputPath, '/\\') . '/';
if (\file_exists($trueReportXmlPath . 'report.xml')) {
break;
}
}
}
if (!\file_exists($trueReportXmlPath . 'report.xml')) {
$this->buildLogger->logFailure('"report.xml" file can not be found in configured "output_path!"');
return false;
}
$parser = new CodeceptionParser($this->build->getBuildPath(), ($trueReportXmlPath . 'report.xml'));
$output = $parser->parse();
$meta = [
'tests' => $parser->getTotalTests(),
'timetaken' => $parser->getTotalTimeTaken(),
'failures' => $parser->getTotalFailures(),
];
// NOTE: Parser does not use stderr, so failure can only be detected
// through tests
$success = (($meta['failures']) < 1);
$this->buildMetaWriter->write(
$this->build->getId(),
self::getName(),
BuildMetaInterface::KEY_META,
$meta
);
$this->buildMetaWriter->write(
$this->build->getId(),
self::getName(),
BuildMetaInterface::KEY_DATA,
$output
);
$this->buildMetaWriter->write(
$this->build->getId(),
self::getName(),
BuildMetaInterface::KEY_ERRORS,
$parser->getTotalFailures()
);
return $success;
}
}