Fixed #436

 * Fixed the copy file issue caused by multi-line in file fields

Author: chinyeungli

docs/CHANGELOG.rst

@@ -5,7 +5,8 @@
     * Update transform code (See #427 and #428)
     * Fixed #431 - Error handling for empty "_file" fields
     * Fixed #432 - Handled UTF-8 variant invented by Microsoft
-    * Fixed #433 - problem was caused by the different multi-lic file format  between json and CSV (CSV with '\n' line break)
+    * Fixed #433 - problem was caused by the different multi-lic file format between json and CSV (CSV with '\n' line break)
+    * Fixed #436 - issue about copy with the `--reference` option
 
 2020-05-05
     Release 4.0.2

src/attributecode/util.py

@@ -437,33 +437,55 @@ def copy_license_notice_files(fields, base_dir, reference_dir, afp):
     for key, value in fields:
         if key == 'license_file' or key == 'notice_file':
             if value:
-                copy_file_name = value
+                # This is to handle multiple license_file value in CSV format
+                # The following code will construct a list to contain the
+                # license file(s) that need to be copied. 
+                # Note that *ONLY* license_file field allows \n. Others file
+                # fields that have \n will prompts error at validation stage 
+                file_list = []
+                if '\n' in value:
+                    f_list = value.split('\n')
+                else:
+                    if not isinstance(value, list):
+                        f_list = [value]
+                    else:
+                        f_list = value
+                # The following code is to adopt the approach from #404
+                # to use comma for multiple files which refer the same license
+                for item in f_list:
+                    if ',' in item:
+                        item_list = item.split(',')
+                        for i in item_list:
+                            file_list.append(i.strip())
+                    else:
+                        file_list.append(item)
             else:
                 continue
 
-            from_lic_path = posixpath.join(to_posix(reference_dir), copy_file_name)
-            about_file_dir = os.path.dirname(to_posix(afp)).lstrip('/')
-            to_lic_path = posixpath.join(to_posix(base_dir), about_file_dir)
-
-            if on_windows:
-                from_lic_path = add_unc(from_lic_path)
-                to_lic_path = add_unc(to_lic_path)
-
-            # Strip the white spaces
-            from_lic_path = from_lic_path.strip()
-            to_lic_path = to_lic_path.strip()
-
-            # Errors will be captured when doing the validation
-            if not posixpath.exists(from_lic_path):
-                continue
-
-            if not posixpath.exists(to_lic_path):
-                os.makedirs(to_lic_path)
-            try:
-                shutil.copy2(from_lic_path, to_lic_path)
-            except Exception as e:
-                print(repr(e))
-                print('Cannot copy file at %(from_lic_path)r.' % locals())
+            for copy_file_name in file_list:
+                from_lic_path = posixpath.join(to_posix(reference_dir), copy_file_name)
+                about_file_dir = os.path.dirname(to_posix(afp)).lstrip('/')
+                to_lic_path = posixpath.join(to_posix(base_dir), about_file_dir)
+    
+                if on_windows:
+                    from_lic_path = add_unc(from_lic_path)
+                    to_lic_path = add_unc(to_lic_path)
+    
+                # Strip the white spaces
+                from_lic_path = from_lic_path.strip()
+                to_lic_path = to_lic_path.strip()
+    
+                # Errors will be captured when doing the validation
+                if not posixpath.exists(from_lic_path):
+                    continue
+    
+                if not posixpath.exists(to_lic_path):
+                    os.makedirs(to_lic_path)
+                try:
+                    shutil.copy2(from_lic_path, to_lic_path)
+                except Exception as e:
+                    print(repr(e))
+                    print('Cannot copy file at %(from_lic_path)r.' % locals())
 
 
 # FIXME: we should use a license object instead

tests/test_util.py

@@ -26,6 +26,7 @@
 
 from testing_utils import extract_test_loc
 from testing_utils import get_test_loc
+from testing_utils import get_temp_dir
 from testing_utils import on_posix
 from testing_utils import on_windows
 
@@ -611,3 +612,19 @@ def test_unique_can_handle_About_object(self):
         abouts = [a, b]
         results = util.unique(abouts)
         assert [a] == results
+
+    def test_copy_license_notice_files(self):
+        base_dir = get_temp_dir()
+        reference_dir = get_test_loc('test_util/licenses')
+        fields = [(u'license_expression', u'mit or public-domain'),
+                  (u'about_resource', u'.'),
+                  (u'name', u'test'),
+                  (u'license_key', [u'mit', u'public-domain']),
+                  (u'license_file', [u'mit.LICENSE, mit2.LICENSE', u'public-domain.LICENSE'])]
+        util.copy_license_notice_files(fields, base_dir, reference_dir, '')
+        licenses = ['mit.LICENSE', 'mit2.LICENSE', 'public-domain.LICENSE']
+        from os import listdir
+        copied_files = listdir(base_dir)
+        assert len(licenses) == len(copied_files)
+        for license in licenses:
+            assert license in copied_files

tests/testdata/test_util/licenses/mit.LICENSE

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.This component is released to the public domain by the author.

tests/testdata/test_util/licenses/mit2.LICENSE

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.This component is released to the public domain by the author.

tests/testdata/test_util/licenses/public-domain.LICENSE

@@ -0,0 +1 @@
+This component is released to the public domain by the author.