Merge ~the-meulengracht/snappy-hwe-snaps/+git/jenkins-jobs:master into ~snappy-hwe-team/snappy-hwe-snaps/+git/jenkins-jobs:master

[Philip Meulengracht]

Use the snap of documentation-builder instead of the python package, it caused conflicts.

Add missing methods from the JLP library that had been removed

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

LGTM

review: Approve

[System Enablement Bot (system-enablement-ci-bot)]

PASSED: Continuous integration, rev:beeb1e8a3c4fbcda9b2526067f04d31f252084d7
https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build-prepare/738/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=amd64/761
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=arm64/761
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=armhf/761
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=i386/761
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-docs/1542
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-cleanup/1284
    None: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-update-mp/1352/console
    FAILURE: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-update-mp/1351/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build-prepare/738/rebuild

review: Approve (continuous-integration)

[System Enablement Bot (system-enablement-ci-bot)]

PASSED: Continuous integration, rev:09608e565bf593dfa8123f3d47b977b51df9c587
https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build-prepare/739/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=amd64/762
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=arm64/762
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=armhf/762
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build/ARCHITECTURE=i386/762
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-docs/1543
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-cleanup/1285
    None: https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-update-mp/1353/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/snappy-hwe-snaps-snap-build-prepare/739/rebuild

review: Approve (continuous-integration)

diff --git a/jobs/infrastructure/prepare-0-install.sh b/jobs/infrastructure/prepare-0-install.sh
index afffe90..06a9f84 100644
--- a/jobs/infrastructure/prepare-0-install.sh
+++ b/jobs/infrastructure/prepare-0-install.sh
@@ -86,13 +86,10 @@ fi
 # Install snaps
 $SUDO snap install snapcraft
 $SUDO snap install yq
+$SUDO snap install documentation-builder
 
 export http_proxy="{http_proxy}"
-export https_proxy="{https_proxy}"
+export https_proxy="{http_proxy}"
 
-# documentation-builder is normally available as a snap but we can't
-# use snaps yet on our agents.
 $SUDO pip3 install --upgrade pip
-$SUDO pip3 install --ignore-installed PyYAML
 $SUDO pip3 install jenkins-job-builder pid
-$SUDO pip3 install ubuntudesign.documentation-builder
diff --git a/tools/vote-on-merge-proposal.py b/tools/vote-on-merge-proposal.py
index 96838a7..89f7153 100755
--- a/tools/vote-on-merge-proposal.py
+++ b/tools/vote-on-merge-proposal.py
@@ -21,6 +21,7 @@ import time
 import logging
 import os
 import re
+from textwrap import dedent
 from shutil import rmtree
 from argparse import ArgumentParser
 from launchpadlib.credentials import RequestTokenAuthorizationEngine
@@ -204,6 +205,128 @@ def get_vote_subject(mp):
             mp.target_branch.display_name)
 
 
