Fixed the tests following restructuration of the code

tdruez · tdruez · commit 1ad5474098f3 · 2013-10-30T22:48:16.000-07:00
diff --git a/README.rst b/README.rst
@@ -28,7 +28,7 @@ http://www.dejacode.org/about_spec_v0.8.0.html
 
 REQUIREMENTS
 ------------
-The ABOUT tool has been tested with Python 2.6 or 2.7 on Linux, Mac and Windows.
+The ABOUT tool is tested with Python 2.6 or 2.7 on Linux, Mac and Windows.
 You will need to install a Python interpreter if you do not have one already
 installed.
 
@@ -63,7 +63,7 @@ https://github.com/dejacode/about-code-tool/archive/master.zip
 
 Then open a terminal or command prompt, extract the download if needed and run::
 
-    python tests.py
+    python setup.py test
 
 
 USAGE
diff --git a/about_code_tool/about.py b/about_code_tool/about.py
@@ -553,7 +553,7 @@ def license_text(self):
             license_text_path = self.file_fields_locations["license_text_file"]
             with open(license_text_path, 'rU') as f:
                 return f.read()
-        except Exception as e: 
+        except Exception as e:
             pass
         #return empty string if the license file does not exist
         return ""
@@ -567,7 +567,7 @@ def notice_text(self):
             notice_text_path = self.file_fields_locations["notice_file"]
             with open(notice_text_path, 'rU') as f:
                 return f.read()
-        except Exception as e: 
+        except Exception as e:
             pass
         #return empty string if the notice file does not exist
         return ""
