Merge ~sylvain-pineau/checkbox-snappy:content-interface-s16 into checkbox-snappy:series16

[Sylvain Pineau]

Content interface deployment

Tested here: https://trello.com/c/xpXp3eor/854-checkbox-snappy-1611dev-1897

Built using the snapcraft snap

[Jonathan Cave (jocave)]

One question below

review: Needs Information

[Sylvain Pineau (sylvain-pineau)]

See below, just to be future proof

[Jonathan Cave (jocave)]

Ok, lets go with that.

review: Approve

diff --git a/launchers/checkbox-cli-wrapper b/launchers/checkbox-cli-wrapper
index 739ad9e..4b9f1c9 100755
--- a/launchers/checkbox-cli-wrapper
+++ b/launchers/checkbox-cli-wrapper
@@ -1,11 +1,5 @@
 #!/bin/bash
 
-if ! snap list &> /dev/null || ! snap list $SNAP_NAME | grep devmode > /dev/null
-then
-    echo "$SNAP_NAME must be installed with --devmode to function properly!"
-    exit 1
-fi
-
 . $(dirname "$(realpath $BASH_SOURCE)")/wrapper_common
 
 cd $HOME
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..e6502eb 100755
--- a/launchers/configure
+++ b/launchers/configure
@@ -1,18 +1,48 @@
 #!/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"))
+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 update_configuration
-from checkbox_support.snap_utils.config import print_checkbox_conf
+sys.path.append(os.path.expandvars(
+    "$SNAP/checkbox-runtime/usr/lib/python3/dist-packages"))
+runtimepath = "$SNAP/checkbox-runtime/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 connect this snap to the checkbox snap.
+
+You can do this with those commands:
+
+snap connect $SNAP_NAME:checkbox-runtime  checkbox:checkbox-runtime
+snap connect $SNAP_NAME:provider-resource checkbox:provider-resource
+snap connect $SNAP_NAME:provider-checkbox checkbox:provider-checkbox
+snap connect $SNAP_NAME:provider-snappy   checkbox:provider-snappy
+snap connect $SNAP_NAME:provider-ipdt     checkbox:provider-ipdt
+snap connect $SNAP_NAME:provider-docker   checkbox:provider-docker
+snap connect $SNAP_NAME:provider-tpm2     checkbox:provider-tpm2
+snap connect $SNAP_NAME:provider-sru      checkbox:provider-sru
+snap connect $SNAP_NAME:provider-edgex    checkbox:provider-edgex
+snap connect $SNAP_NAME:provider-engineering-tests checkbox:provider-engineering-tests
+    """
+    print(os.path.expandvars(msg), file=sys.stderr)
+    sys.exit(1)
 
 
 def main():
diff --git a/launchers/hw-collection b/launchers/hw-collection
old mode 100644
new mode 100755
diff --git a/launchers/wrapper_common b/launchers/wrapper_common
index 6a02421..00e7a12 100644
--- a/launchers/wrapper_common
+++ b/launchers/wrapper_common
@@ -12,11 +12,59 @@ case "$SNAP_ARCH" in
     ;;
 esac
 
+################################################
+# Launcher common exports for any checkbox app #
+################################################
+
+function append_dir() {
+  local var="$1"
+  local dir="$2"
+  if [ -d "$dir" ]; then
+    eval "export $var=\"\${$var:+\$$var:}\$dir\""
+  fi
+}
+
+if [ -d $SNAP/checkbox-runtime ]; then
+  RUNTIME=$SNAP/checkbox-runtime
+  if [ ! -d $RUNTIME/usr ]; then
+    echo "You need to connect this snap to the checkbox snap."
+    echo ""
+    echo "You can do this with those commands:"
+    echo "snap install checkbox"
+    echo "snap connect $SNAP_NAME:checkbox-runtime checkbox:checkbox-runtime"
+    exit 1
+  fi
+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="$PATH:$SNAP/usr/sbin:$SNAP/sbin:/snap/bin"
-export PYTHONPATH="$SNAP/usr/lib/python3/dist-packages:$PYTHONPATH"
 export ALSA_CONFIG_PATH=$SNAP/usr/share/alsa/alsa.conf:$SNAP/usr/share/alsa/pcm/default.conf
-export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$SNAP/lib/fwts"
+export PYTHONPATH="$SNAP/usr/lib/python3/dist-packages:$PYTHONPATH"
+
+if [ -z "$RUNTIME" ]; then
+  RUNTIME=$SNAP
+else
+  # add general paths not added by snapcraft due to runtime snap
+  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
+  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
+  append_dir PATH $RUNTIME/bin
+  append_dir PATH $RUNTIME/usr/bin
+  append_dir PATH $RUNTIME/sbin
+  append_dir PATH $RUNTIME/usr/sbin
+  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
+fi
diff --git a/snap/hooks/configure b/snap/hooks/configure
index 0973a72..2808d23 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
@@ -37,5 +38,32 @@ 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-runtime/usr/lib/python3/dist-packages"))
+runtimepath = "$SNAP/checkbox-runtime/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 connect this snap to the checkbox snap.
+
+You can do this with those commands:
+
+snap connect $SNAP_NAME:checkbox-runtime  checkbox:checkbox-runtime
+snap connect $SNAP_NAME:provider-resource checkbox:provider-resource
+snap connect $SNAP_NAME:provider-checkbox checkbox:provider-checkbox
+snap connect $SNAP_NAME:provider-snappy   checkbox:provider-snappy
+snap connect $SNAP_NAME:provider-ipdt     checkbox:provider-ipdt
+snap connect $SNAP_NAME:provider-docker   checkbox:provider-docker
+snap connect $SNAP_NAME:provider-tpm2     checkbox:provider-tpm2
+snap connect $SNAP_NAME:provider-sru      checkbox:provider-sru
+snap connect $SNAP_NAME:provider-edgex    checkbox:provider-edgex
+snap connect $SNAP_NAME:provider-engineering-tests checkbox:provider-engineering-tests
+    """
+    print(os.path.expandvars(msg), file=sys.stderr)
+    sys.exit(0)
 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 745f397..fb95ce5 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -4,49 +4,47 @@ description: "The provider is a collection of tests to be run on Snappy devices.
 version: '16.11.dev'
 grade: stable
 
