-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathBuildStatusController.php
More file actions
322 lines (263 loc) · 9.41 KB
/
BuildStatusController.php
File metadata and controls
322 lines (263 loc) · 9.41 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
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
<?php
declare(strict_types=1);
namespace PHPCensor\Controller;
use Exception;
use PHPCensor\BuildFactory;
use PHPCensor\Exception\HttpException;
use PHPCensor\Exception\HttpException\NotFoundException;
use PHPCensor\Common\Exception\InvalidArgumentException;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\RedirectResponse;
use PHPCensor\Model\Build;
use PHPCensor\Model\Project;
use PHPCensor\Service\BuildStatusService;
use PHPCensor\Store\BuildStore;
use PHPCensor\Store\ProjectStore;
use PHPCensor\WebController;
use SimpleXMLElement;
/**
* @package PHP Censor
* @subpackage Application
*
* @author Dan Cryer <[email protected]>
* @author Dmitry Khomutov <[email protected]>
*/
class BuildStatusController extends WebController
{
public string $layoutName = 'layoutPublic';
protected ProjectStore $projectStore;
protected BuildStore $buildStore;
protected BuildFactory $buildFactory;
public function init(): void
{
parent::init();
$this->buildStore = $this->storeRegistry->get('Build');
$this->projectStore = $this->storeRegistry->get('Project');
$this->buildFactory = new BuildFactory(
$this->configuration,
$this->storeRegistry
);
}
/**
* Returns status of the last build
*/
protected function getStatus(Project $project, string $branch): string
{
$status = 'passing';
try {
$build = $project->getLatestBuild($branch, [
Build::STATUS_SUCCESS,
Build::STATUS_FAILED,
]);
if (isset($build) && $build instanceof Build && $build->getStatus() !== Build::STATUS_SUCCESS) {
$status = 'failed';
}
} catch (\Throwable $e) {
$status = 'error';
}
return $status;
}
/**
* Returns coverage of the last build
*
* @return string
*/
protected function getPhpunitCoverage(Project $project, string $branch, string $type = 'lines')
{
$coverage = 0;
if (!\in_array($type, ['classes', 'methods', 'lines'], true)) {
$type = 'lines';
}
try {
$build = $project->getLatestBuild($branch, [
Build::STATUS_SUCCESS,
Build::STATUS_FAILED,
]);
if (isset($build) && $build instanceof Build) {
$coverageMeta = $this->buildStore->getMeta(
'php_unit-coverage',
$build->getProjectId(),
$build->getId(),
$build->getBranch()
);
if ($coverageMeta && isset($coverageMeta[0]['meta_value'][$type])) {
$coverage = $coverageMeta[0]['meta_value'][$type];
}
}
} catch (\Throwable $e) {
}
return $coverage;
}
protected function renderXml(?SimpleXMLElement $xml = null): Response
{
$response = new Response();
$response->headers->set('Content-Type', 'text/xml');
$response->setContent($xml->asXML());
return $response;
}
/**
* @throws HttpException
* @throws InvalidArgumentException
*/
protected function getLatestBuilds(int $projectId, string $branch): array
{
$criteria = [
'project_id' => $projectId,
'branch' => $branch,
];
$order = ['id' => 'DESC'];
$builds = $this->buildStore->getWhere($criteria, 10, 0, $order);
foreach ($builds['items'] as &$build) {
$build = $this->buildFactory->getBuild($build);
}
return $builds['items'];
}
/**
* Returns the appropriate build PHPUnit coverage image in SVG format for a given project.
*
* @throws HttpException
*/
public function phpunitCoverageImage(int $projectId): Response
{
/** @var Project $project */
$project = $this->projectStore->getById($projectId);
// plastic|flat|flat-squared|social
$style = $this->getParam('style', 'flat');
$label = $this->getParam('label', 'build');
$type = $this->getParam('type', 'lines');
$branch = $this->getParam('branch', $project->getDefaultBranch());
$optionalParams = [
'logo' => $this->getParam('logo'),
'logoWidth' => $this->getParam('logoWidth'),
'link' => $this->getParam('link'),
'maxAge' => $this->getParam('maxAge'),
];
$coverage = $this->getPhpunitCoverage($project, $branch, $type);
$imageUrl = \sprintf(
'http://img.shields.io/badge/%s-%s-%s.svg?style=%s',
$label,
$coverage. '%25',
'green',
$style
);
foreach ($optionalParams as $paramName => $param) {
if ($param) {
$imageUrl .= '&' . $paramName . '=' . $param;
}
}
$cacheDir = RUNTIME_DIR . 'status_cache/';
$cacheFile = $cacheDir . \md5($imageUrl) . '.svg';
if (!\is_file($cacheFile)) {
$image = \file_get_contents($imageUrl);
\file_put_contents($cacheFile, $image);
}
$image = \file_get_contents($cacheFile);
$response = new Response();
$response->headers->set('Content-Type', 'image/svg+xml');
$response->setContent($image);
return $response;
}
/**
* Returns the appropriate build status image in SVG format for a given project.
*
* @throws HttpException
*/
public function image(int $projectId): Response
{
$project = $this->projectStore->getById($projectId);
// plastic|flat|flat-squared|social
$style = $this->getParam('style', 'flat');
$label = $this->getParam('label', 'build');
$branch = $this->getParam('branch', $project->getDefaultBranch());
$optionalParams = [
'logo' => $this->getParam('logo'),
'logoWidth' => $this->getParam('logoWidth'),
'link' => $this->getParam('link'),
'maxAge' => $this->getParam('maxAge'),
];
$status = $this->getStatus($project, $branch);
if (\is_null($status)) {
return new RedirectResponse('/');
}
$color = ($status === 'passing') ? 'green' : 'red';
$imageUrl = \sprintf(
'http://img.shields.io/badge/%s-%s-%s.svg?style=%s',
$label,
$status,
$color,
$style
);
foreach ($optionalParams as $paramName => $param) {
if ($param) {
$imageUrl .= '&' . $paramName . '=' . $param;
}
}
$cacheDir = RUNTIME_DIR . 'status_cache/';
$cacheFile = $cacheDir . \md5($imageUrl) . '.svg';
if (!\is_file($cacheFile)) {
$image = \file_get_contents($imageUrl);
\file_put_contents($cacheFile, $image);
}
$image = \file_get_contents($cacheFile);
$response = new Response();
$response->headers->set('Content-Type', 'image/svg+xml');
$response->setContent($image);
return $response;
}
/**
* View the public status page of a given project, if enabled.
*
* @throws HttpException
* @throws InvalidArgumentException
* @throws NotFoundException
* @throws \PHPCensor\Common\Exception\RuntimeException
*/
public function view(int $projectId): string
{
$project = $this->projectStore->getById($projectId);
$branch = $this->getParam('branch', $project->getDefaultBranch());
if (empty($project) || !$project->getAllowPublicStatus()) {
throw new NotFoundException('Project with id: ' . $projectId . ' not found');
}
$builds = $this->getLatestBuilds($projectId, $branch);
if (\count($builds)) {
$this->view->latest = $builds[0];
}
$this->view->builds = $builds;
$this->view->project = $project;
$this->view->environmentStore = $this->storeRegistry->get('Environment');
return $this->view->render();
}
/**
* Displays projects information in ccmenu format
*
* @throws Exception
*/
public function ccxml(int $projectId): Response
{
/* @var Project $project */
$project = $this->projectStore->getById($projectId);
$xml = new SimpleXMLElement('<Projects/>');
if (!$project instanceof Project || !$project->getAllowPublicStatus()) {
return $this->renderXml($xml);
}
try {
$branchList = $this->buildStore->getBuildBranches($projectId);
if (!$branchList) {
$branchList = [$project->getDefaultBranch()];
}
foreach ($branchList as $branch) {
$buildStatusService = new BuildStatusService($branch, $project, $project->getLatestBuild($branch));
if ($attributes = $buildStatusService->toArray()) {
$projectXml = $xml->addChild('Project');
foreach ($attributes as $attributeKey => $attributeValue) {
$projectXml->addAttribute($attributeKey, $attributeValue);
}
}
}
} catch (\Throwable $e) {
$xml = new SimpleXMLElement('<projects/>');
}
return $this->renderXml($xml);
}
}