summaryrefslogtreecommitdiff
path: root/src/test_strings.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/test_strings.py')
-rw-r--r--src/test_strings.py280
1 files changed, 280 insertions, 0 deletions
diff --git a/src/test_strings.py b/src/test_strings.py
new file mode 100644
index 0000000..b11c555
--- /dev/null
+++ b/src/test_strings.py
@@ -0,0 +1,280 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "src/test_strings.py 4577 2009/12/27 19:44:43 scons"
+
+"""
+Verify that we have proper strings like Copyright notices on all the
+right files in our distributions.
+
+Note that this is a source file and packaging test, not a functional test,
+so the name of this script doesn't end in *Tests.py.
+"""
+
+import fnmatch
+import os
+import os.path
+import re
+import string
+
+import TestCmd
+import TestSCons
+
+# Use TestCmd, not TestSCons, so we don't chdir to a temporary directory.
+test = TestCmd.TestCmd()
+
+scons_version = TestSCons.SConsVersion
+
+def build_path(*args):
+ return apply(os.path.join, ('build',)+args)
+
+build_scons = build_path('scons')
+build_local = build_path('scons-local', 'scons-local-'+scons_version)
+build_src = build_path('scons-src')
+
+class Checker:
+ def __init__(self, directory,
+ search_list = [],
+ remove_list = [],
+ remove_patterns = []):
+ self.directory = directory
+ self.search_list = search_list
+ self.remove_dict = {}
+ for r in remove_list:
+ self.remove_dict[os.path.join(directory, r)] = 1
+ self.remove_patterns = remove_patterns
+
+ def directory_exists(self):
+ return os.path.exists(self.directory)
+
+ def remove_this(self, name, path):
+ if self.remove_dict.get(path):
+ return 1
+ else:
+ for pattern in self.remove_patterns:
+ if fnmatch.fnmatch(name, pattern):
+ return 1
+ return 0
+
+ def search_this(self, path):
+ if self.search_list:
+ for pattern in self.search_list:
+ if fnmatch.fnmatch(path, pattern):
+ return 1
+ return None
+ else:
+ return os.path.isfile(path)
+
+ def visit(self, result, dirname, names):
+ make_path_tuple = lambda n, d=dirname: (n, os.path.join(d, n))
+ for name, path in map(make_path_tuple, names):
+ if self.remove_this(name, path):
+ names.remove(name)
+ elif self.search_this(path):
+ body = open(path, 'r').read()
+ for expr in self.expressions:
+ if not expr.search(body):
+ msg = '%s: missing %s' % (path, repr(expr.pattern))
+ result.append(msg)
+
+ def find_missing(self):
+ result = []
+ os.path.walk(self.directory, self.visit, result)
+ return result
+
+class CheckUnexpandedStrings(Checker):
+ expressions = [
+ re.compile('Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation'),
+ re.compile('src/test_strings.py 4577 2009/12/27 19:44:43 scons'),
+ ]
+ def must_be_built(self):
+ return None
+
+class CheckPassTest(Checker):
+ expressions = [
+ re.compile(r'\.pass_test()'),
+ ]
+ def must_be_built(self):
+ return None
+
+class CheckExpandedCopyright(Checker):
+ expressions = [
+ re.compile('Copyright.*The SCons Foundation'),
+ ]
+ def must_be_built(self):
+ return 1
+
+check_list = [
+
+ CheckUnexpandedStrings(
+ 'src',
+ search_list = [ '*.py' ],
+ remove_list = [
+ 'engine/SCons/compat/_scons_optparse.py',
+ 'engine/SCons/compat/_scons_sets.py',
+ 'engine/SCons/compat/_scons_sets15.py',
+ 'engine/SCons/compat/_scons_shlex.py',
+ 'engine/SCons/compat/_scons_subprocess.py',
+ 'engine/SCons/compat/_scons_textwrap.py',
+ 'engine/SCons/Conftest.py',
+ 'engine/SCons/dblite.py',
+ ],
+ ),
+
+ CheckUnexpandedStrings(
+ 'test',
+ search_list = [ '*.py' ],
+ ),
+
+ CheckPassTest(
+ 'test',
+ search_list = [ '*.py' ],
+ remove_list = [
+ 'Fortran/common.py',
+ ],
+ ),
+
+ CheckExpandedCopyright(
+ build_scons,
+ remove_list = [
+ 'build',
+ 'build-stamp',
+ 'configure-stamp',
+ 'debian',
+ 'dist',
+ 'gentoo',
+ 'engine/SCons/compat/_scons_optparse.py',
+ 'engine/SCons/compat/_scons_sets.py',
+ 'engine/SCons/compat/_scons_sets15.py',
+ 'engine/SCons/compat/_scons_shlex.py',
+ 'engine/SCons/compat/_scons_subprocess.py',
+ 'engine/SCons/compat/_scons_textwrap.py',
+ 'engine/SCons/Conftest.py',
+ 'engine/SCons/dblite.py',
+ 'MANIFEST',
+ 'os_spawnv_fix.diff',
+ 'setup.cfg',
+ ],
+ # We run epydoc on the *.py files, which generates *.pyc files.
+ remove_patterns = [
+ '*.pyc',
+ ]
+ ),
+
+ CheckExpandedCopyright(
+ build_local,
+ remove_list = [
+ 'SCons/compat/_scons_optparse.py',
+ 'SCons/compat/_scons_sets.py',
+ 'SCons/compat/_scons_sets15.py',
+ 'SCons/compat/_scons_shlex.py',
+ 'SCons/compat/_scons_subprocess.py',
+ 'SCons/compat/_scons_textwrap.py',
+ 'SCons/Conftest.py',
+ 'SCons/dblite.py',
+ 'scons-%s.egg-info' % scons_version,
+ ],
+ ),
+
+ CheckExpandedCopyright(
+ build_src,
+ remove_list = [
+ 'bench/timeit.py',
+ 'bin',
+ 'config',
+ 'debian',
+ 'gentoo',
+ 'doc/design',
+ 'doc/MANIFEST',
+ 'doc/python10',
+ 'doc/reference',
+ 'doc/developer/MANIFEST',
+ 'doc/man/MANIFEST',
+ 'doc/user/cons.pl',
+ 'doc/user/MANIFEST',
+ 'doc/user/SCons-win32-install-1.jpg',
+ 'doc/user/SCons-win32-install-2.jpg',
+ 'doc/user/SCons-win32-install-3.jpg',
+ 'doc/user/SCons-win32-install-4.jpg',
+ 'examples',
+ 'gentoo',
+ 'QMTest/classes.qmc',
+ 'QMTest/configuration',
+ 'QMTest/TestCmd.py',
+ 'QMTest/TestCommon.py',
+ 'QMTest/unittest.py',
+ 'src/os_spawnv_fix.diff',
+ 'src/MANIFEST.in',
+ 'src/setup.cfg',
+ 'src/engine/MANIFEST.in',
+ 'src/engine/MANIFEST-xml.in',
+ 'src/engine/setup.cfg',
+ 'src/engine/SCons/compat/_scons_optparse.py',
+ 'src/engine/SCons/compat/_scons_sets.py',
+ 'src/engine/SCons/compat/_scons_sets15.py',
+ 'src/engine/SCons/compat/_scons_shlex.py',
+ 'src/engine/SCons/compat/_scons_subprocess.py',
+ 'src/engine/SCons/compat/_scons_textwrap.py',
+ 'src/engine/SCons/Conftest.py',
+ 'src/engine/SCons/dblite.py',
+ 'src/script/MANIFEST.in',
+ 'src/script/setup.cfg',
+ 'test/Fortran/.exclude_tests',
+ 'timings/changelog.html',
+ 'timings/graph.html',
+ 'timings/index.html',
+ ],
+ remove_patterns = [
+ '*.js',
+ ]
+ ),
+
+]
+
+missing_strings = []
+not_built = []
+
+for collector in check_list:
+ if collector.directory_exists():
+ missing_strings.extend(collector.find_missing())
+ elif collector.must_be_built():
+ not_built.append(collector.directory)
+
+if missing_strings:
+ print "Found the following files with missing strings:"
+ print "\t" + string.join(missing_strings, "\n\t")
+ test.fail_test(1)
+
+if not_built:
+ print "Cannot check all strings, the following have apparently not been built:"
+ print "\t" + string.join(not_built, "\n\t")
+ test.no_result(1)
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-17 18:42:09 +0000