Add more tests for util. check_duplicate_keys_about_file

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

src/attributecode/util.py

@@ -116,24 +116,31 @@ def check_file_names(paths):
     return errors
 
 
-def check_duplicate_keys_about_file(context):
+def check_duplicate_keys_about_file(about_text):
     """
-    
+    Return a list of duplicated keys given a ABOUT text string.
     """
-    keys = []
-    dup_keys = []
-    for line in context.splitlines():
+    seen = set()
+    duplicates = set()
+    for line in about_text.splitlines():
         """
-        Ignore all the continuation string, string block and empty line
+        Ignore all the continuation string, mapping/list dahs, string block and empty line.
         """
-        if not line.startswith(' ') and not len(line.strip()) == 0 :
-            # Get the key name
-            key = line.partition(':')[0]
-            if key in keys:
-                dup_keys.append(key)
-            else:
-                keys.append(key)
-    return dup_keys
+        if not line.strip() :
+            continue
+        if line.startswith((' ', '\t')):
+            continue
+        if line.strip().startswith('-'):
+            continue
+        if ':' not in line:
+            continue
+        # Get the key name
+        key, _, _val = line.partition(':')
+        if key in seen:
+            duplicates.add(key)
+        else:
+            seen.add(key)
+    return sorted(duplicates)
 
 
 def wrap_boolean_value(context):

tests/test_util.py

@@ -582,17 +582,44 @@ def test_format_about_dict_for_json_output(self):
 
 class TestMiscUtils(unittest.TestCase):
 
-    def test_check_duplicate_keys_about_file(self):
+    def test_check_duplicate_keys_about_file_with_no_dupe(self):
+        test = '''
+name: test
+
+license_expression: mit
+notes: dup key here
+            '''
+        expected = []
+        assert expected == util.check_duplicate_keys_about_file(test)
+
+
+    def test_check_duplicate_keys_about_file_returns_duplicate(self):
         test = '''
 name: test
 notes: some notes
+notes: dup key here
 
+notes: dup key here
 license_expression: mit
 notes: dup key here
             '''
         expected = ['notes']
         assert expected == util.check_duplicate_keys_about_file(test)
 
+    def test_check_duplicate_keys_about_file_ignore_non_key_line(self):
+        test = '''
+ name: test
+- notes: some notes
+  - notes: dup key here
+# some
+    
+notes: dup key here
+license_expression: mit
+notes dup key here
+            '''
+        expected = []
+        assert expected == util.check_duplicate_keys_about_file(test)
+
     def test_wrap_boolean_value(self):
         test = '''
 name: test
@@ -624,7 +651,8 @@ def test_check_duplicate_keys_about_file_with_multiline(self):
  line
 description: sample
             '''
-        expected = ['owner', 'notes']
+        # notes: the output IS sorted
+        expected = ['notes', 'owner', ]
         assert expected == util.check_duplicate_keys_about_file(test)
 
     def test_inventory_filter(self):