Merge ~kzapalowicz/snappy-hwe-snaps/+git/se-dev-tools:feature/add-tools into ~snappy-hwe-team/snappy-hwe-snaps/+git/se-dev-tools:master

[Konrad Zapałowicz]

Add additional tools such as:
  * flightschedule
  * bugsurfer
  * snap-revision

Reference: https://github.com/canonical-system-enablement/se-dev-tools

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

PASSED: Continuous integration, rev:c632526b811228e4fcf6a2dfc1f1735101300596
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1583/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/1953
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1491/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/2331
    None: https://jenkins.canonical.com/system-enablement/job/generic-cleanup-snap/1526/console

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

review: Approve (continuous-integration)

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

Looks good, although I have some comments.

Also, a couple general things:

1. Not that I have used it a lot, but, which is the reason for dropping snap-release-email?

2. Please update README.md with usage of the newly included commands, or some link that describes that

review: Needs Fixing

[Konrad Zapałowicz (kzapalowicz)]

> Looks good, although I have some comments.
>
> Also, a couple general things:
>
> 1. Not that I have used it a lot, but, which is the reason for dropping snap-
> release-email?

With the current way of how we use the "Snaps to Release" list it became not useful.
I am however updating it to be smarter and much more helpful and that will come in
the future. For now I decided to get rid of a tool that might create confusion.

One can still use it though by cloning the repo manually & building.

>
> 2. Please update README.md with usage of the newly included commands, or some
> link that describes that

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

PASSED: Continuous integration, rev:4ca5159ebc5d4ebf297e488d0d9c206f6c5a0246
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1620/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/2060
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1526/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/2431
    None: https://jenkins.canonical.com/system-enablement/job/generic-cleanup-snap/1615/console

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

review: Approve (continuous-integration)

[Alfonso Sanchez-Beato (alfonsosanchezbeato)]

LGTM

review: Approve

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

PASSED: Continuous integration, rev:7c61c2c9d8c1102813c43a2eae7ae8520cc2b999
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1621/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/2061
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1528/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/2432
    None: https://jenkins.canonical.com/system-enablement/job/generic-cleanup-snap/1617/console

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

review: Approve (continuous-integration)

diff --git a/README.md b/README.md
index a6c1e19..d1571e5 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,9 @@
 This is the snap to package se-dev-tools
 
 This snap contains various utilities that help the SE team work with snaps:
- - release email generator
  - snap revision provider
+ - flightschedule
+ - bugsurfer
 
 ### Snap revision provider
 
@@ -16,11 +17,9 @@ https://github.com/canonical-system-enablement/snap-revision-provider
 #### Usage
 
 ```
-Usage of ./snap-revision-provider:
-  -channel <channel name>
-        Channel from which the snap version is queried (default "candidate")
-  -snap <snap name>
-        Snap to query (default "bluez")
+Usage: ./snap-revision-provider [snap]
+  [snap]
+        Snap to query
 ```
 
 #### Output
@@ -28,47 +27,60 @@ Usage of ./snap-revision-provider:
 Similar to rmadison:
 
 ```
-% ./snap-revision-provider -channel candidate -snap bluez
- bluez | candidate | 5.37-2 | 13 | arm64
- bluez | candidate | 5.37-2 | 12 | armhf
- bluez | candidate | 5.37-2 | 15 | amd64
- bluez | candidate | 5.37-2 | 10 | i386
-
+% ./snap-revision-provider udisks2
+  udisks2 | stable    | 2.1.7-8     | 81  | i386
+  udisks2 | stable    | 2.1.7-8     | 80  | amd64
+  udisks2 | stable    | 2.1.7-8     | 82  | arm64
+  udisks2 | stable    | 2.1.7-8     | 83  | armhf
+  udisks2 | candidate | 2.6.4-2     | 102 | arm64
+  udisks2 | candidate | 2.6.4-2     | 103 | armhf
+  udisks2 | candidate | 2.6.4-2     | 100 | amd64
+  udisks2 | candidate | 2.6.4-2     | 101 | i386
+  udisks2 | beta      | 2.6.4-2     | 101 | i386
+  udisks2 | beta      | 2.6.4-2     | 102 | arm64
+  udisks2 | beta      | 2.6.4-2     | 100 | amd64
+  udisks2 | beta      | 2.6.4-2     | 103 | armhf
+  udisks2 | edge      | 2.6.4-3-dev | 104 | amd64
+  udisks2 | edge      | 2.6.4-3-dev | 105 | i386
+  udisks2 | edge      | 2.6.4-3-dev | 106 | arm64
+  udisks2 | edge      | 2.6.4-3-dev | 107 | armhf
 ```
 
