invirtibuilder

   1 #!/usr/bin/python
   2
   3 """Process the Invirt build queue.
   4
   5 The Invirtibuilder handles package builds and uploads. On demand, it
   6 attempts to build a particular package.
   7
   8 If the build succeeds, the new version of the package is uploaded to
   9 the apt repository, tagged in its git repository, and the Invirt
  10 superproject is updated to point at the new version.
  11
  12 If the build fails, the Invirtibuilder sends mail with the build log.
  13
  14 The build queue is tracked via files in /var/lib/invirt-dev/queue. In
  15 order to maintain ordering, all filenames in that directory are the
  16 timestamp of their creation time.
  17
  18 Each queue file contains a file of the form
  19
  20     pocket package hash principal
  21
  22 where pocket is one of the pockets globally configured in
  23 build.pockets. For instance, the pockets in XVM are "prod" and "dev".
  24
  25 principal is the Kerberos principal that requested the build.
  26 """
  27
  28
  29 from __future__ import with_statement
  30
  31 import contextlib
  32 import glob
  33 import os
  34 import re
  35 import shutil
  36 import subprocess
  37 import tempfile
  38 import traceback
  39
  40 import pyinotify
  41
  42 from debian_bundle import deb822
  43
  44 import invirt.builder as b
  45 import invirt.common as c
  46 from invirt import database
  47 from invirt.config import structs as config
  48
  49
  50 logfile = None
  51
  52 def logAndRun(cmd, *args, **kwargs):
  53     # Always grab stdout, even if the caller doesn't need it.
  54     # TODO: don't slurp it all into memory in that case.
  55     if 'stdout' in kwargs and kwargs['stdout'] is None:
  56         del kwargs['stdout']
  57     kwargs['stderr'] = logfile
  58     logfile.write('---> Ran %s\n' % (cmd, ))
  59     if 'stdin_str' in kwargs:
  60         logfile.write('STDIN:\n')
  61         logfile.write(kwargs['stdin_str'])
  62     logfile.write('STDERR:\n')
  63     output = c.captureOutput(cmd, *args, **kwargs)
  64     logfile.write('STDOUT:\n')
  65     logfile.write(output)
  66     return output
  67
  68 def getControl(package, ref):
  69     """Get the parsed debian/control file for a given package.
  70
  71     This returns a list of debian_bundle.deb822.Deb822 objects, one
  72     for each section of the debian/control file. Each Deb822 object
  73     acts roughly like a dict.
  74     """
  75     return deb822.Deb822.iter_paragraphs(
  76         b.getGitFile(package, ref, 'debian/control').split('\n'))
  77
  78
  79 def getBinaries(package, ref):
  80     """Get a list of binary packages in a package at a given ref."""
  81     return [p['Package'] for p in getControl(package, ref)
  82             if 'Package' in p]
  83
  84
  85 def getArches(package, ref):
  86     """Get the set of all architectures in any binary package."""
  87     arches = set()
  88     for section in getControl(package, ref):
  89         if 'Architecture' in section:
  90             arches.update(section['Architecture'].split())
  91     return arches
  92
  93
  94 def getDscName(package, ref):
  95     """Return the .dsc file that will be generated for this package."""
  96     v = b.getVersion(package, ref)
  97     if v.debian_version:
  98         v_str = '%s-%s' % (v.upstream_version,
  99                            v.debian_version)
 100     else:
 101         v_str = v.upstream_version
 102     return '%s_%s.dsc' % (
 103         package,
 104         v_str)
 105
 106
 107 def sanitizeVersion(version):
 108     """Sanitize a Debian package version for use as a git tag.
 109
 110     This function strips the epoch from the version number and
 111     replaces any tildes with underscores."""
 112     if version.debian_version:
 113         v = '%s-%s' % (version.upstream_version,
 114                        version.debian_version)
 115     else:
 116         v = version.upstream_version
 117     return v.replace('~', '_')
 118
 119
 120 def aptCopy(package, commit, dst_pocket, src_pocket):
 121     """Copy a package from one pocket to another."""
 122     binaries = getBinaries(package, commit)
 123     logAndRun(['reprepro-env', 'copy',
 124                b.pocketToApt(dst_pocket),
 125                b.pocketToApt(src_pocket),
 126                package] + binaries)
 127
 128
 129 def sbuild(package, ref, distro, arch, workdir, arch_all=False):
 130     """Build a package for a particular architecture and distro."""
 131     # We append a suffix like ~ubuntu8.04 to differentiate the same
 132     # version built for multiple distros
 133     nmutag = b.distroToSuffix(distro)
 134     env = os.environ.copy()
 135     env['NMUTAG'] = nmutag
 136
 137     # Run sbuild with a hack in place to append arbitrary versions
 138     args = ['perl', '-I/usr/share/invirt-dev', '-MSbuildHack',
 139             '/usr/bin/sbuild',
 140             '--binNMU=171717', '--make-binNMU=Build with sbuild',
 141             '-v', '-d', distro, '--arch', arch]
 142     if arch_all:
 143         args.append('-A')
 144     args.append(getDscName(package, ref))
 145     logAndRun(args, cwd=workdir, env=env)
 146
 147
 148 def sbuildAll(package, ref, distro, workdir):
 149     """Build a package for all architectures it supports."""
 150     arches = getArches(package, ref)
 151     if 'all' in arches or 'any' in arches or 'amd64' in arches:
 152         sbuild(package, ref, distro, 'amd64', workdir, arch_all=True)
 153     if 'any' in arches or 'i386' in arches:
 154         sbuild(package, ref, distro, 'i386', workdir)
 155
 156
 157 def tagSubmodule(pocket, package, commit, principal, version, env):
 158     """Tag a new version of a submodule.
 159
 160     If this pocket does not allow_backtracking, then this will create
 161     a new tag of the version at ref.
 162
 163     This function doesn't need to care about lock
 164     contention. git-receive-pack updates one ref at a time, and only
 165     takes out a lock for that ref after it's passed the update
 166     hook. Because we reject pushes to tags in the update hook, no push
 167     can ever take out a lock on any tags.
 168
 169     I'm sure that long description gives you great confidence in the
 170     legitimacy of my reasoning.
 171     """
 172     if not config.build.pockets[pocket].get('allow_backtracking', False):
 173         branch = b.pocketToGit(pocket)
 174         tag_msg = ('Tag %s of %s\n\n'
 175                    'Requested by %s' % (version.full_version,
 176                                         package,
 177                                         principal))
 178
 179         logAndRun(
 180             ['git', 'tag', '-m', tag_msg, '--', sanitizeVersion(version),
 181              commit],
 182             env=env,
 183             cwd=b.getRepo(package))
 184
 185
 186 def updateSubmoduleBranch(pocket, package, commit):
 187     """Update the appropriately named branch in the submodule."""
 188     branch = b.pocketToGit(pocket)
 189     logAndRun(
 190         ['git', 'update-ref', 'refs/heads/%s' % branch, commit], cwd=b.getRepo(package))
 191
 192
 193 def uploadBuild(pocket, workdir):
 194     """Upload all build products in the work directory."""
 195     force = config.build.pockets[pocket].get('allow_backtracking', False)
 196     apt = b.pocketToApt(pocket)
 197     for changes in glob.glob(os.path.join(workdir, '*.changes')):
 198         upload = ['reprepro-env', '--ignore=wrongdistribution',
 199                   'include', apt, changes]
 200         try:
 201             logAndRun(upload)
 202         except subprocess.CalledProcessError, e:
 203             if not force:
 204                 raise
 205             changelog = deb822.Changes(open(changes).read())
 206             packages = set(changelog['Binary'].split())
 207             packages.add(changelog['Source'])
 208             for package in packages:
 209                 logAndRun(['reprepro-env', 'remove', apt, package])
 210             logAndRun(upload)
 211
 212
 213 def updateSuperproject(pocket, package, commit, principal, version, env):
 214     """Update the superproject.
 215
 216     This will create a new commit on the branch for the given pocket
 217     that sets the commit for the package submodule to commit.
 218
 219     Note that there's no locking issue here, because we disallow all
 220     pushes to the superproject.
 221     """
 222     superproject = os.path.join(b._REPO_DIR, 'invirt/packages.git')
 223     if not b.pocketExists(pocket, superproject):
 224         raise Exception("Super-repository does not contain pocket branch '%s'.  Create it first." % pocket)
 225
 226     branch = b.pocketToGit(pocket)
 227     tree = logAndRun(['git', 'ls-tree', branch],
 228                      cwd=superproject).strip()
 229
 230     tree_items = dict((k, v) for (v, k) in (x.split("\t") for x in tree.split("\n")))
 231
 232     created = not (package in tree_items)
 233
 234     tree_items[package] = "160000 commit "+commit
 235
 236     # If "created" is true, we need to check if the package is
 237     # mentioned in .gitmodules, and add it if not.
 238     if created:
 239         gitmodules = logAndRun(['git', 'cat-file', 'blob', '%s:.gitmodules' % (branch)],
 240                                cwd=superproject)
 241         if ('[submodule "%s"]' % (package)) not in gitmodules.split("\n"):
 242             gitmodules += """[submodule "%s"]
 243 \tpath = %s
 244 \turl = ../packages/%s.git
 245 """ % (package, package, package)
 246             gitmodules_hash = logAndRun(['git', 'hash-object', '-w', '--stdin'],
 247                                         cwd=superproject,
 248                                         stdin_str=gitmodules).strip()
 249             tree_items[package] = "100644 blob "+gitmodules_hash
 250
 251     new_tree = "\n".join("%s\t%s" % (v, k) for (k, v) in tree_items.iteritems())
 252
 253     new_tree_id = logAndRun(['git', 'mktree', '--missing'],
 254                             cwd=superproject,
 255                             stdin_str=new_tree).strip()
 256
 257     if created:
 258         commit_msg = 'Add %s at version %s'
 259     else:
 260         commit_msg = 'Update %s to version %s'
 261     commit_msg = ((commit_msg + '\n\n'
 262                    'Requested by %s') % (package,
 263                                          version.full_version,
 264                                          principal))
 265     new_commit = logAndRun(
 266         ['git', 'commit-tree', new_tree_id, '-p', branch],
 267         cwd=superproject,
 268         env=env,
 269         stdin_str=commit_msg).strip()
 270
 271     logAndRun(
 272         ['git', 'update-ref', 'refs/heads/%s' % branch, new_commit],
 273         cwd=superproject)
 274
 275
 276 def makeReadable(workdir):
 277     os.chmod(workdir, 0755)
 278
 279 @contextlib.contextmanager
 280 def packageWorkdir(package, commit, build_id):
 281     """Checkout the package in a temporary working directory.
 282
 283     This context manager returns that working directory. The requested
 284     package is checked out into a subdirectory of the working
 285     directory with the same name as the package.
 286
 287     When the context wrapped with this context manager is exited, the
 288     working directory is automatically deleted.
 289     """
 290     workdir = tempfile.mkdtemp(prefix=("b%d-" % build_id))
 291     try:
 292         p_archive = subprocess.Popen(
 293             ['git', '--git-dir=%s' % (b.getRepo(package),),
 294              'archive',
 295              '--prefix=%s/' % package,
 296              commit,
 297              ],
 298             stdout=subprocess.PIPE,
 299             )
 300         p_tar = subprocess.Popen(
 301             ['tar', '-x'],
 302             stdin=p_archive.stdout,
 303             cwd=workdir,
 304             )
 305         p_archive.wait()
 306         p_tar.wait()
 307
 308         yield workdir
 309     finally:
 310         shutil.rmtree(workdir)
 311
 312 def build():
 313     """Deal with items in the build queue.
 314
 315     When triggered, iterate over build queue items one at a time,
 316     until there are no more pending build jobs.
 317     """
 318     global logfile
 319
 320     while True:
 321         stage = 'processing incoming job'
 322         queue = os.listdir(b._QUEUE_DIR)
 323         if not queue:
 324             break
 325
 326         build = min(queue)
 327         job = open(os.path.join(b._QUEUE_DIR, build)).read().strip()
 328         pocket, package, commit, principal = job.split()
 329
 330         database.session.begin()
 331         db = database.Build()
 332         db.package = package
 333         db.pocket = pocket
 334         db.commit = commit
 335         db.principal = principal
 336         database.session.save_or_update(db)
 337         database.session.commit()
 338
 339         database.session.begin()
 340
 341         logdir = os.path.join(b._LOG_DIR, str(db.build_id))
 342         if not os.path.exists(logdir):
 343             os.makedirs(logdir)
 344
 345         try:
 346             db.failed_stage = 'validating job'
 347             # Don't expand the commit in the DB until we're sure the user
 348             # isn't trying to be tricky.
 349             b.ensureValidPackage(package)
 350
 351             logfile = open(os.path.join(logdir, '%s.log' % db.package), 'w')
 352
 353             db.commit = commit = b.canonicalize_commit(package, commit)
 354             src = b.validateBuild(pocket, package, commit)
 355             version = b.getVersion(package, commit)
 356             db.version = str(version)
 357             b.runHook('pre-build', [str(db.build_id)])
 358
 359             env = dict(os.environ)
 360             env['GIT_COMMITTER_NAME'] = config.build.tagger.name
 361             env['GIT_COMMITTER_EMAIL'] = config.build.tagger.email
 362
 363             # If validateBuild returns something other than True, then
 364             # it means we should copy from that pocket to our pocket.
 365             #
 366             # (If the validation failed, validateBuild would have
 367             # raised an exception)
 368             if src != True:
 369                 # TODO: cut out this code duplication
 370                 db.failed_stage = 'tagging submodule before copying package'
 371                 tagSubmodule(pocket, package, commit, principal, version, env)
 372                 db.failed_stage = 'updating submodule branches before copying package'
 373                 updateSubmoduleBranch(pocket, package, commit)
 374                 db.failed_stage = 'updating superproject before copying package'
 375                 updateSuperproject(pocket, package, commit, principal, version, env)
 376                 db.failed_stage = 'copying package from another pocket'
 377                 aptCopy(package, commit, pocket, src)
 378
 379             # If we can't copy the package from somewhere, but
 380             # validateBuild didn't raise an exception, then we need to
 381             # do the build ourselves
 382             else:
 383                 db.failed_stage = 'checking out package source'
 384                 with packageWorkdir(package, commit, db.build_id) as workdir:
 385                     db.failed_stage = 'preparing source package'
 386                     packagedir = os.path.join(workdir, package)
 387
 388                     # We should be more clever about dealing with
 389                     # things like non-Debian-native packages than we
 390                     # are.
 391                     #
 392                     # If we were, we could use debuild and get nice
 393                     # environment scrubbing. Since we're not, debuild
 394                     # complains about not having an orig.tar.gz
 395                     logAndRun(['schroot', '-c',
 396                                '%s-amd64-sbuild' % (b.pocketToDistro(pocket),),
 397                                '--', 'dpkg-buildpackage', '-us', '-uc', '-S'],
 398                               cwd=packagedir)
 399
 400                     db.failed_stage = 'building binary packages'
 401                     sbuildAll(package, commit, b.pocketToDistro(pocket), workdir)
 402                     db.failed_stage = 'tagging submodule'
 403                     tagSubmodule(pocket, package, commit, principal, version, env)
 404                     db.failed_stage = 'updating submodule branches'
 405                     updateSubmoduleBranch(pocket, package, commit)
 406                     db.failed_stage = 'updating superproject'
 407                     updateSuperproject(pocket, package, commit, principal, version, env)
 408                     db.failed_stage = 'relaxing permissions on workdir'
 409                     makeReadable(workdir)
 410                     db.failed_stage = 'uploading packages to apt repo'
 411                     uploadBuild(pocket, workdir)
 412
 413                     db.failed_stage = 'cleaning up'
 414         except:
 415             db.traceback = traceback.format_exc()
 416         else:
 417             db.succeeded = True
 418             db.failed_stage = None
 419         finally:
 420             if logfile is not None:
 421                 logfile.close()
 422
 423             database.session.save_or_update(db)
 424             database.session.commit()
 425
 426             # Finally, now that everything is done, remove the
 427             # build queue item
 428             os.unlink(os.path.join(b._QUEUE_DIR, build))
 429
 430             if db.succeeded:
 431                 b.runHook('post-build', [str(db.build_id)])
 432             else:
 433                 b.runHook('failed-build', [str(db.build_id)])
 434
 435 class Invirtibuilder(pyinotify.ProcessEvent):
 436     """Process inotify triggers to build new packages."""
 437     def process_default(self, event):
 438         """Handle an inotify event.
 439
 440         When an inotify event comes in, trigger the builder.
 441         """
 442         build()
 443
 444
 445 def main():
 446     """Initialize the inotifications and start the main loop."""
 447     database.connect()
 448
 449     watch_manager = pyinotify.WatchManager()
 450     invirtibuilder = Invirtibuilder()
 451     notifier = pyinotify.Notifier(watch_manager, invirtibuilder)
 452     watch_manager.add_watch(b._QUEUE_DIR,
 453                             pyinotify.EventsCodes.ALL_FLAGS['IN_CREATE'] |
 454                             pyinotify.EventsCodes.ALL_FLAGS['IN_MOVED_TO'])
 455
 456     # Before inotifying, run any pending builds; otherwise we won't
 457     # get notified for them.
 458     build()
 459
 460     while True:
 461         notifier.process_events()
 462         if notifier.check_events():
 463             notifier.read_events()
 464
 465
 466 if __name__ == '__main__':
 467     main()