Add samba.tests.source, which checks Python files for copyright lines, license headers and invalid characters (dos newlines, tabs).

2 files changed, 169 insertions, 0 deletions

diff --git a/source4/scripting/python/samba/tests/source.py b/source4/scripting/python/samba/tests/source.py
new file mode 100644
index 00000000000..c67634912de
--- /dev/null
+++ b/source4/scripting/python/samba/tests/source.py
@@ -0,0 +1,168 @@
+#!/usr/bin/env python
+
+# Unix SMB/CIFS implementation.
+# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2011
+#
+# Loosely based on bzrlib's test_source.py
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+"""Source level Python tests."""
+
+import errno
+import os
+import re
+import warnings
+
+from samba.tests import (
+    TestCase,
+    )
+
+
+def get_python_source_files():
+    """Iterate over all Python source files."""
+    library_dir = os.path.join(os.path.dirname(__file__), "..", "..", "samba")
+
+    for root, dirs, files in os.walk(library_dir):
+        for f in files:
+            if f.endswith(".py"):
+                yield os.path.abspath(os.path.join(root, f))
+
+    bindir = os.path.join(os.path.dirname(__file__), "..", "..", "..", "..", "bin")
+    for f in os.listdir(bindir):
+        p = os.path.abspath(os.path.join(bindir, f))
+        if not os.path.islink(p):
+            continue
+        target = os.readlink(p)
+        if os.path.dirname(target).endswith("scripting/bin"):
+            yield p
+
+
+def get_source_file_contents():
+    """Iterate over the contents of all python files."""
+    for fname in get_python_source_files():
+        try:
+            f = open(fname, 'rb')
+        except IOError, e:
+            if e.errno == errno.ENOENT:
+                warnings.warn("source file %s broken link?" % fname)
+                continue
+            else:
+                raise
+        try:
+            text = f.read()
+        finally:
+            f.close()
+        yield fname, text
+
+
+class TestSource(TestCase):
+
+    def test_copyright(self):
+        """Test that all Python files have a valid copyright statement."""
+        incorrect = []
+
+        copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
+
+        for fname, text in get_source_file_contents():
+            if fname.endswith("ms_schema.py"):
+                # FIXME: Not sure who holds copyright on ms_schema.py
+                continue
+            match = copyright_re.search(text)
+            if not match:
+                incorrect.append((fname, 'no copyright line found\n'))
+
+        if incorrect:
+            help_text = ["Some files have missing or incorrect copyright"
+                         " statements.",
+                         "",
+                        ]
+            for fname, comment in incorrect:
+                help_text.append(fname)
+                help_text.append((' ' * 4) + comment)
+
+            self.fail('\n'.join(help_text))
+
+    def test_gpl(self):
+        """Test that all .py files have a GPL disclaimer."""
+        incorrect = []
+
+        gpl_txt = """
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+        gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
+
+        for fname, text in get_source_file_contents():
+            if not gpl_re.search(text):
+                incorrect.append(fname)
+
+        if incorrect:
+            help_text = ['Some files have missing or incomplete GPL statement',
+                         gpl_txt]
+            for fname in incorrect:
+                help_text.append((' ' * 4) + fname)
+
+            self.fail('\n'.join(help_text))
+
+    def _push_file(self, dict_, fname, line_no):
+        if fname not in dict_:
+            dict_[fname] = [line_no]
+        else:
+            dict_[fname].append(line_no)
+
+    def _format_message(self, dict_, message):
+        files = ["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
+                for f, lines in dict_.items()]
+        files.sort()
+        return message + '\n\n    %s' % ('\n    '.join(files))
+
+    def _iter_source_files_lines(self):
+        for fname, text in get_source_file_contents():
+            lines = text.splitlines(True)
+            last_line_no = len(lines) - 1
+            for line_no, line in enumerate(lines):
+                yield fname, line_no, line
+
+    def test_no_tabs(self):
+        """Check that there are no tabs in Python files."""
+        tabs = {}
+        for fname, line_no, line in self._iter_source_files_lines():
+            if '\t' in line:
+                self._push_file(tabs, fname, line_no)
+        if tabs:
+            self.fail(self._format_message(tabs,
+                'Tab characters were found in the following source files.'
+                '\nThey should either be replaced by "\\t" or by spaces:'))
+
+    def test_unix_newlines(self):
+        """Check for unix new lines."""
+        illegal_newlines = {}
+        for fname, line_no, line in self._iter_source_files_lines():
+            if not line.endswith('\n') or line.endswith('\r\n'):
+                self._push_file(illegal_newlines, fname, line_no)
+        if illegal_newlines:
+            self.fail(self._format_message(illegal_newlines,
+                'Non-unix newlines were found in the following source files:'))
diff --git a/source4/selftest/tests.py b/source4/selftest/tests.py
index f64a803a785..1e78374d494 100755
--- a/source4/selftest/tests.py
+++ b/source4/selftest/tests.py
@@ -292,6 +292,7 @@ for f in sorted(os.listdir(os.path.join(samba4srcdir, "../pidl/tests"))):
 # work correctly.
 
 planpythontestsuite("none", "samba.tests.blackbox.ndrdump")
+planpythontestsuite("none", "samba.tests.source")
 plantestsuite("samba4.blackbox.samba_tool(dc:local)", "dc:local", [os.path.join(samba4srcdir, "utils/tests/test_samba_tool.sh"),  '$SERVER', "$USERNAME", "$PASSWORD", "$DOMAIN"])
 plantestsuite("samba4.blackbox.pkinit(dc:local)", "dc:local", [os.path.join(bbdir, "test_pkinit.sh"), '$SERVER', '$USERNAME', '$PASSWORD', '$REALM', '$DOMAIN', '$PREFIX', "aes256-cts-hmac-sha1-96", configuration])
 plantestsuite("samba4.blackbox.kinit(dc:local)", "dc:local", [os.path.join(bbdir, "test_kinit.sh"), '$SERVER', '$USERNAME', '$PASSWORD', '$REALM', '$DOMAIN', '$PREFIX', "aes256-cts-hmac-sha1-96", configuration])