Package buildbot :: Package steps :: Module vstudio :: Class VisualStudio
[frames] | no frames]

Class VisualStudio

source code

   process.buildstep.BuildStep --+        
                                 |        
process.buildstep.LoggingBuildStep --+    
                                     |    
                    shell.ShellCommand --+
                                         |
                                        VisualStudio
Known Subclasses:

Instance Methods
 
__init__(self, **kwargs) source code
 
setupProgress(self) source code
 
setupLogfiles(self, cmd, logfiles)
Set up any additional logfiles= logs.
source code
 
setupEnvironment(self, cmd) source code
 
describe(self, done=False)
Return a list of short strings to describe this step, for the status display.
source code
 
createSummary(self, log)
To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)
source code
 
evaluateCommand(self, cmd)
Decide whether the command was SUCCESS, WARNINGS, or FAILURE.
source code
 
finished(self, result) source code

Inherited from shell.ShellCommand: checkForOldSlaveAndLogfiles, setCommand, setDefaultWorkdir, setStepStatus, start

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, getText, getText2, interrupt, maybeGetText2, setStatus, startCommand

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

Class Variables
  name = 'compile'
  description = 'compiling'
  descriptionDone = 'compile'
  logobserver = None
  installdir = None
  mode = 'rebuild'
  projectfile = None
  config = None
  useenv = False
  PATH = []
  INCLUDE = []
  LIB = []

Inherited from shell.ShellCommand: flunkOnFailure

Inherited from process.buildstep.LoggingBuildStep: parms, progressMetrics

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

Instance Variables

Inherited from shell.ShellCommand: command, lazylogfiles, logfiles

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

Method Details

__init__(self, **kwargs)
(Constructor)

source code 
Overrides: process.buildstep.BuildStep.__init__

setupProgress(self)

source code 
Overrides: process.buildstep.BuildStep.setupProgress

setupLogfiles(self, cmd, logfiles)

source code 

Set up any additional logfiles= logs.

Overrides: process.buildstep.LoggingBuildStep.setupLogfiles
(inherited documentation)

setupEnvironment(self, cmd)

source code 
Overrides: shell.ShellCommand.setupEnvironment

describe(self, done=False)

source code 

Return a list of short strings to describe this step, for the status display. This uses the first few words of the shell command. You can replace this by setting .description in your subclass, or by overriding this method to describe the step better.

Parameters:
  • done - whether the command is complete or not, to improve the way the command is described. done=False is used while the command is still running, so a single imperfect-tense verb is appropriate ('compiling', 'testing', ...) done=True is used when the command has finished, and the default getText() method adds some text, so a simple noun is appropriate ('compile', 'tests' ...)
Overrides: process.buildstep.BuildStep.describe

createSummary(self, log)

source code 

To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)

Overrides: process.buildstep.LoggingBuildStep.createSummary
(inherited documentation)

evaluateCommand(self, cmd)

source code 

Decide whether the command was SUCCESS, WARNINGS, or FAILURE. Override this to, say, declare WARNINGS if there is any stderr activity, or to say that rc!=0 is not actually an error.

Overrides: process.buildstep.LoggingBuildStep.evaluateCommand
(inherited documentation)

finished(self, result)

source code 
Overrides: process.buildstep.BuildStep.finished