buildbot.slave.commands.SlaveShellCommand

Package buildbot :: Package slave :: Module commands :: Class SlaveShellCommand

Class SlaveShellCommand

Command --+
          |
         SlaveShellCommand

This is a Command which runs a shell command. The args dict contains the following keys:

['command'] (required): a shell command to run. If this is a string, it will be run with /bin/sh (['/bin/sh', '-c', command]). If it is a list (preferred), it will be used directly.
['workdir'] (required): subdirectory in which the command will be run, relative to the builder dir
['env']: a dict of environment variables to augment/replace os.environ . PYTHONPATH is treated specially, and should be a list of path components to be prepended to any existing PYTHONPATH environment variable.
['initial_stdin']: a string which will be written to the command's stdin as soon as it starts
['keep_stdin_open']: unless True, the command's stdin will be closed as soon as initial_stdin has been written. Set this to True if you plan to write to stdin after the command has been started.
['want_stdout']: 0 if stdout should be thrown away
['want_stderr']: 0 if stderr should be thrown away
['not_really']: 1 to skip execution and return rc=0
['timeout']: seconds of silence to tolerate before killing command
['logfiles']: dict mapping LogFile name to the workdir-relative filename of a local log file. This local file will be watched just like 'tail -f', and all changes will be written to 'log' status updates.

ShellCommand creates the following status messages:

Method Summary
	`closeStdin(self)`
	`interrupt(self)` Override this in a subclass to allow commands to be interrupted.
	`start(self)` Start the command.
	`writeStdin(self, data)`
Inherited from Command
	`__init__(self, builder, stepId, args)`
	`commandComplete(self, res)`
	`doInterrupt(self)`
	`doStart(self)`
	`sendStatus(self, status)` Send a status update to the master.
	`setup(self, args)` Override this in a subclass to extract items from the args dict.

Class Variable Summary
Inherited from Command
`Implements`	`__implemented__` = `<implementedBy buildbot.slave.commands...`
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`bool`	`debug` = `False`
`bool`	`interrupted` = `False`
`bool`	`running` = `False`

Method Details

Override this in a subclass to allow commands to be interrupted. May be called multiple times, test and set self.interrupted=True if this matters.

Overrides:: buildbot.slave.commands.Command.interrupt (inherited documentation)

Start the command. This method should return a Deferred that will fire when the command has completed. The Deferred's argument will be ignored.

This method should be overridden by subclasses.

Overrides:: buildbot.slave.commands.Command.start (inherited documentation)

Generated by Epydoc 2.1 on Sun Dec 10 22:04:44 2006