gdb-buildbot/master.cfg

# -*- python -*-
# ex: set syntax=python:


## TODO:
##
## - Add comments on every function/class
## - License stuff (on all files)
## - Cross testing (needed?)
## - Improve way to store and compare testcases


from buildbot.schedulers.basic import SingleBranchScheduler, AnyBranchScheduler
from buildbot.schedulers.forcesched import ForceScheduler
from buildbot.process import factory
from buildbot.process.properties import WithProperties
from buildbot.steps.shell import Compile
from buildbot.steps.shell import Configure
from buildbot.steps.shell import ShellCommand
from buildbot.steps.shell import SetPropertyFromCommand
from buildbot.steps.transfer import FileUpload
from buildbot.steps.source.git import Git
from buildbot.steps.slave import RemoveDirectory
from buildbot.changes.filter import ChangeFilter
from buildbot.buildslave import BuildSlave
from buildbot.status.results import SUCCESS, WARNINGS, FAILURE, EXCEPTION
from gdbcommand import GdbCatSumfileCommand
from gdbgitdb import SaveGDBResults, get_builder_commit_id
from urllib import quote

from sumfiles import DejaResults, set_web_base
import os.path
import urllib
from json import load
import random

####################################
####################################
#### GDB BuildBot Configuration ####
####################################
####################################

###############################
#### General Configuration ####
###############################

# This is the dictionary that the buildmaster pays attention to. We
# also use a shorter alias to save typing.
c = BuildmasterConfig = {}

# Base directory for the web server.  This is needed in order to
# compare the test results.
gdb_web_base = os.path.expanduser (os.path.join (basedir,
                                                 'public_html',
                                                 'results'))
set_web_base (gdb_web_base)

# 'protocols' contains information about protocols which master will use for
# communicating with slaves.
c['protocols'] = {'pb': {'port': 16123}}

# the 'change_source' setting tells the buildmaster how it should find out
# about source code changes.

from buildbot.changes.gitpoller import GitPoller
c['change_source'] = []
c['change_source'].append(GitPoller(
	repourl = r'git://sourceware.org/git/binutils-gdb.git',
	workdir = os.path.expanduser (os.path.join ('~/', 'buildbot-master-binutils-gdb')),
	branches = [ r'master' ],
	pollinterval = 60 * 3))

# 'status' is a list of Status Targets. The results of each build will be
# pushed to these targets. buildbot/status/*.py has a variety to choose from,
# including web pages, email senders, and IRC bots.

c['status'] = []

# Catch things like PR gdb/42, PR16, PR 16 or bug #11,
# and turn them into gdb bugzilla URLs.
cc_re_tuple = (r'(PR [a-z]+/|PR ?|#)(\d+)',
	       r'http://sourceware.org/bugzilla/show_bug.cgi?id=\2')

from buildbot.status import html
from buildbot.status.web import authz, auth

## The following class is a hack.  It is needed because Builbot's
## webserver treats everything it doesn't know as text/html.  Sigh...
# class WebStatusWithTextDefault(html.WebStatus):
#     def __init__ (self, http_port, authz, **kwargs):
#         html.WebStatus.__init__ (self, http_port = http_port,
#                                  authz = authz, **kwargs)

#     def setupSite(self):
#         result = html.WebStatus.setupSite(self)
#         self.site.resource.defaultType = r"text/plain"
#         return result

authz_cfg=authz.Authz(
    # change any of these to True to enable; see the manual for more
    # options
#    auth=auth.BasicAuth([("t","t")]),
    gracefulShutdown = False,
    forceBuild = True, # use this to test your slave once it is set up
    forceAllBuilds = True,  # ..or this
    pingBuilder = False,
    stopBuild = True,
    stopAllBuilds = True,
    cancelPendingBuild = True,
)
#c['status'].append(WebStatusWithTextDefault (http_port=8010, authz=authz_cfg))
c['status'].append (html.WebStatus (http_port = 8010, authz = authz_cfg))

#c['status'].append(html.WebStatus(http_port=8010,
#				  forceBuild = True,
#				  allowForce=False,
#				  order_console_by_time=True,
#				  changecommentlink=cc_re_tuple))

#from buildbot.status import words
#c['status'].append(words.IRC(host="irc.yyz.redhat.com", nick="sdj-gdbbot",
#			     channels=["#gdbbuild"]))

