diff options
Diffstat (limited to 'status')
| -rw-r--r-- | status/Jamfile.v2 | 52 | ||||
| -rw-r--r-- | status/boost_check_library.py | 226 |
2 files changed, 273 insertions, 5 deletions
diff --git a/status/Jamfile.v2 b/status/Jamfile.v2 index 3cc66bfb36..c0617542fe 100644 --- a/status/Jamfile.v2 +++ b/status/Jamfile.v2 @@ -19,26 +19,64 @@ project status import testing ; import modules ; +import project ; +import regex ; +import modules ; + +local check-libs-only = [ MATCH "^--(check-libs-only)" : [ modules.peek : ARGV ] ] ; +local check-libs-only-targets = ; +local libraries = ; local rule run-tests ( root : tests * ) { local limit-tests = [ MATCH "^--limit-tests=(.*)" : [ modules.peek : ARGV ] ] ; + local location = [ project.attribute $(__name__) location ] ; for local test in $(tests) { + local library = [ regex.split $(test) "/" ] ; + library = $(library[0]) ; if $(limit-tests) { - if [ MATCH "^($(limit-tests))" : $(test) ] + if ! [ MATCH "^($(limit-tests))" : $(test) ] { - build-project ../$(root)/$(test) ; + library = ; + } + } + if $(library) + { + use-project /boost/$(test) : ../$(root)/$(test) ; + if $(root) = libs && ( ! ( $(library) in $(libraries) ) ) + { + libraries += $(library) ; + local test_module = [ project.find ../$(root)/$(test) : $(location) ] ; + modules.poke $(test_module) : __LIBRARY__ : $(root)/$(library) ; + modules.poke $(test_module) : __JAMFILE__ : [ modules.peek project : JAMFILE ] ; + project.push-current [ project.target $(test_module) ] ; + module $(test_module) + { + import testing ; + testing.make-test run-pyd : + $(BOOST_ROOT)/status/boost_check_library.py + : + <pythonpath>$(BOOST_ROOT)/status + <testing.arg>--boost-root=\"$(BOOST_ROOT)\" + <testing.arg>--library=$(__LIBRARY__) + <testing.arg>--jamfile=\"$(__JAMFILE__:J=;)\" + <testing.arg>organization + : + __boost_check_library__ ; + } + project.pop-current ; + check-libs-only-targets += ../$(root)/$(test)//__boost_check_library__ ; } - else + if ! $(check-libs-only) { - use-project /boost/$(test) : ../$(root)/$(test) ; + build-project ../$(root)/$(test) ; } } else { - build-project ../$(root)/$(test) ; + # use-project /boost/$(test) : ../$(root)/$(test) ; } } } @@ -194,3 +232,7 @@ run-tests tools : bcp/test ; +if $(check-libs-only-targets) +{ + alias check-libs-only : $(check-libs-only-targets) ; +} diff --git a/status/boost_check_library.py b/status/boost_check_library.py new file mode 100644 index 0000000000..fd2fc32aee --- /dev/null +++ b/status/boost_check_library.py @@ -0,0 +1,226 @@ +#!/usr/bin/env python + +# Copyright Rene Rivera 2016 +# +# Distributed under the Boost Software License, Version 1.0. +# (See accompanying file LICENSE_1_0.txt or copy at +# http://www.boost.org/LICENSE_1_0.txt) + +import os +import inspect +import optparse +import sys +import glob +import fnmatch + +class check_library(): + ''' + This is a collection of checks for a library to test if a library + follows the Boost C++ Libraries requirements and guidelines. It also + checks for possible and likely errors in the library. + ''' + + def __init__(self): + self.main() + + def check_organization(self): + self.run_batch('check_organization_') + + def check_organization_build(self): + if os.path.isdir(os.path.join(self.library_dir, 'build')): + self.assert_file_exists(os.path.join(self.library_dir, 'build'), self.jamfile, + ''' + Did not find a Boost Build file in the [project-root]/build directory. + The library needs to provide a Boost Build project that the user, + and the top level Boost project, can use to build the library if it + has sources to build. + ''') + if os.path.isdir(os.path.join(self.library_dir, 'src')): + self.assert_dir_exists(os.path.join(self.library_dir,'build'), + ''' + Missing [project-root]/build directory. The [project-root]/build directory + is required for libraries that have a [project-root]/src directory. + ''') + + def check_organization_doc(self): + self.assert_file_exists(self.library_dir, ['index.html'], + ''' + Did not find [project-root]/index.html file. + + The file is required for all libraries. Redirection to HTML documentation. + ''') + self.assert_dir_exists(os.path.join(self.library_dir,'doc'), + ''' + Missing [project-root]/doc directory. The [project-root]/doc directory + is required for all libraries. + + Sources to build with and built documentation for the library. If the + library needs to build documentation from non-HTML files this location + must be buildable with Boost Build. + ''') + + def check_organization_include(self): + if os.path.isdir(os.path.join(self.library_dir,'include','boost',self.library_name)): + self.warn_file_exists(os.path.join(self.library_dir,'include','boost'), ['*.h*'], + ''' + Found extra files in [project-root]/include/boost directory. + ''', + negate = True, + globs_to_exclude = ['%s.h*'%(self.library_name)]) + else: + self.assert_file_exists(os.path.join(self.library_dir,'include','boost'), ['%s.h*'%(self.library_name)], + ''' + Did not find [project-root]/include/boost/[library].h* file. + + A single header for the library is required at [project-root]/include/boost/[library].h* + if the library does not have a header directory at [project-root]/include/boost/[library]. + ''') + + def check_organization_meta(self): + if self.assert_dir_exists(os.path.join(self.library_dir,'meta'), + ''' + Missing [project-root]/meta directory. The [project-root]/meta directory + is required for all libraries. + '''): + self.assert_file_exists(os.path.join(self.library_dir, 'meta'), ['libraries.json'], + ''' + Did not find [project-root]/meta/libraries.json file. + + The file is required for all libraries. And contains information about + the library used to generate website and documentation for the + Boost C++ Libraries collection. + ''') + + def check_organization_test(self): + if self.assert_dir_exists(os.path.join(self.library_dir,'test'), + ''' + Missing [project-root]/test directory. The [project-root]/test directory + is required for all libraries. + + Regression or other test programs or scripts. This is the only location + considered for automated testing. If you have additional locations that + need to be part of automated testing it is required that this location + refer to the additional test locations. + '''): + self.assert_file_exists(os.path.join(self.library_dir, 'test'), self.jamfile, + ''' + Did not find a Boost Build file in the [project-root]/test directory. + ''') + + def main(self): + commands = []; + for method in inspect.getmembers(self, predicate=inspect.ismethod): + if method[0].startswith('check_'): + commands.append(method[0][6:].replace('_','-')) + commands = "commands: %s" % ', '.join(commands) + + opt = optparse.OptionParser( + usage="%prog [options] [commands]", + description=commands) + opt.add_option('--boost-root') + opt.add_option('--library') + opt.add_option('--jamfile') + self.boost_root = None + self.library = None + self.jamfile = None + ( _opt_, self.actions ) = opt.parse_args(None,self) + + self.library_dir = os.path.join(self.boost_root, self.library) + self.error_count = 0; + self.jamfile = self.jamfile.split(';') + self.library_name = os.path.basename(self.library) + + for action in self.actions: + action_m = "check_"+action.replace('-','_') + if hasattr(self,action_m): + getattr(self,action_m)() + + def run_batch(self, action_base, *args, **kargs): + for method in inspect.getmembers(self, predicate=inspect.ismethod): + if method[0].startswith(action_base): + getattr(self,method[0])(*args, **kargs) + + def error(self, reason, message): + self.error_count += 1 + print("%s: error: %s; %s"%( + self.library, + self.clean_message(reason), + self.clean_message(message), + )) + + def warn(self, reason, message): + print("%s: warning: %s; %s"%( + self.library, + self.clean_message(reason), + self.clean_message(message), + )) + + def clean_message(self, message): + return " ".join(message.strip().split()) + + def assert_dir_exists(self, dir, message, negate = False): + if os.path.isdir(dir): + if negate: + self.error("directory found", message) + return False + else: + if not negate: + self.error("directory not found", message) + return False + return True + + def warn_dir_exists(self, dir, message, negate = False): + if os.path.isdir(dir): + if negate: + self.warn("directory found", message) + return False + else: + if not negate: + self.warn("directory not found", message) + return False + return True + + def assert_file_exists(self, dir, globs_to_include, message, negate = False, globs_to_exclude = []): + found = self.test_file_exists(dir, globs_to_include = globs_to_include, globs_to_exclude = globs_to_exclude) + if negate: + if found: + self.error("file found", message) + return False + else: + if not found: + self.error("file not found", message) + return False + return True + + def warn_file_exists(self, dir, globs_to_include, message, negate = False, globs_to_exclude = []): + found = self.test_file_exists(dir, globs_to_include = globs_to_include, globs_to_exclude = globs_to_exclude) + if negate: + if found: + self.warn("file found", message) + return False + else: + if not found: + self.warn("file not found", message) + return False + return True + + def test_dir_exists(self, dir): + return os.path.isdir(dir) + + def test_file_exists(self, dir, globs_to_include, globs_to_exclude = []): + found = False + if os.path.isdir(dir): + for g in globs_to_include: + for f in glob.iglob(os.path.join(dir,g)): + exclude = False + for ge in globs_to_exclude: + if fnmatch.fnmatch(os.path.basename(f),ge): + exclude = True + found = not exclude + if found: + break + return found + +if check_library().error_count > 0: + sys.exit(1) + |