Merge lp:~gz/juju-ci-tools/update_assess_template into lp:juju-ci-tools

[Martin Packman]

Updates template for assess script including tests and a make target

Doesn't get all the way of providing a good test template, mostly because SimpleEnvironment/EnvJujuClient and now BootstrapManager are all a pain to cleanly test in a main function.

[lp:~gz/juju-ci-tools/update_assess_template]

1186. By Martin Packman on 2015-12-16

Add missing template test file

[Curtis Hovey (sinzui)]

Thank you.

review: Approve (code)

[lp:~gz/juju-ci-tools/update_assess_template]

1187. By Martin Packman on 2015-12-16

Log via the local logger in template

=== modified file 'Makefile'
--- Makefile	2015-11-13 16:47:48 +0000
+++ Makefile	2015-12-16 08:02:25 +0000
@@ -19,4 +19,11 @@
 	sudo apt-get install -y juju-local juju juju-quickstart juju-deployer
 	sudo apt-get install -y python-pip
 	./pipdeps.py install
-.PHONY: lint test apt-update install-deps
+name=NAMEHERE
+assess_file=assess_$(name).py
+test_assess_file=tests/test_assess_$(name).py
+new-assess:
+	install -m 755 template_assess.py.tmpl $(assess_file)
+	install -m 644 template_test.py.tmpl $(test_assess_file)
+	sed -i -e "s/TEMPLATE/$(name)/g" $(assess_file) $(test_assess_file)
+.PHONY: lint test cover clean new-assess apt-update install-deps

=== modified file 'template_assess.py.tmpl'
--- template_assess.py.tmpl	2015-12-09 22:41:07 +0000
+++ template_assess.py.tmpl	2015-12-16 08:02:25 +0000
@@ -1,49 +1,52 @@
-#!/usr/bin/python
+#!/usr/bin/env python
+"""TODO: add rough description of what is assessed in this module."""
+
 from __future__ import print_function
 
 __metaclass__ = type
 
-from argparse import ArgumentParser
+import argparse
+import logging
+import sys
 
 from deploy_stack import (
     BootstrapManager,
 )
 from utility import (
-    add_basic_testing_arguments
+    add_basic_testing_arguments,
+    configure_logging,
 )
 
 
-TEST_HUMAN_NAME = "<YOUR TEST HUMAN READABLE HERE>"
-
-
-def parse_args():
+log = logging.getLogger("assess_TEMPLATE")
+
+
+def assess_TEMPLATE(client):
+    # Deploy charms, there are several under ./repository
+    client.juju("deploy", ('local:trusty/my-charm',))
+    # Wait for the deployment to finish.
+    client.wait_for_started()
+    log.info("TODO: Add log line about any test")
+    # TODO: Add specific functional testing actions here.
+
+
+def parse_args(argv):
     """Parse all arguments."""
-    parser = ArgumentParser(TEST_HUMAN_NAME)
-    # Add your positional arguments
+    parser = argparse.ArgumentParser(description="TODO: script info")
+    # TODO: Add additional positional arguments.
     add_basic_testing_arguments(parser)
-    # Add your optional arguments.
-    return parser.parse_args()
-
-
-def main():
-    args = parse_args()
-    series = args.series
-    if series is None:
-        args.series = 'trusty'
+    # TODO: Add additional optional arguments.
+    return parser.parse_args(argv)
+
+
+def main(argv=None):
+    args = parse_args(argv)
+    configure_logging(args.verbose)
     bs_manager = BootstrapManager.from_args(args)
-    client = bs_manager.client
     with bs_manager.booted_context(args.upload_tools):
-        client.get_status(60)
-        # Deploy charms, there are several under ./repository
-        client.juju("deploy", ('local:trusty/my-charm',))
-        # Wait for the deployment to finish.
-        client.wait_for_started()
-
-        # ----------------- CALL YOUR TESTS HERE
-        # At this point you have a juju bootstraped with my-charm
-        # deployed and active with the agent idle.
-        # ----------------- TESTS END HERE
+        assess_TEMPLATE(bs_manager.client)
+    return 0
 
 
 if __name__ == '__main__':
-    main()
+    sys.exit(main())

