forked from sebastianbergmann/phpunit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTrac.php
More file actions
189 lines (174 loc) · 6.56 KB
/
Copy pathTrac.php
File metadata and controls
189 lines (174 loc) · 6.56 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
<?php
/**
* PHPUnit
*
* Copyright (c) 2002-2010, Sebastian Bergmann <[email protected]>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Sebastian Bergmann nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category Testing
* @package PHPUnit
* @author Graham Christensen <[email protected]>
* @author Sean Coates <[email protected]>
* @author Sebastian Bergmann <[email protected]>
* @copyright 2002-2010 Sebastian Bergmann <[email protected]>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @link http://www.phpunit.de/
* @since Class available since Release 3.5.4
*/
/**
* A ticket listener that interacts with Trac.
*
* <code>
* <phpunit>
* <listeners>
* <!-- You may need to update the path to the TicketListener -->
* <listener class="PHPUnit_Extensions_TicketListener_Trac"
* file="/usr/lib/php/PHPUnit/Extensions/TicketListener/Trac.php">
* <arguments>
* <!-- A user and their password. This user must have XML_RPC permissions -->
* <string>trac_username</string>
* <string>trac_password</string>
* <!-- The URL for your XML-RPC endpoint. -->
* <!-- For example, if trac is at 127.0.0.1/trac: -->
* <string>127.0.0.1/trac/login/xmlrpc</string>
* </arguments>
* </listener>
* </listeners>
* </phpunit>
* </code>
*
* @category Testing
* @package PHPUnit
* @author Graham Christensen <[email protected]>
* @author Sean Coates <[email protected]>
* @author Sebastian Bergmann <[email protected]>
* @copyright 2002-2010 Sebastian Bergmann <[email protected]>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: @package_version@
* @link http://www.phpunit.de/
* @since Class available since Release 3.5.4
*/
class PHPUnit_Extensions_TicketListener_Trac extends PHPUnit_Extensions_TicketListener
{
protected $username;
protected $password;
protected $hostpath;
protected $scheme;
private $printTicketStateChanges;
/**
* Constructor
*
* @param string $username Trac-XMLRPC username
* @param string $password Trac-XMLRPC password
* @param string $hostpath Trac-XMLRPC Host+Path (e.g. example.com/trac/login/xmlrpc)
* @param string $scheme Trac scheme (http or https)
* @param bool $printTicketStateChanges To display changes or not
*/
public function __construct($username, $password, $hostpath, $scheme = 'http', $printTicketStateChanges = FALSE)
{
$this->username = $username;
$this->password = $password;
$this->hostpath = $hostpath;
$this->scheme = $scheme;
$this->printTicketStateChanges = $printTicketStateChanges;
}
/**
* Get the status of a ticket message
*
* @param integer $ticketId The ticket ID
* @return array('status' => $status) ($status = new|closed|unknown_ticket)
*/
public function getTicketInfo($ticketId = NULL)
{
if (!is_numeric($ticketId)) {
return array('status' => 'invalid_ticket_id');
}
try {
$info = $this->getClient()->get($ticketId);
switch ($info[3]['status']) {
case 'closed': {
return array('status' => 'closed');
}
break;
case 'new':
case 'reopened': {
return array('status' => 'new');
}
break;
default: {
return array('status' => 'unknown_ticket');
}
}
}
catch (Exception $e) {
return array('status' => 'unknown_ticket');
}
}
/**
* Update a ticket with a new status
*
* @param string $ticketId The ticket number of the ticket under test (TUT).
* @param string $statusToBe The status of the TUT after running the associated test.
* @param string $message The additional message for the TUT.
* @param string $resolution The resolution for the TUT.
*/
protected function updateTicket($ticketId, $statusToBe, $message, $resolution)
{
$change = array('status' => $statusToBe, 'resolution' => $resolution);
$this->getClient()->update((int)$ticketId, $message, $change);
if ($this->printTicketStateChanges) {
printf(
"\nUpdating Trac issue #%d, status: %s\n", $ticketId, $statusToBe
);
}
}
/**
* Get a Trac XML_RPC2 client
*
* @return XML_RPC2_Client
*/
protected function getClient()
{
if (!PHPUnit_Util_Filesystem::fileExistsInIncludePath('XML/RPC2/Client.php')) {
throw new PHPUnit_Framework_Exception('PEAR/XML_RPC2 is not available.');
}
require_once 'XML/RPC2/Client.php';
$url = sprintf(
'%s://%s:%s@%s',
$this->scheme,
$this->username,
$this->password,
$this->hostpath
);
return XML_RPC2_Client::create($url, array('prefix' => 'ticket.'));
}
}