Merge lp:~sbaldassin/snappy-ecosystem-tests/merge_builder_snapd into lp:snappy-ecosystem-tests

[Santiago Baldassin]

Merge Snapcraft and SnapBuilder in a single class

This mp merge Snapcraft and SnapBuilder in a single class as they represent the same class. We'll need to instantiate two different objects, pointing to the builder container and the snapcraft container respectively

[platform-qa-bot (platform-qa-bot)]

PASSED: Continuous integration, rev:47
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/295/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2150/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/295/rebuild

review: Approve (continuous-integration)

[Heber Parrucci (heber013)]

Looks good. One comment inline

review: Needs Fixing

[lp:~sbaldassin/snappy-ecosystem-tests/merge_builder_snapd]

48. By Santiago Baldassin on 2017-03-20

Addressing comments from the reviews

[Santiago Baldassin (sbaldassin)]

Thanks Heber. Comments addressed

[platform-qa-bot (platform-qa-bot)]

PASSED: Continuous integration, rev:48
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/301/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2159/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/301/rebuild

review: Approve (continuous-integration)

[Heber Parrucci (heber013)]

There are some tests failing in this branch that pass on trunk, see log http://paste.ubuntu.com/24215045/

Seems that the time between snaps registration is broken.

review: Needs Fixing

[lp:~sbaldassin/snappy-ecosystem-tests/merge_builder_snapd]

49. By Santiago Baldassin on 2017-03-20

Merge from trunk

[platform-qa-bot (platform-qa-bot)]

PASSED: Continuous integration, rev:49
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/302/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2160/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/302/rebuild

review: Approve (continuous-integration)

[lp:~sbaldassin/snappy-ecosystem-tests/merge_builder_snapd]

50. By Santiago Baldassin on 2017-03-22

Merge from trunk

[platform-qa-bot (platform-qa-bot)]

PASSED: Continuous integration, rev:50
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/304/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/2176/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/snappy-ecosystem-tests-ci/304/rebuild

review: Approve (continuous-integration)

[Heber Parrucci (heber013)]

Tests are passing properly now http://paste.ubuntu.com/24269814/.
Let's land it.

review: Approve

