Update version to 2.0.2

Add try/catch to handle when ABOUT files don't have dje_license_name.

Add code to handle long path specifically in windows (read and write)
See See https://msdn.microsoft.com/en-us/library/aa365247.aspx

Add code to strip the UNC_Prefix for path location the in the error log.

Create test for long path handling.

Add code to strip the quote from the api input.

Author: chinyeungli

about_code_tool/about.py

@@ -32,21 +32,24 @@
 import csv
 from datetime import datetime
 from email.parser import HeaderParser
-from os.path import basename, dirname, join, normpath, realpath
 import errno
 import httplib
 import logging
+import ntpath
 import optparse
 import os
+from os.path import basename, dirname, join, normpath, realpath
 import posixpath
 import socket
 import string
 import sys
 import urlparse
-import ntpath
 
 
-__version__ = '2.0.1'
+on_windows = 'win32' in sys.platform
+UNC_PREFIX = u'\\\\?\\'
+
+__version__ = '2.0.2'
 
 # See http://dejacode.org
 __about_spec_version__ = '1.0'
@@ -1082,7 +1085,10 @@ def get_dje_license_name(self):
         """
         Return the about object's dje_license_name.
         """
-        return self.parsed.get('dje_license_name', '')
+        try:
+            return self.parsed.get('dje_license_name', '')
+        except:
+            return ''
 
 def check_invalid_chars(field_name, line):
     """
@@ -1104,6 +1110,8 @@ def check_invalid_chars(field_name, line):
         warnings = Warn(IGNORED, field_name, line, msg)
     return invalid_chars, warnings
 
+def posix_unc_prefix():
+    return posix_path(u'\\\\?\\')
 
 class Collector(object):
     """
@@ -1144,6 +1152,23 @@ def collect(location):
         """
         # FIXME: we should not accept both a file and dir location as input
         paths = []
+
+        if on_windows:
+            location = unicode(location)
+        """
+        Convert a location to an absolute Window UNC path to support long paths
+        on Windows. Return the location unchanged if not on Windows.
+        See https://msdn.microsoft.com/en-us/library/aa365247.aspx
+        """
+        if on_windows and not location.startswith(UNC_PREFIX):
+            location = UNC_PREFIX + os.path.abspath(location)
+        location = os.path.expanduser(location)
+        location = os.path.expandvars(location)
+        location = os.path.normpath(location)
+        location = os.path.abspath(location)
+
+        assert os.path.exists(location)
+
         if location:
             if os.path.isfile(location) and is_about_file(location):
                 paths.append(location)
@@ -1241,6 +1266,9 @@ def get_about_context(self, about_object):
         if '\n' in about_object.get_dje_license_name():
             msg = ('Multiple licenses is not supported. '
                    'Skipping License generation.')
+            if on_windows:
+                if about_object.location.startswith(posix_unc_prefix()):
+                    about_object.location = about_object.location.strip(posix_unc_prefix())
             err = Error(GENATTRIB, 'dje_license',
                         about_object.location, msg)
             self.genattrib_errors.append(err)
@@ -1258,6 +1286,9 @@ def get_about_context(self, about_object):
             and not '\n' in about_object.get_dje_license_name():
             msg = ('No license_text found. '
                    'Skipping License generation.')
+            if on_windows:
+                if about_object.location.startswith(posix_unc_prefix()):
+                    about_object.location = about_object.location.strip(posix_unc_prefix())
             err = Error(GENATTRIB, 'license_text_file',
                         about_object.location, msg)
             self.genattrib_errors.append(err)
@@ -1314,6 +1345,9 @@ def generate_attribution(self, template_path=None, limit_to=None, verification=N
                         break
 
                 if not component_exist:
+                    if on_windows:
+                        if self.location.startswith(posix_unc_prefix()):
+                            self.location = self.location.strip(posix_unc_prefix())
                     loc = self.location + component
                     msg = ('The requested ABOUT file: %r does not exist. '
                            'No attribution generated for this file.' % loc)
@@ -1364,6 +1398,9 @@ def check_paths(self, paths):
         for path in paths:
             path = posix_path(path)
             afp = join(self.location, path)
+            if on_windows:
+                if afp.startswith(posix_unc_prefix()):
+                    afp = afp.strip(posix_unc_prefix())
             msg = ('The requested ABOUT file: %(afp)r does not exist. '
                    'No attribution generated for this file.' % locals())
             err = Error(GENATTRIB, 'about_file', path, msg)

about_code_tool/genabout.py

@@ -41,7 +41,7 @@
 
 import about
 
-__version__ = '2.0.0'
+__version__ = '2.0.2'
 
 __copyright__ = """
 Copyright (c) 2013-2014 nexB Inc. All rights reserved.
