Merge ~morphis/snappy-hwe-snaps/+git/jenkins-jobs:f/add-snap-docs-build into ~snappy-hwe-team/snappy-hwe-snaps/+git/jenkins-jobs:master

[Simon Fels]

Implement *-snap-docs build job

The new build job will build the documentation for every project and stage the generated documentation as build artifact for further inspection during the review process.

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

PASSED: Continuous integration, rev:c4cb59a71345d72692b7c0186198e5435e115134
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1935/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/3337
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1843/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/3598

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1935/rebuild

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:de9c52d08a653180f242938c7cd9ae2915f89f65
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1936/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/3338
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1844/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/3599

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1936/rebuild

review: Approve (continuous-integration)

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

LGTM

review: Approve

[Konrad Zapałowicz (kzapalowicz)]

ack

review: Approve (continuous-integration)

diff --git a/jobs/snap/snap-build.yaml b/jobs/snap/snap-build.yaml
index dec3b19..e5b22f5 100644
--- a/jobs/snap/snap-build.yaml
+++ b/jobs/snap/snap-build.yaml
@@ -57,6 +57,9 @@
                   RESULTS_ID=$BUILD_TAG
                   ARCHITECTURE=$ARCHITECTURE
               block: true
+            - project: '{name}-snap-docs'
+              current-parameters: true
+              block: true
             - project: '{name}-snap-test'
               current-parameters: true
               predefined-parameters: |
diff --git a/jobs/snap/snap-docs.sh b/jobs/snap/snap-docs.sh
 new file mode 100644
index 0000000..e256294
--- /dev/null
+++ b/jobs/snap/snap-docs.sh
@@ -0,0 +1,38 @@
+#!/bin/sh
+#
+# Copyright (C) 2017 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+set -ex
+
+. "$WORKSPACE/.build_env"
+
+git clone -b $GIT_REPO_BRANCH $GIT_REPO $WORKSPACE/src
+if [ ! -e $WORKSPACE/src/docs ]; then
+    echo "WARNING: repository does not contain any documentation we can build. Aborting."
+    exit 0
+fi
+
+# Run documentation through the builder and ensure everything builds nicely.
+cd $WORKSPACE/src/docs
+documentation-builder
+
+# Generate an archive which will be available as build artifact
+DATE=$(date --rfc-3339=date --utc)
+(cd $WORKSPACE/src/docs/build ; tar cJf $WORKSPACE/docs-$DATE-$BUILD_ID.tar.xz *)
+
+$BUILD_SCRIPTS/tools/update-merge-proposal.py \
+    --merge-proposal=$MERGE_PROPOSAL \
+    --approve \
+    --message="PASSED: Successfully build documentation, rev: $REVISION\n\nGenerated documentation is available at $BUILD_URL"
diff --git a/jobs/snap/snap-docs.yaml b/jobs/snap/snap-docs.yaml
 new file mode 100644
index 0000000..3954f13
--- /dev/null
+++ b/jobs/snap/snap-docs.yaml
@@ -0,0 +1,38 @@
+- job-template:
+    name: '{name}-snap-docs'
+    project-type: freestyle
+    defaults: global
+    description: "Build documentation bits of the snap"
+    display-name: "{name}-snap-docs"
+    concurrent: true
+    node: snap && build
+    parameters:
+        - string:
+            name: GIT_REPO
+            default:
+            description: "Source git repository"
+        - string:
+            name: GIT_REPO_BRANCH
+            default:
+            description: "Branch of the source git repository to use"
+        - string:
+            name: MERGE_PROPOSAL
+            default:
+            description: "Link to the merge proposal this build relates to"
+        - string:
+            name: REVISION
+            default:
+            description: "Revision from the git repository to use"
+    builders:
+        - shell:
+            !include-raw:
+                - common-job-prepare.sh
+        - shell:
+            !include-raw-escape:
+                - snap-docs.sh
+    publishers:
+        - archive:
+            artifacts: 'docs-*.tar.xz'
+            allow-empty: 'true'
+            fingerprint: true
+            default-excludes: false
 \ No newline at end of file
diff --git a/jobs/snap/snap-project-jobs.yaml b/jobs/snap/snap-project-jobs.yaml
index b693af3..05e4f3f 100644
--- a/jobs/snap/snap-project-jobs.yaml
+++ b/jobs/snap/snap-project-jobs.yaml
@@ -11,3 +11,4 @@
       - '{name}-snap-trigger-ci'
       - '{name}-snap-update-mp'
       - '{name}-snap-automerger'
+      - '{name}-snap-docs'
diff --git a/tools/se_utils/__init__.py b/tools/se_utils/__init__.py
index 280450c..64cc0cc 100644
--- a/tools/se_utils/__init__.py
+++ b/tools/se_utils/__init__.py
@@ -20,6 +20,7 @@ import sys
 import time
 import logging
 import os
+import re
 import yaml
 from shutil import rmtree
 from launchpadlib.credentials import RequestTokenAuthorizationEngine
@@ -27,6 +28,11 @@ from lazr.restfulclient.errors import HTTPError
 from launchpadlib.launchpad import Launchpad
 from launchpadlib.credentials import UnencryptedFileCredentialStore
 