@@ -1015,21 +1015,21 @@ def generate_attribution(self, template_path='templates/default.html',
             return
 
         # We only need the fields names and values to render the template
-        about_validated_fields = [about_object.validated_fields 
-                                  for about_object in self.about_objects 
-                                  if not sublist 
+        about_validated_fields = [about_object.validated_fields
+                                  for about_object in self.about_objects
+                                  if not sublist
                                   or about_object.about_resource_path in sublist]
 
-        about_license_text = [about_object.license_text() 
-                              for about_object in self.about_objects 
-                              if not sublist 
+        about_license_text = [about_object.license_text()
+                              for about_object in self.about_objects
+                              if not sublist
                               or about_object.about_resource_path in sublist]
         about_notice_text = [about_object.notice_text()
                              for about_object in self.about_objects
                              if not sublist
                              or about_object.about_resource_path in sublist]
 
-        return template.render(about_objects = about_validated_fields, 
+        return template.render(about_objects = about_validated_fields,
                                license_texts = about_license_text,
                                notice_texts = about_notice_text)
 
diff --git a/about_code_tool/genabout.py b/about_code_tool/genabout.py
@@ -176,13 +176,11 @@ def copy_license_files(self, gen_location, license_list):
                 makedirs(license_parent_dir)
             shutil.copy2(license_path, output_license_path)
 
-    """
-    def extract_licesen_from_url(self):
-        # This function needs discussion
-        test = urllib2.urlopen("https://enterprise.dejacode.com/license_library/Demo/gpl-1.0/#license-text")
-        with open('testdata/test_file.txt', 'wb') as output_file:
-            output_file.write(test.read())
-    """
+    #def extract_license_from_url(self):
+    #    # This function needs discussion
+    #    test = urllib2.urlopen("https://enterprise.dejacode.com/license_library/Demo/gpl-1.0/#license-text")
+    #    with open('testdata/test_file.txt', 'wb') as output_file:
+    #        output_file.write(test.read())
 
     def pre_generation(self, gen_location, input_list, action_num, all_in_one):
         """
@@ -232,36 +230,30 @@ def pre_generation(self, gen_location, input_list, action_num, all_in_one):
                 output_list.append(component_list)
         return output_list
 
-    def format_output(self, input_list):
+    @staticmethod
+    def format_output(input_list):
         """
-        process the input and covert to the specific strings format
+        Process the input and convert to the specific strings format.
         """
         components_list = []
-        for items in input_list:
+        for entry in input_list:
+            about_file_location = entry[0]
+            about_dict_list = entry[1]
+
             component = []
-            about_file_location = items[0]
-            about_dict_list = items[1]
-            context = ''
-            if about_dict_list['name']:
-                name = about_dict_list['name']
-            else:
-                name = ''
-            if about_dict_list['version']:
-                version = about_dict_list['version']
-            else:
-                version = ''
-            context = 'about_resource: ' + about_dict_list['about_resource'] + '\n' \
-                        + 'name: ' + name + '\n' \
-                        + 'version: ' + version + '\n\n'
+            component_name = about_dict_list.get('name', '')
+            component_version = about_dict_list.get('version', '')
+            context = 'about_resource: %s\nname: %s\nversion: %s\n\n' % (
+                about_dict_list['about_resource'], component_name, component_version)
+
             for item in sorted(about_dict_list.iterkeys()):
-                if item == 'about_file':
-                    continue
                 if not item in MANDATORY_FIELDS:
                     # The purpose of the replace('\n', '\n ') is used to
                     # format the continuation strings
                     value = about_dict_list[item].replace('\n', '\n ')
                     if (value or item in MANDATORY_FIELDS) and not item in SKIPPED_FIELDS:
                         context += item + ': ' + value + '\n'
+
             component.append(about_file_location)
             component.append(context)
             components_list.append(component)
diff --git a/about_code_tool/tests/test_about.py b/about_code_tool/tests/test_about.py
@@ -14,6 +14,7 @@
 #  limitations under the License.
 # =============================================================================
 
+from __future__ import print_function
 from __future__ import with_statement
 
 import os
@@ -22,9 +23,12 @@
 from StringIO import StringIO
 import tempfile
 import unittest
+from os.path import abspath, dirname, join
 
 from about_code_tool import about
 
+TESTDATA_PATH = join(abspath(dirname(__file__)), 'testdata')
+
 
 class BasicTest(unittest.TestCase):
     def test_simple_about_command_line_can_run(self):
@@ -37,27 +41,29 @@ def test_simple_about_command_line_can_run(self):
         shutil.rmtree(tst_fn, ignore_errors=True)
 
     def test_return_path_is_not_abspath_and_contains_subdirs_on_file(self):
-        test_input = "testdata/thirdparty/django_snippets_2413.ABOUT"
-        test_output = "testdata/output/test_return_path_is_not_abspath_on_file.csv"
+        # Using a relative path for the purpose of this test
+        test_input = "about_code_tool/tests/testdata/thirdparty/django_snippets_2413.ABOUT"
+        test_output = join(TESTDATA_PATH, 'output/test_return_path_is_not_abspath_on_file.csv')
         try:
             os.remove(test_output)
         except OSError:
             pass
         collector = about.AboutCollector(test_input, test_output, '0')
         collector.extract_about_info()
-        self.assertTrue(open(test_output).read().partition('\n')[2].startswith('testdata/thirdparty/django_snippets_2413.ABOUT'))
+        self.assertTrue(open(test_output).read().partition('\n')[2].startswith('about_code_tool/tests/testdata/thirdparty/django_snippets_2413.ABOUT'))
         os.remove(test_output)
 
     def test_return_path_is_not_abspath_and_contains_subdirs_on_dir(self):
-        test_input = "testdata/basic"
-        test_output = "testdata/output/test_return_path_is_not_abspath_on_dir.csv"
+        # Using a relative path for the purpose of this test
+        test_input = "about_code_tool/tests/testdata/basic"
+        test_output = join(TESTDATA_PATH, 'output/test_return_path_is_not_abspath_on_dir.csv')
         try:
             os.remove(test_output)
         except OSError:
             pass
         collector = about.AboutCollector(test_input, test_output, '0')
         collector.extract_about_info()
-        self.assertTrue(open(test_output).read().partition('\n')[2].startswith('testdata/basic'))
+        self.assertTrue(open(test_output).read().partition('\n')[2].startswith('about_code_tool/tests/testdata/basic'))
         os.remove(test_output)
 
     def test_isvalid_about_file(self):
@@ -221,29 +227,27 @@ def test_pre_process_with_spaces_left_of_colon(self):
         self.assertEqual(expected, result.read())
 
     def test_handles_last_line_is_a_continuation_line(self):
-        about_obj = about.AboutFile()
         warnings = []
         warn = about.AboutFile.check_line_continuation(" Last line is a continuation line.", True)
         warnings.append(warn)
         self.assertTrue(warnings == [""], "This should not throw any warning.")
 
     def test_handles_last_line_is_not_a_continuation_line(self):
-        about_obj = about.AboutFile()
         warnings = []
         warn = about.AboutFile.check_line_continuation(" Last line is NOT a continuation line.", False)
         warnings.append(warn)
         self.assertTrue(len(warnings) == 1, "This should throw ONLY 1 warning.")
 
     def test_normalize_dupe_field_names(self):
-        about_file = about.AboutFile('testdata/parser_tests/dupe_field_name.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/dupe_field_name.ABOUT'))
         expected_warnings = [about.IGNORED, 'Apache HTTP Server']
         self.assertTrue(len(about_file.warnings) == 1, "This should throw one warning")
         for w in about_file.warnings:
             self.assertEqual(expected_warnings[0], w.code)
             self.assertEqual(expected_warnings[1], w.field_value)
 
     def test_normalize_lowercase(self):
-        about_file = about.AboutFile('testdata/parser_tests/upper_field_names.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/upper_field_names.ABOUT'))
         expected = {'name': 'Apache HTTP Server\nthis is a continuation',
                     'home_url': 'http://httpd.apache.org',
                     'download_url': 'http://archive.apache.org/dist/httpd/httpd-2.4.3.tar.gz',
@@ -257,27 +261,27 @@ def test_normalize_lowercase(self):
         self.assertTrue(all(item in about_file.validated_fields.items() for item in expected.items()))
 
     def test_validate_about_ref_testing_the_about_resource_field_is_present(self):
-        about_file = about.AboutFile('testdata/parser_tests/about_resource_field_present.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_resource_field_present.ABOUT'))
         self.assertEquals(about_file.about_resource_path, 'about_resource.c', 'the about_resource was not detected')
 
     def test_validate_about_ref_no_about_ref_key(self):
-        about_file = about.AboutFile('testdata/parser_tests/.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/.ABOUT'))
         expected_errors = [about.VALUE, 'about_resource']
         self.assertTrue(len(about_file.errors) == 1, "This should throw 1 error")
         for w in about_file.errors:
             self.assertEqual(expected_errors[0], w.code)
             self.assertEqual(expected_errors[1], w.field_name)
 
     def test_validate_about_resource_error_thrown_when_file_referenced_by_about_file_does_not_exist(self):
-        about_file = about.AboutFile('testdata/parser_tests/missing_about_ref.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/missing_about_ref.ABOUT'))
         expected_errors = [about.FILE, 'about_resource']
         self.assertTrue(len(about_file.errors) == 1, "This should throw 1 error")
         for w in about_file.errors:
             self.assertEqual(expected_errors[0], w.code)
             self.assertEqual(expected_errors[1], w.field_name)
 
     def test_validate_mand_fields_name_and_version_and_about_resource_present(self):
-        about_file = about.AboutFile('testdata/parser_tests/missing_mand.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/missing_mand.ABOUT'))
         expected_errors = [(about.VALUE, 'about_resource'),
                            (about.VALUE, 'name'),
                            (about.VALUE, 'version'), ]
@@ -286,7 +290,7 @@ def test_validate_mand_fields_name_and_version_and_about_resource_present(self):
             self.assertEqual(expected_errors[i][0], w.code)
             self.assertEqual(expected_errors[i][1], w.field_name)
 
-        about_file = about.AboutFile('testdata/parser_tests/missing_mand_values.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/missing_mand_values.ABOUT'))
         expected_errors = [(about.VALUE, 'name'),
                              (about.VALUE, 'version'),
                              (about.VALUE, 'about_resource')]
@@ -296,7 +300,7 @@ def test_validate_mand_fields_name_and_version_and_about_resource_present(self):
             self.assertEqual(expected_errors[i][1], w.field_name)
 
     def test_validate_optional_file_field_value(self):
-        about_file = about.AboutFile('testdata/parser_tests/about_file_ref.c.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_file_ref.c.ABOUT'))
         expected_warnings = [about.VALUE, 'notice_file']
         self.assertTrue(len(about_file.warnings) == 1, "This should throw one warning")
         for w in about_file.warnings:
@@ -376,27 +380,27 @@ def test_validate_is_ascii_key(self):
         self.assertFalse(about_file.check_is_ascii(u'測試'))
 
     def test_validate_is_ascii_value(self):
-        about_file = about.AboutFile('testdata/filesfields/non_ascii_field.about')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'filesfields/non_ascii_field.about'))
         expected_errors = [about.ASCII]
         self.assertTrue(len(about_file.errors) == 1, "This should throw 1 error")
         self.assertEqual(about_file.errors[0].code, expected_errors[0])
 
     def test_validate_spdx_licenses(self):
-        about_file = about.AboutFile('testdata/spdx_licenses/incorrect_spdx.about')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'spdx_licenses/incorrect_spdx.about'))
         expected_errors = [about.SPDX]
         self.assertTrue(len(about_file.errors) == 1, "This should throw 1 error")
         for w in about_file.errors:
             self.assertEqual(expected_errors[0], w.code)
 
     def test_validate_spdx_licenses1(self):
-        about_file = about.AboutFile('testdata/spdx_licenses/invalid_multi_format_spdx.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'spdx_licenses/invalid_multi_format_spdx.ABOUT'))
         expected_errors = [about.SPDX]
         self.assertTrue(len(about_file.errors) == 1, "This should throw 1 error")
         for w in about_file.errors:
             self.assertEqual(expected_errors[0], w.code)
 
     def test_validate_spdx_licenses2(self):
-        about_file = about.AboutFile('testdata/spdx_licenses/invalid_multi_name.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'spdx_licenses/invalid_multi_name.ABOUT'))
         expected_errors = [about.SPDX]
         # The test case is: license_spdx: Something and SomeOtherThings
         # Thus, it should throw 2 errors: 'Something', 'SomeOtherThings'
@@ -405,21 +409,21 @@ def test_validate_spdx_licenses2(self):
             self.assertEqual(expected_errors[0], w.code)
 
     def test_validate_spdx_licenses3(self):
-        about_file = about.AboutFile('testdata/spdx_licenses/lower_case_spdx.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'spdx_licenses/lower_case_spdx.ABOUT'))
         expected_warnings = [about.SPDX]
         self.assertTrue(len(about_file.warnings) == 1, "This should throw one warning")
         for w in about_file.warnings:
             self.assertEqual(expected_warnings[0], w.code)
 
     def test_validate_not_supported_date_format(self):
-        about_file = about.AboutFile('testdata/DateTest/non-supported_date_format.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'DateTest/non-supported_date_format.ABOUT'))
         expected_warnings = [about.DATE]
         self.assertTrue(len(about_file.warnings) == 1, "This should throw one warning")
         for w in about_file.warnings:
             self.assertEqual(expected_warnings[0], w.code)
 
     def test_validate_supported_date_format(self):
-        about_file = about.AboutFile('testdata/DateTest/supported_date_format.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'DateTest/supported_date_format.ABOUT'))
         self.assertTrue(len(about_file.warnings) == 0, "This should not throw warning.")
 
     def test_remove_blank_lines_and_field_spaces(self):
@@ -468,8 +472,8 @@ def test_remove_blank_lines_and_no_colon_fields(self):
 
     def test_generate_attribution(self):
         expected = u'version:2.4.3about_resource:httpd-2.4.3.tar.gzname:Apache HTTP Server'
-        about_collector = about.AboutCollector('testdata/attrib/attrib.ABOUT', None, 0)
-        result = about_collector.generate_attribution('testdata/attrib/test.template')
+        about_collector = about.AboutCollector(join(TESTDATA_PATH, 'attrib/attrib.ABOUT'), None, 0)
+        result = about_collector.generate_attribution(join(TESTDATA_PATH, 'attrib/test.template'))
         self.assertEqual(result, expected)
 
     def test_license_text_extracted_from_license_text_file(self):
@@ -478,39 +482,36 @@ def test_license_text_extracted_from_license_text_file(self):
 
 * Email Test@tester.com for any questions'''
 
-        about_file = about.AboutFile('testdata/attrib/license_text.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/license_text.ABOUT'))
         license_text = about_file.license_text()
         self.assertEqual(license_text, expected)
 
     def test_notice_text_extacted_from_notice_text_file(self):
         expected ='''Test component is released to Public Domain.'''
-        about_file = about.AboutFile('testdata/attrib/license_text.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/license_text.ABOUT'))
         notice_text = about_file.notice_text()
         self.assertEqual(notice_text, expected)
 
     def test_license_text_returns_empty_string_when_no_field_present(self):
         expected = ''
-        about_file = about.AboutFile('testdata/attrib/no_text_file_field.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/no_text_file_field.ABOUT'))
         license_text = about_file.license_text()
         self.assertEqual(license_text, expected)
 
     def test_notice_text_returns_empty_string_when_no_field_present(self):
         expected = ''
-        about_file = about.AboutFile('testdata/attrib/no_text_file_field.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/no_text_file_field.ABOUT'))
         notice_text = about_file.notice_text()
         self.assertEqual(notice_text, expected)
 
     def test_license_text_returns_empty_string_when_ref_file_doesnt_exist(self):
         expected = ''
-        about_file = about.AboutFile('testdata/attrib/missing_notice_license_files.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/missing_notice_license_files.ABOUT'))
         license_text = about_file.license_text()
         self.assertEqual(license_text, expected)
 
     def test_notice_text_returns_empty_string_when_ref_file_doesnt_exist(self):
         expected = ''
-        about_file = about.AboutFile('testdata/attrib/missing_notice_license_files.ABOUT')
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/missing_notice_license_files.ABOUT'))
         notice_text = about_file.notice_text()
         self.assertEqual(notice_text, expected)
-
-if __name__ == "__main__":
-    unittest.main()
diff --git a/about_code_tool/tests/test_genabout.py b/about_code_tool/tests/test_genabout.py