=== removed file 'snappy_ecosystem_tests/helpers/snapcraft/build_snap.py'
--- snappy_ecosystem_tests/helpers/snapcraft/build_snap.py	2017-03-16 11:40:13 +0000
+++ snappy_ecosystem_tests/helpers/snapcraft/build_snap.py	1970-01-01 00:00:00 +0000
@@ -1,161 +0,0 @@
-# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-
-#
-# Snappy Ecosystem Tests
-# Copyright (C) 2017 Canonical
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# 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/>.
-#
-
-"""Module to build a snap in a remote machine."""
-
-import os
-from pathlib import PurePath
-
-from snappy_ecosystem_tests.utils.ssh import SSHManager
-
-COMMANDS_SETUP = [
-    'apt update',
-    'apt dist-upgrade -y',
-    'apt install snapcraft -y'
-]
-SNAPCRAFT_YAML = """\
-name: {snap_name}
-version: {version}
-summary: {summary}
-description: |
-  {description}
-
-grade: {grade}
-confinement: {confinement}
-
-parts:
-  {snap_name}:
-    plugin: nil
-
-apps:
-  {snap_name}:
-    command: echo ok
-"""
-SUMMARY_SNAP_DEFAULT = 'A test snap.'
-DESCRIPTION_SNAP_DEFAULT = 'A very awesome test snap.'
-GRADE_SNAP_DEFAULT = 'stable'
-CONFINEMENT_SNAP_DEFAULT = 'strict'
-
-
-class SnapBuilder:
-    """Class to build a snap on a remote machine and download its content."""
-    def __init__(self, hostname, username, port=22):
-        self.hostname = hostname
-        self.username = username
-        self.port = port
-
-    @property
-    def ssh(self):
-        """Property tu ensure we get an active connection for every command
-         execution over ssh"""
-        return SSHManager.get_instance(self.hostname, self.username, self.port)
-
-    def run_command_ssh(self, command, cwd=''):
-        """Run command over ssh with optional cwd."""
-        if cwd:
-            command = 'cd {}; {}'.format(cwd, command)
-        return self.ssh.exec_command(command)
-
-    def is_host_setup(self):
-        """Return bool representing whether the remote host is setup by
-        checking if snapcraft package is installed."""
-        try:
-            self.ssh.exec_command('which snapcraft')
-            return True
-        except ValueError:
-            return False
-
-    def setup_host(self):
-        """Setup the host to build a snap, currently only installs
-        snapcraft."""
-        for command in COMMANDS_SETUP:
-            self.ssh.exec_command(command)
-
-    def build(self, name, version, summary=SUMMARY_SNAP_DEFAULT,
-              description=DESCRIPTION_SNAP_DEFAULT, grade=GRADE_SNAP_DEFAULT,
-              confinement=CONFINEMENT_SNAP_DEFAULT):
-        """Build a new snap in the remote host and return its remote path.
-
-        :param name: name of the snap to build.
-        :param version: version number for the snap to build.
-        :param summary: short summary of the snap to build.
-        :param description: long description of the snap.
-        :param grade: stability grade of the snap e.g. stable or devel.
-        :param confinement: confinement policy for the snap e.g.
-            classic, devmode or strict.
-        :raises ValueError: If an error is occurred during snap build.
-        :return: Remote path of the newly build snap package.
-        """
-        if not self.is_host_setup():
-            self.setup_host()
-        tempdir = self.ssh.exec_command('mktemp -d')
-        self.run_command_ssh('mkdir snap', cwd=tempdir)
-        self.run_command_ssh('echo "{}" > snap/snapcraft.yaml'.format(
-            SNAPCRAFT_YAML.format(
-                snap_name=name,
-                version=version,
-                summary=summary,
-                description=description,
-                grade=grade,
-                confinement=confinement
-            )
-        ), cwd=tempdir)
-        self.run_command_ssh('snapcraft', cwd=tempdir)
-        return os.path.join(
-            tempdir,
-            '{name}_{version}_{arch}.snap'.format(
-                name=name,
-                version=version,
-                arch=self.ssh.exec_command('dpkg --print-architecture')
-            )
-        )
-
-    def build_and_pull(self, name, version, summary=SUMMARY_SNAP_DEFAULT,
-                       description=DESCRIPTION_SNAP_DEFAULT,
-                       grade=GRADE_SNAP_DEFAULT,
-                       confinement=CONFINEMENT_SNAP_DEFAULT,
-                       output_location='.'):
-        """Build a snap based on the provided arguments and download it.
-
-        :param name: name of the snap to build.
-        :param version: version number for the snap to build.
-        :param summary: short summary of the snap to build.
-        :param description: long description of the snap.
-        :param grade: stability grade of the snap e.g. stable or devel.
-        :param confinement: confinement policy for the snap e.g.
-            classic, devmode or strict.
-        :param output_location: Local location to download the newly built
-            snap to. Defaults to pwd.
-        :raises ValueError: If an error is occurred during snap build.
-        :return: Local path of the newly built and downloaded snap package.
-        """
-        remote_snap_path = self.build(
-            name=name,
-            version=version,
-            summary=summary,
-            description=description,
-            grade=grade,
-            confinement=confinement
-        )
-        output_path_absolute = os.path.abspath(
-            os.path.join(output_location, PurePath(remote_snap_path).name)
-        )
-        self.ssh.pull(remote_snap_path, output_path_absolute)
-        return output_path_absolute

=== modified file 'snappy_ecosystem_tests/helpers/snapcraft/client.py'
--- snappy_ecosystem_tests/helpers/snapcraft/client.py	2017-03-16 16:42:44 +0000
+++ snappy_ecosystem_tests/helpers/snapcraft/client.py	2017-03-22 12:29:23 +0000
@@ -21,9 +21,12 @@
 """Snapcraft client helpers"""
 
 import logging
