Package buildbot :: Package steps :: Module transfer :: Class FileUpload
[frames] | no frames]

Class FileUpload

source code

process.buildstep.BuildStep --+    
             _TransferBuildStep --+

Build step to transfer a file from the slave to the master.


- ['slavesrc']   filename of source file at slave, relative to workdir
- ['masterdest'] filename of destination file at master
- ['workdir']    string with slave working directory relative to builder
                 base dir, default 'build'
- ['maxsize']    maximum size of the file, default None (=unlimited)
- ['blocksize']  maximum size of each block being transfered
- ['mode']       file access mode for the resulting master-side file.
                 The default (=None) is to leave it up to the umask of
                 the buildmaster process.
- ['keepstamp']  whether to preserve file modified and accessed times

Instance Methods
__init__(self, slavesrc, masterdest, workdir=None, maxsize=None, blocksize=16384, mode=None, keepstamp=False, **buildstep_kwargs) source code
Begin the step.
source code

Inherited from _TransferBuildStep: finished, interrupt, setDefaultWorkdir

Inherited from process.buildstep.BuildStep: acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, describe, failed, getLog, getProperty, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuild, setBuildSlave, setProgress, setProperty, setStepStatus, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Class Variables
  name = 'upload'
  renderables = ['slavesrc', 'masterdest']

Inherited from _TransferBuildStep: DEFAULT_WORKDIR, flunkOnFailure, haltOnFailure

Inherited from process.buildstep.BuildStep: alwaysRun, doStepIf, flunkOnWarnings, locks, parms, progressMetrics, useProgress, warnOnFailure, warnOnWarnings

Instance Variables

Inherited from process.buildstep.BuildStep: build, progress, step_status

Method Details

__init__(self, slavesrc, masterdest, workdir=None, maxsize=None, blocksize=16384, mode=None, keepstamp=False, **buildstep_kwargs)

source code 
Overrides: process.buildstep.BuildStep.__init__


source code 

Begin the step. Override this method and add code to do local processing, fire off remote commands, etc.

To spawn a command in the buildslave, create a RemoteCommand instance and run it with self.runCommand:

 c = RemoteCommandFoo(args)
 d = self.runCommand(c)

As the step runs, it should send status information to the BuildStepStatus:

 self.step_status.setText(['compile', 'failed'])
 self.step_status.setText2(['4', 'warnings'])

To have some code parse stdio (or other log stream) in realtime, add a LogObserver subclass. This observer can use self.step.setProgress() to provide better progress notification to the step.:

 self.addLogObserver('stdio', MyLogObserver())

To add a LogFile, use self.addLog. Make sure it gets closed when it finishes. When giving a Logfile to a RemoteShellCommand, just ask it to close the log when the command completes:

 log = self.addLog('output')
 cmd = RemoteShellCommand(args)
 cmd.useLog(log, closeWhenFinished=True)

You can also create complete Logfiles with generated text in a single step:

 self.addCompleteLog('warnings', text)

When the step is done, it should call self.finished(result). 'result' will be provided to the, and should be one of the constants defined above: SUCCESS, WARNINGS, FAILURE, or SKIPPED.

If the step encounters an exception, it should call self.failed(why). 'why' should be a Failure object. This automatically fails the whole build with an exception. It is a good idea to add self.failed as an errback to any Deferreds you might obtain.

If the step decides it does not need to be run, start() can return the constant SKIPPED. This fires the callback immediately: it is not necessary to call .finished yourself. This can also indicate to the status-reporting mechanism that this step should not be displayed.

A step can be configured to only run under certain conditions. To do this, set the step's doStepIf to a boolean value, or to a function that returns a boolean value. If the value or function result is False, then the step will return SKIPPED without doing anything, otherwise the step will be executed normally. If you set doStepIf to a function, that function should accept one parameter, which will be the Step object itself.

Overrides: process.buildstep.BuildStep.start
(inherited documentation)