=== added file 'template_test.py.tmpl'
--- template_test.py.tmpl	1970-01-01 00:00:00 +0000
+++ template_test.py.tmpl	2015-12-16 08:02:25 +0000
@@ -0,0 +1,69 @@
+"""Tests for assess_TEMPLATE module."""
+
+import logging
+from mock import Mock, patch
+import StringIO
+
+from assess_TEMPLATE import (
+    assess_TEMPLATE,
+    parse_args,
+    main,
+)
+from tests import (
+    parse_error,
+    TestCase,
+)
+
+
+class TestParseArgs(TestCase):
+
+    def test_common_args(self):
+        args = parse_args(["an-env", "/bin/juju", "/tmp/logs", "an-env-mod"])
+        self.assertEqual("an-env", args.env)
+        self.assertEqual("/bin/juju", args.juju_bin)
+        self.assertEqual("/tmp/logs", args.logs)
+        self.assertEqual("an-env-mod", args.temp_env_name)
+        self.assertEqual(False, args.debug)
+
+    def test_help(self):
+        fake_stdout = StringIO.StringIO()
+        with parse_error(self) as fake_stderr:
+            with patch("sys.stdout", fake_stdout):
+                parse_args(["--help"])
+        self.assertEqual("", fake_stderr.getvalue())
+        self.assertNotIn("TODO", fake_stdout.getvalue())
+
+
+class TestMain(TestCase):
+
+    def test_main(self):
+        argv = ["an-env", "/bin/juju", "/tmp/logs", "an-env-mod", "--verbose"]
+        env = object()
+        client = Mock(spec=["is_jes_enabled"])
+        with patch("assess_TEMPLATE.configure_logging",
+                   autospec=True) as mock_cl:
+            with patch("assess_TEMPLATE.BootstrapManager.booted_context",
+                       autospec=True) as mock_bc:
+                with patch("jujupy.SimpleEnvironment.from_config",
+                           return_value=env) as mock_e:
+                    with patch("jujupy.EnvJujuClient.by_version",
+                               return_value=client) as mock_c:
+                        with patch("assess_TEMPLATE.assess_TEMPLATE",
+                                   autospec=True) as mock_assess:
+                            main(argv)
+        mock_cl.assert_called_once_with(logging.DEBUG)
+        mock_e.assert_called_once_with("an-env")
+        mock_c.assert_called_once_with(env, "/bin/juju", debug=False)
+        self.assertEqual(mock_bc.call_count, 1)
+        mock_assess.assert_called_once_with(client)
+
+
+class TestAssess(TestCase):
+
+    def test_TEMPLATE(self):
+        mock_client = Mock(spec=["juju", "wait_for_started"])
+        assess_TEMPLATE(mock_client)
+        mock_client.juju.assert_called_once_with(
+            'deploy', ('local:trusty/my-charm',))
+        mock_client.wait_for_started.assert_called_once_with()
+        self.assertNotIn("TODO", self.log_stream.getvalue())

=== modified file 'tests/test_deploy_stack.py'
--- tests/test_deploy_stack.py	2015-12-15 17:03:17 +0000
+++ tests/test_deploy_stack.py	2015-12-16 08:02:25 +0000
@@ -251,8 +251,7 @@
             self.assertEqual(
                 ['machine-2'],
                 sorted(os.listdir(artifacts_dir)))
-        self.assertEqual(
-                (client, {'0': '10.10.0.1'}), gm_mock.call_args[0])
+        self.assertEqual((client, {'0': '10.10.0.1'}), gm_mock.call_args[0])
         self.assertEqual(
             [(self.r2, '%s/machine-2' % artifacts_dir)],
             [cal[0] for cal in crl_mock.call_args_list])
@@ -1105,8 +1104,8 @@
         else:
             runtime_config = os.path.join(client.env.juju_home, 'environments',
                                           'bar.jenv')
-        dl_mock.assert_called_once_with(
-                client, log_dir, runtime_config, {'0': 'foo'})
+        dl_mock.assert_called_once_with(client, log_dir, runtime_config,
+                                        {'0': 'foo'})
         if keep_env:
             tear_down_count = 1
         else: