1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Copyright (c) Enalean, 2012. All Rights Reserved. |
4
|
|
|
* |
5
|
|
|
* This file is a part of Tuleap. |
6
|
|
|
* |
7
|
|
|
* Tuleap is free software; you can redistribute it and/or modify |
8
|
|
|
* it under the terms of the GNU General Public License as published by |
9
|
|
|
* the Free Software Foundation; either version 2 of the License, or |
10
|
|
|
* (at your option) any later version. |
11
|
|
|
* |
12
|
|
|
* Tuleap is distributed in the hope that it will be useful, |
13
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
14
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15
|
|
|
* GNU General Public License for more details. |
16
|
|
|
* |
17
|
|
|
* You should have received a copy of the GNU General Public License |
18
|
|
|
* along with Tuleap; if not, write to the Free Software |
19
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
20
|
|
|
*/ |
21
|
|
|
require_once 'common/Http/Client.class.php'; |
22
|
|
|
require_once 'ClientUnableToLaunchBuildException.class.php'; |
23
|
|
|
|
24
|
|
|
/** |
25
|
|
|
* A class to be able to work with the jenkins server |
26
|
|
|
*/ |
27
|
|
|
class Jenkins_Client { |
28
|
|
|
|
29
|
|
|
const BUILD_WITH_PARAMETERS_REGEXP = '%(?P<job_url>.*)/buildWithParameters(/|\?).*%'; |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* @var Http_Client |
33
|
|
|
*/ |
34
|
|
|
private $http_curl_client; |
35
|
|
|
|
36
|
|
|
/** |
37
|
|
|
* @var String |
38
|
|
|
*/ |
39
|
|
|
private $token = null; |
40
|
|
|
|
41
|
|
|
/** |
42
|
|
|
* @param Http_Client $http_curl_client Any instance of Http_Client |
43
|
|
|
*/ |
44
|
|
|
public function __construct(Http_Client $http_curl_client) { |
45
|
|
|
$this->http_curl_client = $http_curl_client; |
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
/** |
49
|
|
|
* Allow to define token to be used for authentication |
50
|
|
|
* |
51
|
|
|
* @param String $token Jenkins authentication token |
52
|
|
|
* |
53
|
|
|
* @return Jenkins_Client |
54
|
|
|
*/ |
55
|
|
|
public function setToken($token) { |
56
|
|
|
$this->token = $token; |
57
|
|
|
return $this; |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* @param string $job_url |
62
|
|
|
* @param array $parameters |
|
|
|
|
63
|
|
|
* |
64
|
|
|
* @throws Tracker_Exception |
65
|
|
|
*/ |
66
|
|
|
public function launchJobBuild($job_url, array $build_parameters = array()) { |
67
|
|
|
$options = array( |
68
|
|
|
CURLOPT_URL => $this->getBuildUrl($job_url), |
69
|
|
|
CURLOPT_SSL_VERIFYPEER => false, |
70
|
|
|
CURLOPT_POST => true, |
71
|
|
|
); |
72
|
|
|
|
73
|
|
|
if (count($build_parameters) > 0) { |
74
|
|
|
$options[CURLOPT_POSTFIELDS] = $this->generateBuildParameters($build_parameters); |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
$this->http_curl_client->addOptions($options); |
78
|
|
|
|
79
|
|
|
try { |
80
|
|
|
$this->http_curl_client->doRequest(); |
81
|
|
|
} catch (Http_ClientException $e) { |
82
|
|
|
throw new Jenkins_ClientUnableToLaunchBuildException('Job: ' . $job_url . '; Message: ' . $e->getMessage()); |
83
|
|
|
} |
84
|
|
|
} |
85
|
|
|
|
86
|
|
|
private function getBuildUrl($job_url) { |
87
|
|
|
$params = http_build_query($this->getTokenUrlParameter()); |
88
|
|
|
if (preg_match(self::BUILD_WITH_PARAMETERS_REGEXP, $job_url)) { |
89
|
|
|
$separator = '&'; |
90
|
|
|
} else { |
91
|
|
|
$job_url = $job_url . '/build'; |
92
|
|
|
$separator = '?'; |
93
|
|
|
} |
94
|
|
|
if ($params) { |
95
|
|
|
$params = $separator.$params; |
96
|
|
|
} |
97
|
|
|
return $job_url . $params; |
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
private function getTokenUrlParameter() { |
101
|
|
|
if ($this->token) { |
102
|
|
|
return array('token' => $this->token); |
103
|
|
|
} |
104
|
|
|
return array(); |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* @param array $build_parameters |
109
|
|
|
* @return string |
110
|
|
|
*/ |
111
|
|
|
private function generateBuildParameters(array $build_parameters) { |
112
|
|
|
$parameters = array(); |
113
|
|
|
foreach ($build_parameters as $name => $value) { |
114
|
|
|
$parameters['parameter'][] = array( |
115
|
|
|
'name' => $name, |
116
|
|
|
'value' => $value |
117
|
|
|
); |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
return 'json=' . json_encode($parameters); |
121
|
|
|
} |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
?> |
125
|
|
|
|
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.
Consider the following example. The parameter
$ireland
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was changed, but the annotation was not.