4.13.1.3 XMLRPC server

When using WebStatus, the buildbot runs an XML-RPC server at /xmlrpc that can be used by other programs to query build status. The following table lists the methods that can be invoked using this interface.

getAllBuilders()

Return a list of the names of all builders.

getLastBuildResults(builder_name)

Return the build result for the last completed build by the given builder. The result is a string, one of "success", "warnings", "failure", "skipped", "exception", or "retry".

getLastBuilds(builder_name, num_builds)

Get the last NUM_BUILDS builds completed by the named builder. The return value is an array, with each build represented as an array with the following items

• builder name
• build number
• start time (seconds since epoch)
• end time (seconds since epoch)
• branch
• revision
• result (same format as getLastBuildResults)
• text
• reasons (list of strings giving reasosn for that steps failed)

getLastBuildsAllBuilders(num_builds)

Similar to getLastBuilds, but returns the last builds for all builders. This method can consume a lot of buildmaster CPU and disk resources.

getAllBuildsInInterval(start, stop)

Return a list of builds that have completed after the 'start' timestamp and before the 'stop' timestamp, both given as seconds since the epoch. This looks at all builders. Each build is returned in a format similar to, but not the same as that for getLastBuilds. In particular, the start time and reasons are omitted.

getBuild(builder_name, build_number)

Return information about a specific build.

This returns a dictionary (a struct in XMLRPC terms) with complete information about the build. Because it extracts log information, this call is a very heavyweight operation for the buildmaster.

Keys include:

builder_name

url

reason

slavename

results

text

reasons

Just as for getLastBuilds, above.

number

The build number

branch

revision

start

end

steps

See below.

full_error

logs

See below.

The steps key is a list of information about each step in the build, with keys

name

start

end

results

This is a list of (integer result, text) that is probably not useful to callers.

text

The full_error and logs keys contains most of the build's logfiles, in an odd format. The full_error key contains a hash keyed by step name, but containing only failed logs. The values are the text of an arbitrary one of the logs for each failing step.

The logs key is a list of logs, each of which is represented by a hash with keys name, in the format stepname/logname, and text, which is always the constant string HUGE.