Class SlaveShellCommand

source code

base.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
• ['usePTY']: True or False if the command should use a PTY (defaults to configuration of the slave)
• ['not_really']: 1 to skip execution and return rc=0
• ['timeout']: seconds of silence to tolerate before killing command
• ['maxTime']: seconds 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.
• ['logEnviron']: False to not log the environment variables on the slave

ShellCommand creates the following status messages:

• {'stdout': data} : when stdout data is available
• {'stderr': data} : when stderr data is available
• {'header': data} : when headers (command start/stop) are available
• {'log': (logfile_name, data)} : when log files have new contents
• {'rc': rc} : when the process has terminated