def MessageGDBTesters (mode, name, build, results, master_status):
    """This function is responsible for composing the message that will be
send to the gdb-testers mailing list."""
    git_url = "http://gdb-build.sergiodj.net/cgit"

    # Subject
    subj = "Failures on %s" % name

    # Body
    text = ""

    # Buildslave name, useful for knowing the exact configuration.
    text += "Buildslave:\n"
    text += "\t%s\n" % build.getSlavename ()

    # Commits that were tested.  Usually we should be dealing with
    # only one commit
    text += "Commit(s) tested:\n"
    ss_list = build.getSourceStamps ()
    for ss in ss_list:
        for chg in ss.changes:
            text += "\t%s\n" % chg.revision

    # Who's to blame?
    text += "Author(s) (in the same order as the commits):\n"
    for ss in ss_list:
        for chg in ss.changes:
            text += "\t%s\n" % chg.who

    # URL to find more info about what went wrong.
    text += "Log URL(s):\n"
    for ss in ss_list:
        commit_id = get_builder_commit_id (name, ss.revision)
        if commit_id:
            text += "\t<%s/%s/.git/tree/?id=%s>\n" % (git_url, name, commit_id)
        else:
            text += "\t<Error fetching commit ID for %s>\n" % ss.revision

    # Including the 'regressions' log.  This is the 'diff' of what
    # went wrong.
    text += "\n"
    print_xfail = False
    for log in build.getLogs ():
        st = log.getStep ()
        if st.getResults ()[0] == FAILURE:
            n = st.getName ()
            if n == 'update gdb master repo' or n == 'update gdb repo':
                text += "*** Failed to update GDB git repository.  This is probably a timeout problem with sourceware. ***\n"
                break
            elif n == 'configure gdb':
                text += "*** Failed to configure GDB. ***\n"
                text += "============================\n"
                text += log.getText ()
                text += "============================\n"
                break
            elif n == 'compile gdb':
                text += "*** Failed to compiled GDB.  ***\n"
                text += "============================\n"
                text += log.getText ()
                text += "============================\n"
                break
            elif n == 'make tags':
                # We do not want to break here, because if this step
                # fails the test will continue.
                text += "*** Failed to make TAGS ***\n"
                text += "Log URL: %s/steps/%s/logs/%s\n\n" % (master_status.getURLForThing (build),
                                                              quote (n), quote (log.getName ()))
                continue
            elif n == 'regressions' and log.getName () == 'regressions':
                text += "*** Regressions found ***\n"
                text += "============================\n"
                text += log.getText ()
                text += "============================\n"
                print_xfail = True
                break

    # Including the 'xfail' log.  It is important to say which tests
    # we are ignoring.
    if print_xfail:
        xfail = os.path.join (gdb_web_base, name, 'xfail')
        if os.path.exists (xfail):
            text += "\n"
            text += "Failures that are being ignored:\n\n"
            with open (xfail, 'r') as f:
                text += f.read ()
    text += "\n"
    return { 'body' : text,
             'type' : 'plain',
             'subject' : subj }

from buildbot.status import mail
mn = mail.MailNotifier(fromaddr = "sergiodj@redhat.com",
                       sendToInterestedUsers = False,
                       extraRecipients = ['gdb-testers@sourceware.org'],
                       mode = ('failing'),
                       messageFormatter = MessageGDBTesters,
                       extraHeaders = { 'X-GDB-Buildbot' : '1' })

c['status'].append (mn)

c['title'] = "GDB"
c['titleURL'] = "https://gnu.org/s/gdb"

c['buildbotURL'] = "http://gdb-build.sergiodj.net/"

c['db'] = {
    'db_url' : "sqlite:///state.sqlite",
}

#####################
#### Build steps ####
#####################

## This is where we define our build steps.  A build step is some
## command/action that buildbot will perform while building GDB.  See
## the documentation on each build step class to understand what it
## does.

class RandomWaitForClone (ShellCommand):
    """This build step is responsible for waiting a random number of
seconds before trying to update the local git repository.  This is a
hack, and is needed because sourceware imposes a load average when one
tries to update more than 3 repositories at the same time.  An obvious
FIXME for this would be to have a git mirror somewhere where we could
do more than 3 updates at a time."""
    name = "random wait for clone"
    description = r"randomly waiting before git fetching"
    descriptionDone = r"waited before git fetching"
    command = ['sleep', WithProperties (r"%ss", r'randomWait')]

