Merge lp:~om26er/core-snap/improve_build_script into lp:core-snap

[Omer Akram]

* Port build script to python3
* Organize the code into a class
* Rename the script to lp-build-core
* Other cleanups

While taking a look at the build script, I ended up making some changes to it. Below is what changed

* Port build script to python3
* Organize the code into a class
* Rename the script to lp-build-core
* Other cleanups

[lp:~om26er/core-snap/improve_build_script]

49. By Omer Akram on 2016-10-05

Merge with trunk

[Omer Akram (om26er)]

Fixed conflicts, rebased on top of current trunk.

Unmerged revisions

49. By Omer Akram on 2016-10-05

Merge with trunk

48. By Omer Akram on 2016-10-04

rename build script to lp-build-core

47. By Omer Akram on 2016-10-04

Port the build script to python3, move the code into a class

46. By Omer Akram on 2016-10-04

join paths instead of concatination

=== modified file 'cron-scripts/lp-build-core'
--- cron-scripts/lp-build-core	2016-10-05 10:33:07 +0000
+++ cron-scripts/lp-build-core	2016-10-05 13:18:34 +0000
@@ -1,132 +1,169 @@
-#! /usr/bin/python
+#!/usr/bin/python3
 
 import os
 import sys
 import time
 import smtplib
-
 from datetime import datetime
-from os.path import basename
+
 from launchpadlib.launchpad import Launchpad
 from email.mime.text import MIMEText
 
-# where failure mails go
-mailreceivers = ['[e-mail]']
-
-# basic data
-arches = ['amd64', 'i386', 'armhf', 'arm64', 'ppc64el', 's390x']
-series = 'xenial'
-
-# basic paths
-home = os.getenv("HOME")
-workdir = home+"/core-builds"
-
+MAIL_RECEIVERS = ['[e-mail]']
+MAIL_SENDER = '[e-mail]'
+ARCHES = ['amd64', 'i386', 'armhf', 'arm64', 'ppc64el', 's390x']
+SERIES = 'xenial'
+HOME = os.getenv("HOME")
+WORK_DIR = os.path.join(HOME, "core-builds")
+PID_FILE = os.path.join(WORK_DIR, "build.pid")
 # we need to store credentials once for cronned builds
