Ticket #293: amf.py

"""
AMF server for buildbot that can be used by other programs to query build status.
"""

import pyamf
from pyamf.remoting.gateway.twisted import TwistedGateway

from twisted.python import log
from buildbot.status.builder import Results
from itertools import count
from datetime import datetime   

class AMFServer(TwistedGateway):
    def __init__(self):
        self.services = {
            "buildbot.getAllBuilders":          self.getAllBuilders,
            "buildbot.getStatus":               self.getStatus,
            "buildbot.getLastBuilds":           self.getLastBuilds,
            "buildbot.getAllBuildsInInterval":  self.getAllBuildsInInterval,
            "buildbot.getBuild":                self.getBuild
        }
        TwistedGateway.__init__(self, self.services, expose_request=False)

    def render(self, req):
        # extract the IStatus and IControl objects for later use, since they
        # come from the request object. They'll be the same each time, but
        # they aren't available until the first request arrives.
        self.status = req.site.buildbot_service.getStatus()
        self.control = req.site.buildbot_service.getControl()
        
        return TwistedGateway.render(self, req)
    
    def getAllBuilders(self):
        """
        Return a list of all builder names.
        """
        log.msg("getAllBuilders")
        
        return self.status.getBuilderNames()

    def getStatus(self, builder_name):
        """
        Return the result of the last build for the given builder.
        """
        builder = self.status.getBuilder(builder_name)
        lastbuild = builder.getBuild(-1)

        if lastbuild == None:
            return lastbuild
        
        return Results[lastbuild.getResults()]

    def getLastBuilds(self, builder_name, num_builds):
        """
        Return the last N completed builds for the given builder.
        'builder_name' is the name of the builder to query
        'num_builds' is the number of builds to return

        Each build is returned in the same form as C{getAllBuildsInInterval}.
        """
        log.msg("getLastBuilds: %s - %d" % (builder_name, num_builds))
        builder = self.status.getBuilder(builder_name)
        all_builds = []
        for build_number in range(1, num_builds+1):
            build = builder.getBuild(-build_number)
            if not build:
                break
            if not build.isFinished():
                continue
            (build_start, build_end) = build.getTimes()

            ss = build.getSourceStamp()
            branch = ss.branch
            if branch is None:
                branch = ""
            try:
                revision = build.getProperty("got_revision")
            except KeyError:
                revision = ""
            revision = str(revision)

            answer = BuildInfo()
            answer.builder_name = builder_name
            answer.number = build.getNumber()
            answer.end = datetime.fromtimestamp(build_end)
            answer.branchname = branch
            answer.revision = revision
            answer.results = Results[build.getResults()]
            answer.text = build.getText()

            all_builds.append((build_end, answer))

        # now we've gotten all the builds we're interested in. Sort them by
        # end time.
        all_builds.sort(lambda a,b: cmp(a[0], b[0]))
        # and remove the timestamps
        all_builds = [t[1] for t in all_builds]

        log.msg("ready to go: %s" % (all_builds,))

        return all_builds

    def getAllBuildsInInterval(self, start, stop):
        """
        Return a list of builds that have completed after the 'start'
        timestamp and before the 'stop' timestamp. This looks at all
        Builders.

        The timestamps are integers, interpreted as standard unix timestamps
        (seconds since epoch).

        Each Build is returned as a tuple in the form::
         (buildername, buildnumber, build_end, branchname, revision,
          results, text)

        The buildnumber is an integer. 'build_end' is an integer (seconds
        since epoch) specifying when the build finished.

        The branchname is a string, which may be an empty string to indicate
        None (i.e. the default branch). The revision is a string whose
        meaning is specific to the VC system in use, and comes from the
        'got_revision' build property. The results are expressed as a string,
        one of ('success', 'warnings', 'failure', 'exception'). The text is a
        list of short strings that ought to be joined by spaces and include
        slightly more data about the results of the build.
        """
        #log.msg("start: %s %s %s" % (start, type(start), start.__class__))
        log.msg("getAllBuildsInInterval: %d - %d" % (start, stop))
        all_builds = []

        for builder_name in self.status.getBuilderNames():
            builder = self.status.getBuilder(builder_name)
            for build_number in count(1):
                build = builder.getBuild(-build_number)
                if not build:
                    break
                if not build.isFinished():
                    continue
                (build_start, build_end) = build.getTimes()
                # in reality, builds are mostly ordered by start time. For
                # the purposes of this method, we pretend that they are
                # strictly ordered by end time, so that we can stop searching
                # when we start seeing builds that are outside the window.
                if build_end > stop:
                    continue # keep looking
                if build_end < start:
                    break # stop looking

                ss = build.getSourceStamp()
                branch = ss.branch
                if branch is None:
                    branch = ""
                try:
                    revision = build.getProperty("got_revision")
                except KeyError:
                    revision = ""
                revision = str(revision)

                answer = (builder_name,
                          build.getNumber(),
                          datetime.fromtimestamp(build_end),
                          branch,
                          revision,
                          Results[build.getResults()],
                          build.getText(),
                          )
                all_builds.append((build_end, answer))
            # we've gotten all the builds that we care about from this
            # particular builder, so now we can continue on the next builder

        # now we've gotten all the builds we're interested in. Sort them by
        # end time.
        all_builds.sort(lambda a,b: cmp(a[0], b[0]))
        # and remove the timestamps
        all_builds = [t[1] for t in all_builds]

        log.msg("ready to go: %s" % (all_builds,))

        return all_builds

    def getBuild(self, builder_name, build_number, details=False):
        """
        Return information about a specific build.
        """
        builder = self.status.getBuilder(builder_name)
        build = builder.getBuild(build_number)
        info = BuildDetails()
        info.builder_name = builder.getName()
        info.url = self.status.getURLForThing(build)
        info.reason = build.getReason()
        info.slavename = build.getSlavename()
        info.results = build.getResults()
        info.text = build.getText()
        ss = build.getSourceStamp()
        build_start, build_end = build.getTimes()
        info.start = datetime.fromtimestamp(build_start)
        info.end = datetime.fromtimestamp(build_end)

        info_steps = []
        for s in build.getSteps():
            stepinfo = StepInfo()
            stepinfo.name = s.getName()
            step_start, step_end = s.getTimes()
            stepinfo.start = datetime.fromtimestamp(step_start)
            stepinfo.end = datetime.fromtimestamp(step_end)
            stepinfo.results = s.getResults()
            info_steps.append(stepinfo)
        info.steps = info_steps

        info_logs = []
        for l in build.getLogs():
            loginfo = LogInfo()
            loginfo.name = l.getStep().getName() + "/" + l.getName()
            loginfo.text = l.getText()
            info_logs.append(loginfo)
        info.logs = info_logs

        return info