class CloneOrUpdateGDBMasterRepo (Git):
    """This build step updates the so-called "master" git repository.  For
each buildslave, we have one master GDB git repository, which is then
used to create each builder's GDB git repository.  In other words,
each builder inside a buildslave will have something like:

    -- master GDB git repo
      |
      |---- builder X
          |
          |-- GDB git repo (clone from the master above)
      |
      |----- builder Y
          |
          |-- GDB git repo (clone from the master above)

and so on.  This layout helps us to save some when fetching changes
from the principal repository."""
    name = "update gdb master repo"
    description = r"fetching GDB master sources"
    descriptionDone = r"fetched GDB master sources"
    def __init__ (self):
        Git.__init__ (self,
                      repourl = r'git://sourceware.org/git/binutils-gdb.git',
                      workdir = WithProperties (r"%s/../binutils-gdb-master/",
                                                r'builddir'),
                      retryFetch = True,
                      mode = r'incremental')
        self.haltOnFailure = False
        self.flunkOnFailure = False

class CloneOrUpdateGDBRepo (Git):
    """This build step is used to clone the GDB git repository that will
be used by an specific builder (inside a buildslave).  The trick here
is to use the "reference" parameter to initialize the class, which
makes BuildBot clone the git repository mostly using the objects
present at the reference repository (i.e., locally)."""
    name = "clone gdb repo"
    description = "fetching GDB sources"
    descriptionDone = "fetched GDB sources"
    def __init__ (self):
        Git.__init__ (self,
                      repourl = 'git://sourceware.org/git/binutils-gdb.git',
                      workdir = WithProperties ('%s/binutils-gdb/', 'builddir'),
                      reference = WithProperties ("%s/../binutils-gdb-master/",
                                                  'builddir'),
                      retryFetch = True)

class ConfigureGDB (Configure):
    """This build step runs the GDB "configure" command, providing extra
flags for it if needed."""
    name = "configure gdb"
    description = r"configure GDB"
    descriptionDone = r"configured GDB"
    def __init__ (self, extra_conf_flags, **kwargs):
        Configure.__init__ (self, **kwargs)
        self.workdir = WithProperties (r"%s", r'builddir')
        self.command = ['../binutils-gdb/configure',
                        '--enable-targets=all',
                        '--disable-binutils',
                        '--disable-ld',
                        '--disable-gold',
                        '--disable-gas',
                        '--disable-sim',
                        '--disable-gprof'] + extra_conf_flags

class CompileGDB (Compile):
    """This build step runs "make" to compile the GDB sources.  It
provides extra "make" flags to "make" if needed.  It also uses the
"jobs" properties to figure out how many parallel jobs we can use when
compiling GDB; this is the "-j" flag for "make".  The value of the
"jobs" property is set at the "config.json" file, for each
buildslave."""
    name = "compile gdb"
    description = r"compile GDB"
    descriptionDone = r"compiled GDB"
    def __init__ (self, extra_make_flags = [], **kwargs):
        Compile.__init__ (self, **kwargs)
        self.workdir = WithProperties (r"%s", r'builddir')
        self.command = ['make',
                        WithProperties (r"-j%s", r'jobs'),
                        'all'] + extra_make_flags

class MakeTAGSGDB (ShellCommand):
    name = 'make tags'
    description = 'running make TAGS'
    descriptionDone = 'ran make TAGS'
    def __init__ (self, **kwargs):
        ShellCommand.__init__ (self, **kwargs)
        self.workdir = WithProperties ("%s/build/gdb", 'builddir')
        self.command = [ 'make', 'TAGS' ]
        # We do not want to stop testing when this command fails.
        self.haltOnFailure = False
        self.flunkOnFailure = False
        self.flunkOnWarnings = False

class TestGDB (ShellCommand):
    """This build step runs the full testsuite for GDB.  It can run in
parallel mode (see BuildAndTestGDBFactory below), and it will also
provide any extra flags for "make" if needed.  Unfortunately, because
our testsuite is not perfect (yet), this command must not make
BuildBot halt on failure."""
    name = "test gdb"
    description = r"testing GDB"
    descriptionDone = r"tested GDB"
    def __init__ (self, extra_make_check_flags = [], test_env = {},
                  **kwargs):
        ShellCommand.__init__ (self, decodeRC = { 0 : SUCCESS,
                                                  1 : SUCCESS,
                                                  2 : SUCCESS },
                               **kwargs)

        self.workdir = WithProperties (r"%s/build/gdb/testsuite", r'builddir')
        self.command = ['make',
                        '-k',
                        'check'] + extra_make_check_flags

        self.env = test_env
        # Needed because of dejagnu
        self.haltOnFailure = False
        self.flunkOnFailure = False
        self.flunkOnWarnings = False


#######################
#### Build Factory ####
#######################