+import os
 import subprocess
 import time
 
+from pathlib import PurePath
+
 from snappy_ecosystem_tests.models.snap import Snap
 from snappy_ecosystem_tests.utils.commands import build_command
 from snappy_ecosystem_tests.utils.filters import filter_list
@@ -61,6 +64,34 @@
 SNAPCRAFT_CONFIG_FILE_PATH = '~/.config/snapcraft/snapcraft.cfg'
 
 
+COMMANDS_SETUP = [
+    'apt update',
+    'apt dist-upgrade -y',
+    'apt install snapcraft -y'
+]
+SNAPCRAFT_YAML = """\
+name: {snap_name}
+version: {version}
+summary: {summary}
+description: |
+  {description}
+
+grade: {grade}
+confinement: {confinement}
+
+parts:
+  {snap_name}:
+    plugin: nil
+
+apps:
+  {snap_name}:
+    command: echo ok
+"""
+SUMMARY_SNAP_DEFAULT = 'A test snap.'
+DESCRIPTION_SNAP_DEFAULT = 'A very awesome test snap.'
+GRADE_SNAP_DEFAULT = 'stable'
+CONFINEMENT_SNAP_DEFAULT = 'strict'
+
 class Snapcraft:
     """Contain Snapcraft specific functionality to use via command
     line interface"""
@@ -75,7 +106,22 @@
          execution over ssh"""
         return SSHManager.get_instance(HOSTNAME, USERNAME, PORT)
 
-    def _run_snapcraft_command_ssh(self, command, debug=True):
+    def is_host_setup(self):
+        """Return bool representing whether the remote host is setup by
+        checking if snapcraft package is installed."""
+        try:
+            self.ssh.run_command('which snapcraft')
+            return True
+        except ValueError:
+            return False
+
+    def setup_host(self):
+        """Setup the host to build a snap, currently only installs
+        snapcraft."""
+        for command in COMMANDS_SETUP:
+            self.ssh.run_command(command)
+
+    def _run_snapcraft_command_ssh(self, command='', debug=True, cwd=''):
         """
         Run snapcraft command via ssh
         :param command: the command to be executed.
@@ -87,7 +133,7 @@
             command = build_snapcraft_command(command)
         if debug:
             command += ' -d'
-        return self.ssh.exec_command(command)
+        return self.ssh.run_command(command, cwd=cwd)
 
     def assert_logged_in(self):
         """Assert that an user is logged.
@@ -100,7 +146,7 @@
     def is_logged_in(self):
         """Return bool representing if the user is logged into snapcraft."""
         try:
-            output = self.ssh.exec_command(
+            output = self.ssh.run_command(
                 'cat %s' % SNAPCRAFT_CONFIG_FILE_PATH)
             return output is not ''
         except ValueError:
@@ -123,7 +169,7 @@
         :param email: the SSO email
         :param password: the email password
         """