+def _get_result_line(result, url):
+    """Helper method for get_executed_test_runs_message.
+
+    Given a result and url it returns a string.
+    In case the result is failed it provides a link to console output:
+    FAILED: http://[...]/./distribution=quantal,flavor=amd64/267/console
+
+    In case the result is success or unstable (some tests failed) it provides
+    a link to the job:
+    SUCCESS: http://[...]/distribution=quantal,flavor=amd64/267
+
+    :param result: one of SUCCESS, UNSTABLE or FAILURE (comes from jenkins)
+    :param url: url of the build or configuration in case of matrix job
+    """
+
+    url = url.rstrip('/')
+    if result == 'SUCCESS' or result == 'UNSTABLE':
+        if url.endswith('console'):
+            # strip "/console"
+            url = url[:-8]
+    return "\n    {result}: {output}".format(
+        result=result,
+        output=url)
+
+
+def get_executed_test_runs_message(url):
+    """Return a string with executed runs for a given jenkins build url.
+
+    :param url: url with jenkins build
+
+    This is an example result of this function:
+    ----snip----
+Executed test runs:
+    FAILURE: http://[...]/./distribution=raring,flavor=amd64/3/console
+    FAILURE: http://[...]/./distribution=raring,flavor=i386/3/console
+    SUCCESS: http://[...]/job-freestyle/7
+        deb: http://[...]/job-freestyle/7/artifact/work/output/*zip*/output.zip
+    UNSTABLE: http://jenkins/job/freestyle-downstream/12
+Coverity artifacts:
+    http://[...]/artifact/results/coverity/CID_10895.html
+    http://[...]/results/coverity/CID_10896.html
+    http://[...]/results/coverity/CID_10895.html
+    http://[...]/results/coverity/CID_10896.html
+    ----snip----
+    """
+
+    ret = "\nExecuted test runs:"
+    jenkins = jenkinsutils.get_json_jenkins()
+    builds = jenkinsutils.get_executed_builds(jenkins, url)
+    coverity_artifacts = []
+    for build in builds:
+        ret += _get_result_line(
+            build['result'],
+            jenkinsutils.hide_jenkins_url(build['output']))
+        if build['output'].endswith('console'):
+            build_url = build['output'][:-len('console')]
+            artifacts = jenkinsutils.get_coverity_artifacts(jenkins, build_url)
+            debs = jenkinsutils.get_deb_artifacts(jenkins, build_url)
+            if debs:
+                ret += "\n        deb: {}".format(jenkinsutils.hide_jenkins_url(debs))
+            coverity_artifacts += artifacts
+    if coverity_artifacts:
+        ret += "\nCoverity artifacts:"
+        for artifact in coverity_artifacts:
+            ret += "\n    {}".format(jenkinsutils.hide_jenkins_url(artifact))
+
+    return ret
+
+
+def format_message_for_mp_update(build_url, message=None,
+                                 include_rebuild_link=True):
+    """Return a formatted message that is then posted as comment to the merge
+    proposal.
+
+    The message consists of:
+    * message
+    * executed test-runs (and links to artifacts such as deb files)
+    * rubuild link
+
+    :params build_url: jenkins url of the build in question
+    :params message: custom message (usually PASSED/FAILED)
+    :include_rebuild_link: boolean which affects the generation of rebuild link
+
+    Example:
+    ----snip----
+    PASSED: Continuous integration, rev:114
+    http://s-jenkins.ubuntu-ci:8080/job/jenkins-launchpad-plugin-ci/267/
+    Executed test runs:
+        SUCCESS: http://[...]/distribution=quantal,flavor=amd64/267
+
+    Click here to trigger a rebuild:
+    http://s-jenkins.ubuntu-ci:8080/job/jenkins-launchpad-plugin-ci/267/rebuild
+    ----snip----
+
+    """
+    formatted_message = dedent('''\
+            {message}{build_url}{executed_test_runs}
+            ''')
+    if include_rebuild_link:
+        formatted_message = formatted_message + dedent('''\
+
+            Click here to trigger a rebuild:
+            {rebuild_url}
+            ''')
+    if not message:
+        message = ''
+    if not build_url:
+        build_url = ''
+        executed_test_runs_message = ''
+    else:
+        executed_test_runs_message = \
+            get_executed_test_runs_message(build_url)
+
+    rebuild_url = '{build_url}/rebuild'.format(
+        build_url=build_url.rstrip('/'))
+    return formatted_message.format(
+        message=message,
+        build_url=jenkinsutils.hide_jenkins_url(build_url),
+        rebuild_url=jenkinsutils.hide_jenkins_url(rebuild_url),
+        executed_test_runs=executed_test_runs_message)
+
+
 def approve_mp(mp, revision, build_url):
     """Approve a given merge proposal a revision.
 
@@ -215,8 +338,7 @@ def approve_mp(mp, revision, build_url):
     """
     state = 'PASSED: Continuous integration, rev:' + str(revision)
     logger.debug(state)
-    content = jenkinsutils.format_message_for_mp_update(build_url,
-                                                        state + "\n")
+    content = format_message_for_mp_update(build_url, state + "\n")
     mp.createComment(review_type=get_config_option('launchpad_review_type'),
                      vote=LaunchpadVote.APPROVE, subject=get_vote_subject(mp),
                      content=content)
@@ -238,8 +360,7 @@ def disapprove_mp(mp, revision, build_url, reason=None):
         state = "{state}\n{reason}".format(state=state, reason=reason)
 
     logger.debug(state)
-    content = jenkinsutils.format_message_for_mp_update(
-        build_url, state + "\n")
+    content = format_message_for_mp_update(build_url, state + "\n")
     mp.createComment(review_type=get_config_option('launchpad_review_type'),
                      vote=LaunchpadVote.NEEDS_FIXING,
                      subject=get_vote_subject(mp),