Fixed the tests and attribution

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

src/attributecode/model.py

@@ -65,6 +65,7 @@
 from attributecode.util import add_unc
 from attributecode.util import copy_license_notice_files
 from attributecode.util import on_windows
+from attributecode.util import ungroup_licenses
 from attributecode.util import UNC_PREFIX
 from attributecode.util import UNC_PREFIX_POSIX
 
@@ -289,6 +290,8 @@ def _validate(self, *args, **kwargs):
 
         if isinstance(self.original_value, basestring):
             values = self.original_value.splitlines(False)
+        elif isinstance(self.original_value, list):
+            values = self.original_value
         else:
             values = [repr(self.original_value)]
 
@@ -957,7 +960,6 @@ def process(self, fields, about_file_path, running_inventory=False,
         if license_notice_text_location:
             copy_license_notice_files(
                 fields, base_dir, license_notice_text_location, afp)
-
         # we validate all fields, not only these hydrated
         all_fields = self.all_fields()
         validation_errors = validate_fields(
@@ -1025,6 +1027,38 @@ def load_dict(self, fields_dict, base_dir, running_inventory=False,
         about_file_path = self.about_file_path
         if not with_empty:
             fields = [(n, v) for n, v in fields_dict.items() if v]
+        for key, value in fields:
+            if key == u'licenses':
+                lic_key, lic_name, lic_file, lic_url = ungroup_licenses(value)
+                if lic_key:
+                    fields.append(('license_key', lic_key))
+                if lic_name:
+                    fields.append(('license_name', lic_name))
+                if lic_file:
+                    fields.append(('license_file', lic_file))
+                if lic_url:
+                    fields.append(('license_url', lic_url))
+                # The licenses field has been ungrouped and can be removed.
+                # Otherwise, it will gives the following INFO level error
+                # 'Field licenses is not a supported field and is ignored.'
+                licenses_field = (key, value)
+                fields.remove(licenses_field)
+        """
+        # Generate about_resource_path if not present so that it can be validate
+        # the existence of the about_resource
+        arp_present = False 
+        about_resource_value = u''
+        about_parent = u''
+        for n, v in fields:
+            about_parent = dirname(self.about_file_path)
+            if n == u'about_resource_path':
+                arp_present = True
+            elif n == u'about_resource':
+                about_resource_value = v
+        if not arp_present:
+            #about_parent = dirname(self.about_file_path)
+            fields.append((u'about_resource_path', u'.' + posixpath.join(about_parent, about_resource_value)))
+        """
         errors = self.process(
             fields, about_file_path, running_inventory, base_dir, 
             license_notice_text_location, use_mapping, mapping_file)
@@ -1044,36 +1078,37 @@ def dumps(self, with_absent=False, with_empty=True):
         license_name = []
         license_file = []
         license_url = []
+        file_fields = ['about_resource_path', 'notice_file', 'changelog_file', 'author_file']
 
         for field in self.all_fields(with_absent, with_empty):
-            if field.name == 'license_key':
+            if field.name == 'license_key' and field.value:
                 license_key = field.value
-            elif field.name == 'license_name':
+            elif field.name == 'license_name' and field.value:
                 license_name = field.value
-            elif field.name == 'license_file':
+            elif field.name == 'license_file' and field.value:
                 license_file = field.value.keys()
-            elif field.name == 'license_url':
+            elif field.name == 'license_url' and field.value:
                 license_url = field.value
             # No multiple 'about_resource' and 'about_resource_path' reference supported.
             # Take the first element (should only be one) in the list for the
             # value of 'about_resource' and 'about_resource_path'
-            elif field.name == 'about_resource':
+            elif field.name == 'about_resource' and field.value:
                 about_data[field.name] = field.value[0]
-            elif field.name == 'about_resource_path':
+            elif field.name in file_fields and field.value:
                 about_data[field.name] = field.value.keys()[0]
             else:
                 about_data[field.name] = field.value
         # Group the same license information in a list
         license_group = list(zip_longest(license_key, license_name, license_file, license_url))
         for lic_group in license_group:
             lic_dict = {}
-            if lic_group[0] or with_empty:
+            if lic_group[0]:
                 lic_dict['key'] = lic_group[0]
-            if lic_group[1] or with_empty:
+            if lic_group[1]:
                 lic_dict['name'] = lic_group[1]
-            if lic_group[2] or with_empty:
+            if lic_group[2]:
                 lic_dict['file'] = lic_group[2]
-            if lic_group[3] or with_empty:
+            if lic_group[3]:
                 lic_dict['url'] = lic_group[3] 
             about_data.setdefault('licenses', []).append(lic_dict)
         return saneyaml.dump(about_data)

src/attributecode/util.py

@@ -647,6 +647,25 @@ def update_about_dictionary_keys(about_dictionary_list, mapping_output):
         updated_dict_list.append(updated_ordered_dict)
     return updated_dict_list
 
+def ungroup_licenses(licenses):
+    """
+    Ungroup multiple licenses information
+    """
+    lic_key = []
+    lic_name = []
+    lic_file = []
+    lic_url = []
+    for lic in licenses:
+        if 'key' in lic:
+            lic_key.append(lic['key'])
+        if 'name' in lic:
+            lic_name.append(lic['name'])
+        if 'file' in lic:
+            lic_file.append(lic['file'])
+        if 'url' in lic:
+            lic_url.append(lic['url'])
+    return lic_key, lic_name, lic_file, lic_url
+
 class NoDuplicateConstructor(Constructor):
     def construct_mapping(self, node, deep=False):
         if not isinstance(node, MappingNode):

tests/test_gen.py

@@ -62,11 +62,11 @@ def test_load_inventory(self):
         assert expected_errors == errors
 
         expected = [u'about_resource: .\n'
-                    u'name: AboutCode\n'
-                    u'version: 0.11.0\n'
-                    u'description: |\n'
+                    u'description: |-\n'
                     u'    multi\n'
-                    u'    line\n']
+                    u'    line\n'
+                    u'name: AboutCode\n'
+                    u'version: 0.11.0\n']
         result = [a.dumps(with_absent=False, with_empty=False)
                         for a in abouts]
         assert expected == result
@@ -86,13 +86,13 @@ def test_load_inventory_with_mapping(self):
         assert sorted(expected_errors) == sorted(errors)
 
         expected = [u'about_resource: .\n'
-                    u'name: AboutCode\n'
-                    u'version: 0.11.0\n'
-                    u'description: |\n'
+                    u'copyright: Copyright (c) nexB, Inc.\n'
+                    u'description: |-\n'
                     u'    multi\n'
                     u'    line\n'
-                    u'copyright: Copyright (c) nexB, Inc.\n'
+                    u'name: AboutCode\n'
                     u'resource: this.ABOUT\n'
+                    u'version: 0.11.0\n'
                     ]
         result = [a.dumps(with_absent=False, with_empty=False)
                         for a in abouts]
@@ -151,12 +151,12 @@ def test_generate(self):
         in_mem_result = [a.dumps(with_absent=False, with_empty=False)
                         for a in abouts][0]
         expected = (u'about_resource: .\n'
-                    u'name: AboutCode\n'
                     u'about_resource_path: .\n'
-                    u'version: 0.11.0\n'
-                    u'description: |\n'
+                    u'description: |-\n'
                     u'    multi\n'
-                    u'    line\n')
+                    u'    line\n'
+                    u'name: AboutCode\n'
+                    u'version: 0.11.0\n')
         assert expected == in_mem_result
 
     def test_generate_not_overwrite_original_license_file(self):
@@ -170,10 +170,11 @@ def test_generate_not_overwrite_original_license_file(self):
         in_mem_result = [a.dumps(with_absent=False, with_empty=False)
                         for a in abouts][0]
         expected = (u'about_resource: .\n'
-                    u'name: AboutCode\n'
                     u'about_resource_path: .\n'
-                    u'version: 0.11.0\n'
-                    u'license_file: this.LICENSE\n')
+                    u'licenses:\n'
+                    u'    -   file: this.LICENSE\n'
+                    u'name: AboutCode\n'
+                    u'version: 0.11.0\n')
         assert expected == in_mem_result
 
     def test_deduplicate(self):

