Merge lp:~andrewjbeach/juju-ci-tools/get-juju-dict into lp:juju-ci-tools

[Andrew James Beach]

Added an method to EnvJujuClient, get_juju_dict. It is a thin operation, but
it wraps up get_juju_output with a yaml.safe_load. This pair of operations
(and adding '--format' 'yaml' to the arguments list) comes up in a number of
other methods as well as the general code base. Commonly enough it should be
worth wrapping up the idiom. It may also cut out some import yaml calls.

Added get_juju_dict to EnvJujuClient in jujupy.py.
Added test_get_juju_dict to TestJujuClient in test_jujupy.py.

Unmerged revisions

1624. By Andrew James Beach on 2016-09-29

Added EnvJujuClient.get_juju_dict, which wraps the common get_juju_output and then parse to dict operation.

=== modified file 'jujupy.py'
--- jujupy.py	2016-09-28 14:03:15 +0000
+++ jujupy.py	2016-09-29 15:30:12 +0000
@@ -1292,6 +1292,16 @@
             command, args, self.used_feature_flags, self.env.juju_home,
             model, user_name=self.env.user_name, **pass_kwargs)
 
+    def get_juju_dict(self, command, *args, **kwargs):
+        """Call a juju command and return the output as a dict.
+
+        As get_juju_output but with '--format yaml' appended to args and
+        the results parsed into a python dict object.
+        """
+        format_args = args + ('--format', 'yaml')
+        text = self.get_juju_output(command, *format_args, **kwargs)
+        return yaml.safe_load(text)
+
     def show_status(self):
         """Print the status to output."""
         self.juju(self._show_status, ('--format', 'yaml'))

=== modified file 'tests/test_jujupy.py'
--- tests/test_jujupy.py	2016-09-28 14:03:15 +0000
+++ tests/test_jujupy.py	2016-09-29 15:30:12 +0000
@@ -1178,6 +1178,22 @@
             (sys.executable, get_timeout_path(), '5.00', '--', 'juju',
              '--show-log', 'bar', '-m', 'foo:foo'))
 
+    def test_get_juju_dict(self):
+        client = EnvJujuClient(JujuData('foo'), None, 'juju')
+        with patch.object(client, 'get_juju_output', return_value=dedent("""\
+        model:
+            name: test
+        machines:
+            "0": example
+        applications: {}
+        """), autospec=True) as output_mock:
+            data = client.get_juju_dict('show-machine', '0', timeout=200)
+        output_mock.assert_called_once_with('show-machine', '0', '--format',
+                                            'yaml', timeout=200)
+        self.assertEquals({'model': {'name': 'test'},
+                           'machines': {"0": 'example'},
+                           'applications': {}}, data)
+
     def test__shell_environ_juju_data(self):
         client = EnvJujuClient(
             JujuData('baz', {'type': 'ec2'}), '1.25-foobar', 'path', 'asdf')