Merge lp:~free.ekanayaka/landscape-charm/use-sample-hashids-for-tests into lp:~landscape/landscape-charm/trunk

[Free Ekanayaka]

Use the lightweight hashids package when running integration tests.

This branch changes the integration tests code to add a "flag" use-sample-hashids file to the charm directory. If the install hook sees this file it will add an extra PPA that holds a lightweight hashids package.

Use the lightweight hashids package when running integration tests.

This branch changes the integration tests code to add a "flag" use-sample-hashids file to the charm directory. If the install hook sees this file it will add an extra PPA that holds a lightweight hashids package.

The extra PPA is a temporary one, but is good enough for now.

To test it, just run integration tests:

SKIP_SLOW_TESTS=1 make integration-test-trunk

(make sure juju is pointing to a non-bootstrapped environment, with the local provider)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 264
Branch: lp:~free.ekanayaka/landscape-charm/use-sample-hashids-for-tests
Jenkins: https://ci.lscape.net/job/latch-test/892/

review: Approve (test results)

[lp:~free.ekanayaka/landscape-charm/use-sample-hashids-for-tests]

265. By Free Ekanayaka on 2015-05-11

Merge from trunk

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 265
Branch: lp:~free.ekanayaka/landscape-charm/use-sample-hashids-for-tests
Jenkins: https://ci.lscape.net/job/latch-test/894/

review: Approve (test results)

[Björn Tillenius (bjornt)]

Thanks for this, this reduced the deploy time by 30 seconds for me. +1 with some minor comments.

review: Approve

[lp:~free.ekanayaka/landscape-charm/use-sample-hashids-for-tests]

266. By Free Ekanayaka on 2015-05-12

Address review comments

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 266
Branch: lp:~free.ekanayaka/landscape-charm/use-sample-hashids-for-tests
Jenkins: https://ci.lscape.net/job/latch-test/904/

review: Approve (test results)

[Fernando Correa Neto (fcorrea)]

Looks good. +1

Still having 100% of cronjob failures but it seems unrelated to this branch.

review: Approve

=== modified file 'lib/apt.py'
--- lib/apt.py	2015-04-08 11:28:24 +0000
+++ lib/apt.py	2015-05-12 10:27:12 +0000
@@ -13,6 +13,10 @@
 PACKAGES_DEV = ("dpkg-dev", "pbuilder")
 TARBALL = "landscape-server_*.tar.gz"
 
+# XXX Eventually we'll want to use a dedicated PPA, populated by Jenkins.
+SAMPLE_HASHIDS_PPA = "ppa:landscape/fake-kernel"
+SAMPLE_HASHIDS_KEY = "4652B4E6"
+
 # XXX Default options taken from charmhelpers, there's no way to just
 #     extend them.
 DEFAULT_INSTALL_OPTIONS = ("--option=Dpkg::Options::=--force-confold",)
@@ -86,6 +90,9 @@
 
         self._fetch.add_source(source, config.get("key"))
 
+        if self._use_sample_hashids():
+            self._fetch.add_source(SAMPLE_HASHIDS_PPA, SAMPLE_HASHIDS_KEY)
+
         return True
 
     def _set_local_source(self):
@@ -135,3 +142,12 @@
             fd.write(digest)
 
         return True
+
+    def _use_sample_hashids(self):
+        """Whether to use sample hashids instead of the real ones.
+
+        This method will check for a 'use-sample-hashids' file in the charm
+        directory and return True if it finds one.
+        """
+        charm_dir = self._hookenv.charm_dir()
+        return os.path.exists(os.path.join(charm_dir, "use-sample-hashids"))

=== modified file 'lib/tests/test_apt.py'
--- lib/tests/test_apt.py	2015-03-09 11:56:34 +0000
+++ lib/tests/test_apt.py	2015-05-12 10:27:12 +0000
@@ -1,6 +1,8 @@
 import os
 
