Merge lp:~sinzui/juju-ci-tools/check-subet-resources into lp:juju-ci-tools

[Curtis Hovey]

Check the subset of resource data that is interesting.

The resource tests are failing because Juju 2.2 now includes combinedrevision and combinedorigin keys in the resource data. The first is a time stamp we cannot predict, the second is a value we already test for.

This branch moved assert_dict_is_subset from assess_storage to assess_resources, then replaces the resources checks with the safer function. This also reduced the code we maintain.

=== modified file 'assess_resources.py'
--- assess_resources.py	2016-10-06 01:28:20 +0000
+++ assess_resources.py	2017-04-10 14:35:59 +0000
@@ -16,6 +16,7 @@
 )
 from utility import (
     add_basic_testing_arguments,
+    assert_dict_is_subset,
     configure_logging,
     JujuAssertionError,
 )
@@ -51,14 +52,8 @@
                 service_app_id = 'applicationId'
             expected_values = _resource_info(name, fingerprint,
                                              size, service_app_id)
-            if resource['expected'] != expected_values:
-                raise JujuAssertionError(
-                    'Unexpected resource list values: {} Expected: {}'.format(
-                        resource['expected'], expected_values))
-            if resource['unit'] != expected_values:
-                raise JujuAssertionError(
-                    'Unexpected unit resource list values: {} Expected: '
-                    '{}'.format(resource['unit'], expected_values))
+            assert_dict_is_subset(expected_values, resource['expected'])
+            assert_dict_is_subset(expected_values, resource['unit'])
             break
     else:
         raise JujuAssertionError('Resource id not found.')

=== modified file 'assess_storage.py'
--- assess_storage.py	2017-03-07 19:22:24 +0000
+++ assess_storage.py	2017-04-10 14:35:59 +0000
@@ -19,8 +19,8 @@
 )
 from utility import (
     add_basic_testing_arguments,
+    assert_dict_is_subset,
     configure_logging,
-    JujuAssertionError,
     temp_dir,
 )
 from jujupy.version_client import ModelClient2_1
@@ -247,18 +247,6 @@
         client.wait_for_started()
 
 
-def assert_dict_is_subset(sub_dict, super_dict):
-    """Assert that every item in the sub_dict is in the super_dict.
-
-    :raises JujuAssertionError: when sub_dict items are missing.
-    :return: True when when sub_dict is a subset of super_dict
-    """
-    if not all(item in super_dict.items() for item in sub_dict.items()):
-        raise JujuAssertionError(
-            'Found: {} \nExpected: {}'.format(super_dict, sub_dict))
-    return True
-
-
 def check_storage_list(client, expected):
     storage_list_derived = storage_list(client)
     assert_dict_is_subset(expected, storage_list_derived)

=== modified file 'tests/test_assess_resources.py'
--- tests/test_assess_resources.py	2017-03-10 16:17:23 +0000
+++ tests/test_assess_resources.py	2017-04-10 14:35:59 +0000
@@ -86,14 +86,14 @@
         status = make_resource_list()
         status['resources'][0]['expected']['origin'] = 'charmstore'
         with self.assertRaisesRegexp(
-                JujuAssertionError, 'Unexpected resource list values'):
+                JujuAssertionError, 'Found:.*\nExpected:'):
             verify_status(status, 'dummy-resource/foo', 'foo', '1234', 27)
 
     def test_verify_status_unit_exception(self):
         status = make_resource_list()
         status['resources'][0]['unit']['origin'] = 'charmstore'
         with self.assertRaisesRegexp(
-                JujuAssertionError, 'Unexpected unit resource list values'):
+                JujuAssertionError, 'Found:.*\nExpected:'):
             verify_status(status, 'dummy-resource/foo', 'foo', '1234', 27)
 
     def test_verify_status_no_resoruce_id_exception(self):

