l.b.m.b.BuildFarmJobBehaviourBase : class documentation

Part of lp.buildmaster.model.buildfarmjobbehaviour View In Hierarchy

Known subclasses: lp.code.model.recipebuilder.RecipeBuildBehaviour, lp.snappy.model.snapbuildbehaviour.SnapBuildBehaviour, lp.soyuz.model.binarypackagebuildbehaviour.BinaryPackageBuildBehaviour, lp.soyuz.model.livefsbuildbehaviour.LiveFSBuildBehaviour, lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

Ensures that all behaviours inherit the same initialization.

All build-farm job behaviours should inherit from this.

Method	__init__	Store a reference to the job_type with which we were created.
Method	archive	Undocumented
Method	distro_arch_series	Undocumented
Method	pocket	Undocumented
Method	setBuilder	The builder should be set once and not changed.
Method	determineFilesToSend	The default behaviour is to send no files.
Method	extraBuildArgs	The default behaviour is to send only common extra arguments.
Method	composeBuildRequest	Undocumented
Method	verifyBuildRequest	The default behaviour is a no-op.
Method	dispatchBuildToSlave	See `IBuildFarmJobBehaviour`.
Method	getUploadDirLeaf	See `IPackageBuild`.
Method	transferSlaveFileToLibrarian	Transfer a file from the slave to the librarian.
Method	getLogFileName	Return the preferred file name for this job's log.
Method	getLogFromSlave	Return a Deferred which fires when the log is in the librarian.
Method	storeLogFromSlave	See `IBuildFarmJob`.
Method	verifySuccessfulBuild	See `IBuildFarmJobBehaviour`.
Method	handleStatus	See `IBuildFarmJobBehaviour`.
Method	handleSuccess	Handle a package that built successfully.

def __init__(self, build):

Store a reference to the job_type with which we were created.

@property
def archive(self):

overridden in lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

Undocumented

@property
def distro_arch_series(self):

overridden in lp.code.model.recipebuilder.RecipeBuildBehaviour, lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

Undocumented

@property
def pocket(self):

overridden in lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

Undocumented

def setBuilder(self, builder, slave):

The builder should be set once and not changed.

def determineFilesToSend(self):

overridden in lp.soyuz.model.binarypackagebuildbehaviour.BinaryPackageBuildBehaviour

The default behaviour is to send no files.

def extraBuildArgs(self, logger=None):

overridden in lp.code.model.recipebuilder.RecipeBuildBehaviour, lp.snappy.model.snapbuildbehaviour.SnapBuildBehaviour, lp.soyuz.model.binarypackagebuildbehaviour.BinaryPackageBuildBehaviour, lp.soyuz.model.livefsbuildbehaviour.LiveFSBuildBehaviour, lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

The default behaviour is to send only common extra arguments.

@defer.inlineCallbacks
def composeBuildRequest(self, logger):

Undocumented

def verifyBuildRequest(self, logger):

The default behaviour is a no-op.

@defer.inlineCallbacks
def dispatchBuildToSlave(self, logger):

See IBuildFarmJobBehaviour.

def getUploadDirLeaf(self, build_cookie, now=None):

See IPackageBuild.

def transferSlaveFileToLibrarian(self, file_sha1, filename, private):

Transfer a file from the slave to the librarian.

Parameters	file_sha1	The file's sha1, which is how the file is addressed in the slave XMLRPC protocol. Specially, the file_sha1 'buildlog' will cause the build log to be retrieved and gzipped.
	filename	The name of the file to be given to the librarian file alias.
	private	True if the build is for a private archive.
Returns	A Deferred that calls back with a librarian file alias.

def getLogFileName(self):

overridden in lp.snappy.model.snapbuildbehaviour.SnapBuildBehaviour, lp.soyuz.model.binarypackagebuildbehaviour.BinaryPackageBuildBehaviour, lp.soyuz.model.livefsbuildbehaviour.LiveFSBuildBehaviour, lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

Return the preferred file name for this job's log.

def getLogFromSlave(self, queue_item):

Return a Deferred which fires when the log is in the librarian.

@defer.inlineCallbacks
def storeLogFromSlave(self, build_queue=None):

See IBuildFarmJob.

def verifySuccessfulBuild(self):

overridden in lp.snappy.model.snapbuildbehaviour.SnapBuildBehaviour, lp.soyuz.model.livefsbuildbehaviour.LiveFSBuildBehaviour

See IBuildFarmJobBehaviour.

@defer.inlineCallbacks
def handleStatus(self, bq, status, slave_status):

See IBuildFarmJobBehaviour.

@defer.inlineCallbacks
def handleSuccess(self, slave_status, logger):

overridden in lp.translations.model.translationtemplatesbuildbehaviour.TranslationTemplatesBuildBehaviour

Handle a package that built successfully.

Once built successfully, we pull the files, store them in a directory, store build information and push them through the uploader.

API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.