-# Don't forget to add a new slot if a new provider part is added in the parts
-# section below.
-slots:
+plugs:
+  checkbox-runtime:
+    interface: content
+    target: $SNAP/checkbox-runtime
+    default-provider: checkbox
   provider-resource:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-resource
+    target: $SNAP/providers/plainbox-provider-resource
+    default-provider: checkbox
   provider-checkbox:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-checkbox
+    target: $SNAP/providers/plainbox-provider-checkbox
+    default-provider: checkbox
   provider-snappy:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-snappy
+    target: $SNAP/providers/plainbox-provider-snappy
+    default-provider: checkbox
   provider-ipdt:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-ipdt
+    target: $SNAP/providers/plainbox-provider-ipdt
+    default-provider: checkbox
   provider-docker:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-docker
+    target: $SNAP/providers/plainbox-provider-docker
+    default-provider: checkbox
   provider-tpm2:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-tpm2
+    target: $SNAP/providers/plainbox-provider-tpm2
+    default-provider: checkbox
   provider-engineering-tests:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-engineering-tests
+    target: $SNAP/providers/plainbox-provider-engineering-tests
+    default-provider: checkbox
   provider-sru:
     interface: content
-    read:
-      - $SNAP/providers/plainbox-provider-sru
+    target: $SNAP/providers/plainbox-provider-sru
+    default-provider: checkbox
   provider-edgex:
     interface: content
-    read:
-      - $SNAP/providers/checkbox-provider-edgex
-  checkbox-runtime:
-    interface: content
-    read:
-      - /
+    target: $SNAP/providers/checkbox-provider-edgex
+    default-provider: checkbox
 
 apps:
   checkbox-cli:
@@ -69,9 +67,6 @@ apps:
   test-runner-edgex:
     command: bin/test-runner-edgex
     plugs: *standard
-  python3:
-    command: python3
-    plugs: *standard
   engineering-tests:
     command: bin/engineering-tests
     plugs: *standard
@@ -90,64 +85,12 @@ apps:
     plugs: *standard
 
 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: ""
-    after: [plainbox-provider-resource]
-  plainbox-provider-snappy:
-    source-tag: ""
-    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]
-  plainbox-provider-sru:
-    source-tag: ""
-    after: [plainbox-provider-tpm2]
-  plainbox-provider-engineering-tests:
-    source-tag: ""
-    after: [plainbox-provider-sru]
-  checkbox-provider-edgex:
-    source-tag: ""
-    after: [plainbox-provider-engineering-tests]
   launchers:
     plugin: dump
     source: launchers/
     organize:
       '*': bin/
-  i2c-tools:
-    plugin: nil
-    stage-packages:
-      - i2c-tools
-    prime:
-      - usr/sbin/i2cdetect
-  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