tests/test_model.py

@@ -586,47 +586,6 @@ def FAILING_test_About_equals_with_small_text_differences(self):
         assert a.dumps(True) == b.dumps(True)
         assert a == b
 
-    def test_About_dumps_does_not_transform_strings_in_lists(self):
-        test_file = get_test_loc('dumps/complete2/about.ABOUT')
-        a = model.About(test_file, about_file_path='complete2/about.ABOUT')
-        expected = u'''about_resource: .
-name: AboutCode
-about_resource_path:
-version: 0.11.0
-download_url:
-description: AboutCode is a tool to process ABOUT files. An ABOUT file is a file.
-homepage_url: http://dejacode.org
-notes:
-license_expression: apache-2.0
-license_key: apache-2.0
-license_name:
-license_file: apache-2.0.LICENSE
-license_url:
-copyright: Copyright (c) 2013-2014 nexB Inc.
-notice_file: NOTICE
-notice_url:
-redistribute:
-attribute:
-track_changes:
-modified:
-changelog_file:
-owner: nexB Inc.
-owner_url:
-contact:
-author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
-author_file:
-vcs_tool: git
-vcs_repository: https://github.com/dejacode/about-code-tool.git
-vcs_path:
-vcs_tag:
-vcs_branch:
-vcs_revision:
-checksum_md5:
-checksum_sha1:
-checksum_sha256:
-spec_version:
-'''
-        assert expected == a.dumps(with_absent=True)
 
     def test_About_same_attribution(self):
         base_dir = 'some_dir'
