Fixed #152 - Log error when multiple licenses are detected. In addition,

this commit also removed some dead code and comments.

Author: chinyeungli

about_code_tool/about.py

@@ -97,7 +97,7 @@ def repr_problem(obj):
 
 
 IGNORED = 'field or line ignored problem'
-VALUE = 'missing or empty value problem'
+VALUE = 'missing or empty or multiple value problem'
 FILE = 'file problem'
 URL = 'URL problem'
 VCS = 'Version control problem'
@@ -109,16 +109,13 @@ def repr_problem(obj):
 
 
 MANDATORY_FIELDS = (
-    # 'about_resource',
-    # 'about_file',
     'name',
     'version',
 )
 
 
 BASIC_FIELDS = (
     'about_resource',
-    'about_resource_path',  # Need to update spec
     'spec_version',
     'date',
     'description',
@@ -734,7 +731,6 @@ def validate(self):
 
         for field_name, value in self.validated_fields.items():
             self.check_is_ascii(self.validated_fields.get(field_name))
-            # self.validate_known_optional_fields(field_name)
             self.validate_file_field_exists(field_name, value)
             self.validate_url_field(field_name, network_check=False)
             self.validate_spdx_license(field_name, value)
@@ -854,28 +850,28 @@ def validate_spdx_license(self, field_name, field_value):
         if not field_name == 'license_spdx':
             return
         # FIXME: do we support more than one ID?
-        spdx_ids = field_value.split()
-        for spdx_id in spdx_ids:
-            # valid id, matching the case
-            if spdx_id in SPDX_LICENSE_IDS.values():
-                continue
+        # Not support multiple IDs
+        spdx_id = field_value
+        # valid id, matching the case
+        if spdx_id in SPDX_LICENSE_IDS.values():
+            return
 
-            spdx_id_lower = spdx_id.lower()
+        spdx_id_lower = spdx_id.lower()
 
-            # conjunctions
-            if spdx_id_lower in ['or', 'and']:
-                continue
+        # conjunctions
+        if spdx_id_lower in ['or', 'and']:
+            return
 
-            # lowercase check
-            try:
-                standard_id = SPDX_LICENSE_IDS[spdx_id_lower]
-            except KeyError:
-                self.errors.append(Error(SPDX, field_name, spdx_id,
-                                         'Invalid SPDX license id.'))
-            else:
-                msg = ('Non standard SPDX license id case. Should be %r.'
-                       % (standard_id))
-                self.warnings.append(Warn(SPDX, field_name, id, msg))
+        # lowercase check
+        try:
+            standard_id = SPDX_LICENSE_IDS[spdx_id_lower]
+        except KeyError:
+            self.errors.append(Error(SPDX, field_name, spdx_id,
+                                     'Invalid SPDX license id.'))
+        else:
+            msg = ('Non standard SPDX license id case. Should be %r.'
+                   % (standard_id))
+            self.warnings.append(Warn(SPDX, field_name, id, msg))
 
     def validate_url_field(self, field_name, network_check=False):
         """
@@ -974,23 +970,31 @@ def get_custom_field_keys(self):
         return custom_key
 
     def get_row_data(self, updated_path, custom_keys):
+        print(updated_path)
+        print(custom_keys)
         """
         Create a csv compatible row of data for this object.
         """
         row = [updated_path]
-        # FIXME: this list is not used? what was the intent?
-        custom_field = []
+        no_multi_license_fields = ('license_text_file',
+                                    'license_spdx',
+                                    'dje_license',
+                                    'dje_license_name')
         for field in MANDATORY_FIELDS + OPTIONAL_FIELDS:
             if field in self.validated_fields:
                 row += [self.validated_fields[field]]
-            elif field == 'about_resource_path':
-                about = self.validated_fields['about_resource']
-                if about.endswith('.'):
-                    about_resource_path = dirname(updated_path) + '/'
-                else:
-                    about_resource_path = normpath(join(dirname(updated_path),
-                                                        about))
-                row += [about_resource_path]
+                # The following code is to catch is the input contians any
+                # multiple licenses
+                if field in no_multi_license_fields:
+                    for lic_field in no_multi_license_fields:
+                        try:
+                            if '\n' in self.validated_fields[lic_field]:
+                                self.errors.append(Error(VALUE,
+                                                         lic_field,
+                                                         self.validated_fields[field],
+                                                         "Multiple Licenses are not supported."))
+                        except:
+                            pass
             else:
                 row += ['']
 
@@ -1044,20 +1048,6 @@ def duplicate_file_names_when_lowercased(file_location):
                 names.append(name)
         return names
 
-    """def tmp_get_license_text(self):
-        # TODO: This is a temp fix for handling multiple 'license_text_file'
-        # The code should get the license text from the def license_text(self),
-        # not this function.
-        license_text = ""
-        licenses = self.parsed.get('license_text_file', '')
-        license_list = licenses.split('\n ')
-        for lic in license_list:
-            location = join(dirname(self.location), lic)
-            with open(location, 'rU') as f:
-                license_text += f.read()
-                license_text += '\n\n\n\n\n\n'
-        return license_text"""
-
     def license_text(self):
         """
         Return the license text if the license_text_file field exists and the

about_code_tool/tests/test_about.py

@@ -106,7 +106,7 @@ def test_return_path_is_not_abspath_and_contains_subdirs_on_dir(self):
 
     def test_header_row_in_csv_output(self):
         expected_header = ('about_file,name,version,about_resource,'
-        'about_resource_path,spec_version,date,description,description_file,'
+        'spec_version,date,description,description_file,'
         'home_url,download_url,readme,readme_file,install,install_file,'
         'changelog,changelog_file,news,news_file,news_url,notes,notes_file,'
         'contact,owner,author,author_file,copyright,copyright_file,'
@@ -533,8 +533,7 @@ def test_validate_spdx_licenses2(self):
         about_file = about.AboutFile(test_file)
         expected_errors = [about.SPDX]
         # The test case is: license_spdx: Something and SomeOtherThings
-        # Thus, it should throw 2 errors: 'Something', 'SomeOtherThings'
-        self.assertEqual(2, len(about_file.errors))
+        self.assertEqual(1, len(about_file.errors))
         for w in about_file.errors:
             self.assertEqual(expected_errors[0], w.code)