+class LaunchpadVote():
+    APPROVE = 'Approve'
+    DISAPPROVE = 'Disapprove'
+    NEEDS_FIXING = 'Needs Fixing'
+
 ACCESS_TOKEN_POLL_TIME = 10
 WAITING_FOR_USER = """Open this link:
 {}
@@ -120,3 +126,87 @@ def load_config():
 def get_config_option(name):
     config = load_config()
     return config[name]
+
+def get_branch_handle_from_url(lp_handle, url):
+    """ Return a branch/repo handle for the given url.
+    Returns a launchpad branch or git repository handle for the given url.
+    :param lp_handle: launchpad API handle/instance
+    :param url: url of the branch or git repository
+    """
+    if '+git' in url:
+        name = url.replace('https://code.launchpad.net/', '')
+        print('fetching repo: ' + name)
+        try:
+            return lp_handle.git_repositories.getByPath(path=name)
+        except AttributeError:
+            print('git_repositories.getByPath was not found. You may need to set lp_version=devel in the config')
+            return None
+    else:
+        name = url.replace('https://code.launchpad.net/', 'lp:')
+        name = name.replace('https://code.staging.launchpad.net/', 'lp://staging/')
+        print('fetching branch: ' + name)
+        return lp_handle.branches.getByUrl(url=name)
+
+def get_branch_from_mp(merge_proposal):
+    """Return a link to branch given a link to a merge proposal.
+
+    If merge_proposal is:
+      https://copde.launchpad.net/~user/project/name/+merge/12345
+    then the result will be:
+      https://copde.launchpad.net/~user/project/name/
+
+    :param merge_proposal: url of a launchpad merge proposal
+    """
+    m = re.search('(.*)\+merge/[0-9]+$', merge_proposal)
+    if m:
+        return m.group(1)
+    return None
+
+def get_mp_handle_from_url(lp_handle, merge_proposal_link):
+    """ Get launchpad handle for merge proposal given a merge proposal URL.
+
+    Returns None in case the merge proposal can't be found.
+    :param merge_proposal_link: URL of the merge proposal
+    """
+    branch_link = get_branch_from_mp(merge_proposal_link)
+    if not branch_link:
+        print('Unable to get branch link from merge proposal link.')
+        return None
+
+    branch =  get_branch_handle_from_url(lp_handle, branch_link)
+    if not branch:
+        print('Branch {} does not exist'.format(branch_link))
+        return None
+
+    print('mp_link: {}.'.format(merge_proposal_link))
+
+    for mp in branch.landing_targets:
+        print('mp.web_link: {}'.format(mp.web_link))
+        if mp.web_link == merge_proposal_link:
+            return mp
+
+    return None
+
+def get_vote_subject(mp):
+    """Given a mp handle return a subject for the vote message
+
+    Unfortunately there is no method in the API that gives you the "standard"
+    subject that launchapd is using and some email clients (gmail) are
+    grouping conversations into threads based on subject.
+
+    This returns what seems to be the launchpad way of doing subjects.
+    :param  mp: launchpad merge proposal handle
+    """
+
+    if '+git' in mp.web_link:
+        source = mp.source_git_repository.display_name.replace('lp:', '') + \
+                 ':' + \
+                 mp.source_git_path.replace('refs/heads/', '')
+        target = mp.target_git_repository.display_name.replace('lp:', '') + \
+                 ':' + \
+                 mp.target_git_path.replace('refs/heads/', '')
+        return 'Re: [Merge] {} into {}'.format(source, target)
+    else:
+        return 'Re: [Merge] {} into {}'.format(
+            mp.source_branch.display_name,
+            mp.target_branch.display_name)
 \ No newline at end of file
diff --git a/tools/se_utils/__init__.pyc b/tools/se_utils/__init__.pyc
 deleted file mode 100644
index f1be9ca..0000000
 Binary files a/tools/se_utils/__init__.pyc and /dev/null differ
diff --git a/tools/update-merge-proposal.py b/tools/update-merge-proposal.py
 new file mode 100755
index 0000000..9e0b95a
--- /dev/null
+++ b/tools/update-merge-proposal.py
@@ -0,0 +1,64 @@
+#!/usr/bin/env python
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2017 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import atexit
+import sys
+import time
+import logging
+import os
+import yaml
+import re
+from shutil import rmtree
+from argparse import ArgumentParser
+
+import se_utils
+
+parser = ArgumentParser(description="Vote on a Launchpad merge proposal.")
+parser.add_argument('-p', '--merge-proposal', required=True, help="URL of the merge proposal to update")
+parser.add_argument('-a', '--approve', action='store_true', help="approve merge proposal")
+parser.add_argument('-d', '--disapprove', action='store_true', help="disapprove merge proposal")
+parser.add_argument('-m', '--message', help="message to add as a comment to the merge-proposal")
+
+args = vars(parser.parse_args())
+
+# Get us connected with launchpad
+lp_app = se_utils.get_config_option("lp_app")
+lp_env = se_utils.get_config_option("lp_env")
+credential_store_path = se_utils.get_config_option('credential_store_path')
+lp_handle = se_utils.get_launchpad(None, credential_store_path, lp_app, lp_env)
+
+mp = se_utils.get_mp_handle_from_url(lp_handle, args["merge_proposal"])
+if not mp:
+    parser.error('merge proposal related to this branch was not found')
+
+content = args["message"]
+if content is None or len(content) == 0:
+    parser.error('no message was provided')
+# Unescape message to ensure we get all new lines etc.
+content = content.decode('string_escape')
+
+if not args['approve'] and not args['disapprove']:
+    parser.error('neither approved or disapproved the MP')
+
+vote=""
+if args["approve"]:
+    vote = se_utils.LaunchpadVote.APPROVE
+else if args["disapprove"]:
+    vote = se_utils.LaunchpadVote.DISAPPROVE
+
+subject = se_utils.get_vote_subject(mp)
+mp.createComment(content=content, subject=subject)