=== modified file 'tests/test_assess_storage.py'
--- tests/test_assess_storage.py	2017-03-07 17:26:23 +0000
+++ tests/test_assess_storage.py	2017-04-10 14:35:59 +0000
@@ -8,7 +8,6 @@
 
 from assess_storage import (
     AWS_DEFAULT_STORAGE_POOL_DETAILS,
-    assert_dict_is_subset,
     assess_storage,
     parse_args,
     make_expected_disk,
@@ -30,7 +29,6 @@
     parse_error,
     TestCase,
 )
-from utility import JujuAssertionError
 
 
 class TestParseArgs(TestCase):
@@ -75,28 +73,6 @@
 
 class TestAssess(TestCase):
 
-    def test_assert_dict_is_subset(self):
-        # Identical dicts.
-        self.assertIsTrue(
-            assert_dict_is_subset(
-                {'a': 1, 'b': 2},
-                {'a': 1, 'b': 2}))
-        # super dict has an extra item.
-        self.assertIsTrue(
-            assert_dict_is_subset(
-                {'a': 1, 'b': 2},
-                {'a': 1, 'b': 2, 'c': 3}))
-        # A key is missing.
-        with self.assertRaises(JujuAssertionError):
-            assert_dict_is_subset(
-                {'a': 1, 'b': 2},
-                {'a': 1, 'c': 2})
-        # A value is different.
-        with self.assertRaises(JujuAssertionError):
-            assert_dict_is_subset(
-                {'a': 1, 'b': 2},
-                {'a': 1, 'b': 4})
-
     def test_make_expected_ls(self):
         client = fake_juju_client()
         data = make_expected_ls(client, 'data/0', 'foo/0')

=== modified file 'tests/test_utility.py'
--- tests/test_utility.py	2017-03-01 19:02:24 +0000
+++ tests/test_utility.py	2017-04-10 14:35:59 +0000
@@ -28,6 +28,7 @@
     )
 from utility import (
     add_basic_testing_arguments,
+    assert_dict_is_subset,
     as_literal_address,
     extract_deb,
     _find_candidates,
@@ -36,6 +37,7 @@
     get_candidates_path,
     get_deb_arch,
     get_winrm_certs,
+    JujuAssertionError,
     log_and_wrap_exception,
     logged_exception,
     LoggedException,
@@ -582,3 +584,28 @@
         mock_logger.info.assert_called_once_with(
             'Output from exception:\nstdout:\n%s\nstderr:\n%s', 'some output',
             None)
+
+
+class TestAssertDictIsSubset(TestCase):
+
+    def test_assert_dict_is_subset(self):
+        # Identical dicts.
+        self.assertIsTrue(
+            assert_dict_is_subset(
+                {'a': 1, 'b': 2},
+                {'a': 1, 'b': 2}))
+        # super dict has an extra item.
+        self.assertIsTrue(
+            assert_dict_is_subset(
+                {'a': 1, 'b': 2},
+                {'a': 1, 'b': 2, 'c': 3}))
+        # A key is missing.
+        with self.assertRaises(JujuAssertionError):
+            assert_dict_is_subset(
+                {'a': 1, 'b': 2},
+                {'a': 1, 'c': 2})
+        # A value is different.
+        with self.assertRaises(JujuAssertionError):
+            assert_dict_is_subset(
+                {'a': 1, 'b': 2},
+                {'a': 1, 'b': 4})

=== modified file 'utility.py'
--- utility.py	2017-03-01 20:34:01 +0000
+++ utility.py	2017-04-10 14:35:59 +0000
@@ -426,3 +426,15 @@
         yield
     except (Exception, KeyboardInterrupt) as e:
         raise log_and_wrap_exception(logger, e)
+
+
+def assert_dict_is_subset(sub_dict, super_dict):
+    """Assert that every item in the sub_dict is in the super_dict.
+
+    :raises JujuAssertionError: when sub_dict items are missing.
+    :return: True when when sub_dict is a subset of super_dict
+    """
+    if not all(item in super_dict.items() for item in sub_dict.items()):
+        raise JujuAssertionError(
+            'Found: {} \nExpected: {}'.format(super_dict, sub_dict))
+    return True