#450 - Code enhancement and added tests

Author: chinyeungli

src/attributecode/attrib.py

@@ -96,6 +96,7 @@ def generate(abouts, template=None, variables=None):
                 if about.license_expression.value or about.license_key.value:
                     if about.license_expression.value:
                         special_char, lic_list = parse_license_expression(about.license_expression.value)
+                        about.license_key.value = lic_list
                     else:
                         lic_list = about.license_key.value
                         special_char = []
@@ -109,9 +110,8 @@ def generate(abouts, template=None, variables=None):
                                       'license_expression or license_key: %s' % special_char)
                         return error, ''
                 else:
-                    # No license_key or license_expression present. We will use
-                    # the license_file_name as the license_key as needed for the
-                    # linking feature in the jinja2 template
+                    # No license_key or license_expression present. We will put
+                    # None as the value of license key
                     about.license_key.value = about.license_file.value.keys()
                     lic_list = about.license_file.value.keys()
 

src/attributecode/model.py

@@ -1085,13 +1085,13 @@ def dumps(self, licenses_dict=None):
                                 license_file.append(lic)
                     else:
                         if isinstance(field.original_value, list):
-                            license_file = field.value.keys()
+                            license_file = list(field.value.keys())
                         else:
                             # Restore the original license_file value
                             # See #444
                             license_file = [field.original_value]
                 else:
-                    license_file = field.value.keys()
+                    license_file = list(field.value.keys())
             elif field.name == 'license_url' and field.value:
                 license_url = field.value
             elif field.name in file_fields and field.value:
@@ -1105,10 +1105,10 @@ def dumps(self, licenses_dict=None):
         # Group the same license information in a list
         # This `licenses_dict` is a dictionary with license key as the key and the 
         # value is the list of [license_name, license_context, license_url]
-        lic_key_dup = license_key[:]
+        lic_key_copy = license_key[:]
+        lic_dict_list = []
         for lic_key in license_key:
             lic_dict = OrderedDict()
-
             if licenses_dict and lic_key in licenses_dict:
                 lic_dict['key'] = lic_key
                 lic_name = licenses_dict[lic_key][0]
@@ -1120,30 +1120,43 @@ def dumps(self, licenses_dict=None):
                 lic_dict['url'] = lic_url
 
                 # Remove the license information if it has been handled
-                #license_key.remove(lic_key)
-                #print(license_key)
-                lic_key_dup.remove(lic_key)
+                lic_key_copy.remove(lic_key)
                 if lic_name in license_name:
                     license_name.remove(lic_name)
                 if lic_url in license_url:
                     license_url.remove(lic_url)
                 if lic_file in license_file:
                     license_file.remove(lic_file)
-                data.setdefault('licenses', []).append(lic_dict)
+                lic_dict_list.append(lic_dict)
 
         # Handle license information that have not been handled.
-        license_group = list(zip_longest(lic_key_dup, license_name, license_file, license_url))
+        license_group = list(zip_longest(lic_key_copy, license_name, license_file, license_url))
         for lic_group in license_group:
             lic_dict = OrderedDict()
             if lic_group[0]:
                 lic_dict['key'] = lic_group[0]
             if lic_group[1]:
                 lic_dict['name'] = lic_group[1]
+            else:
+                # If no name is given, treat the key as the name
+                if lic_group[0]:
+                    lic_dict['name'] = lic_group[0]
             if lic_group[2]:
                 lic_dict['file'] = lic_group[2]
             if lic_group[3]:
                 lic_dict['url'] = lic_group[3]
-            data.setdefault('licenses', []).append(lic_dict)
+            lic_dict_list.append(lic_dict)
+
+        # Format the license information in the same order of the license expression
+        if license_key:
+            for key in license_key:
+                for lic_dict in lic_dict_list:
+                    if key == lic_dict['key']:
+                        data.setdefault('licenses', []).append(lic_dict)
+                        break
+        else:
+            for lic_dict in lic_dict_list:
+                data.setdefault('licenses', []).append(lic_dict)
 
         return saneyaml.dump(data)
 
@@ -1234,13 +1247,16 @@ def dump_lic(self, location, license_dict):
 
         if self.license_expression.present:
             special_char_in_expression, lic_list = parse_license_expression(self.license_expression.value)
+            self.license_key.value = lic_list
             self.license_key.present = True
             if not special_char_in_expression:
                 for lic_key in lic_list:
                     try:
                         if license_dict[lic_key]:
+                            """
                             if not lic_key in self.license_key.value:
                                 self.license_key.value.append(lic_key)
+                            """
                             license_path = posixpath.join(parent, lic_key)
                             license_path += u'.LICENSE'
                             license_path = add_unc(license_path)

templates/default_html.template

@@ -95,10 +95,10 @@ See "get_license_file_key" in `attrib.py` for more information
 
     <h3>Common Licenses Used in This Product</h3>
 
-    {% for key in license_key_and_context %}
+    {% for key in license_file_key_and_context %}
         {% if key in common_licenses %}
             <h3 id="component-license-{{ key }}">{{ key }}</h3>
-            <pre>{{ license_key_and_context[key]|e }}</pre>
+            <pre>{{ license_file_key_and_context[key]|e }}</pre>
         {% endif %}
     {% endfor %}
 

tests/test_gen.py

@@ -217,10 +217,13 @@ def test_generate_multi_lic_issue_443(self):
 version: '1.5'
 licenses:
   - key: License1
+    name: License1
     file: LIC1.LICENSE
   - key: License2