## This is where our Build Factory is defined.  A build factory is a
## description of the build process, which is made in terms of build
## steps.  The BuildAndTestGDBFactory is the main build factory for
## GDB; it is configurable and should be more than enough to describe
## most builds.

class BuildAndTestGDBFactory (factory.BuildFactory):
    """This is the main build factory for the GDB project.  It was made to
be very configurable, and should be enough to describe most builds.
The parameters of the class are:

    - ConfigureClass: set this to be the class (i.e., build step) that
      will be called to configure GDB.  It needs to accept the same
      arguments as the ConfigureGDB class above.  The default is to
      use ConfigureGDB.

    - CompileClass: set this to be the class (i.e., build step) that
      will be called to compile GDB.  It needs to accept the same
      arguments as the CompileGDB class above.  The default is to use
      CompileGDB.

    - TestClass: set this to be the class (i.e., build step) that will
      be called to test GDB.  It needs to accept the same arguments as
      the TestGDB class above.  The default is to use TestGDB.

    - extra_conf_flags: extra flags to be passed to "configure".
      Should be a list (i.e., []).  The default is None.

    - extra_make_flags: extra flags to be passed to "make", when
      compiling.  Should be a list (i.e., []).  The default is None.

    - extra_make_check_flags: extra flags to be passed to "make
      check", when testing.  Should be a list (i.e., []).  The default
      is None.

    - test_env: extra environment variables to be passed to "make
      check", when testing.  Should be a dictionary (i.e., {}).  The
      default is None.

    - test_parallel: set to True if the test shall be parallelized.
      Default is False.  Beware that parallelizing tests may cause
      some failures due to limited system resources.

    - use_system_debuginfo: set to False if GDB should be compiled
      with the "--with-separate-debug-dir" option set to
      "/usr/lib/debug".  Default is True.
    """
    ConfigureClass = ConfigureGDB
    CompileClass = CompileGDB
    TestClass = TestGDB

    extra_conf_flags = None
    extra_make_flags = None
    extra_make_check_flags = None
    test_env = None

    # Set this to false to disable parallel testing (i.e., do not use
    # FORCE_PARALLEL)
    test_parallel = False

    # Set this to False to disable using system's debuginfo files
    # (i.e., do not use '--with-separate-debug-dir')
    use_system_debuginfo = True

    def __init__ (self, architecture_triplet = []):
        factory.BuildFactory.__init__ (self)
        self.addStep (RemoveDirectory (dir = WithProperties (r"%s/build",
                                                             r'builddir'),
                                       description = r"removing old build dir",
                                       descriptionDone = r"removed old build dir"))
        # Unfortunately we need to have this random wait, otherwise
        # git fetch won't work
        self.addStep (RandomWaitForClone ())
        self.addStep (CloneOrUpdateGDBMasterRepo ())
        self.addStep (CloneOrUpdateGDBRepo ())

        if not self.extra_conf_flags:
            self.extra_conf_flags = []

        if self.use_system_debuginfo:
            self.extra_conf_flags.append (r'--with-separate-debug-dir=/usr/lib/debug')

        self.addStep (self.ConfigureClass (self.extra_conf_flags + architecture_triplet))

        if not self.extra_make_flags:
            self.extra_make_flags = []
        self.addStep (self.CompileClass (self.extra_make_flags))

        # Disabling this until we figure out how to properly run + test
#        self.addStep (MakeTAGSGDB ())

        if not self.extra_make_check_flags:
            self.extra_make_check_flags = []
        if not self.test_env:
            self.test_env = {}

        if self.test_parallel:
            self.extra_make_check_flags.append (WithProperties (r"-j%s", r'jobs'))
            self.extra_make_check_flags.append (r'FORCE_PARALLEL=1')

        self.addStep (self.TestClass (self.extra_make_check_flags, self.test_env))

        self.addStep (GdbCatSumfileCommand (workdir = WithProperties (r'%s/build/gdb/testsuite',
                                                                      r'builddir'),
                                            description = r'analyze test results'))
        self.addStep (FileUpload (slavesrc = WithProperties (r"%s/build/gdb/testsuite/gdb.log",
                                                             r'builddir'),
                                  masterdest = WithProperties (r"public_html/results/%s/gdb.log",
                                                               r'buildername')))
#                                  masterdest = WithProperties (r"public_html/results/%s/%s/gdb.log",
#                                                               r'buildername',
#                                                               r'got_revision')))
        self.addStep (SaveGDBResults ())


##################
#### Builders ####
##################

