Fixed #137 - remove the 'about_resource_path' in the generated ABOUT file and keep it in the generated CSV file.

Author: chinyeungli

about_code_tool/about.py

@@ -32,7 +32,7 @@
 import csv
 from datetime import datetime
 from email.parser import HeaderParser
-from os.path import basename, dirname, join, realpath
+from os.path import basename, dirname, join, normpath, realpath
 import errno
 import httplib
 import logging
@@ -948,6 +948,14 @@ def get_row_data(self, updated_path, custom_keys):
         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]
             else:
                 row += ['']
 

about_code_tool/genabout.py

@@ -512,21 +512,6 @@ def pre_generation(self, gen_location, input_list, action_num, all_in_one):
                     file_location = join(file_location, basename(file_location))
                 file_location += '.ABOUT'
 
-            """line['about_resource'] = basename(file_location)
-            if not file_location.startswith('/'):
-                line['about_resource_path'] = '/' + file_location
-            else:
-                line['about_resource_path'] = file_location
-                # Strip the first '/' for the later 'join'
-                file_location = file_location.partition('/')[2]
-            if not file_location.endswith('.ABOUT'):
-                if file_location.endswith('/'):
-                    file_location = dirname(file_location)
-                    file_location = join(file_location, basename(file_location))
-                    # Since this is referencing everything in the current directory,
-                    # we will use a '.' period to reference it.
-                    line['about_resource'] = '.'
-                file_location += '.ABOUT'"""
             if all_in_one:
                 # This is to get the filename instead of the file path
                 file_location = file_location.rpartition('/')[2]
@@ -560,11 +545,9 @@ def pre_generation(self, gen_location, input_list, action_num, all_in_one):
                 elif action_num == ACTION_REPLACE_THE_ABOUT_FILE_WITH_THE_CURRENT_GENERATED_FILE:
                     pass
 
-            # The following is to ensure about_resource and
-            # about_resource_path fields are present. If they exist already,
-            # the code will not changes these.
+            # The following is to ensure about_resource is present.
+            # If they exist already, the code will not changes these.
             self.update_about_resource(line, about_file_exist)
-            self.update_about_resource_path(line, about_file_exist)
 
             component_list.append(about_file_location)
             component_list.append(line)
@@ -587,23 +570,6 @@ def update_about_resource(self, line, about_file_exist):
             else:
                 line['about_resource'] = basename(about_resource)
 
-    def update_about_resource_path(self, line, about_file_exist):
-        # Check if 'about_resource_path' exist
-        try:
-            if line['about_resoure_path']:
-                if not about_file_exist:
-                    file_path = line['about_file']
-                    if not file_path.startswith('/'):
-                        line['about_resource_path'] = '/' + file_path
-                    else:
-                        line['about_resource_path'] = file_path
-        except:
-            file_path = line['about_file']
-            if not file_path.startswith('/'):
-                line['about_resource_path'] = '/' + file_path
-            else:
-                line['about_resource_path'] = file_path
-
     @staticmethod
     def gen_license_list(line):
         dje_license_name = line['dje_license_name']

about_code_tool/tests/test_about.py

@@ -115,7 +115,7 @@ def test_header_row_in_csv_output(self):
         'checksum_sha1,checksum_md5,checksum_sha256,dje_component,'
         'dje_license,dje_organization,dje_license_name,scm_branch,'
         'scm_repository,signature_gpg_file,redistribute_sources,about_format,'
-        'usage,scm_tool,scm_path,scm_tag,scm_rev,organization,'
+        'usage,scm_path,scm_tool,scm_rev,scm_tag,organization,'
         'warnings,errors')
 
         test_file = 'about_code_tool/tests/testdata/basic'
@@ -678,9 +678,10 @@ 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',
-                         'scm_tool', 'scm_path', 'scm_tag', 'scm_rev',
-                         'organization']
+                    'redistribute_sources', 'about_format', 'usage',
+                    'scm_path', 'scm_tool', 'scm_rev', 'scm_tag',
+                    'organization']
+        print(result)
         self.assertEqual(result, expected)
 
 

about_code_tool/tests/test_genabout.py

@@ -441,7 +441,6 @@ def test_pre_generation_about_is_dir_exists_action_0(self):
                           'TESTCASE.ABOUT'),
                      {'about_file': '/TESTCASE/',
                       'version': '0.8.1',
-                      'about_resource_path' : '/TESTCASE/',
                       'about_resource': '.',
                       'name': 'ABOUT tool'}]]
 
