Fixed #397 - Log version used

 * Add which version of TK was used to generated ABOUT files and
attribution

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

Author: chinyeungli

src/attributecode/attrib.py

@@ -2,7 +2,7 @@
 # -*- coding: utf8 -*-
 
 # ============================================================================
-#  Copyright (c) 2013-2018 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2019 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
@@ -25,6 +25,7 @@
 
 import jinja2
 
+from attributecode import __version__
 from attributecode import CRITICAL
 from attributecode import ERROR
 from attributecode import Error
@@ -124,6 +125,7 @@ def generate(abouts, template=None, variables=None):
             license_key_to_license_name=license_key_to_license_name,
             license_name_to_license_key=license_name_to_license_key,
             utcnow=utcnow,
+            tkversion=__version__,
             variables=variables
         )
     except Exception as e:

src/attributecode/model.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf8 -*-
 # ============================================================================
-#  Copyright (c) 2013-2018 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2019 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
@@ -51,6 +51,7 @@
 
 from license_expression import Licensing
 
+from attributecode import __version__
 from attributecode import CRITICAL
 from attributecode import ERROR
 from attributecode import INFO
@@ -69,6 +70,7 @@
 from attributecode.util import ungroup_licenses
 from attributecode.util import unique
 
+genereated_tk_version = "# Generated with AboutCode Toolkit Version %s \n\n" % __version__
 
 class Field(object):
     """
@@ -1068,6 +1070,7 @@ def dump(self, location):
             about_file_path = add_unc(about_file_path)
 
         with io.open(about_file_path, mode='w', encoding='utf-8') as dumped:
+            dumped.write(genereated_tk_version)
             dumped.write(self.dumps())
 
     def dump_lic(self, location, license_dict):

src/attributecode/templates/default_html.template

@@ -81,7 +81,7 @@
     {% endfor %}
 
     <h3><a id="End">End</a></h3>
-    <i>This file was generated on: {{ utcnow }} (UTC)</i>
+    <i>This file was generated with AboutCode Toolkit version: {{ tkversion }} on: {{ utcnow }} (UTC)</i>
     </body>
 </html>
 

tests/test_model.py

@@ -752,7 +752,12 @@ def test_load_dump_is_idempotent(self):
 
         expected = get_unicode_content(test_file).splitlines()
         result = get_unicode_content(dumped_file).splitlines()
-        assert expected == result
+        # Ignore comment and empty line
+        filtered_result = []
+        for line in result:
+            if not line.startswith('#') and not line == '':
+                filtered_result.append(line)
+        assert expected == filtered_result
 
     def test_load_can_load_unicode(self):
         test_file = get_test_loc('test_model/unicode/nose-selecttests.ABOUT')