@@ -614,6 +614,8 @@ def format_output(input_list):
     @staticmethod
     def write_output(output):
         for about_file_location, context in output:
+            if about.on_windows:
+                about_file_location = about.UNC_PREFIX + os.path.abspath(about_file_location)
             if _exists(about_file_location):
                 os.remove(about_file_location)
             with open(about_file_location, 'wb') as output_file:
@@ -855,6 +857,10 @@ def main(parser, options, args):
                 sys.exit(errno.EINVAL)
 
     if gen_license:
+        # Strip the ' and " for api_url, api_username and api_key from input
+        api_url = api_url.strip("'").strip("\"")
+        api_username = api_username.strip("'").strip("\"")
+        api_key = api_key.strip("'").strip("\"")
         dje_license_dict = gen.pre_process_and_dje_license_dict(input_list,
                                                                 api_url,
                                                                 api_username,

about_code_tool/genattrib.py

@@ -43,7 +43,7 @@
 logger.addHandler(handler)
 file_logger = logging.getLogger(__name__ + '_file')
 
-__version__ = '2.0.0'
+__version__ = '2.0.2'
 
 __about_spec_version__ = '1.0.0'  # See http://dejacode.org
 

about_code_tool/tests/test_about.py

@@ -27,9 +27,12 @@
 from os.path import abspath, dirname, join, split
 
 from about_code_tool import about
+from pip._vendor.distlib.wheel import to_posix
+from about_code_tool.about import on_windows
 
 
 TESTDATA_DIR = join(abspath(dirname(__file__)), 'testdata')
+UNC_PREFIX = u'\\\\?\\'
 
 
 def create_dir(location):
@@ -134,11 +137,16 @@ def test_header_row_in_csv_output(self):
 
     def test_collect_can_collect_a_directory_tree(self):
         test_dir = 'about_code_tool/tests/testdata/DateTest'
-        expected = [('about_code_tool/tests/testdata/DateTest'
-                     '/non-supported_date_format.ABOUT'),
-                    ('about_code_tool/tests/testdata/DateTest'
-                     '/supported_date_format.ABOUT')]
+        expected = [(os.path.abspath('about_code_tool/tests/testdata/DateTest'
+                     '/non-supported_date_format.ABOUT')),
+                    (os.path.abspath('about_code_tool/tests/testdata/DateTest'
+                     '/supported_date_format.ABOUT'))]
         result = about.Collector.collect(test_dir)
+        if on_windows:
+            expected = [(to_posix(UNC_PREFIX + os.path.abspath('about_code_tool/tests/testdata/DateTest'
+             '/non-supported_date_format.ABOUT'))),
+            (to_posix(UNC_PREFIX + os.path.abspath('about_code_tool/tests/testdata/DateTest'
+             '/supported_date_format.ABOUT')))]
         self.assertEqual(sorted(expected), sorted(result))
 
     def test_collect_can_collect_a_single_file(self):
@@ -147,8 +155,24 @@ def test_collect_can_collect_a_single_file(self):
         expected = ['about_code_tool/tests/testdata/thirdparty'
                     '/django_snippets_2413.ABOUT']
         result = about.Collector.collect(test_file)
+        if on_windows:
+            expected = [to_posix(UNC_PREFIX + os.path.abspath('about_code_tool/tests/testdata/thirdparty'
+                    '/django_snippets_2413.ABOUT'))]
         self.assertEqual(expected, result)
 
+    def test_collect_can_collect_a_long_directory_tree(self):
+        test_dir = 'about_code_tool/tests/testdata/longpath/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/'
+        expected = [('about_code_tool/tests/testdata/longpath/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1'
+                     '/non-supported_date_format.ABOUT')]
+        result = about.Collector.collect(test_dir)
+        if on_windows:
+            # For some reasons, the os.path.abspath doesn't work if I have long
+            # path in the parameter. Therefore, I just append to long path
+            # after the os.path.abspath()
+            expected = [to_posix(UNC_PREFIX + os.path.abspath('about_code_tool') + '/tests/testdata/longpath/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1/longpath1'
+                     '/non-supported_date_format.ABOUT')]
+        self.assertEqual(sorted(expected), sorted(result))
+
     def test_collector_errors_encapsulation(self):
         test_file = 'about_code_tool/tests/testdata/DateTest'
         collector = about.Collector(test_file)