Merge lp:~canonical-platform-qa/snappy-ecosystem-tests/fix_private_snap_test into lp:snappy-ecosystem-tests

[Omer Akram]

Stabilize private snap install test.

Stabilize private snap install test. The test was failing sometimes as there is a timing issue between the time a snap is published and it actually being installable. The difference is closely 1-2 seconds. To ensure stability we first check if the snap is really available by calling 'snap info'.

[Omer Akram (om26er)]

Test results: http://paste.ubuntu.com/24197140/ -- Excuse the failing tests, that's because I am running these tests in a remote environment where X is not available.

[Omer Akram (om26er)]

*test.

On Sat, Mar 18, 2017 at 1:07 AM, Omer Akram <email address hidden>
wrote:

> Test results: http://paste.ubuntu.com/24197140/ -- Excuse the failing
> tests, that's because I am running these tests in a remote environment
> where X is not available.
> --
> https://code.launchpad.net/~canonical-platform-qa/snappy-
> ecosystem-tests/fix_private_snap_test/+merge/320255
> Your team Canonical Platform QA Team is subscribed to branch
> lp:~canonical-platform-qa/snappy-ecosystem-tests/fix_private_snap_test.
>

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

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

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

review: Approve (continuous-integration)

[lp:~canonical-platform-qa/snappy-ecosystem-tests/fix_private_snap_test]

94. By Omer Akram on 2017-03-17

Be absolute when waiting for snap to publish

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

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

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

review: Approve (continuous-integration)

[lp:~canonical-platform-qa/snappy-ecosystem-tests/fix_private_snap_test]

95. By Omer Akram on 2017-03-17

more reusable code

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

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

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

review: Approve (continuous-integration)

[lp:~canonical-platform-qa/snappy-ecosystem-tests/fix_private_snap_test]

96. By Omer Akram on 2017-03-19

More rock solid is_published

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

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

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

review: Approve (continuous-integration)

[Heber Parrucci (heber013)]

Code LGTM

review: Approve

=== modified file 'snappy_ecosystem_tests/helpers/snapd/snapd.py'
--- snappy_ecosystem_tests/helpers/snapd/snapd.py	2017-03-16 16:49:31 +0000
+++ snappy_ecosystem_tests/helpers/snapd/snapd.py	2017-03-19 15:27:27 +0000
@@ -22,6 +22,7 @@
 
 import json
 import logging
+from time import sleep
 
 import yaml
 
@@ -166,3 +167,39 @@
         return Snapd._parse_output(
             self.run_snapd_command_ssh(COMMAND_FIND.format(
                 search_term=keyword)))
+
+    def is_published(self, snap_name, revision, channel='stable'):
+        """Return bool representing whether a snap is published.
+
+        :param snap_name: Name of the snap to check.
+        :param revision: Revision to check.
+        :param channel: Channel to check.
+        :return: True if published, False otherwise.
+        """
+        try:
+            return int(self.info(snap_name)['channels'][channel].split()[1]
+                       .strip('()')) >= int(revision)
+        except (ValueError, KeyError):
+            return False
+
+    def wait_for_publish(self, snap_name, revision, channel='stable',
+                         retry_attempts=10, retry_interval=1):
+        """Waits for the requested snap to publish by checking if its info
+        can be retrieved.
+
+        :param snap_name: Name of the snap to wait for publish.
+        :param revision: Snap revision number to check.
+        :param channel: Channel to check snap in.
+        :param retry_attempts: Number of times to check for the publish.
+        :param retry_interval: Time between each attempt.
+        :raises ValueError: If the snap is not found published after the
+            given time.
+        """
+        for _ in range(retry_attempts):
+            if self.is_published(snap_name, revision, channel):
+                break
+            else:
+                sleep(retry_interval)
+        else:
+            raise ValueError('Snap not published, waited {} seconds.'.format(
+                retry_attempts * retry_interval))

=== modified file 'snappy_ecosystem_tests/tests/test_install_private_snap.py'
--- snappy_ecosystem_tests/tests/test_install_private_snap.py	2017-03-16 19:28:12 +0000
+++ snappy_ecosystem_tests/tests/test_install_private_snap.py	2017-03-19 15:27:27 +0000
@@ -49,13 +49,17 @@
         """Test to register and upload a private snap via the REST API
         and installing through snapd."""
         snap_name = get_random_snap_name()
+        channels = ['stable']
+        revision = '1'
         self.assertTrue(self.store.register(snap_name, private=True),
                         'Unable to register snap')
         # Upload the snap and wait for its processing on server to finish.
         tracker = self.store.upload(
             snap_name, self.snap_builder.build_and_pull(snap_name, '0.1'))
         tracker.track()
-        self.store.release(snap_name, '1', ['stable'])
+        response = self.store.release(snap_name, revision, channels)
+        self.assertEqual(channels, response.get('opened_channels', None))
+        self.snapd.wait_for_publish(snap_name, revision, channels[0])
         self.snapd.install(snap_name)
         self.addCleanup(self.snapd.remove, snap_name)
         self.assertTrue(self.snapd.is_installed, snap_name)