Merge ~sylvain-pineau/checkbox-snappy/+git/checkbox-snappy-classic:content-interface-s16 into ~checkbox-dev/checkbox-snappy/+git/checkbox-snappy-classic:series16

[Sylvain Pineau]

Content interface deployment

Built using the snapcraft snap

diff --git a/launchers/checkbox-launcher-wrapper b/launchers/checkbox-launcher-wrapper
deleted file mode 100755
index bf193ee..0000000
--- a/launchers/checkbox-launcher-wrapper
+++ /dev/null
@@ -1,6 +0,0 @@
-#!/bin/bash
-
-. $(dirname "$(realpath $BASH_SOURCE)")/wrapper_common
-
-cd $HOME
-exec python3 $(which checkbox-launcher) "$@"
diff --git a/launchers/configure b/launchers/configure
index e9b95d1..19863a1 100755
--- a/launchers/configure
+++ b/launchers/configure
@@ -1,18 +1,37 @@
 #!/usr/bin/env python3
-# Copyright 2017 Canonical Ltd.
+# Copyright 2018-2019 Canonical Ltd.
 # All rights reserved.
 #
 # Written by:
 #   Maciej Kisielewski <[e-mail]>
+#   Sylvain Pineau <[e-mail]>
 import os
 import re
 import sys
 
 sys.path.append(os.path.expandvars("$SNAP/usr/lib/python3/dist-packages"))
-sys.path.append(os.path.expandvars("$SNAP/lib/python3.5/site-packages"))
-
-from checkbox_support.snap_utils.config import update_configuration
-from checkbox_support.snap_utils.config import print_checkbox_conf
+sitepkgpath = "$SNAP/lib/python{}.{}/site-packages".format(
+    sys.version_info[0], sys.version_info[1])
+sys.path.append(os.path.expandvars(sitepkgpath))
+
+sys.path.append(os.path.expandvars(
+    "/snap/checkbox/current/usr/lib/python3/dist-packages"))
+runtimepath = "/snap/checkbox/current/lib/python{}.{}/site-packages".format(
+    sys.version_info[0], sys.version_info[1])
+sys.path.append(os.path.expandvars(runtimepath))
+
+try:
+    from checkbox_support.snap_utils.config import update_configuration
+    from checkbox_support.snap_utils.config import print_checkbox_conf
+except ImportError:
+    msg = """
+checkbox-support not found!
+You need to install the checkbox snap:
+
+snap install checkbox
+    """
+    print(os.path.expandvars(msg), file=sys.stderr)
+    sys.exit(1)
 
 
 def main():
diff --git a/launchers/wrapper_common b/launchers/wrapper_common
index 3acbd5d..a5ca8ae 100644
--- a/launchers/wrapper_common
+++ b/launchers/wrapper_common
@@ -12,32 +12,79 @@ case "$SNAP_ARCH" in
     ;;
 esac
 
+################################################
+# Launcher common exports for any checkbox app #
+################################################
+
+function prepend_dir() {
+  local var="$1"
+  local dir="$2"
+  if [ -d "$dir" ]; then
+    eval "export $var=\"\$dir\${$var:+:\$$var}\""
+  fi
+}
+
+function append_dir() {
+  local var="$1"
+  local dir="$2"
+  if [ -d "$dir" ]; then
+    eval "export $var=\"\${$var:+\$$var:}\$dir\""
+  fi
+}
+
+export LC_ALL=C.UTF-8
+PERL_VERSION=$(perl -e '$^V=~/^v(\d+\.\d+)/;print $1')
+export PERL5LIB="$PERL5LIB:$SNAP/usr/lib/$ARCH/perl/$PERL_VERSION:$SNAP/usr/lib/$ARCH/perl5/$PERL_VERSION:$SNAP/usr/share/perl/$PERL_VERSION:$SNAP/usr/share/perl5"
 export GI_TYPELIB_PATH=$SNAP/usr/lib/girepository-1.0:$SNAP/usr/lib/$ARCH/girepository-1.0
+export PATH="$SNAP/usr/sbin:$SNAP/sbin:/snap/bin:$PATH"
+export ALSA_CONFIG_PATH=$SNAP/usr/share/alsa/alsa.conf:$SNAP/usr/share/alsa/pcm/default.conf
+export PYTHONPATH="$SNAP/usr/lib/python3/dist-packages:$PYTHONPATH"
+
+RUNTIME=/snap/checkbox/current
+if [ ! -d "$RUNTIME" ]; then
+    echo "You need to install the checkbox snap."
+    echo ""
+    echo "You can do this with this command:"
+    echo "snap install checkbox"
+    exit 1
+fi
 
