l.b.i.BuilderSlave(object) : class documentation

Add in a few useful methods for the XMLRPC slave.

Instance Variables url The URL of the actual builder. The XML-RPC resource and the filecache live beneath this.

Method	__init__	Initialize a BuilderSlave.
Class Method	makeBuilderSlave	Create and return a `BuilderSlave`.
Method	abort	Abort the current build.
Method	clean	Clean up the waiting files and reset the slave's internal state.
Method	echo	Echo the arguments back.
Method	info	Return the protocol version and the builder methods supported.
Method	status	Return the status of the build daemon.
Method	ensurepresent	Attempt to ensure the given file is present.
Method	getURL	Get the URL for a file on the builder with a given SHA-1.
Method	getFile	Fetch a file from the builder.
Method	getFiles	Fetch many files from the builder.
Method	resume	Resume the builder in an asynchronous fashion.
Method	sendFileToSlave	Helper to send the file at 'url' with 'sha1' to this builder.
Method	build	Build a thing on this build slave.
Method	_with_timeout	Undocumented

def __init__(self, proxy, builder_url, vm_host, timeout, reactor, pool):

Initialize a BuilderSlave.

Parameters	proxy	An XML-RPC proxy, implementing 'callRemote'. It must support passing and returning None objects.
	builder_url	The URL of the builder.
	vm_host	The VM host to use when resuming.

@classmethod
def makeBuilderSlave(cls, builder_url, vm_host, timeout, reactor=None, proxy=None, pool=None):

Create and return a BuilderSlave.

Parameters	builder_url	The URL of the slave buildd machine, e.g. http://localhost:8221
	vm_host	If the slave is virtual, specify its host machine here.
	reactor	Used by tests to override the Twisted reactor.
	proxy	Used By tests to override the xmlrpc.Proxy.
	pool	Used by tests to override the HTTPConnectionPool.

def _with_timeout(self, d, timeout=None):

Undocumented

def abort(self):

Abort the current build.

def clean(self):

Clean up the waiting files and reset the slave's internal state.

def echo(self, *args):

Echo the arguments back.

def info(self):

Return the protocol version and the builder methods supported.

def status(self):

Return the status of the build daemon.

def ensurepresent(self, sha1sum, url, username, password):

Attempt to ensure the given file is present.

def getURL(self, sha1):

Get the URL for a file on the builder with a given SHA-1.

def getFile(self, sha_sum, file_to_write, logger=None):

Fetch a file from the builder.

Parameters	sha_sum	The sha of the file (which is also its name on the builder)
	file_to_write	A file name or file-like object to write the file to
	logger	An optional logger.
Returns	A Deferred that calls back when the download is done, or errback with the error string.

def getFiles(self, files, logger=None):

Fetch many files from the builder.

Parameters	files	A sequence of pairs of the builder file name to retrieve and the file name or file object to write the file to.
	logger	An optional logger.
Returns	A DeferredList that calls back when the download is done.

def resume(self, clock=None):

Resume the builder in an asynchronous fashion.

We use the builddmaster configuration 'socket_timeout' as the process timeout.

Parameters	clock	An optional twisted.internet.task.Clock to override the default clock. For use in tests.
Returns	a Deferred that returns a (stdout, stderr, subprocess exitcode) triple

@defer.inlineCallbacks
def sendFileToSlave(self, sha1, url, username='', password='', logger=None):

Helper to send the file at 'url' with 'sha1' to this builder.

def build(self, buildid, builder_type, chroot_sha1, filemap, args):

Build a thing on this build slave.

Parameters	buildid	A string identifying this build.
	builder_type	The type of builder needed.
	chroot_sha1	XXX
	filemap	A dictionary mapping from paths to SHA-1 hashes of the file contents.
	args	A dictionary of extra arguments. The contents depend on the build job type.

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