Create test code for supporting 'about_resource_path' #287

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

Author: chinyeungli

tests/test_model.py

@@ -826,10 +826,6 @@ def test_About_as_dict_contains_special_paths(self):
         result = as_dict[model.About.about_file_path_attr]
         assert expected == result
 
-        expected = 'complete'
-        result = as_dict[model.About.about_resource_path_attr]
-        assert expected == result
-
     def test_About_as_dict_with_empty(self):
         test_file = get_test_loc('as_dict/about.ABOUT')
         a = model.About(test_file, about_file_path='complete/about.ABOUT')
@@ -1211,9 +1207,35 @@ def test_collect_inventory_basic_from_directory(self):
         expected = get_test_loc('inventory/basic/expected.csv')
         self.check_csv(expected, result)
 
-    # FIXME: The self.chec_csv is failing because there are many keys in the ABOUT files that are
+    def test_collect_inventory_with_about_resource_path_from_directory(self):
+        location = get_test_loc('inventory/basic_with_about_resource_path')
+        result = get_temp_file()
+        errors, abouts = model.collect_inventory(location)
+
+        model.write_output(abouts, result, format = 'csv')
+
+        expected_errors = []
+        assert expected_errors == errors
+
+        expected = get_test_loc('inventory/basic_with_about_resource_path/expected.csv')
+        self.check_csv(expected, result)
+
+    def test_collect_inventory_with_no_about_resource_from_directory(self):
+        location = get_test_loc('inventory/no_about_resource_key')
+        result = get_temp_file()
+        errors, abouts = model.collect_inventory(location)
+
+        model.write_output(abouts, result, format = 'csv')
+
+        expected_errors = [Error(CRITICAL, u'about/about.ABOUT: Field about_resource is required')]
+        assert expected_errors == errors
+
+        expected = get_test_loc('inventory/no_about_resource_key/expected.csv')
+        self.check_csv(expected, result)
+
+    # FIXME: The self.check_csv is failing because there are many keys in the ABOUT files that are
     # not supported. Instead of removing all the non-supported keys in the output
-    # and do the comparson, it may be best to apply the mapping to include theses keys
+    # and do the comparison, it may be best to apply the mapping to include theses keys
     @expectedFailure
     def test_collect_inventory_complex_from_directory(self):
         location = get_test_loc('inventory/complex')

tests/test_util.py

@@ -275,8 +275,8 @@ def test_load_json(self):
         test_file = get_test_loc('load/expected.json')
         expected = [OrderedDict(
                     [('about_file_path', '/load/this.ABOUT'),
+                     ('about_resource_path', '.'),
                      ('about_resource', '.'),
-                     ('about_resource_path', '/load/'),
                      ('name', 'AboutCode'),
                      ('version', '0.11.0')])
                     ]

tests/testdata/inventory/basic/expected.csv

@@ -1,2 +1,2 @@
 about_file_path,about_resource_path,about_resource,name,version,download_url,description,home_url,notes,license,license_expression,license_name,license_file,license_url,copyright,notice_file,notice_url,redistribute,attribute,track_change,modified,changelog_file,owner,owner_url,contact,author,vcs_tool,vcs_repository,vcs_path,vcs_tag,vcs_branch,vcs_revision,checksum,spec_version
-/about/about.ABOUT,/about/,.,AboutCode,0.11.0,,AboutCode is a tool to process ABOUT files. An ABOUT file is a file.,http://dejacode.org,,apache-2.0,,,apache-2.0.LICENSE,,Copyright (c) 2013-2014 nexB Inc.,NOTICE,,,,,,,nexB Inc.,,,"Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez",git,https://github.com/dejacode/about-code-tool.git,,,,,,
+/about/about.ABOUT,.,.,AboutCode,0.11.0,,AboutCode is a tool to process ABOUT files. An ABOUT file is a file.,http://dejacode.org,,apache-2.0,,,apache-2.0.LICENSE,,Copyright (c) 2013-2014 nexB Inc.,NOTICE,,,,,,,nexB Inc.,,,"Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez",git,https://github.com/dejacode/about-code-tool.git,,,,,,

tests/testdata/inventory/basic_with_about_resource_path/about/about_with_about_resource_path.ABOUT

@@ -0,0 +1,6 @@
+about_resource: apache-2.0.LICENSE
+name: Apache License 2.0
+
+about_resource_path: |
+    ./apache-2.0.LICENSE
+    ../../complex/about/apache-2.0.LICENSE

tests/testdata/inventory/basic_with_about_resource_path/about/apache-2.0.LICENSE

@@ -0,0 +1,3 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/

tests/testdata/inventory/basic_with_about_resource_path/expected.csv

@@ -0,0 +1,3 @@
+about_file_path,about_resource_path,about_resource,name,version,download_url,description,home_url,notes,license,license_expression,license_name,license_file,license_url,copyright,notice_file,notice_url,redistribute,attribute,track_change,modified,changelog_file,owner,owner_url,contact,author,vcs_tool,vcs_repository,vcs_path,vcs_tag,vcs_branch,vcs_revision,checksum,spec_version
+/about/about_with_about_resource_path.ABOUT,"./apache-2.0.LICENSE
+../../complex/about/apache-2.0.LICENSE",apache-2.0.LICENSE,Apache License 2.0,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,

tests/testdata/inventory/no_about_resource_key/about/about.ABOUT

@@ -0,0 +1 @@
+name: AboutCode

tests/testdata/inventory/no_about_resource_key/expected.csv

@@ -0,0 +1,2 @@
+about_file_path,about_resource_path,about_resource,name,version,download_url,description,home_url,notes,license,license_expression,license_name,license_file,license_url,copyright,notice_file,notice_url,redistribute,attribute,track_change,modified,changelog_file,owner,owner_url,contact,author,vcs_tool,vcs_repository,vcs_path,vcs_tag,vcs_branch,vcs_revision,checksum,spec_version
+/about/about.ABOUT,,,AboutCode,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,

tests/testdata/load/expected.csv

@@ -1,2 +1,2 @@
 about_file_path,about_resource_path,about_resource,name,version,download_url,description,home_url,notes,license,license_expression,license_name,license_file,license_url,copyright,notice_file,notice_url,redistribute,attribute,track_change,modified,changelog_file,owner,owner_url,contact,author,vcs_tool,vcs_repository,vcs_path,vcs_tag,vcs_branch,vcs_revision,checksum,spec_version
-/load/this.ABOUT,/load/,.,AboutCode,0.11.0,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+/load/this.ABOUT,.,.,AboutCode,0.11.0,,,,,,,,,,,,,,,,,,,,,,,,,,,,,

tests/testdata/load/expected.json

@@ -1,7 +1,7 @@
 [
   {
     "about_file_path": "/load/this.ABOUT", 
-    "about_resource_path": "/load/", 
+    "about_resource_path": ".", 
     "about_resource": ".", 
     "name": "AboutCode", 
     "version": "0.11.0"