-export LIBGL_DRIVERS_PATH=$SNAP/usr/lib/$ARCH/dri
+# add general paths not added by snapcraft due to runtime snap
+append_dir LD_LIBRARY_PATH $RUNTIME/lib/$ARCH
+append_dir LD_LIBRARY_PATH $RUNTIME/usr/lib/$ARCH
+append_dir LD_LIBRARY_PATH $RUNTIME/lib/fwts
+append_dir GI_TYPELIB_PATH $RUNTIME/usr/lib/girepository-1.0
+append_dir GI_TYPELIB_PATH $RUNTIME/usr/lib/$ARCH/girepository-1.0
+prepend_dir PATH $RUNTIME/bin
+prepend_dir PATH $RUNTIME/usr/bin
+prepend_dir PATH $RUNTIME/sbin
+prepend_dir PATH $RUNTIME/usr/sbin
+prepend_dir PATH $RUNTIME/usr/lib/qt5/bin
+append_dir ALSA_CONFIG_PATH $RUNTIME/usr/share/alsa/alsa.conf
+append_dir ALSA_CONFIG_PATH $RUNTIME/usr/share/alsa/pcm/default.conf
+append_dir PYTHONUSERBASE $RUNTIME
+append_dir PYTHONHOME $RUNTIME/usr
+append_dir PYTHONPATH $RUNTIME/usr/lib/python3/dist-packages
+append_dir PYTHONPATH $RUNTIME/lib/python3*/site-packages
+append_dir PERL5LIB $RUNTIME/usr/lib/$ARCH/perl/$PERL_VERSION
+append_dir PERL5LIB $RUNTIME/usr/lib/$ARCH/perl5/$PERL_VERSION
+append_dir PERL5LIB $RUNTIME/usr/share/perl/$PERL_VERSION
+append_dir PERL5LIB $RUNTIME/usr/share/perl5
 
 # Use a modules directory which doesn't exist so we don't load random things
 # which may then get deleted (or their dependencies) and potentially segfault
 export GIO_MODULE_DIR=$SNAP/gio/modules-dummy
 
-export PATH="$SNAP/bin:$SNAP/usr/bin:$SNAP/usr/sbin:$SNAP/sbin:/snap/bin:$PATH"
-
-#export LD_LIBRARY_PATH="$SNAP/lib:$SNAP/usr/lib:$SNAP/lib/$ARCH:$SNAP/usr/lib/$ARCH:$SNAP/lib/fwts:$SNAP/usr/lib/$ARCH/pulseaudio:$LD_LIBRARY_PATH"
-
-export QML2_IMPORT_PATH="$SNAP/usr/lib/$ARCH/qt5/qml:$QML2_IMPORT_PATH"
-export QT_PLUGIN_PATH=$SNAP/usr/lib/$ARCH/qt5/plugins
+export QML2_IMPORT_PATH="$RUNTIME/usr/lib/$ARCH/qt5/qml:$QML2_IMPORT_PATH"
+export QT_PLUGIN_PATH=$RUNTIME/usr/lib/$ARCH/qt5/plugins
 export QT_QPA_PLATFORM=xcb
 export QT_QPA_PLATFORMTHEME=appmenu-qt5
 
-export PYTHONUSERBASE=$SNAP
-export PYTHONHOME=$SNAP/usr
-export PYTHONPATH="$SNAP/usr/lib/python3/dist-packages:$PYTHONPATH"
-
 # Tell GStreamer where to find its plugins
-export GST_PLUGIN_PATH=$SNAP/usr/lib/$ARCH/gstreamer-1.0
-export GST_PLUGIN_SYSTEM_PATH=$SNAP/usr/lib/$ARCH/gstreamer-1.0
+export GST_PLUGIN_PATH=$RUNTIME/usr/lib/$ARCH/gstreamer-1.0
+export GST_PLUGIN_SYSTEM_PATH=$RUNTIME/usr/lib/$ARCH/gstreamer-1.0
 # gst plugin scanner doesn't install in the correct path: https://github.com/ubuntu/snapcraft-desktop-helpers/issues/43