-        self.ssh.exec_command(
+        self.ssh.run_command(
             COMMANDS_LOGIN.format(email=email, password=password,
                                   snapcraft=PATH_SNAPCRAFT))
         return self.is_logged_in()
@@ -185,6 +231,79 @@
         LOGGER.info('Snap %s registered successfully!!!', snap_name)
         return True
 
+    def build(self, name, version, summary=SUMMARY_SNAP_DEFAULT,
+              description=DESCRIPTION_SNAP_DEFAULT, grade=GRADE_SNAP_DEFAULT,
+              confinement=CONFINEMENT_SNAP_DEFAULT):
+        """Build a new snap in the remote host and return its remote path.
+
+        :param name: name of the snap to build.
+        :param version: version number for the snap to build.
+        :param summary: short summary of the snap to build.
+        :param description: long description of the snap.
+        :param grade: stability grade of the snap e.g. stable or devel.
+        :param confinement: confinement policy for the snap e.g.
+            classic, devmode or strict.
+        :raises ValueError: If an error is occurred during snap build.
+        :return: Remote path of the newly build snap package.
+        """
+        if not self.is_host_setup():
+            self.setup_host()
+        tempdir = self.ssh.run_command('mktemp -d')
+        self.ssh.run_command('mkdir snap', cwd=tempdir)
+        self.ssh.run_command(
+            'echo "{}" > snap/snapcraft.yaml'.format(
+                SNAPCRAFT_YAML.format(
+                    snap_name=name,
+                    version=version,
+                    summary=summary,
+                    description=description,
+                    grade=grade,
+                    confinement=confinement
+                )
+            ), cwd=tempdir)
+        self._run_snapcraft_command_ssh(cwd=tempdir)
+        return os.path.join(
+            tempdir,
+            '{name}_{version}_{arch}.snap'.format(
+                name=name,
+                version=version,
+                arch=self.ssh.run_command('dpkg --print-architecture')
+            )
+        )
+
+    def build_and_pull(self, name, version, summary=SUMMARY_SNAP_DEFAULT,
+                       description=DESCRIPTION_SNAP_DEFAULT,
+                       grade=GRADE_SNAP_DEFAULT,
+                       confinement=CONFINEMENT_SNAP_DEFAULT,
+                       output_location='.'):
+        """Build a snap based on the provided arguments and download it.
+
+        :param name: name of the snap to build.
+        :param version: version number for the snap to build.
+        :param summary: short summary of the snap to build.
+        :param description: long description of the snap.
+        :param grade: stability grade of the snap e.g. stable or devel.
+        :param confinement: confinement policy for the snap e.g.
+            classic, devmode or strict.
+        :param output_location: Local location to download the newly built
+            snap to. Defaults to pwd.
+        :raises ValueError: If an error is occurred during snap build.
+        :return: Local path of the newly built and downloaded snap package.
+        """
+        remote_snap_path = self.build(
+            name=name,
+            version=version,
+            summary=summary,
+            description=description,
+            grade=grade,
+            confinement=confinement
+        )
+        output_path_absolute = os.path.abspath(
+            os.path.join(output_location, PurePath(remote_snap_path).name)
+        )
+        self.ssh.pull(remote_snap_path, output_path_absolute)
+        return output_path_absolute
+
 
 def build_snapcraft_command(*args, base_command=PATH_SNAPCRAFT):
     """

=== modified file 'snappy_ecosystem_tests/helpers/snapd/snapd.py'
--- snappy_ecosystem_tests/helpers/snapd/snapd.py	2017-03-19 15:27:11 +0000
+++ snappy_ecosystem_tests/helpers/snapd/snapd.py	2017-03-22 12:29:23 +0000
@@ -74,7 +74,7 @@
             command = '{} {}'.format(PATH_SNAP, command)
         if cwd:
             command = '{}; {}'.format(cwd, command)
-        return self.ssh.exec_command(command)
+        return self.ssh.run_command(command)
 
     def login(self, email, password):
         """Login to snapd.
@@ -82,15 +82,15 @@
         :param email: Ubuntu SSO account email address.
         :param password: Ubuntu SSO account password.
         """
-        self.ssh.exec_command(COMMANDS_LOGIN.format(email=email,
-                                                    password=password))
+        self.ssh.run_command(COMMANDS_LOGIN.format(email=email,
+                                                   password=password))
         return self.is_logged_in(email)
 
     def is_logged_in(self, email):
         """Return bool representing if the user is logged into snapd."""
         try:
             return json.loads(
-                self.ssh.exec_command(
+                self.ssh.run_command(
                     'cat ~/.snap/auth.json')).get('email') == email
         except ValueError:
             return False
@@ -108,7 +108,7 @@
         """
         command = COMMAND_DOWNLOAD.format(snap=snap, channel=channel)
         self.run_snapd_command_ssh(command,
-                                   cwd=self.ssh.exec_command('mktemp -d'))
+                                   cwd=self.ssh.run_command('mktemp -d'))
 
     def install(self, snap, channel=CHANNEL_STABLE):
         """Install the requested snap."""

