Fixed #74

It's now using file logger to log the errors.
In addition, it has its own function, get_genattrib_errors, to get the error from the attribtution generation instead of getting ALL the errors/warnings that are not relevant for the attribution generation.
Improved some test cases.

Author: chinyeungli

about_code_tool/about.py

@@ -84,6 +84,7 @@ def repr_problem(obj):
 ASCII = 'ASCII problem'
 SPDX = 'SPDX license problem'
 UNKNOWN = 'Unknown problem'
+GENATTRIB = 'Attribution generation problem'
 
 MANDATORY_FIELDS = (
     'about_resource',
@@ -929,7 +930,7 @@ def notice_text(self):
 
         return ""  # Returns empty string if the notice file does not exist
 
-    def dje_license(self):
+    def get_dje_license_name(self):
         """
         Return the dje_license value if the dje_license field exists
         """
@@ -938,7 +939,7 @@ def dje_license(self):
         except Exception as e:
             pass
 
-        return ""  # Returns empty string if the dje_license key does not exist
+        return ""
 
     def get_license_text_file_name(self):
         """
@@ -949,7 +950,7 @@ def get_license_text_file_name(self):
         except Exception as e:
             pass
 
-        return ""  # Returns empty string if the license_text_file key does not exist
+        return ""
 
 class AboutCollector(object):
     """
@@ -967,6 +968,8 @@ def __init__(self, input_path):
         self._errors = []
         self._warnings = []
 
+        self.genattrib_errors = []
+
         self.abouts = [AboutFile(f)
                        for f in self._collect_about_files(self.absolute_path)]
 
@@ -1097,22 +1100,45 @@ def generate_attribution(self, template_path='templates/default.html',
             if not limit_to or about_object.about_resource_path in limit_to:
                 validated_fields.append(about_object.validated_fields)
                 notice_text.append(about_object.notice_text())
-                if about_object.dje_license():
-                    if not about_object.dje_license() in unique_license \
-                        and not about_object.dje_license() == None:
-                        unique_license.append(about_object.dje_license())
-                        license_text.append(about_object.license_text())
+                dje_license_name = about_object.get_dje_license_name()
+                if dje_license_name:
+                    if not dje_license_name in unique_license \
+                        and not dje_license_name == None:
+                        if about_object.license_text():
+                            unique_license.append(about_object.get_dje_license_name())
+                            license_text.append(about_object.license_text())
+                        else:
+                            msg = 'About resource: %s - license_text does not exist.'\
+                                ' Attribution generation is skipped.'\
+                                % about_object.about_resource_path
+                            self.genattrib_errors.append(Error(GENATTRIB,\
+                                                               'dje_license',\
+                                                               dje_license_name, msg))
                 elif about_object.get_license_text_file_name():
-                    if not about_object.get_license_text_file_name() in unique_license \
-                        and about_object.license_text():
-                        unique_license.append(about_object.get_license_text_file_name())
-                        license_text.append(about_object.license_text())
+                    if not about_object.get_license_text_file_name() in unique_license:
+                        if about_object.license_text():
+                            unique_license.append(about_object.get_license_text_file_name())
+                            license_text.append(about_object.license_text())
+                        else:
+                            msg = 'About resource: %s - license_text does not exist.'\
+                                ' Attribution generation is skipped.'\
+                                % about_object.about_resource_path
+                            self.genattrib_errors.append(Error(GENATTRIB,\
+                                                               'license_text',\
+                                                               about_object.get_license_text_file_name(), msg))
+                else:
+                    msg = 'No dje_license or license_text is found. Attribution generation is skipped.'
+                    self.genattrib_errors.append(Error(GENATTRIB, 'about_resource',\
+                                                        about_object.about_resource_path,\
+                                                        msg))
 
         return template.render(about_objects=validated_fields,
                                license_texts=license_text,
                                notice_texts=notice_text,
                                unique_licenses=unique_license)
 
+    def get_genattrib_errors(self):
+        return self.genattrib_errors
 
 USAGE_SYNTAX = """\
     Input can be a file or directory.

about_code_tool/genattrib.py

@@ -1,19 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf8 -*-
 
-# =============================================================================
-#  Copyright (c) 2013 by nexB, Inc. http://www.nexb.com/ - All rights reserved.
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#      http://www.apache.org/licenses/LICENSE-2.0
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-# =============================================================================
-
 """
 This is a tool to generate component attribution based on a set of .ABOUT files.
 Optionally, one could pass a subset list of specific components for set of
@@ -45,13 +32,14 @@
 from os.path import exists, dirname, join, abspath, isdir, basename, normpath
 from StringIO import StringIO
 
+LOG_FILENAME = 'error.log'
 
 logger = logging.getLogger(__name__)
 handler = logging.StreamHandler()
 handler.setLevel(logging.CRITICAL)
 handler.setFormatter(logging.Formatter('%(levelname)s: %(message)s'))
 logger.addHandler(handler)
-
+file_logger = logging.getLogger(__name__+'_file')
 
 __version__ = '0.9.0'
 
@@ -125,6 +113,13 @@ def main(parser, options, args):
     reload(sys)
     sys.setdefaultencoding('utf-8')
 
+    # Clear the log file
+    with open(join(dirname(output_path), LOG_FILENAME), 'w'):
+        pass
+
+    file_handler = logging.FileHandler(join(dirname(output_path), LOG_FILENAME))
+    file_logger.addHandler(file_handler)
+
     if not exists(input_path):
         print('Input path does not exist.')
         parser.print_help()
@@ -152,12 +147,14 @@ def main(parser, options, args):
         attrib_str = collector.generate_attribution( limit_to = sublist )
         with open(output_path, "w") as f:
             f.write(attrib_str)
-
+        errors = collector.get_genattrib_errors()
+        for error_msg in errors:
+                logger.error(error_msg)
+                file_logger.error(error_msg)
     else:
         # we should never reach this
         assert False, "Unsupported option(s)."
 
-
 def get_parser():
     class MyFormatter(optparse.IndentedHelpFormatter):
         def _format_text(self, text):

about_code_tool/tests/test_about.py

@@ -578,3 +578,39 @@ def test_notice_text_returns_empty_string_when_ref_file_doesnt_exist(self):
         about_file = about.AboutFile(join(TESTDATA_PATH, 'attrib/missing_notice_license_files.ABOUT'))
         notice_text = about_file.notice_text()
         self.assertEqual(notice_text, expected)
+
+    def test_get_dje_license_name(self):
+        expected = 'apache-2.0'
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_resource_field_present.ABOUT'))
+        output = about_file.get_dje_license_name()
+        self.assertTrue(output == expected)
+
+    def test_get_license_text_file_name(self):
+        expected = 'httpd.LICENSE'
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_resource_field_present.ABOUT'))
+        output = about_file.get_license_text_file_name()
+        self.assertTrue(output == expected)
+
+    def test_get_dje_license_name_no_value(self):
+        expected = ''
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_file_empty_value_for_dje_license_license_text_file.ABOUT'))
+        output = about_file.get_dje_license_name()
+        self.assertTrue(output == expected)
+
+    def test_get_license_text_file_name_no_value(self):
+        expected = ''
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_file_empty_value_for_dje_license_license_text_file.ABOUT'))
+        output = about_file.get_license_text_file_name()
+        self.assertTrue(output == expected)
+
+    def test_get_dje_license_name_no_key(self):
+        expected = None
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_file_no_dje_license_no_license_text_file_keys.ABOUT'))
+        output = about_file.get_dje_license_name()
+        self.assertTrue(output == expected)
+
+    def test_get_license_text_file_name_no_key(self):
+        expected = None
+        about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_file_no_dje_license_no_license_text_file_keys.ABOUT'))
+        output = about_file.get_license_text_file_name()
+        self.assertTrue(output == expected)

about_code_tool/tests/testdata/parser_tests/about_file_empty_value_for_dje_license_license_text_file.ABOUT

@@ -0,0 +1,5 @@
+name: Apache HTTP Server
+version: 2.4.3
+
+dje_license:
+license_text_file:

about_code_tool/tests/testdata/parser_tests/about_file_no_dje_license_no_license_text_file_keys.ABOUT

@@ -0,0 +1,2 @@
+name: Apache HTTP Server
+version: 2.4.3

about_code_tool/tests/testdata/parser_tests/about_resource_field_present.ABOUT

@@ -5,4 +5,5 @@ license_spdx: Apache-2.0
 license_text_file: httpd.LICENSE
 copyright: Copyright 2012 The Apache Software Foundation.
 notice_file: httpd.NOTICE
-about_resource: about_resource.c
+about_resource: about_resource.c
+dje_license: apache-2.0