Fixed #133 - Use 'dje_license_key' instead of 'dje_license'

Author: chinyeungli

about_code_tool/about.py

@@ -180,7 +180,7 @@ def repr_problem(obj):
 
 DJE_FIELDS = (
     'dje_component',
-    'dje_license',
+    'dje_license_key',
     'dje_organization',
     'dje_license_name'
 )

about_code_tool/genabout.py

@@ -340,7 +340,7 @@ def request_license_data(self, url, username, api_key, license_key):
                                          username + '/' + api_key, error_msg))
             else:
                 # FIXME: would this be only with a 404?
-                self.errors.append(Error(VALUE, 'dje_license', license_key,
+                self.errors.append(Error(VALUE, 'dje_license_key', license_key,
                                          "Invalid 'dje_license_key'"))
         except urllib2.URLError:
             if about.check_network_connection():
@@ -413,26 +413,26 @@ def get_dje_license_list(self, gen_location, input_list, gen_license, dje_licens
                         self.errors.append(Error(FILE, 'license_text_file', license_file, "The 'license_text_file' does not exist."))
                 else:
                     if gen_license:
-                        if line['dje_license']:
+                        if line['dje_license_key']:
                             license_output_list.append(self.gen_license_list(line))
                             lic_name = line['dje_license_name']
                             line['license_text_file'] = dje_license_dict[lic_name][0] + '.LICENSE'
                         else:
-                            self.warnings.append(Warn(VALUE, 'dje_license', '',
-                                                      "Missing 'dje_license' for " + line['about_file']))
+                            self.warnings.append(Warn(VALUE, 'dje_license_key', '',
+                                                      "Missing 'dje_license_key' for " + line['about_file']))
             # This except condition will force the tool to create the
             # 'license_text_file' key column from the self.gen_license_list(line)
             except Exception:
                 # FIXME: this is too complex
                 if gen_license:
-                    if line['dje_license']:
+                    if line['dje_license_key']:
                         license_output_list.append(self.gen_license_list(line))
                         lic_name = line['dje_license_name']
                         if lic_name:
                             line['license_text_file'] = dje_license_dict[lic_name][0] + '.LICENSE'
                     else:
-                        self.warnings.append(Warn(VALUE, 'dje_license', '',
-                                                  "Missing 'dje_license' for " + line['about_file']))
+                        self.warnings.append(Warn(VALUE, 'dje_license_key', '',
+                                                  "Missing 'dje_license_key' for " + line['about_file']))
         return license_output_list
 
     def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, api_key):
@@ -441,14 +441,14 @@ def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, ap
         license_dict = {}
         for line in input_list:
             try:
-                if line['dje_license']:
-                    if '\n' in line['dje_license']:
+                if line['dje_license_key']:
+                    if '\n' in line['dje_license_key']:
                         line['dje_license_name'] = ""
-                        self.errors.append(Error(VALUE, 'dje_license',
-                                                 line['dje_license'],
+                        self.errors.append(Error(VALUE, 'dje_license_key',
+                                                 line['dje_license_key'],
                                                  "No multiple licenses or newline character are accepted."))
                         continue
-                    lic = line['dje_license']
+                    lic = line['dje_license_key']
                     if not lic in license_dict:
                         detail_list = []
                         detail = self.get_license_details_from_api(api_url, api_username, api_key, lic)
@@ -464,8 +464,8 @@ def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, ap
                         line['dje_license_name'] = license_dict[lic]
                         line['dje_license_url'] = dje_lic_urn + lic
             except Exception:
-                err = Warn(VALUE, 'dje_license', '',
-                           'Missing "dje_license" for ' + line['about_file'])
+                err = Warn(VALUE, 'dje_license_key', '',
+                           'Missing "dje_license_key" for ' + line['about_file'])
                 self.warnings.append(err)
         return key_text_dict
 
@@ -823,7 +823,6 @@ def main(parser, options, args):
                 gen.copy_files(output_path, license_list)
 
     if license_text_path:
-        print(normpath(license_text_path))
         if not isdir(license_text_path):
             print("The '--license_text_location' <license_path> "
                   "must be a directory.")
@@ -844,11 +843,11 @@ def main(parser, options, args):
             sys.exit(errno.EINVAL)
         for line in input_list:
             try:
-                if line['dje_license']:
+                if line['dje_license_key']:
                     break
             except Exception as e:
                 print(repr(e))
-                print("The input does not have the 'dje_license' "
+                print("The input does not have the 'dje_license_key' "
                       "key which is required.")
                 sys.exit(errno.EINVAL)
 

about_code_tool/tests/test_about.py

@@ -113,11 +113,10 @@ def test_header_row_in_csv_output(self):
         'notice_file,notice_url,license_text_file,license_url,license_spdx,'
         'redistribute,attribute,track_changes,vcs_tool,vcs_repository,'
         'vcs_path,vcs_tag,vcs_branch,vcs_revision,checksum_sha1,checksum_md5,'
-        'checksum_sha256,dje_component,dje_license,dje_organization,'
+        'checksum_sha256,dje_component,dje_license_key,dje_organization,'
         'dje_license_name,scm_branch,scm_repository,signature_gpg_file,'
-        'redistribute_sources,about_format,usage,'
-        'license_text,notice,'  # These two are not supported and thus treat as custom keys
-        'scm_path,scm_tool,scm_rev,scm_tag,organization,'
+        'redistribute_sources,dje_license,about_format,usage,'
+        'license_text,notice,scm_path,scm_tool,scm_rev,scm_tag,organization,'
         'warnings,errors')
 
         test_file = 'about_code_tool/tests/testdata/basic'
@@ -690,7 +689,8 @@ def test_get_custom_field_keys(self):
         about_file = about.AboutFile(join(TESTDATA_DIR, 'basic/basic.about'))
         result = about_file.get_custom_field_keys()
         expected = ['scm_branch', 'scm_repository', 'signature_gpg_file',
-                    'redistribute_sources', 'about_format', 'usage',
+                    'redistribute_sources', 'dje_license',
+                    'about_format', 'usage',
                     # These two keys are removed from the spec and therefore
                     # become a custom keys
                     'license_text', 'notice',

about_code_tool/tests/test_genabout.py

@@ -361,7 +361,7 @@ def test_get_dje_license_list_gen_license_with_dje_license_key_empty_license_tex
                         'version': '0.8.1',
                         'about_resource': '.',
                         'name': 'ABOUT tool',
-                        'dje_license': 'apache-2.0',
+                        'dje_license_key': 'apache-2.0',
                         'dje_license_name': 'Apache License 2.0',
                         'license_text_file': ''}]
         gen_license = True
@@ -390,7 +390,7 @@ def test_get_dje_license_list_gen_license_with_empty_dje_license_key_empty_licen
                         'about_resource': '.',
                         'name': 'ABOUT tool',
                         'license_text_file': '',
-                        'dje_license': ''}]
+                        'dje_license_key': ''}]
         gen_license = True
         dje_license_dict = {'Apache License 2.0': [u'apache-2.0',
                                                    'test context']}
@@ -413,7 +413,7 @@ def test_get_dje_license_list_gen_license_with_dje_license_key_no_license_text_f
                         'about_resource': '.',
                         'name': 'ABOUT tool',
                         'dje_license_name': 'Apache License 2.0',
-                        'dje_license': 'Apache License 2.0'}]
+                        'dje_license_key': 'apache-2.0'}]
 
         expected = [('/', 'Apache License 2.0')]
         gen_license = True