Refactoring license check a bit and moved to unit test suite

Author: kraigher

acceptance_test/test_license.py

@@ -0,0 +1,66 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (c) 2015, Lars Asplund lars.anders.asplund@gmail.com
+
+import unittest
+from os.path import join, dirname, splitext, abspath, commonprefix
+from os import walk
+from re import compile
+from datetime import datetime
+from subprocess import Popen, PIPE, STDOUT
+
+class TestLicense(unittest.TestCase):
+    _re_license_notice = compile(r"""(?P<comment_start>#|--|//) This Source Code Form is subject to the terms of the Mozilla Public
+(?P=comment_start) License, v\. 2\.0\. If a copy of the MPL was not distributed with this file,
+(?P=comment_start) You can obtain one at http://mozilla\.org/MPL/2\.0/\.
+(?P=comment_start)
+(?P=comment_start) Copyright \(c\) (?P<first_year>20\d\d)(-(?P<last_year>20\d\d))?, Lars Asplund lars\.anders\.asplund@gmail\.com""")
+    _re_log_date = compile(r'Date:\s*(?P<year>20\d\d)-\d\d-\d\d')
+
+    def test_that_a_valid_license_notice_exists_in_every_source_file_and_that_global_licensing_information_is_correct(self):
+        licensed_files = []
+        repo_root = abspath(join(dirname(__file__), '..', '..'))
+        for root, dirs, files in walk(repo_root):
+            for file_name in files:
+                if 'preprocessed' in root:
+                    continue
+                osvvm_directory = abspath(join(repo_root, 'vhdl', 'osvvm'))
+                if commonprefix([osvvm_directory, abspath(join(root, file_name))]) == osvvm_directory:
+                    continue
+                osvvm_integration_example_directory = abspath(join(repo_root, 'examples', 'osvvm_integration', 'src'))
+                if commonprefix([osvvm_integration_example_directory, abspath(join(root, file_name))]) == osvvm_integration_example_directory:
+                    continue
+                if splitext(file_name)[1] in ['.vhd', '.vhdl', '.py', '.v', '.sv']:
+                    licensed_files.append(join(root, file_name))
+
+        for file_name in licensed_files:
+            self._check_license(file_name)
+
+    def _check_license(self, file_name):
+        proc = Popen(['git', 'log',  '--follow', '--date=short', file_name], \
+              bufsize=0, stdout=PIPE, stdin=PIPE, stderr=STDOUT, universal_newlines=True)
+        out, _ = proc.communicate()
+        first_year = None
+        last_year = None
+        for date in self._re_log_date.finditer(out):
+            first_year = int(date.group('year')) if first_year is None else min(int(date.group('year')), first_year)
+            last_year = int(date.group('year')) if last_year is None else max(int(date.group('year')), last_year)
+
+        if first_year is None and last_year is None:
+            # File not in log yet, set to current year
+            first_year = datetime.now().year
+            last_year = first_year
+
+        with open(file_name) as fp:
+            code = fp.read()
+            match = self._re_license_notice.search(code)
+            self.assertIsNotNone(match, "Failed to find license notice in %s" % file_name)
+            if first_year == last_year:
+                self.assertEqual(int(match.group('first_year')), first_year, 'Expected copyright year to be %d in %s' % (first_year, file_name))
+                self.assertIsNone(match.group('last_year'), 'Expected no copyright years range in %s' % file_name)
+            else:
+                self.assertIsNotNone(match.group('last_year'), 'Expected copyright year range %d-%d in %s' % (first_year, last_year, file_name))
+                self.assertEqual(int(match.group('first_year')), first_year, 'Expected copyright year range to start with %d in %s' % (first_year, file_name))
+                self.assertEqual(int(match.group('last_year')), last_year, 'Expected copyright year range to end with %d in %s' % (last_year, file_name))