@@ -740,28 +699,37 @@ def test_About_dumps(self):
         a = model.About(test_file)
         assert [] == a.errors
 
+# Since the licenses group was not processed, 
         expected = u'''about_resource: .
-name: AboutCode
-version: 0.11.0
-description: |
+author:
+    - Jillian Daguil
+    - Chin Yeung Li
+    - Philippe Ombredanne
+    - Thomas Druez
+copyright: Copyright (c) 2013-2014 nexB Inc.
+description: |-
     AboutCode is a tool
     to process ABOUT files.
     An ABOUT file is a file.
-homepage_url: http://dejacode.org
+homepage_url:
+    - http://dejacode.org
 license_expression: apache-2.0
-license_key: apache-2.0
-license_file: apache-2.0.LICENSE
-copyright: Copyright (c) 2013-2014 nexB Inc.
+licenses:
+    -   file: apache-2.0.LICENSE
+        key: apache-2.0
+name: AboutCode
 notice_file: NOTICE
-owner: nexB Inc.
-author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
-vcs_tool: git
+owner:
+    - nexB Inc.
 vcs_repository: https://github.com/dejacode/about-code-tool.git
+vcs_tool: git
+version: 0.11.0
 '''
         result = a.dumps()
         assert expected == result
 
-    def test_About_dumps_all_fields_if_not_present_with_absent_True(self):
+    # We do not support with_absent and with_empty staring in version 3.2.0.
+    def FAILING_test_About_dumps_all_fields_if_not_present_with_absent_True(self):
         test_file = get_test_loc('parse/complete2/about.ABOUT')
         a = model.About(test_file)
         expected_error = [

tests/testdata/dumps/complete2/about.ABOUT

@@ -4,22 +4,26 @@ name: AboutCode
 version: 0.11.0
 
 owner: nexB Inc.
-author: Jillian Daguil, 
- Chin Yeung Li, 
- Philippe Ombredanne, 
- Thomas Druez
+author:
+    - Jillian Daguil, 
+    - Chin Yeung Li, 
+    - Philippe Ombredanne, 
+    - Thomas Druez
 
 homepage_url: http://dejacode.org
 
 vcs_tool: git
 vcs_repository: https://github.com/dejacode/about-code-tool.git
 
-description: AboutCode is a tool to process ABOUT files. 
- An ABOUT file is a file.
+description: |-
+    AboutCode is a tool to process ABOUT files. 
+    An ABOUT file is a file.
 
-license_key: apache-2.0
 license_expression: apache-2.0
-license_file: apache-2.0.LICENSE
+licenses:
+    -   key: apache-2.0
+        file: apache-2.0.LICENSE
+
 copyright: Copyright (c) 2013-2014 nexB Inc.
 
 notice_file: NOTICE

tests/testdata/parse/complete/about.ABOUT

@@ -4,14 +4,18 @@ name: AboutCode
 version: 0.11.0
 
 owner: nexB Inc.
-author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
+author:
+    - Jillian Daguil
+    - Chin Yeung Li
+    - Philippe Ombredanne
+    - Thomas Druez
 
 homepage_url: http://dejacode.org
 
 vcs_tool: git
 vcs_repository: https://github.com/dejacode/about-code-tool.git
 
-description: |
+description: |-
     AboutCode is a tool 
     to process ABOUT files. 
     An ABOUT file is a file.