-export GST_PLUGIN_SCANNER=$SNAP/usr/lib/$ARCH/gstreamer1.0/gstreamer-1.0/gst-plugin-scanner
+export GST_PLUGIN_SCANNER=$RUNTIME/usr/lib/$ARCH/gstreamer1.0/gstreamer-1.0/gst-plugin-scanner
 
 # Make PulseAudio socket available inside the snap-specific $XDG_RUNTIME_DIR
 if [ -n "$XDG_RUNTIME_DIR" ]; then
@@ -45,5 +92,7 @@ if [ -n "$XDG_RUNTIME_DIR" ]; then
     export PULSE_SYSTEM=1
 fi
 
+BASE_PROVIDERS=($RUNTIME/providers/*)
+BASE_PROVIDERS_PATH=$(IFS=:; echo "${BASE_PROVIDERS[*]}")
 PROVIDERS=($SNAP/providers/*)
-export PROVIDERPATH=$(IFS=:; echo "${PROVIDERS[*]}")
+export PROVIDERPATH=$(IFS=:; echo "${PROVIDERS[*]}"):$BASE_PROVIDERS_PATH
diff --git a/snap/hooks/configure b/snap/hooks/configure
index 4b5f324..c93e385 100755
--- a/snap/hooks/configure
+++ b/snap/hooks/configure
@@ -1,9 +1,10 @@
 #!/usr/bin/env python3
-# Copyright 2017 Canonical Ltd.
+# Copyright 2017-2019 Canonical Ltd.
 # All rights reserved.
 #
 # Written by:
 #   Maciej Kisielewski <[e-mail]>
+#   Sylvain Pineau <[e-mail]>
 """
 This hook reads `config_vars` file from the root of a snap and reenters this
 configuration using snapd's config facilities and rewrites the file to a
@@ -18,11 +19,15 @@ OPEN_N_SSID
 OPEN_BG_SSID
 STRESS_S3_WAIT_DELAY=60
 
-To change those values using `snap set` command, you need to change CAPS to
-lowercase and underscores to dashes (-).
+To change those values use the configure launcher.
+E.g.
+    $ checkbox-snappy-classic.configure OPEN_N_SSID=my-wifi
+
+If you __really__ need to change those values using `snap set` command,
+you need to change CAPS to lowercase and underscores to dashes (-).
 
 E.g.
-    $ snap set checkbox-snappy open-n-ssid=my-wifi
+    $ snap set checkbox-snappy-classic open-n-ssid=my-wifi
 """
 
 import os
@@ -33,5 +38,21 @@ sitepkgpath = "$SNAP/lib/python{}.{}/site-packages".format(
     sys.version_info[0], sys.version_info[1])
 sys.path.append(os.path.expandvars(sitepkgpath))
 
-from checkbox_support.snap_utils.config import refresh_configuration
+sys.path.append(os.path.expandvars(
+    "/snap/checkbox/current/usr/lib/python3/dist-packages"))
+runtimepath = "/snap/checkbox/current/lib/python{}.{}/site-packages".format(
+    sys.version_info[0], sys.version_info[1])
+sys.path.append(os.path.expandvars(runtimepath))
+
+try:
+    from checkbox_support.snap_utils.config import refresh_configuration
+except ImportError:
+    msg = """
+checkbox-support not found!
+You need to install the checkbox snap:
+
+snap install checkbox
+    """
+    print(os.path.expandvars(msg), file=sys.stderr)
+    sys.exit(1)
 refresh_configuration()
diff --git a/snap/plugins/checkbox_provider.py b/snap/plugins/checkbox_provider.py
new file mode 100644
index 0000000..eded14b
--- /dev/null
+++ b/snap/plugins/checkbox_provider.py
@@ -0,0 +1,67 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2016-2019 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 os
+
+from snapcraft.internal import mangling
+from snapcraft.plugins import plainbox_provider
+
+
+class CheckboxProvider(plainbox_provider.PlainboxProviderPlugin):
+
+    def __init__(self, name, options, project):
+        super().__init__(name, options, project)
+        self.build_snaps.append("checkbox-provider-tools")
+        if project.info.base in (None, "core16"):
+            self.build_snaps.append("checkbox")
+        if project.info.base == "core18":
+            self.build_snaps.append("checkbox18")
+
+    def build(self):
+        env = os.environ.copy()
+        # Ensure the first provider does not attempt to validate against
+        # providers installed on the build host by initialising PROVIDERPATH
+        # to empty
+        env["PROVIDERPATH"] = ""
+        provider_stage_dir = os.path.join(self.project.stage_dir, "providers")
+        if os.path.exists(provider_stage_dir):
+            provider_dirs = [
+                os.path.join(provider_stage_dir, provider)
+                for provider in os.listdir(provider_stage_dir)
+            ]
+            env["PROVIDERPATH"] = ":".join(provider_dirs)
+        for snap_name in self.build_snaps:
+            build_snap_provider_dir = os.path.join(
+                "/snap", snap_name, "current", "providers")
+            if os.path.exists(build_snap_provider_dir):
+                provider_dirs = [
+                    os.path.join(build_snap_provider_dir, provider)
+                    for provider in os.listdir(build_snap_provider_dir)
+                ]
+                env["PROVIDERPATH"] = ":".join(provider_dirs)
+        cmd = "checkbox-provider-tools"
+        self.run([cmd, "validate"], env=env)
+        self.run([cmd, "build"])
+        self.run(
+            [
+                cmd,
+                "install",
+                "--layout=relocatable",
+                "--prefix=/providers/{}".format(self.name),
+                "--root={}".format(self.installdir),
+            ]
+        )
+        mangling.rewrite_python_shebangs(self.installdir)
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index 3a44062..94bef45 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -1,13 +1,10 @@
 name: checkbox-snappy-classic
 summary: Checkbox tests for Snappy devices
 description: "The provider is a collection of tests to be run on Snappy devices.\n"
-version: '16.9.dev'
+version: '16.11.dev'
 grade: stable
 confinement: classic
 
-# Don't forget to add a new slot if a new provider part is added in the parts
-# section below.
-
 apps:
   checkbox-cli:
     command: bin/checkbox-cli-wrapper
@@ -19,8 +16,6 @@ apps:
     command: bin/smoke-test
   snappy-generic-automated:
     command: bin/snappy-generic-automated
-  python3:
-    command: python3
   engineering-tests:
     command: bin/engineering-tests
   hw-collection:
@@ -35,74 +30,12 @@ apps:
     command: bin/shell-wrapper
 
 parts:
-  fwts:
-    source-tag: ""
-  stress-ng:
-    source-tag: ""
-    after: [plainbox-provider-checkbox]
-  checkbox-support-dev:
-    source-tag: ""
-    after: [fwts]
-  checkbox-ng-dev:
-    source-tag: ""
-  plainbox-provider-resource:
-    source-tag: ""
-    after: [checkbox-support-dev, checkbox-ng-dev]
-  plainbox-provider-checkbox:
-    source-tag: ""
-    stage:
-      - -usr/bin/stress-ng
-      - -usr/share/man/man1/stress-ng*
-      - -usr/share/stress-ng/*
-    after: [plainbox-provider-resource]
-  plainbox-provider-snappy:
-    source-tag: ""
-    stage:
-      - -usr/bin/stress-ng
-      - -usr/share/man/man1/stress-ng*
-      - -usr/share/stress-ng/*
-    after: [plainbox-provider-checkbox]
-  plainbox-provider-ipdt:
-    source-tag: ""
-    after: [plainbox-provider-snappy]
-  plainbox-provider-docker:
-    source-tag: ""
-    after: [plainbox-provider-ipdt]
-  plainbox-provider-tpm2:
-    source-tag: ""
-    after: [plainbox-provider-docker, tpm2-tools-3]
-  plainbox-provider-sru:
-    source-tag: ""
-    after: [plainbox-provider-tpm2]
-  plainbox-provider-engineering-tests:
-    source-tag: ""
-    after: [plainbox-provider-sru]
   launchers:
     plugin: dump
     source: launchers/
     organize:
       '*': bin/
-  i2c-tools:
-    plugin: nil
-    stage-packages:
-      - i2c-tools
-    prime:
-      - usr/sbin/i2cdetect
-  # Keep this, fwts builds are somehow affected by staged libs if not built
-  # first hence the after clause in tpm2-tss-1.4.
-  tpm2-tss-1.4:
-    after: [fwts]
-  parts-meta-info:
-    after: [plainbox-provider-engineering-tests]
   config-variables:
     plugin: dump
     source: .
     stage: [config_vars]
-  # This module is a dependency for the job gpio/gpiomem_loopback_pairs_{model}
-  # in plainbox-provider-snappy only available in pypi and so can't be addded
-  # to stage-packages of the remote part
-  rpi-support-libs:
-    plugin: python
-    python-packages:
-      - RPi.GPIO
-      - netifaces