Use license expression for multiple license support #275

 * Change the `license` from ListField() to StringField()
 * Created a new function `parse_license_expression` to parse the
license expression
 * Added/updated some test code

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

Author: chinyeungli

src/attributecode/model.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf8 -*-
 # ============================================================================
-#  Copyright (c) 2013-2016 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2017 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -47,6 +47,7 @@
 from attributecode import saneyaml
 from attributecode import util
 from attributecode.util import add_unc, UNC_PREFIX, UNC_PREFIX_POSIX, on_windows, copy_license_files
+from license_expression import Licensing
 
 
 class Field(object):
@@ -628,7 +629,7 @@ def create_fields(self):
             ('home_url', UrlField()),
             ('notes', StringField()),
 
-            ('license', ListField()),
+            ('license', StringField()),
             ('license_name', StringField()),
             ('license_file', FileTextField()),
             ('license_url', UrlField()),
@@ -1009,7 +1010,7 @@ def dump_lic(self, location, license_dict):
             os.makedirs(add_unc(parent))
 
         if self.license.present and not self.license_file.present:
-            for lic_key in self.license.value:
+            for lic_key in parse_license_expression(self.license.value):
                 try:
                     if license_dict[lic_key]:
                         license_path = posixpath.join(parent, lic_key)
@@ -1247,7 +1248,7 @@ def by_license(abouts):
     no_license = grouped['']
     for about in abouts:
         if about.license.value:
-            for lic in about.license.value:
+            for lic in parse_license_expression(about.license.value):
                 if lic in grouped:
                     grouped[lic].append(about)
                 else:
@@ -1299,7 +1300,7 @@ def by_license_content(abouts):
     no_license = grouped['']
     for about in abouts:
         if about.license.value:
-            for lic in about.license.value:
+            for lic in parse_license_expression(about.license.value):
                 if lic in grouped:
                     grouped[lic].append(about)
                 else:
@@ -1341,7 +1342,7 @@ def pre_process_and_fetch_license_dict(abouts, api_url, api_key):
         if auth_error in errors:
             break
         if about.license.present:
-            for lic_key in about.license.value:
+            for lic_key in parse_license_expression(about.license.value):
                 if not lic_key in captured_license:
                     detail_list = []
                     license_name, license_key, license_text, errs = api.get_license_details_from_api(api_url, api_key, lic_key)
@@ -1357,6 +1358,11 @@ def pre_process_and_fetch_license_dict(abouts, api_url, api_key):
                         key_text_dict[license_key] = detail_list
     return key_text_dict, errors
 
+def parse_license_expression(lic_expression):
+    licensing = Licensing()
+    # Parse the license expression and save it into a list
+    lic_list = licensing.license_keys(lic_expression)
+    return lic_list
 
 def valid_api_url(api_url):
     try:

tests/test_model.py

@@ -1131,13 +1131,26 @@ def test_collect_inventory_populate_about_file_path(self):
         assert expected == result
 
     def test_collect_inventory_with_multi_line(self):
-        test_loc = get_test_loc('parse/multi_line.ABOUT')
+        test_loc = get_test_loc('parse/multi_line_license_expresion.ABOUT')
         errors, abouts = model.collect_inventory(test_loc)
         assert [] == errors
-        expected_lic = [u'x11', u'mit', u'public-domain', u'bsd-simplified']
+        expected_lic_url = [u'https://enterprise.dejacode.com/urn/?urn=urn:dje:license:mit', u'https://enterprise.dejacode.com/urn/?urn=urn:dje:license:apache-2.0']
+        returned_lic_url = abouts[0].license_url.value
+        assert expected_lic_url == returned_lic_url
+
+    def test_collect_inventory_with_license_expression(self):
+        test_loc = get_test_loc('parse/multi_line_license_expresion.ABOUT')
+        errors, abouts = model.collect_inventory(test_loc)
+        assert [] == errors
+        expected_lic = u'mit or apache-2.0'
         returned_lic = abouts[0].license.value
         assert expected_lic == returned_lic
 
+    def test_parse_license_expression(self):
+        returned_lic = model.parse_license_expression(u'mit or apache-2.0')
+        expected_lic = [u'mit', u'apache-2.0']
+        assert expected_lic == returned_lic
+
     def test_collect_inventory_works_with_relative_paths(self):
         # FIXME: This test need to be run under src/attributecode/
         # or otherwise it will fail as the test depends on the launching
@@ -1224,7 +1237,7 @@ def test_unique(self):
     def test_by_license(self):
         base_dir = 'some_dir'
         a = model.About()
-        a.load_dict({'license': u'apache-2.0\n cddl-1.0', }, base_dir)
+        a.load_dict({'license': u'apache-2.0 and cddl-1.0', }, base_dir)
         b = model.About()
         b.load_dict({'license': u'apache-2.0', }, base_dir)
         c = model.About()

tests/testdata/parse/multi_line.ABOUT

@@ -0,0 +1,6 @@
+about_resource: .
+name: test
+license: mit or apache-2.0
+license_url: |
+    https://enterprise.dejacode.com/urn/?urn=urn:dje:license:mit
+    https://enterprise.dejacode.com/urn/?urn=urn:dje:license:apache-2.0