@@ -479,7 +478,6 @@ def test_pre_generation_about_exists_action_1(self):
         expected = [[join(TESTDATA_DIR, 'test_files_for_genabout',
                           'about.py.ABOUT'),
                      {'about_file': '/about.py.ABOUT',
-                      'about_resource_path': '/about.py.ABOUT',
                       'version': '0.8.2',
                       'about_resource': '.',
                       'name': 'ABOUT tool'}]]
@@ -503,7 +501,6 @@ def test_pre_generation_about_exists_action_2(self):
                           'about.py.ABOUT'),
                      {'about_file': 'about.py.ABOUT',
                       'name': 'ABOUT tool',
-                      'about_resource_path': '/about.py.ABOUT',
                       'version': '0.8.1',
                       'test': 'test sample',
                       'about_resource': '.'}]]
@@ -527,7 +524,6 @@ def test_pre_generation_about_exists_action_3(self):
                           'about.py.ABOUT'),
                      {'about_file': '/about.py.ABOUT',
                       'version': '0.8.2',
-                      'about_resource_path': '/about.py.ABOUT',
                       'about_resource': '.',
                       'name': '',
                       'test': 'test sample'}]]
@@ -787,57 +783,3 @@ def test_update_about_resource_no_about_file_no_field_isdir(self):
         about_file_exist = False
         gen.update_about_resource(test_fields, about_file_exist)
         self.assertEqual(test_fields, expected)
-
-    def test_update_about_resource_path_about_file_field_exist(self):
-        gen = genabout.GenAbout()
-        test_fields = {'about_resource_path': '/tmp/test.c',
-                       'about_file': '/tmp/test.c'}
-        about_file_exist = True
-        gen.update_about_resource_path(test_fields, about_file_exist)
-        # FIXME: this will always be true: the test is incorrect
-        self.assertTrue(test_fields == test_fields, 'The dict should not be changed.')
-
-    def test_update_about_resource_path_about_file_field_not_exist_isFile(self):
-        gen = genabout.GenAbout()
-        test_fields = {'about_file': '/tmp/test.c'}
-        expected = {'about_file': '/tmp/test.c',
-                    'about_resource_path': '/tmp/test.c'}
-        about_file_exist = True
-        gen.update_about_resource_path(test_fields, about_file_exist)
-        self.assertEqual(test_fields, expected)
-
-    def test_update_about_resource_path_about_file_field_not_exist_isDir(self):
-        gen = genabout.GenAbout()
-        test_fields = {'about_file': '/tmp/test/'}
-        expected = {'about_file': '/tmp/test/',
-                    'about_resource_path': '/tmp/test/'}
-        about_file_exist = True
-        gen.update_about_resource_path(test_fields, about_file_exist)
-        self.assertEqual(test_fields, expected)
-
-    def test_update_about_resource_path_no_about_file_field_exist(self):
-        gen = genabout.GenAbout()
-        test_fields = {'about_resource_path': '/tmp/test.c',
-                       'about_file': '/tmp/test.c'}
-        about_file_exist = False
-        gen.update_about_resource_path(test_fields, about_file_exist)
-        # FIXME: this will always be true: the test is incorrect
-        self.assertTrue(test_fields == test_fields, 'The dict should not be changed.')
-
-    def test_update_about_resource_path_no_about_file_field_not_exist_isFile(self):
-        gen = genabout.GenAbout()
-        test_fields = {'about_file': '/tmp/test.c'}
-        expected = {'about_file': '/tmp/test.c',
-                    'about_resource_path': '/tmp/test.c'}
-        about_file_exist = False
-        gen.update_about_resource_path(test_fields, about_file_exist)
-        self.assertEqual(test_fields, expected)
-
-    def test_update_about_resource_path_no_about_file_field_not_exist_isDir(self):
-        gen = genabout.GenAbout()
-        test_fields = {'about_file': '/tmp/test/'}
-        expected = {'about_file': '/tmp/test/',
-                    'about_resource_path': '/tmp/test/'}
-        about_file_exist = False
-        gen.update_about_resource_path(test_fields, about_file_exist)
-        self.assertEqual(test_fields, expected)

about_code_tool/tests/testdata/basic/basic.about

@@ -1,3 +1,4 @@
+about_resource: .
 name: optional
 version: 2.2
 about_format: 2.0