-cachedir = workdir+"/cache"
-creds = workdir+"/credentials"
-
-def sendMail(arch, stamp, failure, buildlog):
-    # send failure mails to defined recipients
-    sender = '[e-mail]'
-    if buildlog:
-        mailtext = "core {} snap\nBuild requested at {}\nFailed for id: {}\nLink to build log: {}".format(arch, stamp, failure, buildlog)
-    mailtext = "build-core: {} ".format(failure)
-
-    message = MIMEText(mailtext)
-    message['Subject'] = '%s core snap failed to build !' % arch
-    message['From'] = 'Snap Auto Builder <%s>' % sender
-    message['To'] = ", ".join(mailreceivers)
-    try:
-       smtpObj = smtplib.SMTP('localhost')
-       smtpObj.sendmail(sender, mailreceivers, message.as_string())
-       print ("Successfully sent failure email to {}".format(mailreceivers))
-    except Exception:
-       print ("Error: unable to send failure email")
-
-
-# make sure we dont clash with an older build attempt
-pid = str(os.getpid())
-pidfile = workdir+"/build.pid"
-if os.path.isfile(pidfile):
-    print "A pid file %s already exists, it seems like" % pidfile
-    print "there is already a lp-build-core running."
-    print "exiting !"
-    sendMail("","","pid exists","")
-    sys.exit()
-file(pidfile, 'w').write(pid)
-
-# log in
-launchpad = Launchpad.login_with('Ubuntu Core Builds',
-                                 'production', cachedir,
-                                 credentials_file=creds,
-                                 version='devel')
-
-# get snappy-dev team data and ppa
-snappydev = launchpad.people['snappy-dev']
-imageppa = snappydev.getPPAByName(name='image')
-
-# get snap
-ubuntucore = launchpad.snaps.getByName(name='core',
-                                       owner=snappydev)
-
-# get distro info
-ubuntu = launchpad.distributions['ubuntu']
-release = ubuntu.getSeries(name_or_version=series)
-
-# print a stamp
-stamp = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
-print("Trying to trigger builds at: {}".format(stamp))
-
-# loop over arches and trigger builds
-mybuilds = []
-for buildarch in arches:
-    arch = release.getDistroArchSeries(archtag=buildarch)
-    request = ubuntucore.requestBuild(archive=imageppa,
-                                      distro_arch_series=arch,
-                                      pocket='Proposed')
-    buildid = str(request).rsplit('/', 1)[-1]
-    mybuilds.append(buildid)
-    print("Arch: {} is building under: {}".format(buildarch,
-                                                  request))
-
-# check the status each minute til all builds have finished
-failures = []
-while len(mybuilds):
-    for build in mybuilds:
-        try:
-            response = ubuntucore.getBuildSummariesForSnapBuildIds(snap_build_ids=[build])
-        except:
-            print ("could not get response for {} (was there an LP timeout ?)".format(build))
-            continue
-        status = response[build]['status']
-        if status == "FULLYBUILT":
-            mybuilds.remove(build)
-            continue
-        elif status == "FAILEDTOBUILD":
-            failures.append(build)
-            mybuilds.remove(build)
-            continue
-        elif status == "CANCELLED":
-            mybuilds.remove(build)
-            continue
-    time.sleep(60)
-
-# if we had failures, print them and send mails
-if len(failures):
-    for failure in failures:
-        try:
-            response = ubuntucore.getBuildSummariesForSnapBuildIds(snap_build_ids=[failure])
-        except:
-            print ("could not get failure data for {} (was there an LP timeout ?)".format(build))
-            continue
-        buildlog = response[build]['build_log_url']
-        if buildlog != 'None':
-            print(buildlog)
-            arch = str(buildlog).split('_')[4]
-        print("core snap {} build at {} failed for id: {} log: {}".format(arch, stamp, failure, buildlog))
-        sendMail(arch, stamp, failure, buildlog)
-
-
-# tell the log we are done and remove pid file
-print("done")
-os.unlink(pidfile)
+CACHE_DIR = os.path.join(WORK_DIR, "cache")
+CREDENTIALS = os.path.join(WORK_DIR, "credentials")
+
+
+class CoreBuilder:
+    @classmethod
+    def build(cls):
+        cls._create_pid_lock()
+        core, image_ppa, release = cls._fetch_data_from_launchpad()
+        stamp = cls._print_and_get_timestamp()
+        failures = cls._monitor_build_status(
+            cls._trigger_builds(core, image_ppa, release),
+            core
+        )
+        cls._report_failures_if_any(failures, core, stamp)
+        # tell the log we are done and remove pid file
+        print("done")
+        os.unlink(PID_FILE)
+
+    @staticmethod
+    def _create_pid_lock():
+        # make sure we don't clash with an older build attempt
+        if os.path.isfile(PID_FILE):
+            print("A pid file {} already exists, it seems like".format(
+                PID_FILE))
+            print("there is already a build-core running.")
+            print("exiting !")
+            CoreBuilder._send_failure_mail("", "", "pid exists", "")
+            sys.exit()
+        with open(PID_FILE, 'w') as file:
+            file.write(str(os.getpid()))
+
+    @staticmethod
+    def _assemble_mail(arch, stamp, failure, build_log):
+        if build_log:
+            mail_text = "core {} snap\nBuild requested at {}\n" \
+                        "Failed for id: {}\nLink to build log: {}".format(
+                            arch, stamp, failure, build_log)
+        else:
+            mail_text = "build-core: {} ".format(failure)
+
+        message = MIMEText(mail_text)
+        message['Subject'] = '{} core snap failed to build !'.format(arch)
+        message['From'] = 'Snap Auto Builder <{}>'.format(MAIL_SENDER)
+        message['To'] = ", ".join(MAIL_RECEIVERS)
+        return message.as_string()
+
+    @staticmethod
+    def _send_failure_mail(arch, stamp, failure, build_log):
+        try:
+            smtp_obj = smtplib.SMTP('localhost')
+            smtp_obj.sendmail(
+                MAIL_SENDER,
+                MAIL_RECEIVERS,
+                CoreBuilder._assemble_mail(arch, stamp, failure, build_log)
+            )
+            print(
+                "Successfully sent failure email to {}".format(MAIL_RECEIVERS)
+            )
+        except Exception:
+            print("Error: unable to send failure email")
+
+    @staticmethod
+    def _fetch_data_from_launchpad():
+        # log in
+        launchpad = Launchpad.login_with(
+            'Ubuntu Core Builds',
+            'production',
+            CACHE_DIR,
+            credentials_file=CREDENTIALS,
+            version='devel'
+        )
+        # get snappy-dev team data and ppa
+        snappy_dev = launchpad.people['snappy-dev']
+        image_ppa = snappy_dev.getPPAByName(name='image')
+        # get snap
+        core = launchpad.snaps.getByName(name='core', owner=snappy_dev)
+        # get distro info
+        ubuntu = launchpad.distributions['ubuntu']
+        release = ubuntu.getSeries(name_or_version=SERIES)
+        return core, image_ppa, release
+
+    @staticmethod
+    def _print_and_get_timestamp():
+        time_stamp = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+        print("Trying to trigger builds at: {}".format(time_stamp))
+        return time_stamp
+
+    @staticmethod
+    def _trigger_builds(core, image_ppa, release):
+        my_builds = []
+        for build_arch in ARCHES:
+            arch = release.getDistroArchSeries(archtag=build_arch)
+            request = core.requestBuild(
+                archive=image_ppa, distro_arch_series=arch, pocket='Proposed')
+            build_id = str(request).rsplit('/', 1)[-1]
+            my_builds.append(build_id)
+            print("Arch: {} is building under: {}".format(build_arch, request))
+        return my_builds
+
+    @staticmethod
+    def _monitor_build_status(my_builds, core):
+        failures = []
+        while len(my_builds):
+            for build in my_builds:
+                try:
+                    response = core.getBuildSummariesForSnapBuildIds(
+                        snap_build_ids=[build])
+                except Exception:
+                    print(
+                        "could not get response for {} (was there an LP "
+                        "timeout ?)".format(build))
+                    continue
+                status = response[build]['status']
+                if status == "FULLYBUILT":
+                    my_builds.remove(build)
+                    continue
+                elif status == "FAILEDTOBUILD":
+                    failures.append(build)
+                    my_builds.remove(build)
+                    continue
+                elif status == "CANCELLED":
+                    my_builds.remove(build)
+                    continue
+            time.sleep(60)
+        return failures
+
+    @staticmethod
+    def _report_failures_if_any(failures, core, stamp):
+        for failure in failures:
+            try:
+                response = core.getBuildSummariesForSnapBuildIds(
+                    snap_build_ids=[failure])
+            except Exception:
+                print(
+                    "could not get failure data for {} (was there an LP "
+                    "timeout ?)".format(failure))
+                continue
+            build_log = response[failure]['build_log_url']
+            if build_log != 'None':
+                print(build_log)
+                arch = str(build_log).split('_')[4]
+            print(
+                "core snap {} build at {} failed for id: {} log: "
+                "{}".format(arch, stamp, failure, build_log))
+            CoreBuilder._send_failure_mail(arch, stamp, failure, build_log)
+
+
+if __name__ == "__main__":
+    CoreBuilder.build()