Merge lp:~stub/charms/precise/postgresql/use-amulet into lp:charms/postgresql

[Stuart Bishop]

Change to using Amulet instead of our own bespoke test harness where possible.

[Stuart Bishop (stub)]

This spike is looking promising.

Issues to address:
  - Reuse of machines.
    - We can detect 'free' machines, and inject the machine allocations into the juju-deployer structure.
    - add_unit will need to use a 'free' machine if there is one.
  - sentry.wait() needs to detect failed hooks and abort.
  - Should amulet actually be using juju-deployer? There is stuff in there we don't want, such as building a bzr branch of the charm.

review: Needs Fixing

[Stuart Bishop (stub)]

review: Needs Fixing

[lp:~stub/charms/precise/postgresql/use-amulet]

170. By Stuart Bishop on 2014-02-17

Merged syslog into use-amulet.

171. By Stuart Bishop on 2014-03-04

Merged syslog into use-amulet.

172. By Stuart Bishop on 2014-03-05

Merged syslog into use-amulet.

173. By Stuart Bishop on 2014-03-31

resolve conflicts

174. By Stuart Bishop on 2014-03-31

Merged syslog into use-amulet.

175. By Stuart Bishop on 2014-03-31

Merged syslog into use-amulet.

176. By Stuart Bishop on 2014-04-01

Merged syslog into use-amulet.

177. By Stuart Bishop on 2014-04-04

resolve conflicts

178. By Stuart Bishop on 2014-04-04

Merged syslog into use-amulet.

179. By Stuart Bishop on 2014-05-07

Merged syslog into use-amulet.

180. By Stuart Bishop on 2014-05-19

Merged syslog into use-amulet.

181. By Stuart Bishop on 2014-05-23

Merged syslog into use-amulet.

182. By Stuart Bishop on 2014-05-29

Merged syslog into use-amulet.

183. By Stuart Bishop on 2014-05-29

Merged syslog into use-amulet.

184. By Stuart Bishop on 2014-06-03

Merged syslog into use-amulet.

185. By Stuart Bishop on 2014-06-05

Merged syslog into use-amulet.

186. By Stuart Bishop on 2014-06-05

Merged syslog into use-amulet.

187. By Stuart Bishop on 2014-06-10

Merged syslog into use-amulet.

188. By Stuart Bishop on 2014-06-27

Merged syslog into use-amulet.

189. By Stuart Bishop on 2014-06-27

Merged syslog into use-amulet.

190. By Stuart Bishop on 2014-06-30

Merged syslog into use-amulet.

191. By Stuart Bishop on 2014-07-14

Merged syslog into use-amulet.

192. By Stuart Bishop on 2014-07-14

Merged syslog into use-amulet.

193. By Stuart Bishop on 2014-08-22

Merged syslog into use-amulet.

194. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

195. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

196. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

197. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

198. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

199. By Stuart Bishop on 2014-09-08

Merged syslog into use-amulet.

200. By Stuart Bishop on 2014-09-22

Merged syslog into use-amulet.

201. By Stuart Bishop on 2014-10-07

Merged syslog into use-amulet.

202. By Stuart Bishop on 2014-10-24

mergr trunk

Unmerged revisions

202. By Stuart Bishop on 2014-10-24

mergr trunk

201. By Stuart Bishop on 2014-10-07

Merged syslog into use-amulet.

200. By Stuart Bishop on 2014-09-22

Merged syslog into use-amulet.

199. By Stuart Bishop on 2014-09-08

Merged syslog into use-amulet.

198. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

197. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

196. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

195. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

194. By Stuart Bishop on 2014-08-27

Merged syslog into use-amulet.

193. By Stuart Bishop on 2014-08-22

Merged syslog into use-amulet.

