Merge lp:~mbruzek/charm-tools/bash-updates into lp:charm-tools/1.6

[Matt Bruzek]

This proposal updates the bash template for charms.

[Matt Bruzek (mbruzek)]

This merge is over 2 years old and will not be merged. Closing

Unmerged revisions

353. By Matt Bruzek on 2015-03-10

Adding tests for bash template, removing revision file from bash and python, and adding smarter logic to the 00-setup tests.

=== modified file 'charmtools/templates/bash/files/hooks/config-changed'
--- charmtools/templates/bash/files/hooks/config-changed	2014-05-22 20:28:08 +0000
+++ charmtools/templates/bash/files/hooks/config-changed	2015-03-10 21:48:00 +0000
@@ -1,2 +1,10 @@
 #!/bin/bash
-# config-changed occurs everytime a new configuration value is updated (juju set)
+
+# The config-changed is the only hook that runs when a configuration value is
+# updated by the Juju GUI or command line: juju set $metadata.package key=value
+
+# A good practice is to get all the charm's configuration options (config-get)
+# in the config-changed hook to avoid immutable configuration.
+STRING=`config-get string-option`
+BOOLEAN=`config-get boolean-option`
+INT=`config-get int-option`

=== modified file 'charmtools/templates/bash/files/hooks/install'
--- charmtools/templates/bash/files/hooks/install	2014-05-22 20:28:08 +0000
+++ charmtools/templates/bash/files/hooks/install	2015-03-10 21:48:00 +0000
@@ -1,7 +1,7 @@
 #!/bin/bash
 #
-# Here do anything needed to install the service
-# i.e. apt-get install -y foo  or  bzr branch http://myserver/mycode /srv/webroot
+# Do anything in this hook needed to install the service
+# i.e. apt-get install -y foo or bzr branch http://myserver/mycode /srv/webroot
 #
 # Make sure this hook exits cleanly and is idempotent, common problems here are
 # failing to account for a debconf question on a dependency, or trying to pull

=== removed file 'charmtools/templates/bash/files/revision'
--- charmtools/templates/bash/files/revision	2014-05-22 20:28:08 +0000
+++ charmtools/templates/bash/files/revision	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-1

=== added directory 'charmtools/templates/bash/files/tests'
=== added file 'charmtools/templates/bash/files/tests/00-setup'
--- charmtools/templates/bash/files/tests/00-setup	1970-01-01 00:00:00 +0000
+++ charmtools/templates/bash/files/tests/00-setup	2015-03-10 21:48:00 +0000
@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -x
+
+# Check if amulet is installed before adding repository and updating apt-get.
+dpkg -s amulet
+if [ $? -ne 0 ]; then
+    sudo add-apt-repository -y ppa:juju/stable
+    sudo apt-get update
+    sudo apt-get install -y amulet
+fi
+# Install any additional packages needed for tests here.
+# sudo apt-get install -y python3-requests 

=== added file 'charmtools/templates/bash/files/tests/10-deploy'
--- charmtools/templates/bash/files/tests/10-deploy	1970-01-01 00:00:00 +0000
+++ charmtools/templates/bash/files/tests/10-deploy	2015-03-10 21:48:00 +0000
@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+
+import amulet
+import unittest
+
+
+class TestDeployment(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.deployment = amulet.Deployment()
+
+        cls.deployment.add('$metadata.package')
+        cls.deployment.expose('$metadata.package')
+
+        try:
+            cls.deployment.setup(timeout=900)
+            cls.deployment.sentry.wait()
+        except amulet.helpers.TimeoutError:
+            amulet.raise_status(amulet.SKIP, msg="Environment wasn't stood up in time")
+        except:
+            raise
+        cls.unit = cls.deployment.sentry.unit['$metadata.package/0']
+
+    def test_case(self):
+        # Now you can use self.deployment.sentry.unit[UNIT] to address each of
+        # the units and perform more in-depth steps.  You can also reference
+        # the first unit as self.unit.
+        # There are three test statuses that can be triggered with
+        # amulet.raise_status():
+        #   - amulet.PASS
+        #   - amulet.FAIL
+        #   - amulet.SKIP
+        # Each unit has the following methods:
+        #   - .info - An array of the information of that unit from Juju
+        #   - .file(PATH) - Get the details of a file on that unit
+        #   - .file_contents(PATH) - Get plain text output of PATH file from that unit
+        #   - .directory(PATH) - Get details of directory
+        #   - .directory_contents(PATH) - List files and folders in PATH on that unit
+        #   - .relation(relation, service:rel) - Get relation data from return service
+        #          add tests here to confirm service is up and working properly
+        # For example, to confirm that it has a functioning HTTP server:
+        #     page = requests.get('http://{}'.format(self.unit.info['public-address']))
+        #     page.raise_for_status()
+        # More information on writing Amulet tests can be found at:
+        #     https://juju.ubuntu.com/docs/tools-amulet.html
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()

=== removed file 'charmtools/templates/python/files/revision'
--- charmtools/templates/python/files/revision	2014-05-23 20:10:24 +0000
+++ charmtools/templates/python/files/revision	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-1

=== modified file 'charmtools/templates/python/files/tests/00-setup'
--- charmtools/templates/python/files/tests/00-setup	2014-05-23 20:10:24 +0000
+++ charmtools/templates/python/files/tests/00-setup	2015-03-10 21:48:00 +0000
@@ -1,5 +1,14 @@
 #!/bin/bash
 
-sudo add-apt-repository ppa:juju/stable -y
-sudo apt-get update
-sudo apt-get install amulet python-requests -y
+set -x
+
+# Check if amulet is installed before adding repository and updating apt-get.
+dpkg -s amulet
+if [ $? -ne 0 ]; then
+    sudo add-apt-repository -y ppa:juju/stable
+    sudo apt-get update
+    sudo apt-get install -y amulet
+fi
+# Install any additional packages needed for tests here.
+sudo apt-get install -y python3-requests 
+

=== modified file 'charmtools/templates/python_services/files/tests/00-setup'
--- charmtools/templates/python_services/files/tests/00-setup	2014-09-10 18:38:30 +0000
+++ charmtools/templates/python_services/files/tests/00-setup	2015-03-10 21:48:00 +0000
@@ -1,5 +1,14 @@
 #!/bin/bash
 
-sudo add-apt-repository ppa:juju/stable -y
-sudo apt-get update
-sudo apt-get install amulet python-requests -y
+set -x
+
+# Check if amulet is installed before adding repository and updating apt-get.
+dpkg -s amulet
+if [ $? -ne 0 ]; then
+    sudo add-apt-repository -y ppa:juju/stable
+    sudo apt-get update
+    sudo apt-get install -y amulet
+fi
+# Install any additional packages needed for tests here.
+sudo apt-get install -y python3-requests 
+