-from lib.apt import Apt, PACKAGES, BUILD_LOCAL_ARCHIVE, DEFAULT_INSTALL_OPTIONS
+from lib.apt import (
+    Apt, PACKAGES, BUILD_LOCAL_ARCHIVE, DEFAULT_INSTALL_OPTIONS,
+    SAMPLE_HASHIDS_PPA, SAMPLE_HASHIDS_KEY)
 from lib.hook import HookError
 from lib.tests.stubs import FetchStub, SubprocessStub
 from lib.tests.helpers import HookenvTest
@@ -64,6 +66,23 @@
         self.assertEqual([("ppa:landscape/15.01", None)], self.fetch.sources)
         self.assertEqual([True], self.fetch.updates)
 
+    def test_set_sources_sample_hashids(self):
+        """
+        The C{set_sources} method adds the sample hashids PPA if a
+        file named 'use-sample-hashids' is found.
+        """
+        self.hookenv.config()["source"] = "ppa:landscape/14.10"
+        flag_file = os.path.join(
+            self.hookenv.charm_dir(), "use-sample-hashids")
+        with open(flag_file, "w") as fd:
+            fd.write("")
+        self.apt.set_sources()
+        self.assertEqual(
+            [("ppa:landscape/14.10", None),
+             (SAMPLE_HASHIDS_PPA, SAMPLE_HASHIDS_KEY)],
+            self.fetch.sources)
+        self.assertEqual([True], self.fetch.updates)
+
     def test_local_tarball(self):
         """
         If a Landscape tarball is found, the C{set_sources} method builds local

=== modified file 'tests/helpers.py'
--- tests/helpers.py	2015-05-11 14:16:10 +0000
+++ tests/helpers.py	2015-05-12 10:27:12 +0000
@@ -77,7 +77,7 @@
             try:
                 self._deployment.setup(timeout=self._timeout)
             finally:
-                shutil.rmtree(repo_dir)
+                self._clean_repo_dir(repo_dir)
             self._deployment.sentry.wait(self._timeout)
 
         self._stopped_landscape_services = []
@@ -100,10 +100,17 @@
         """Start the given Landscape service on the given unit."""
         self._control_landscape_service("start", service, unit)
 
+    def _get_charm_dir(self):
+        """Get the path to the root of the charm directory."""
+        return os.path.join(os.path.dirname(__file__), "..")
+
+    def _get_sample_hashids_path(self):
+        """Get the path to the flag file for enabling sample hashids."""
+        return os.path.join(self._get_charm_dir(), "use-sample-hashids")
+
     def _get_bundle(self):
         """Return a dict with the data for the test bundle."""
-        charm_dir = os.path.join(os.path.dirname(__file__), "..")
-        bundles_dir = os.path.join(charm_dir, "bundles")
+        bundles_dir = os.path.join(self._get_charm_dir(), "bundles")
         environment = Environment(
             loader=FileSystemLoader(bundles_dir), trim_blocks=True,
             lstrip_blocks=True, keep_trailing_newline=True)
@@ -115,7 +122,7 @@
             if source == "lds-trunk-ppa":
                 # We want the lds-trunk PPA, let's grab its details from
                 # the secrets directory
-                secrets_dir = os.path.join(charm_dir, "secrets")
+                secrets_dir = os.path.join(self._get_charm_dir(), "secrets")
                 with open(os.path.join(secrets_dir, "lds-trunk-ppa")) as fd:
                     extra_config = yaml.safe_load(fd.read())
             else:
@@ -148,8 +155,18 @@
         charm_link = os.path.join(series_dir, "landscape-server")
         os.symlink(branch_dir, charm_link)
         os.environ["JUJU_REPOSITORY"] = repo_dir
+
+        # Enable sample hashids
+        with open(self._get_sample_hashids_path(), "w") as fd:
+            fd.write("")
+
         return repo_dir
 
+    def _clean_repo_dir(self, repo_dir):
+        """Clean up the repository directory and the sample hashids flag."""
+        shutil.rmtree(repo_dir)
+        os.unlink(self._get_sample_hashids_path())
+
     def _control_landscape_service(self, action, service, unit):
         """Start or stop the given Landscape service on the given unit."""
         unit = self._deployment.sentry.unit["landscape-server/%d" % unit]