-### Release email generator
-
-This small utility helps to generate the release emails for snaps. It
-uses the Trello board to retrieve the currently released snaps and
-construct an email message.
-
-https://github.com/canonical-system-enablement/snap-release-email-generator
-
-#### Requirements
-
-trello_secrets.json file that contains the Application Key and Token.
+### Flight Schedule
 
-Follow the instructions here https://trello.com/app-key to obtain an API
-key and token.
-
-```
-konrad at annapurna in snap-release-email-generator (master) % cat trello_secrets.json 
-{"app_id":"APP ID","token":"TOKEN"}
-
-```
+This tool queries the Launchpad and returns the list of the merge proposals
+currently in motion for the [snappy-hwe-team](https://launchpad.net/~snappy-hwe-team)
 
 #### Usage
 
 ```
-Usage of ./snap-release-email-generator:
-  -publisher <publisher name>
-        Snap publisher's name (default "Simon")
-  -secrets <trello_secrets.json>
-        Trello Secrets configuration (default "trello_secrets.json")
+$ ./flightschedule
 ```
 
-#### Constraints
-
-Right now the app examines the contents of the "Snaps to Release" column.
-If the card title changes and/or it's state is not accurate the release
-email will contain inaccurate info. Make sure to read it before sending.
+### Bug Surfer
+
+This tool queries the Launchpad and returns the list of 10 recently updated bugs
+for a person who is logged in. Additionally it can read a config file named 
+*bugsurfer.config* from:
+
+* ~/.go-launchpad/
+* * $SNAP_DATA/.go-launchpad
+*
+* for additional bug lists to provide.
+*
+* #### Config file format
+*
+* Each line shall contain either $DISTRIBUTION or $DISTRIBUTION/$PACKAGE. The
+* Distribution is for example 'ubuntu', a package can be 'bluez'. It can be easily
+* read from the bug url: https://bugs.launchpad.net/ubuntu/+source/bluez/+bug/1221524
+* The pattern is: $DISTRIBUTION/+source/$PACKAGE
+*
+* For example a config file for including all bugs for ubuntu and for bluez
+* separately would look like:
+*
+* ```
+* $ cat ~/.go-launchpad/bugsurfer.config
+* ubuntu
+* ubuntu/bluez
+* $
+* ```
diff --git a/bin/setup-snap-repo.sh b/bin/setup-snap-repo.sh
new file mode 100755
index 0000000..486d769
--- /dev/null
+++ b/bin/setup-snap-repo.sh
@@ -0,0 +1,357 @@
+#!/bin/sh -e
+#
+# 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/>.
+
+# This function just displays help
+show_help() {
+	cat << EOF
+Usage: ${0##*/} [OPTIONS] DIRECTORY
+
+This is a utility script that aids in creating a new snap. It creates the
+necessary files. The snap name is deducted from the current working dir
+
+mandatory arguments:
+  DIRECTORY            The directory to where the snap should be initialized
+                       If does not exist, it will be created.
+
+optional arguments:
+  --help               Show this help and exit
+  --no-tests           Do not create spread tests templates
+EOF
+}
+
+snap_name=${PWD##*/}
+skip_tests="no"
+maintainer="$(git config user.name) <$(git config user.email)>"
+
+COLOR='\033[0;32m'
+NC='\033[0m' # No Color
+
+TESTS_EXTRAS_URL="https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/tests-extras"
+TESTS_EXTRAS_PATH=".tests-extras"
+
+
+clone_tests_extras() {
+	echo "INFO: Fetching tests-extras scripts into $TESTS_EXTRAS_PATH ..."
+	git clone -b master $TESTS_EXTRAS_URL $TESTS_EXTRAS_PATH >/dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		echo "ERROR: Failed to fetch the $TESTS_EXTRAS_URL repo, exiting.."
+		exit 1
+	fi
+}
+
+create_run_tests() {
+	if [ "$skip_tests" = "yes" ]; then
+		touch .ci_tests_disabled
+		git add .ci_tests_disabled
+	else
+		cp $TESTS_EXTRAS_PATH/templates/run-tests.sh .
+		git add run-tests.sh
+	fi
+}
+
+create_file_changelog() {
+	echo "<DATE> $maintainer - <VERSION>" > ChangeLog
+	git add ChangeLog
+}
+
+create_file_snapcraftyaml() {
+	cat << EOF > snapcraft.yaml
+name: $snap_name
+version: <VERSION>
+summary: <TODO>
+description: |
+  <ADD YOUR CONTENT HERE>
+  Please find the source code at https://code.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/$snap_name
+confinement: strict
+grade: stable
+
+slots:
+
+plugs:
+
+apps:
+
+parts:
+EOF
+	git add snapcraft.yaml
+}
+
+create_file_spreadyaml() {
+	if [ "$skip_tests" = "yes" ]; then
+		exit
+	fi
+
+cat << 'EOF' > spread.yaml
+#
+# Copyright (C) 2015, 2016 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/>.
+
+
+project: <SNAPNAME>
+
+environment:
+    PROJECT_PATH: /home/<SNAPNAME>
+    TESTSLIB: $PROJECT_PATH/tests/lib
+    SNAP_NAME: <SNAPNAME>
+    # Allow the host to pass the channel to use for the test run
+    SNAP_CHANNEL: $(HOST:echo $SNAP_CHANNEL)
+
+backends:
+    qemu:
+        systems:
+            - ubuntu-core-16:
+                username: test
+                password: test
+
+# Put this somewhere where we have read-write access
+path: /home/<SNAPNAME>
+
+exclude:
+  - .git
+
+prepare: |
+  . $TESTSLIB/prepare-all.sh
+
+suites:
+    tests/main/:
+        summary: Full-system tests for <SNAPNAME>
+        systems:
+            - ubuntu-core-16
+        prepare: |
+            . $TESTSLIB/prepare.sh
+        restore-each: |
+            . $TESTSLIB/restore-each.sh
+EOF
+	git add spread.yaml
+}
+
+create_file_gitignore() {
+	cat << 'EOF' > .gitignore
+.tests-extras
+EOF
+	git add .gitignore
+}
+
+create_file_maintainers() {
+	echo $maintainer > MAINTAINERS
+	git add MAINTAINERS
+}
+
+create_file_readme() {
+	cat << EOF > ./README.md
+## $snap_name
+
+This is the snap to package $snap_name
+EOF
+
+	if [ "$skip_tests" = "yes" ]; then
+		cat << 'EOF' >> README.md
+
+## Running tests
+
+We have a set of spread (https://github.com/snapcore/spread) tests which
+can be executed on a virtual machine or real hardware.
+
+In order to run those tests you need the follow things
+
+ * ubuntu-image
+ * spread
+
+ You can install both as a snap
+
+```
+ $ snap install --edge --devmode ubuntu-image
+ $ snap install --devmode spread
+```
+
+NOTE: As of today the version of spread in the store misses support for qemu so
+you have to build your own one for now:
+
+```
+ $ WORKDIR=`mktemp -d`
+ $ export GOPATH=$WORKDIR
+ $ go get -d -v github.com/snapcore/spread/...
+ $ go build github.com/snapcore/spread/cmd/spread
+ $ sudo cp spread /usr/local/bin
+```
+
+Make sure /usr/local/bin is in your path and is used as default:
+
+```
+ $ which spread
+ /usr/local/bin/spread
+```
+
+Now you have everything to run the test suite.
+
+```
+  $ ./run-tests
+```
+
+The script will reach out to tests-extras repository and download the helper
+scripts: image creator and test runner. Next it will execute the test runner
+passing the arguments as-is.
+
+The helper scripts are tracked here:
+https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/tests-extras
+
+The test runner script will create an image via ubuntu-image and make it available
+to spread by copying it to ~/.spread/qemu or ~/snap/spread/<version>/.spread/qemu
+depending on if you're using a local spread version or the one from the
+snap.
+
+If you want to see more verbose debugging output of spread run
+
+```
+ $ ./run-tests --debug
+```
+
+If you do not want to build the network-manager snap from source but test one
+from a specific channel start testing with
+
+```
+ $ ./run-tests --channel=beta --test-from-channel
+```
+
+You can also run spread directly which allows you run just specific tests
+
+```
+ $ spread tests/main/installation
+```
+
+This will by default build the network-manager snap from source. If you
+want it to test it from a specific channel run
+
+```
+ $ SNAP_CHANNEL=candidate spread tests/main/installation
+```
+
+And if you want to run an entire suite
+
+```
+ $ spread tests/main/
+```
+
+## Available test suites
+
+<ADD YOUR CONTENT HERE>
+
+EOF
+	fi
+	git add README.md
+}
+
+# Here it starts
+
+# Check if the scrips has been properly called, if not show help and exit.
+if [ $# -eq 0 ]; then
+	echo "No arguments were specified"
+	echo ""
+	show_help
+	exit 1
+fi
+
+# Parse the arguments
+while [ -n "$1" ]; do
+	case "$1" in
+		--help)
+			show_help
+			exit
+			;;
+		--no-tests)
+			skip_tests="yes"
+			shift
+			;;
+		*)
+			if [ -d $1 ]; then
+				cd $1
+				snap_name=${PWD##*/}
+				shift
+			else
+				echo "Directory $1 does not exists, creating"
+				mkdir -p $1
+				cd $1
+				snap_name=${PWD##*/}
+				shift
+			fi
+			;;
+	esac
+done
+
+# If this is not a git repository
+# then initialize it
+if [ -d .git ]; then
+	echo "${COLOR}Good, this is git repo${NC}"
+else
+	echo "${COLOR}This is not git repo, initializing${NC}"
+	git init
+fi
+
+# Add remote
+echo "${COLOR}Adding remote origin git://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/$snap_name${NC}"
+git remote add origin git://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/$snap_name
+
+# On branch master add empty README.md and commit
+echo "${COLOR}Making an initial commit with empty README.md${NC}"
+echo "# $snap_name" > README.md
+git add README.md && git commit -m "Initial import"
+
+# From now-on everything happens on feature/new-snap branch
+echo "${COLOR}Creating feature/new-snap branch for development${NC}"
+git checkout -b feature/new-snap
+
+echo "${COLOR}Now adding necessary files${NC}"
+clone_tests_extras
+
+create_file_gitignore
+create_file_maintainers
+create_run_tests
+create_file_readme
+create_file_snapcraftyaml
+create_file_spreadyaml
+create_file_changelog
+
+echo "${COLOR}Making an initial commit${NC}"
+git commit -m "add templates for snap development"
+
+echo ""
+echo "At this point you are on a feature/new-snap branch with all the"
+echo "necessary files created and commited. Your job now is to fill them"
+echo "with valid data."
+echo ""
+echo "There is also 'master' branch available with an empty README.md"
+echo "commited (but not pushed) there."
+echo ""
+echo "I have not pushed anything and it is your job to do so. Make sure"
+echo "that you follow the way-of-working that is:"
+echo " - First git push origin master"
+echo " - Add your own remote pointing to your repository and push"
+echo "   feature/new-snap there."
+echo " - Submit your snap as a MP against master branch that you just have"
+echo "   pushed directly"
+echo ""
+echo "Have fun!"
diff --git a/snapcraft.yaml b/snapcraft.yaml
index 1e8e505..b677374 100644
--- a/snapcraft.yaml
+++ b/snapcraft.yaml
@@ -9,28 +9,36 @@ confinement: strict
 grade: stable
 
 apps:
-  snap-revision:
-    command: snap-revision-provider.git
+  bugsurfer:
+    command: "bin/bugsurfer"
     plugs:
       - network
-  snap-release-email:
-    command: snap-release-email-generator.git
+  flightschedule:
+    command: "bin/flightschedule"
+    plugs:
+      - network
+  snap-revision:
+    command: "bin/snap-revision-provider"
     plugs:
       - network
-      - home
   shyaml:
     command: bin/shyaml
+  setup-snap-repo:
+    command: "bin/setup-snap-repo.sh"
+    plugs:
+      - home
 
 parts:
-  snap-revision:
-    plugin: go
-    source: https://github.com/canonical-system-enablement/snap-revision-provider.git
-    source-type: git
-  snap-release-email-generator:
+  se-dev-tools:
     plugin: go
-    source: https://github.com/canonical-system-enablement/snap-release-email-generator.git
-    source-type: git
+    go-importpath: github.com/canonical-system-enablement/se-dev-tools
+    source: https://github.com/canonical-system-enablement/se-dev-tools.git
   shyaml:
     plugin: python
     python-packages:
       - shyaml
+  setup-snap-repo:
+    source: bin/
+    plugin: dump
+    organize:
+      setup-snap-repo.sh: bin/setup-snap-repo.sh