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
|
# This file is part of Buildbot. Buildbot is free software: you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright Buildbot Team Members
import stat
from twisted.internet import defer
from buildbot.process import buildstep
from buildbot.status.results import SUCCESS, FAILURE
from buildbot.interfaces import BuildSlaveTooOldError
class SlaveBuildStep(buildstep.BuildStep):
def describe(self, done=False):
return self.descriptionDone if done else self.description
class SetPropertiesFromEnv(SlaveBuildStep):
"""
Sets properties from envirionment variables on the slave.
Note this is transfered when the slave first connects
"""
name='SetPropertiesFromEnv'
description=['Setting']
descriptionDone=['Set']
def __init__(self, variables, source="SlaveEnvironment", **kwargs):
buildstep.BuildStep.__init__(self, **kwargs)
self.variables = variables
self.source = source
def start(self):
# on Windows, environment variables are case-insensitive, but we have
# a case-sensitive dictionary in slave_environ. Fortunately, that
# dictionary is also folded to uppercase, so we can simply fold the
# variable names to uppercase to duplicate the case-insensitivity.
fold_to_uppercase = (self.buildslave.slave_system == 'win32')
properties = self.build.getProperties()
environ = self.buildslave.slave_environ
variables = self.variables
log = []
if isinstance(variables, str):
variables = [self.variables]
for variable in variables:
key = variable
if fold_to_uppercase:
key = variable.upper()
value = environ.get(key, None)
if value:
# note that the property is not uppercased
properties.setProperty(variable, value, self.source,
runtime=True)
log.append("%s = %r" % (variable, value))
self.addCompleteLog("properties", "\n".join(log))
self.step_status.setText(self.describe(done=True))
self.finished(SUCCESS)
class FileExists(SlaveBuildStep):
"""
Check for the existence of a file on the slave.
"""
name='FileExists'
description='Checking'
descriptionDone='Checked'
renderables = [ 'file' ]
haltOnFailure = True
flunkOnFailure = True
def __init__(self, file, **kwargs):
buildstep.BuildStep.__init__(self, **kwargs)
self.file = file
def start(self):
slavever = self.slaveVersion('stat')
if not slavever:
raise BuildSlaveTooOldError("slave is too old, does not know "
"about stat")
cmd = buildstep.RemoteCommand('stat', {'file': self.file })
d = self.runCommand(cmd)
d.addCallback(lambda res: self.commandComplete(cmd))
d.addErrback(self.failed)
def commandComplete(self, cmd):
if cmd.didFail():
self.step_status.setText(["File not found."])
self.finished(FAILURE)
return
s = cmd.updates["stat"][-1]
if stat.S_ISREG(s[stat.ST_MODE]):
self.step_status.setText(["File found."])
self.finished(SUCCESS)
else:
self.step_status.setText(["Not a file."])
self.finished(FAILURE)
class CopyDirectory(SlaveBuildStep):
"""
Copy a directory tree on the slave.
"""
name='CopyDirectory'
description=['Copying']
descriptionDone=['Copied']
renderables = [ 'src', 'dest' ]
haltOnFailure = True
flunkOnFailure = True
def __init__(self, src, dest, timeout=None, maxTime=None, **kwargs):
buildstep.BuildStep.__init__(self, **kwargs)
self.src = src
self.dest = dest
self.timeout = timeout
self.maxTime = maxTime
def start(self):
slavever = self.slaveVersion('cpdir')
if not slavever:
raise BuildSlaveTooOldError("slave is too old, does not know "
"about cpdir")
args = {'fromdir': self.src, 'todir': self.dest }
if self.timeout:
args['timeout'] = self.timeout
if self.maxTime:
args['maxTime'] = self.maxTime
cmd = buildstep.RemoteCommand('cpdir', args)
d = self.runCommand(cmd)
d.addCallback(lambda res: self.commandComplete(cmd))
d.addErrback(self.failed)
def commandComplete(self, cmd):
if cmd.didFail():
self.step_status.setText(["Copying", self.src, "to", self.dest, "failed."])
self.finished(FAILURE)
return
self.step_status.setText(self.describe(done=True))
self.finished(SUCCESS)
def describe(self, done=False):
desc = self.descriptionDone if done else self.description
desc = desc[:]
desc.extend([self.src, "to", self.dest])
return desc
class RemoveDirectory(SlaveBuildStep):
"""
Remove a directory tree on the slave.
"""
name='RemoveDirectory'
description=['Deleting']
descriptionDone=['Deleted']
renderables = [ 'dir' ]
haltOnFailure = True
flunkOnFailure = True
def __init__(self, dir, **kwargs):
buildstep.BuildStep.__init__(self, **kwargs)
self.dir = dir
def start(self):
slavever = self.slaveVersion('rmdir')
if not slavever:
raise BuildSlaveTooOldError("slave is too old, does not know "
"about rmdir")
cmd = buildstep.RemoteCommand('rmdir', {'dir': self.dir })
d = self.runCommand(cmd)
d.addCallback(lambda res: self.commandComplete(cmd))
d.addErrback(self.failed)
def commandComplete(self, cmd):
if cmd.didFail():
self.step_status.setText(["Delete failed."])
self.finished(FAILURE)
return
self.step_status.setText(self.describe(done=True))
self.finished(SUCCESS)
class MakeDirectory(SlaveBuildStep):
"""
Create a directory on the slave.
"""
name='MakeDirectory'
description=['Creating']
descriptionDone=['Created']
renderables = [ 'dir' ]
haltOnFailure = True
flunkOnFailure = True
def __init__(self, dir, **kwargs):
buildstep.BuildStep.__init__(self, **kwargs)
self.dir = dir
def start(self):
slavever = self.slaveVersion('mkdir')
if not slavever:
raise BuildSlaveTooOldError("slave is too old, does not know "
"about mkdir")
cmd = buildstep.RemoteCommand('mkdir', {'dir': self.dir })
d = self.runCommand(cmd)
d.addCallback(lambda res: self.commandComplete(cmd))
d.addErrback(self.failed)
def commandComplete(self, cmd):
if cmd.didFail():
self.step_status.setText(["Create failed."])
self.finished(FAILURE)
return
self.step_status.setText(self.describe(done=True))
self.finished(SUCCESS)
class CompositeStepMixin():
"""I define utils for composite steps, factorizing basic remote commands"""
def addLogForRemoteCommands(self, logname):
"""This method must be called by user classes
composite steps could create several logs, this mixin functions will write
to the last one.
"""
self.rc_log = self.addLog(logname)
return self.rc_log
def runRemoteCommand(self, cmd, args, abandonOnFailure=True):
"""generic RemoteCommand boilerplate"""
cmd = buildstep.RemoteCommand(cmd, args)
cmd.useLog(self.rc_log, False)
d = self.runCommand(cmd)
def commandComplete(cmd):
if abandonOnFailure and cmd.didFail():
raise buildstep.BuildStepFailed()
return cmd.didFail()
d.addCallback(lambda res: commandComplete(cmd))
return d
def runRmdir(self, dir, **kwargs):
""" remove a directory from the slave """
return self.runRemoteCommand('rmdir',
{'dir': dir, 'logEnviron': self.logEnviron },
**kwargs)
@defer.inlineCallbacks
def pathExists(self, path):
""" test whether path exists"""
res = yield self.runRemoteCommand('stat', {'file': path,
'logEnviron': self.logEnviron,},
abandonOnFailure=False)
defer.returnValue(not res)
def runMkdir(self, _dir, **kwargs):
""" create a directory and its parents"""
return self.runRemoteCommand('mkdir', {'dir': _dir,
'logEnviron': self.logEnviron,},
**kwargs)
|
