Merge pull request #4 from boegel/checksums-itemdict

fix type spec for checksums

Author: edmondac

easybuild/framework/easyconfig/types.py

@@ -514,6 +514,12 @@ def ensure_iterable_license_specs(specs):
 TUPLE_OF_STRINGS = (tuple, as_hashable({'elem_types': [str]}))
 LIST_OF_STRINGS = (list, as_hashable({'elem_types': [str]}))
 STRING_OR_TUPLE_LIST = (list, as_hashable({'elem_types': [str, TUPLE_OF_STRINGS]}))
+STRING_DICT = (dict, as_hashable(
+    {
+        'elem_types': [str],
+        'key_types': [str],
+    }
+))
 SANITY_CHECK_PATHS_DICT = (dict, as_hashable({
     'elem_types': {
         'files': [STRING_OR_TUPLE_LIST],
@@ -522,17 +528,16 @@ def ensure_iterable_license_specs(specs):
     'opt_keys': [],
     'req_keys': ['files', 'dirs'],
 }))
-CHECKSUM = (list, as_hashable({'elem_types': [str, TUPLE_OF_STRINGS]}))
-DICT_CHECKSUM = (dict, as_hashable(
-    {
-        'elem_types': [str, CHECKSUM],
-        'key_types': [str],
-    }
-))
-CHECKSUMS = (list, as_hashable({'elem_types': [CHECKSUM, DICT_CHECKSUM]}))
-
-CHECKABLE_TYPES = [CHECKSUM, CHECKSUMS, DEPENDENCIES, DEPENDENCY_DICT, DICT_CHECKSUM, LIST_OF_STRINGS,
-                   SANITY_CHECK_PATHS_DICT, STRING_OR_TUPLE_LIST, TOOLCHAIN_DICT, TUPLE_OF_STRINGS]
+# checksums is a list of checksums, one entry per file (source/patch)
+# each entry can be:
+# a single checksum value (string)
+# a single checksum value of a specified type (2-tuple, 1st element is checksum type, 2nd element is checksum)
+# a list of checksums (of different types) as string values, which should *all* be valid
+# a dictionary with a mapping from filename to checksum value
+CHECKSUMS = (list, as_hashable({'elem_types': [str, tuple, LIST_OF_STRINGS, STRING_DICT]}))
+
+CHECKABLE_TYPES = [CHECKSUMS, DEPENDENCIES, DEPENDENCY_DICT, LIST_OF_STRINGS,
+                   SANITY_CHECK_PATHS_DICT, STRING_DICT, STRING_OR_TUPLE_LIST, TOOLCHAIN_DICT, TUPLE_OF_STRINGS]
 
 # easy types, that can be verified with isinstance
 EASY_TYPES = [basestring, bool, dict, int, list, str, tuple]

test/framework/type_checking.py

@@ -170,6 +170,42 @@ def test_check_type_of_param_value_sanity_check_paths(self):
         out = {'files': ['bin/foo', ('bin/bar', 'bin/baz')], 'dirs': [('lib', 'lib64', 'lib32')]}
         self.assertEqual(check_type_of_param_value('sanity_check_paths', inp, auto_convert=True), (True, out))
 
+    def test_check_type_of_param_value_checksums(self):
+        """Test check_type_of_param_value function for checksums."""
+
+        md5_checksum = 'fa618be8435447a017fd1bf2c7ae9224'
+        sha256_checksum1 = 'fa618be8435447a017fd1bf2c7ae922d0428056cfc7449f7a8641edf76b48265'
+        sha256_checksum2 = 'b5f9cb06105c1d2d30719db5ffb3ea67da60919fb68deaefa583deccd8813551'
+        sha256_checksum3 = '033be54514a03e255df75c5aee8f9e672f663f93abb723444caec8fe43437bde'
+
+        # valid values for 'checksums' easyconfig parameters
+        inputs = [
+            [],
+            # single checksum (one file)
+            [md5_checksum],
+            [sha256_checksum1],
+            # one checksum, for 3 files
+            [sha256_checksum1, sha256_checksum2, sha256_checksum3],
+            # one checksum of specific type
+            [('md5', md5_checksum)],
+            [('sha256', sha256_checksum1)],
+            # multiple checksums of specific type, one for each file
+            [('md5', md5_checksum), ('sha256', sha256_checksum1)],
+            # checksum as dict (file to checksum mapping)
+            [{'foo.txt': sha256_checksum1, 'bar.txt': sha256_checksum2}],
+            # list of checksums for a single file
+            [[md5_checksum]],
+            [[sha256_checksum1, sha256_checksum2, sha256_checksum3]],
+            # in the mix (3 files, each a different kind of checksum spec)...
+            [
+                sha256_checksum1,
+                ('md5', md5_checksum),
+                {'foo.txt': sha256_checksum2, 'bar.txt': sha256_checksum3},
+            ],
+        ]
+        for inp in inputs:
+            self.assertEqual(check_type_of_param_value('checksums', inp), (True, inp))
+
     def test_convert_value_type(self):
         """Test convert_value_type function."""
         # to string