## This section describes our builders.  The builders are instances of
## a build factory, and they will be used to do a specific build of
## the project.
##
## The nomenclature here is important.  Every builder should start
## with the prefix "RunTestGDB", and then be followed by the testing
## scenario that the build will test, followed by "_cXXtYY", where XX
## is the bitness of the compilation, and YY is the bitness of the
## testing.  So, for example, if we are specifically testing GDB
## running the native-gdbserver tests, compiling GDB on a 64-bit
## machine, but running the tests in 32-bit mode, our builder would be called:
##
##     RunTestGDBNativeGDBServer_c64t32

class RunTestGDBPlain_c64t64 (BuildAndTestGDBFactory):
    """Compiling for 64-bit, testing on 64-bit."""
    pass

class RunTestGDBPlain_c32t32 (BuildAndTestGDBFactory):
    """Compiling on 32-bit, testing on 32-bit."""
    extra_conf_flags = [ r'CFLAGS=-m32' ]
    extra_make_check_flags = [ r'RUNTESTFLAGS=--target_board unix/-m32' ]

class RunTestGDBm32_c64t32 (BuildAndTestGDBFactory):
    """Compiling on 64-bit, testing on 32-bit."""
    extra_make_check_flags = [ r'RUNTESTFLAGS=--target_board unix/-m32' ]

class RunTestGDBNativeGDBServer_c64t64 (BuildAndTestGDBFactory):
    """Compiling on 64-bit, testing native-gdbserver on 64-bit."""
    extra_make_check_flags = [ r'RUNTESTFLAGS=--target_board native-gdbserver' ]

class RunTestGDBNativeGDBServer_c64t32 (BuildAndTestGDBFactory):
    """Compiling on 64-bit, testing native-gdbserver on 32-bit."""
    extra_make_check_flags = [ r'RUNTESTFLAGS=--target_board native-gdbserver/-m32' ]

class RunTestGDBNativeExtendedGDBServer_c64t64 (BuildAndTestGDBFactory):
    """Compiling on 64-bit, testing native-extended-gdbserver on 64-bit."""
    extra_make_check_flags = [ r'RUNTESTFLAGS=--target_board native-extended-gdbserver' ]

class RunTestGDBNativeExtendedGDBServer_c64t32 (BuildAndTestGDBFactory):
    """Compiling on 64-bit, testing native-extended-gdbserver on 32-bit."""
    extra_make_check_flags = [ r'RUNTESTFLAGS=--target_board native-extended-gdbserver/-m32' ]

class RunTestGDBIndexBuild (BuildAndTestGDBFactory):
    """Testing with the "cc-with-tweaks.sh" passing -i.  FIXME: include bitness here."""
    extra_make_check_flags = [ WithProperties (r'CC_FOR_TARGET=/bin/sh %s/binutils-gdb/gdb/contrib/cc-with-tweaks.sh -i gcc', r'builddir'),
                               WithProperties (r'CXX_FOR_TARGET=/bin/sh %s/binutils-gdb/gdb/contrib/cc-with-tweaks.sh -i g++', r'builddir') ]


# For now, we only support testing the "master" branch.
master_filter = ChangeFilter (branch = [ r'master' ])

###############################
#### Configuration loading ####
###############################

## This is "the heart" of this file.  This function is responsible for
## loading the configuration present in the "lib/config.json" file,
## and initializing everything needed for BuildBot to work.  Most of
## this function was copied from WebKit's BuildBot configuration, with
## lots of tweaks.

def load_config (c):
    config = load (open ("lib/config.json"))
    passwd = load (open ("lib/passwords.json"))

    random.seed ()
    c['slaves'] = [BuildSlave (slave['name'], passwd[slave['name']],
                               max_builds = 1,
                               properties = { 'jobs' : slave['jobs'],
                                              'randomWait' : "%d" % random.randrange (1, 30) })
                   for slave in config['slaves']]

    c['schedulers'] = []
    for s in config['schedulers']:
        if "change_filter" in s:
            s['change_filter'] = globals ()[s['change_filter']]
        kls = globals ()[s.pop ('type')]
        s = dict (map (lambda key_value_pair : (str (key_value_pair[0]),
                                                key_value_pair[1]),
                       s.items ()))
        c['schedulers'].append (kls (**s))

    c['builders'] = []
    for b in config['builders']:
        if 'arch_triplet' in b:
            arch_triplet = [ b.pop ('arch_triplet') ]
        else:
            arch_triplet = []
        btype = b.pop ('type')
        factory = globals ()[ "RunTestGDB%s" % btype ]
        b['factory'] = factory (arch_triplet)
        c['builders'].append (b)

load_config (c)