=== modified file 'snappy_ecosystem_tests/helpers/test_base.py'
--- snappy_ecosystem_tests/helpers/test_base.py	2017-03-08 17:29:20 +0000
+++ snappy_ecosystem_tests/helpers/test_base.py	2017-03-22 12:29:23 +0000
@@ -15,7 +15,6 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """Base Snappy Ecosystem test"""
-
 import testscenarios
 import testtools
 

=== modified file 'snappy_ecosystem_tests/tests/test_install_private_snap.py'
--- snappy_ecosystem_tests/tests/test_install_private_snap.py	2017-03-17 20:50:55 +0000
+++ snappy_ecosystem_tests/tests/test_install_private_snap.py	2017-03-22 12:29:23 +0000
@@ -19,16 +19,12 @@
 #
 
 """Tests for Installing private snaps."""
-
+from snappy_ecosystem_tests.helpers.snapcraft.client import Snapcraft
 from snappy_ecosystem_tests.helpers.snapd.snapd import Snapd
 from snappy_ecosystem_tests.helpers.store_apis.rest_apis import Store
-from snappy_ecosystem_tests.helpers.snapcraft.build_snap import SnapBuilder
 from snappy_ecosystem_tests.helpers.test_base import SnappyEcosystemTestCase
 from snappy_ecosystem_tests.tests.commons import get_random_snap_name
 from snappy_ecosystem_tests.utils.storeconfig import get_store_credentials
-from snappy_ecosystem_tests.utils.user import (
-    get_snapcraft_remote_host_credentials
-)
 
 
 class RegisterInstallPrivateSnapTestCase(SnappyEcosystemTestCase):
@@ -42,8 +38,7 @@
         self.addCleanup(self.snapd.logout, email)
         self.store.login(email, password)
         self.addCleanup(self.store.logout)
-        self.snap_builder = SnapBuilder(
-            *get_snapcraft_remote_host_credentials())
+        self.snap_builder = Snapcraft()
 
     def test_upload_and_install_private_snap(self):
         """Test to register and upload a private snap via the REST API

=== modified file 'snappy_ecosystem_tests/utils/ssh.py'
--- snappy_ecosystem_tests/utils/ssh.py	2017-03-09 17:24:06 +0000
+++ snappy_ecosystem_tests/utils/ssh.py	2017-03-22 12:29:23 +0000
@@ -30,12 +30,14 @@
 class SSHClient(paramiko.SSHClient):
     """Extended SSHClient."""
 
-    def exec_command(self, command, bufsize=-1, timeout=None, get_pty=False,
-                     environment=None):
+    def run_command(self, command, bufsize=-1, timeout=None,
+                    get_pty=False, cwd=''):
         """Execute the given command over ssh."""
+        if cwd:
+            command = 'cd {}; {}'.format(cwd, command)
         _, stdout, stderr = super().exec_command(
             command, bufsize, timeout,
-            get_pty, environment=environment)
+            get_pty)
         if stdout.channel.recv_exit_status() != 0:
             raise ValueError(stderr.read().decode().strip())
         response = stdout.read().decode().strip()

=== modified file 'snappy_ecosystem_tests/utils/user.py'
--- snappy_ecosystem_tests/utils/user.py	2017-03-09 10:41:13 +0000
+++ snappy_ecosystem_tests/utils/user.py	2017-03-22 12:29:23 +0000
@@ -27,7 +27,6 @@
 
 MANAGER = get_manager(os.environ['target'])
 
-
 def get_snapd_remote_host_credentials():
     """Return credentials for snapd remote machine, to run commands on."""
     _ip = MANAGER.driver.get_ip(USER_CONFIG_STACK.get(