=== modified file 'test.py'
--- test.py	2014-10-24 05:42:49 +0000
+++ test.py	2014-10-24 05:42:49 +0000
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 
 """
 Test the PostgreSQL charm.
@@ -23,6 +23,7 @@
 import psycopg2
 import testtools
 
+from testing.amuletfixture import AmuletFixture
 from testing.jujufixture import JujuFixture, run
 
 
@@ -92,6 +93,8 @@
         # Tests may add or change options.
         self.pg_config = dict(version=version, pgdg=use_pgdg)
 
+        self.amulet = self.useFixture(AmuletFixture())
+
         # Mirror charmhelpers into our support charms, since charms
         # can't symlink out of their subtree.
         here = os.path.abspath(os.path.dirname(__file__))
@@ -307,8 +310,8 @@
         '''
         # Which psql unit we are going to query from.
         if psql_unit is None:
-            psql_unit = (
-                self.juju.status['services']['psql']['units'].keys()[0])
+            psql_unit = list(
+                self.juju.status['services']['psql']['units'].keys())[0]
 
         full_rel_info = self.juju.relation_info(psql_unit)
 
@@ -409,10 +412,17 @@
 
     def test_basic(self):
         '''Connect to a a single unit service via the db relationship.'''
-        self.juju.deploy(TEST_CHARM, 'postgresql', config=self.pg_config)
-        self.juju.deploy(PSQL_CHARM, 'psql')
-        self.juju.do(['add-relation', 'postgresql:db', 'psql:db'])
-        self.wait_until_ready(['postgresql/0'])
+        ## self.juju.deploy(TEST_CHARM, 'postgresql', config=self.pg_config)
+        ## self.juju.deploy(PSQL_CHARM, 'psql')
+        ## self.juju.do(['add-relation', 'postgresql:db', 'psql:db'])
+        ## self.wait_until_ready()
+
+        self.amulet.add('postgresql')
+        self.amulet.configure('postgresql', self.pg_config)
+        self.amulet.add('psql', PSQL_CHARM)
+        self.amulet.relate('postgresql:db', 'psql:db')
+        self.amulet.setup()
+        self.amulet.sentry.wait()
 
         result = self.sql('SELECT TRUE')
         self.assertEqual(result, [(True,)])

=== added file 'testing/amuletfixture.py'
--- testing/amuletfixture.py	1970-01-01 00:00:00 +0000
+++ testing/amuletfixture.py	2014-10-24 05:42:49 +0000
@@ -0,0 +1,133 @@
+import json
+import subprocess
+import time
+
+import amulet.helpers
+import fixtures
+from testtools.content import text_content
+
+
+class EnvironmentResetError(Exception):
+    pass
+
+
+class MyDeployment(amulet.Deployment):
+
+    def setup(self):
+        # Specify an empty BZR_HOME. juju-deployer wants to run bzr
+        # commands, and we don't want to use the user's normal bzr
+        # configuration or silly things happen like GPG signing popups.
+        with fixtures.TempDir() as bzr_home:
+            with fixtures.EnvironmentVariable('BZR_HOME', bzr_home.path):
+                super(MyDeployment, self).setup()
+
+    def do(self, cmd, timeout=600):
+        """Run an arbitrary juju command.
+
+        cmd is the juju command line as a list of arguments. It is
+        automatically prefixed with 'juju' and suffixed with the environment
+        to operate in.
+
+        eg. amulet.do(['destroy-unit', 'foo/2'])
+        """
+        cmd = ['juju'] + cmd + ['--environment', self.juju_env]
+        self._run(cmd, timeout)
+
+    def query(self, cmd, timeout=600):
+        """Run a juju query, returning the decoded result as structured data.
+
+        cmd is the juju command line as a list of arguments. It is
+        automatically prefixed with 'juju', the environment details,
+        and '--format=json'.
+
+        eg. status = amulet.query(['status'])
+        """
+        cmd = ['juju'] + cmd + [
+            '--environment', self.juju_env, '--format', 'json']
+        return json.loads(self._run(cmd, timeout).decode('UTF-8'))
+
+    def add_unit(self, service, units=1):
+        if service not in self.services:
+            raise ValueError('Service {0} is not deployed'.format(service))
+        self.services[service]['num_units'] += units
+        self.do(['add-unit', '-n', str(int(units)), service])
+
+    def destroy_unit(self, units):
+        if isinstance(units, basestring):
+            units = [units]
+        for unit in units:
+            service = unit.split('/')[0]
+            if service not in self.services:
+                raise ValueError('Service {0} is not deployed'.format(service))
+            self.service[service]['num_units'] -= 1
+        self.do(['destroy-unit'] + units)
+
+    def cleanup(self, force=False):
+        # Temporarily work around a bug in Deployer.cleanup()
+        self._sentry = self._sentries
+        super(MyDeployment, self).cleanup()
+
+        # Tear down any services left running that we know we spawned.
+        while True:
+            found_services = False
+
+            status = self.query(['status'])
+
+            # Kill any services this fixture knows it started.
+            for service_name, service in status.get('services', {}).items():
+                if service_name.replace('-sentry', '') in self.services:
+                    found_services = True
+                    if service.get('life', '') not in ('dying', 'dead'):
+                        self.do(['destroy-service', service_name])
+
+                    # Handle failed units.
+                    for unit_name, unit in service.get('units', {}).items():
+                        if unit.get('agent-state', None) == 'error':
+                            if force:
+                                try:
+                                    self.do(['resolved', unit_name])
+                                except subprocess.CalledProcessError:
+                                    # More race conditions in juju. A
+                                    # previous 'resolved' call may cause a
+                                    # subsequent one to fail if it is still
+                                    # being processed. However, we need to
+                                    # keep retrying because after a
+                                    # 'resolved' has been processed,
+                                    # other hooks may run and fail.
+                                    pass
+                            else:
+                                raise EnvironmentResetError(
+                                    'Failed unit {}'.format(unit_name))
+            if not found_services:
+                break
+            time.sleep(1)
+
+    def _run(self, cmd, timeout):
+        # We want to keep test runners happy, so ensure we don't spam
+        # stdout and stderr.
+        with amulet.helpers.timeout(timeout):
+            p = subprocess.Popen(
+                cmd, stdin=subprocess.PIPE,
+                stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            (out, err) = p.communicate()
+            if p.returncode != 0:
+                self.addDetail('stdout', text_content(out.decode('UTF-8')))
+                self.addDetail('stderr', text_content(err.decode('UTF-8')))
+                raise subprocess.CalledProcessError(p.returncode, cmd, err)
+            return out
+
+
+class AmuletFixture(fixtures.Fixture, MyDeployment):
+    """An Amulet Deployment as a Fixture."""
+    def setUp(self):
+        # Does nothing, as initialized in constructor.
+        super(AmuletFixture, self).setUp()
+
+    def cleanUp(self):
+        try:
+            super(AmuletFixture, self).cleanup()
+        except EnvironmentResetError:
+            super(AmuletFixture, self).cleanup(force=True)
+            raise
+
+

=== modified file 'testing/jujufixture.py'
--- testing/jujufixture.py	2014-10-14 10:12:02 +0000
+++ testing/jujufixture.py	2014-10-24 05:42:49 +0000
@@ -42,7 +42,7 @@
         cmd = ['juju'] + cmd + ['--format=json']
         out = run(self, cmd)
         if out:
-            return json.loads(out)
+            return json.loads(out.decode('UTF-8'))
         return None
 
     def deploy(self, charm, name=None, num_units=1, config=None):

=== modified file 'tests/00_setup.test'
--- tests/00_setup.test	2014-04-01 12:15:48 +0000
+++ tests/00_setup.test	2014-10-24 05:42:49 +0000
@@ -1,6 +1,14 @@
 #!/bin/sh
 
+dpkg -s amulet
+if [ $? -ne 0 ]; then
+    # Install the Amulet testing harness.
+    sudo add-apt-repository -y ppa:juju/stable
+    sudo apt-get update 
+fi
+
 sudo apt-get install -y \
+    amulet
     python-flake8 \
     python-fixtures \
     python-jinja2 \
@@ -11,3 +19,10 @@
     python-yaml \
     pgtune
 
+sudo apt-get install -y \
+    python3-flake8 \
+    python3-fixtures \
+    python3-jinja2 \
+    python3-psycopg2 \
+    python3-testtools \
+    python3-yaml