Merge lp:~stub/charms/precise/postgresql/tests into lp:charms/postgresql

[Stuart Bishop]

Migrating the Juju fixture into charm-helpers.

Also some delinting.

[Stuart Bishop (stub)]

This should probably be dropped in favor of amulet (https://launchpad.net/amulet)

[lp:~stub/charms/precise/postgresql/tests]

86. By Stuart Bishop on 2013-10-10

Resolve conflicts

87. By Stuart Bishop on 2013-10-10

Put back testing support

Unmerged revisions

150. By Stuart Bishop on 2014-10-24

Merged cleanups into tests.

=== modified file 'hooks/hooks.py'
--- hooks/hooks.py	2013-09-23 09:39:17 +0000
+++ hooks/hooks.py	2013-10-09 10:21:55 +0000
@@ -18,6 +18,7 @@
 import yaml
 from yaml.constructor import ConstructorError
 
+from charmhelpers import fetch
 from charmhelpers.core import hookenv, host
 from charmhelpers.core.hookenv import (
     CRITICAL, ERROR, WARNING, INFO, DEBUG,
@@ -25,6 +26,7 @@
 
 hooks = hookenv.Hooks()
 
+
 # jinja2 may not be importable until the install hook has installed the
 # required packages.
 def Template(*args, **kw):
@@ -505,13 +507,12 @@
             admin_ip_list = [config_data["admin_addresses"]]
 
         for admin_ip in admin_ip_list:
-            admin_host = {'database':'all',
-                'user':'all',
-                'private-address':munge_address(admin_ip),
-            }
+            admin_host = {
+                'database': 'all',
+                'user': 'all',
+                'private-address': munge_address(admin_ip)}
             relation_data.append(admin_host)
 
-
     pg_hba_template = Template(open("templates/pg_hba.conf.tmpl").read())
     host.write_file(
         postgresql_hba, pg_hba_template.render(access_list=relation_data),
@@ -826,8 +827,8 @@
                 "python-psycopg2", "postgresql-contrib", "postgresql-plpython",
                 "postgresql-%s-debversion" % config_data["version"]]
     packages.extend((hookenv.config('extra-packages') or '').split())
-    packages = host.filter_installed_packages(packages)
-    host.apt_install(packages, fatal=True)
+    packages = fetch.filter_installed_packages(packages)
+    fetch.apt_install(packages, fatal=True)
 
     if not 'state' in local_state:
         # Fresh installation. Because this function is invoked by both
@@ -1063,7 +1064,7 @@
 # A more complex approach is for the first database unit that joins
 # the relation to generate the usernames and passwords and publish
 # this to the relation. Subsequent units can retrieve this
-# information and republish it. Of course, the master unit also 
+# information and republish it. Of course, the master unit also
 # creates the database and users when it joins the relation.
 # This approach should work reliably on the server side. However,
 # there is a window from when a slave unit joins a client relation
@@ -1101,6 +1102,7 @@
 # slave replication-relation-changed (noop; slave not yet joined db rel)
 # slave db-relation-joined (republish)
 
+
 @hooks.hook('db-relation-joined', 'db-relation-changed')
 def db_relation_joined_changed():
     if local_state['state'] == 'hot standby':

=== modified file 'test.py'
--- test.py	2013-08-23 08:03:02 +0000
+++ test.py	2013-10-09 10:21:55 +0000
@@ -5,18 +5,22 @@
 
 Usage:
     juju bootstrap
-    TEST_DEBUG_FILE=test-debug.log TEST_TIMEOUT=900 ./test.py -v
+    TEST_TIMEOUT=900 ./test.py -v
     juju destroy-environment
 """
 
-import fixtures
-import json
 import os.path
 import subprocess
+import sys
+import time
+import unittest
+
+import fixtures
 import testtools
 from testtools.content import text_content
-import time
-import unittest
+
+sys.path.append(os.path.join(os.path.dirname(__file__), 'hooks'))
+from charmhelpers.testing.jujufixture import JujuFixture, run
 
 
 SERIES = 'precise'
@@ -24,191 +28,16 @@
 PSQL_CHARM = 'local:postgresql-psql'
 
 
-def DEBUG(msg):
-    """Allow us to watch these slow tests as they run."""
-    debug_file = os.environ.get('TEST_DEBUG_FILE', '')
-    if debug_file:
-        with open(debug_file, 'a') as f:
-            f.write('{}> {}\n'.format(time.ctime(), msg))
-            f.flush()
-
-
-def _run(detail_collector, cmd, input=''):
-    DEBUG("Running {}".format(' '.join(cmd)))
-    try:
-        proc = subprocess.Popen(
-            cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
-            stderr=subprocess.PIPE)
-    except subprocess.CalledProcessError, x:
-        DEBUG("exception: {!r}".format(x))
-        DEBUG("stderr: {}".format(proc.stderr.read()))
-        raise
-
-    (out, err) = proc.communicate(input)
-    if out:
-        DEBUG("stdout: {}".format(out))
-        detail_collector.addDetail('stdout', text_content(out))
-    if err:
-        DEBUG("stderr: {}".format(err))
-        detail_collector.addDetail('stderr', text_content(err))
-    if proc.returncode != 0:
-        DEBUG("rv: {}".format(proc.returncode))
-        raise subprocess.CalledProcessError(
-            proc.returncode, cmd, err)
-    return out
-
-
-class JujuFixture(fixtures.Fixture):
-    """Interact with juju. Assumes juju environment is bootstrapped."""
-    _deployed_charms = set()
-
-    def do(self, cmd):
-        cmd = ['juju'] + cmd
-        _run(self, cmd)
-
-    def get_result(self, cmd):
-        cmd = ['juju'] + cmd + ['--format=json']
-        out = _run(self, cmd)
-        if out:
-            return json.loads(out)
-        return None
-
-    def deploy(self, charm, name=None, num_units=1):
-        # The first time we deploy a local: charm in the test run, it
-        # needs to deploy with --update to ensure we are testing the
-        # desired revision of the charm. Subsequent deploys we do not
-        # use --update to avoid overhead and needless incrementing of the
-        # revision number.
-        if not charm.startswith('local:') or charm in self._deployed_charms:
-            cmd = ['deploy']
-        else:
-            cmd = ['deploy', '-u']
-            self._deployed_charms.add(charm)
-
-        if num_units > 1:
-            cmd.extend(['-n', str(num_units)])
-
-        cmd.append(charm)
-
-        if name:
-            cmd.append(name)
-
-        self.do(cmd)
-
-    # The most recent environment status, updated by refresh_status()
-    status = None
-
-    def refresh_status(self):
-        self.status = self.get_result(['status'])
-        return self.status
-
-    def wait_until_ready(self, extra=45):
-        ready = False
-        while not ready:
-            self.refresh_status()
-            ready = True
-            for service in self.status['services']:
-                if self.status['services'][service].get('life', '') == 'dying':
-                    ready = False
-                units = self.status['services'][service].get('units', {})
-                for unit in units.keys():
-                    agent_state = units[unit].get('agent-state', '')
-                    if agent_state == 'error':
-                        raise RuntimeError('{} error: {}'.format(
-                            unit, units[unit].get('agent-state-info','')))
-                    if agent_state != 'started':
-                        ready = False
-        # Unfortunately, there is no way to tell when a system is
-        # actually ready for us to test. Juju only tells us that a
-        # relation has started being setup, and that no errors have been
-        # encountered yet. It utterly fails to inform us when the
-        # cascade of hooks this triggers has finished and the
-        # environment is in a stable and actually testable state.
-        # So as a work around for Bug #1200267, we need to sleep long
-        # enough that our system is probably stable. This means we have
-        # extremely slow and flaky tests, but that is possibly better
-        # than no tests.
-        time.sleep(extra)
-
-    def setUp(self):
-        DEBUG("JujuFixture.setUp()")
-        super(JujuFixture, self).setUp()
-        self.reset()
-        # Optionally, don't teardown services and machines after running
-        # a test. If a subsequent test is run, they will be torn down at
-        # that point. This option is only useful when running a single
-        # test, or when the test harness is set to abort after the first
-        # failed test.
-        if not os.environ.get('TEST_DONT_TEARDOWN_JUJU', False):
-            self.addCleanup(self.reset)
-
-    def reset(self):
-        DEBUG("JujuFixture.reset()")
-        # Tear down any services left running.
-        found_services = False
-        self.refresh_status()
-        for service in self.status['services']:
-            found_services = True
-            # It is an error to destroy a dying service.
-            if self.status['services'][service].get('life', '') != 'dying':
-                self.do(['destroy-service', service])
-
-        # Per Bug #1190250 (WONTFIX), we need to wait for dying services
-        # to die before we can continue.
-        if found_services:
-            self.wait_until_ready(0)
-
-        # We shouldn't reuse machines, as we have no guarantee they are
-        # still in a usable state, so tear them down too. Per
-        # Bug #1190492 (INVALID), in the future this will be much nicer
-        # when we can use containers for isolation and can happily reuse
-        # machines.
-        dirty_machines = [
-            m for m in self.status['machines'].keys() if m != '0']
-        if dirty_machines:
-            self.do(['terminate-machine'] + dirty_machines)
-
-
-class LocalCharmRepositoryFixture(fixtures.Fixture):
-    """Create links so the given directory can be deployed as a charm."""
-    def __init__(self, path=None):
-        if path is None:
-            path = os.getcwd()
-        self.local_repo_path = os.path.abspath(path)
-
-    def setUp(self):
-        super(LocalCharmRepositoryFixture, self).setUp()
-
-        series_dir = os.path.join(self.local_repo_path, SERIES)
-        charm_dir = os.path.join(series_dir, TEST_CHARM)
-
-        if not os.path.exists(series_dir):
-            os.mkdir(series_dir, 0o700)
-            self.addCleanup(os.rmdir, series_dir)
-
-        if not os.path.exists(charm_dir):
-            os.symlink(self.local_repo_path, charm_dir)
-            self.addCleanup(os.remove, charm_dir)
-
-        self.useFixture(fixtures.EnvironmentVariable(
-            'JUJU_REPOSITORY', self.local_repo_path))
-
-
 class PostgreSQLCharmTestCase(testtools.TestCase, fixtures.TestWithFixtures):
 
     def setUp(self):
         super(PostgreSQLCharmTestCase, self).setUp()
 
-        self.juju = self.useFixture(JujuFixture())
-
-        ## Disabled until postgresql-psql is in the charm store.
-        ## Otherwise, we need to make the local:postgresql-psql charm
-        ## discoverable.
-        ## self.useFixture(LocalCharmRepositoryFixture())
+        self.juju = self.useFixture(JujuFixture(
+            reuse_machines=True,
+            do_teardown='TEST_DONT_TEARDOWN_JUJU' not in os.environ))
 
         # If the charms fail, we don't want tests to hang indefinitely.
-        # We might need to increase this in some environments or if the
-        # environment doesn't have enough machines warmed up.
         timeout = int(os.environ.get('TEST_TIMEOUT', 900))
         self.useFixture(fixtures.Timeout(timeout, gentle=True))
 
@@ -254,9 +83,7 @@
             # Due to Bug #1191079, we need to send the whole remote command
             # as a single argument.
             ' '.join(psql_cmd + psql_args)]
-        DEBUG("SQL {}".format(sql))
-        out = _run(self, cmd, input=sql)
-        DEBUG("OUT {}".format(out))
+        out = run(self, cmd, input=sql)
         result = [line.split(',') for line in out.splitlines()]
         self.addDetail('sql', text_content(repr((sql, result))))
         return result
@@ -266,7 +93,7 @@
             # Due to Bug #1191079, we need to send the whole remote command
             # as a single argument.
             'sudo pg_ctlcluster 9.1 main -force {}'.format(command)]
-        _run(self, cmd)
+        run(self, cmd)
 
     def test_basic(self):
         '''Connect to a a single unit service via the db relationship.'''
@@ -275,10 +102,6 @@
         self.juju.do(['add-relation', 'postgresql:db', 'psql:db'])
         self.juju.wait_until_ready()
 
-        # There a race condition here, as hooks may still be running
-        # from adding the relation. I'm protected here as 'juju status'
-        # takes about 25 seconds to run from here to my test cloud but
-        # others might not be so 'lucky'.
         result = self.sql('SELECT TRUE')
         self.assertEqual(result, [['t']])