class BuildInfo(object):
        def __init__(self):
            self.builder_name = None
            self.number = None
            self.end = None
            self.branchname = None
            self.revision = None
            self.results = None
            self.text = []
        
        def __repr__(self):
            return '<%s builder=%s number=%s>' % (BuildInfo.__name__, self.builder_name, self.number)
        
pyamf.register_class(BuildInfo, 'net.buildbot.build.BuildInfo')

class BuildDetails(object):
        def __init__(self):
            self.builder_name = None
            self.url = None
            self.reason = None
            self.slavename = None
            self.results = None
            self.text = []
            self.start = None
            self.end = None
            self.steps = []
            self.logs = []

        def __repr__(self):
            return '<%s builder=%s slave=%s>' % (BuildDetails.__name__, self.builder_name, self.slavename) 

pyamf.register_class(BuildDetails, 'net.buildbot.build.BuildDetails')

class StepInfo(object):
        def __init__(self):
            self.name = None
            self.start = None
            self.end = None
            self.results = []

        def __repr__(self):                                                     
            return '<%s name=%s>' % (StepInfo.__name__, self.name)

pyamf.register_class(StepInfo, 'net.buildbot.build.StepInfo')

class LogInfo(object):
        def __init__(self):
            self.name = None
            self.text = None

        def __repr__(self):
            return '<%s name=%s>' % (LogInfo.__name__, self.name)

pyamf.register_class(LogInfo, 'net.buildbot.build.LogInfo')