+    name: License2
     file: LIC2.LICENSE
   - key: License3
+    name: License3
     file: LIC3.LICENSE
 '''
         )
@@ -238,11 +241,113 @@ def test_generate_multi_lic_issue_444(self):
 name: test.c
 licenses:
   - key: License1
+    name: License1
     file: LIC1.LICENSE, LIC2.LICENSE
 '''
         )
         assert expected == result
 
+    def test_generate_license_key_with_custom_file_450_no_fetch(self):
+        location = get_test_loc('test_gen/lic_issue_450/custom_and_valid_lic_key_with_file.csv')
+        base_dir = get_temp_dir()
+
+        errors, abouts = gen.generate(location, base_dir)
+
+        result = [a.dumps() for a in abouts][0]
+        expected = (
+'''about_resource: test.c
+name: test.c
+license_expression: public-domain AND custom
+licenses:
+  - file: custom.txt
+'''
+        )
+        assert expected == result
+
+    def test_generate_license_key_with_custom_file_450_with_fetch(self):
+        location = get_test_loc('test_gen/lic_issue_450/custom_and_valid_lic_key_with_file.csv')
+        base_dir = get_temp_dir()
+
+        errors, abouts = gen.generate(location, base_dir)
+
+        lic_dict = {u'public-domain': [u'Public Domain',
+                                       u'This component is released to the public domain by the author.',
+                                       u'https://enterprise.dejacode.com/urn/?urn=urn:dje:license:public-domain'
+                                       ]}
+        a = abouts[0]
+        a.license_key.value.append('public-domain')
+        a.license_key.value.append('custom')
+        result = a.dumps(lic_dict)
+        expected = (
+'''about_resource: test.c
+name: test.c
+license_expression: public-domain AND custom
+licenses:
+  - key: public-domain
+    name: Public Domain
+    file: public-domain.LICENSE
+    url: https://enterprise.dejacode.com/urn/?urn=urn:dje:license:public-domain
+  - key: custom
+    name: custom
+    file: custom.txt
+'''
+        )
+        assert expected == result
+
+
+    def test_generate_license_key_with_custom_file_450_with_fetch_with_order(self):
+        location = get_test_loc('test_gen/lic_issue_450/custom_and_valid_lic_key_with_file.csv')
+        base_dir = get_temp_dir()
+
+        errors, abouts = gen.generate(location, base_dir)
+
+        lic_dict = {u'public-domain': [u'Public Domain',
+                                       u'This component is released to the public domain by the author.',
+                                       u'https://enterprise.dejacode.com/urn/?urn=urn:dje:license:public-domain'
+                                       ]}
+        # The first row from the test file
+        a = abouts[0]
+        a.license_key.value.append('public-domain')
+        a.license_key.value.append('custom')
+        result1 = a.dumps(lic_dict)
+        # The second row from the test file
+        b = abouts[1]
+        b.license_key.value.append('custom')
+        b.license_key.value.append('public-domain')
+        result2 = b.dumps(lic_dict)
+
+        expected1 = (
+'''about_resource: test.c
+name: test.c
+license_expression: public-domain AND custom
+licenses:
+  - key: public-domain
+    name: Public Domain
+    file: public-domain.LICENSE
+    url: https://enterprise.dejacode.com/urn/?urn=urn:dje:license:public-domain
+  - key: custom
+    name: custom
+    file: custom.txt
+'''
+        )
+
+        expected2 = (
+'''about_resource: test.h
+name: test.h
+license_expression: custom AND public-domain
+licenses:
+  - key: custom
+    name: custom
+    file: custom.txt
+  - key: public-domain
+    name: Public Domain
+    file: public-domain.LICENSE
+    url: https://enterprise.dejacode.com/urn/?urn=urn:dje:license:public-domain
+'''
+        )
+        assert expected1 == result1
+        assert expected2 == result2
+
     @skip('FIXME: this test is making a failed, live API call')
     def test_generate_not_overwrite_original_license_file(self):
         location = get_test_loc('test_gen/inv5.csv')

tests/test_model.py

@@ -749,6 +749,7 @@ def test_About_dumps(self):
 vcs_repository: https://github.com/dejacode/about-code-tool.git
 licenses:
   - key: apache-2.0
+    name: Apache 2.0
     file: apache-2.0.LICENSE
 '''
         result = a.dumps()

tests/testdata/test_attrib/gen_license_key_name_check/test.ABOUT

@@ -1,6 +1,6 @@
 about_resource: .
 name: test
-license_expression: LGPL-3.0-or-later OR Apache-2.0
+license_expression: Apache-2.0 OR LGPL-3.0-or-later
 licenses:
   - key: Apache-2.0
     name: Apache License 2.0

tests/testdata/test_gen/lic_issue_450/custom.txt

@@ -0,0 +1 @@
+This is a custom license.

tests/testdata/test_gen/lic_issue_450/custom_and_valid_lic_key_with_file.csv

@@ -0,0 +1,3 @@
+about_resource,name,license_expression,license_file
+test.c,test.c,public-domain AND custom,custom.txt
+test.h,test.h,custom AND public-domain,custom.txt

tests/testdata/test_model/dumps/about.ABOUT

@@ -18,6 +18,7 @@ description: |
 
 license_expression: apache-2.0
 license_key: apache-2.0
+license_name: Apache 2.0
 license_file: apache-2.0.LICENSE
 copyright: Copyright (c) 2013-2014 nexB Inc.