python/samba/tests/source.py

   1 # Unix SMB/CIFS implementation.
   2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2011
   3 #
   4 # Loosely based on bzrlib's test_source.py
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19
  20 """Source level Python tests."""
  21
  22 import io
  23 import errno
  24 import os
  25 import re
  26 import warnings
  27
  28 from samba.tests import (
  29     TestCase,
  30     )
  31
  32
  33 def get_python_source_files():
  34     """Iterate over all Python source files."""
  35     library_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "samba"))
  36     assert os.path.isdir(library_dir), library_dir
  37
  38     for root, dirs, files in os.walk(library_dir):
  39         for f in files:
  40             if f.endswith(".py"):
  41                 yield os.path.abspath(os.path.join(root, f))
  42
  43     bindir = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "..", "..", "bin"))
  44     assert os.path.isdir(bindir), bindir
  45     for f in os.listdir(bindir):
  46         p = os.path.abspath(os.path.join(bindir, f))
  47         if not os.path.islink(p):
  48             continue
  49         target = os.readlink(p)
  50         if os.path.dirname(target).endswith("scripting/bin"):
  51             yield p
  52     wafsambadir = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "..", "..", "buildtools", "wafsamba"))
  53     assert os.path.isdir(wafsambadir), wafsambadir
  54     for root, dirs, files in os.walk(wafsambadir):
  55         for f in files:
  56             if f.endswith(".py"):
  57                 yield os.path.abspath(os.path.join(root, f))
  58
  59
  60 def get_source_file_contents():
  61     """Iterate over the contents of all python files."""
  62     for fname in get_python_source_files():
  63         try:
  64             f = io.open(fname, mode='r', encoding='utf-8')
  65         except IOError as e:
  66             if e.errno == errno.ENOENT:
  67                 warnings.warn("source file %s broken link?" % fname)
  68                 continue
  69             else:
  70                 raise
  71         try:
  72             text = f.read()
  73         finally:
  74             f.close()
  75         yield fname, text
  76
  77
  78 class TestSource(TestCase):
  79
  80     def test_copyright(self):
  81         """Test that all Python files have a valid copyright statement."""
  82         incorrect = []
  83
  84         copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
  85
  86         for fname, text in get_source_file_contents():
  87             if fname.endswith("ms_schema.py"):
  88                 # FIXME: Not sure who holds copyright on ms_schema.py
  89                 continue
  90             if "wafsamba" in fname:
  91                 # FIXME: No copyright headers in wafsamba
  92                 continue
  93             match = copyright_re.search(text)
  94             if not match:
  95                 incorrect.append((fname, 'no copyright line found\n'))
  96
  97         if incorrect:
  98             help_text = [
  99                 "Some files have missing or incorrect copyright"
 100                 " statements.", ""]
 101             for fname, comment in incorrect:
 102                 help_text.append(fname)
 103                 help_text.append((' ' * 4) + comment)
 104
 105             self.fail('\n'.join(help_text))
 106
 107     def test_gpl(self):
 108         """Test that all .py files have a GPL disclaimer."""
 109         incorrect = []
 110
 111         gpl_txt = """
 112 # This program is free software; you can redistribute it and/or modify
 113 # it under the terms of the GNU General Public License as published by
 114 # the Free Software Foundation; either version 3 of the License, or
 115 # (at your option) any later version.
 116 #
 117 # This program is distributed in the hope that it will be useful,
 118 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 119 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 120 # GNU General Public License for more details.
 121 #
 122 # You should have received a copy of the GNU General Public License
 123 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 124 """
 125         gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
 126
 127         for fname, text in get_source_file_contents():
 128             if "wafsamba" in fname:
 129                 # FIXME: License to wafsamba hasn't been clarified yet
 130                 continue
 131             if fname.endswith("/python/samba/subunit/run.py"):
 132                 # Imported from subunit/testtools, which are dual
 133                 # Apache2/BSD-3.
 134                 continue
 135             if not gpl_re.search(text):
 136                 incorrect.append(fname)
 137
 138         if incorrect:
 139             help_text = ['Some files have missing or incomplete GPL statement',
 140                          gpl_txt]
 141             for fname in incorrect:
 142                 help_text.append((' ' * 4) + fname)
 143
 144             self.fail('\n'.join(help_text))
 145
 146     def _push_file(self, dict_, fname, line_no):
 147         if fname not in dict_:
 148             dict_[fname] = [line_no]
 149         else:
 150             dict_[fname].append(line_no)
 151
 152     def _format_message(self, dict_, message):
 153         files = ["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
 154                 for f, lines in dict_.items()]
 155         files.sort()
 156         return message + '\n\n    %s' % ('\n    '.join(files))
 157
 158     def _iter_source_files_lines(self):
 159         for fname, text in get_source_file_contents():
 160             lines = text.splitlines(True)
 161             last_line_no = len(lines) - 1
 162             for line_no, line in enumerate(lines):
 163                 yield fname, line_no, line
 164
 165     def test_no_tabs(self):
 166         """Check that there are no tabs in Python files."""
 167         tabs = {}
 168         for fname, line_no, line in self._iter_source_files_lines():
 169             if '\t' in line:
 170                 self._push_file(tabs, fname, line_no)
 171         if tabs:
 172             self.fail(self._format_message(tabs,
 173                 'Tab characters were found in the following source files.'
 174                 '\nThey should either be replaced by "\\t" or by spaces:'))
 175
 176     def test_unix_newlines(self):
 177         """Check for unix new lines."""
 178         illegal_newlines = {}
 179         for fname, line_no, line in self._iter_source_files_lines():
 180             if not line.endswith('\n') or line.endswith('\r\n'):
 181                 self._push_file(illegal_newlines, fname, line_no)
 182         if illegal_newlines:
 183             self.fail(self._format_message(illegal_newlines,
 184                 'Non-unix newlines were found in the following source files:'))
 185
 186     def test_trailing_whitespace(self):
 187         """Check that there is not trailing whitespace in Python files."""
 188         trailing_whitespace = {}
 189         for fname, line_no, line in self._iter_source_files_lines():
 190             if line.rstrip("\n").endswith(" "):
 191                 self._push_file(trailing_whitespace, fname, line_no)
 192         if trailing_whitespace:
 193             self.fail(self._format_message(trailing_whitespace,
 194                 'Trailing whitespace was found in the following source files.'))
 195
 196     def test_shebang_lines(self):
 197         """Check that files with shebang lines and only those are executable."""
 198         files_with_shebang = {}
 199         files_without_shebang= {}
 200         for fname, line_no, line in self._iter_source_files_lines():
 201             if line_no >= 1:
 202                 continue
 203             executable = (os.stat(fname).st_mode & 0o111)
 204             has_shebang = line.startswith("#!")
 205             if has_shebang and not executable:
 206                 self._push_file(files_with_shebang, fname, line_no)
 207             if not has_shebang and executable:
 208                 self._push_file(files_without_shebang, fname, line_no)
 209         if files_with_shebang:
 210             self.fail(self._format_message(files_with_shebang,
 211                       'Files with shebang line that are not executable:'))
 212         if files_without_shebang:
 213             self.fail(self._format_message(files_without_shebang,
 214                       'Files without shebang line that are executable:'))