Blame tests/generate.py

Packit Service 20376f
#!/usr/bin/env python
Packit Service 20376f
#
Packit Service 20376f
# Copyright (c) Vicent Marti. All rights reserved.
Packit Service 20376f
#
Packit Service 20376f
# This file is part of clar, distributed under the ISC license.
Packit Service 20376f
# For full terms see the included COPYING file.
Packit Service 20376f
#
Packit Service 20376f
Packit Service 20376f
from __future__ import with_statement
Packit Service 20376f
from string import Template
Packit Service 20376f
import re, fnmatch, os, codecs, pickle
Packit Service 20376f
Packit Service 20376f
class Module(object):
Packit Service 20376f
    class Template(object):
Packit Service 20376f
        def __init__(self, module):
Packit Service 20376f
            self.module = module
Packit Service 20376f
Packit Service 20376f
        def _render_callback(self, cb):
Packit Service 20376f
            if not cb:
Packit Service 20376f
                return '    { NULL, NULL }'
Packit Service 20376f
            return '    { "%s", &%s }' % (cb['short_name'], cb['symbol'])
Packit Service 20376f
Packit Service 20376f
    class DeclarationTemplate(Template):
Packit Service 20376f
        def render(self):
Packit Service 20376f
            out = "\n".join("extern %s;" % cb['declaration'] for cb in self.module.callbacks) + "\n"
Packit Service 20376f
Packit Service 20376f
            if self.module.initialize:
Packit Service 20376f
                out += "extern %s;\n" % self.module.initialize['declaration']
Packit Service 20376f
Packit Service 20376f
            if self.module.cleanup:
Packit Service 20376f
                out += "extern %s;\n" % self.module.cleanup['declaration']
Packit Service 20376f
Packit Service 20376f
            return out
Packit Service 20376f
Packit Service 20376f
    class CallbacksTemplate(Template):
Packit Service 20376f
        def render(self):
Packit Service 20376f
            out = "static const struct clar_func _clar_cb_%s[] = {\n" % self.module.name
Packit Service 20376f
            out += ",\n".join(self._render_callback(cb) for cb in self.module.callbacks)
Packit Service 20376f
            out += "\n};\n"
Packit Service 20376f
            return out
Packit Service 20376f
Packit Service 20376f
    class InfoTemplate(Template):
Packit Service 20376f
        def render(self):
Packit Service 20376f
            return Template(
Packit Service 20376f
            r"""
Packit Service 20376f
    {
Packit Service 20376f
        "${clean_name}",
Packit Service 20376f
    ${initialize},
Packit Service 20376f
    ${cleanup},
Packit Service 20376f
        ${cb_ptr}, ${cb_count}, ${enabled}
Packit Service 20376f
    }"""
Packit Service 20376f
            ).substitute(
Packit Service 20376f
                clean_name = self.module.clean_name(),
Packit Service 20376f
                initialize = self._render_callback(self.module.initialize),
Packit Service 20376f
                cleanup = self._render_callback(self.module.cleanup),
Packit Service 20376f
                cb_ptr = "_clar_cb_%s" % self.module.name,
Packit Service 20376f
                cb_count = len(self.module.callbacks),
Packit Service 20376f
                enabled = int(self.module.enabled)
Packit Service 20376f
            )
Packit Service 20376f
Packit Service 20376f
    def __init__(self, name):
Packit Service 20376f
        self.name = name
Packit Service 20376f
Packit Service 20376f
        self.mtime = 0
Packit Service 20376f
        self.enabled = True
Packit Service 20376f
        self.modified = False
Packit Service 20376f
Packit Service 20376f
    def clean_name(self):
Packit Service 20376f
        return self.name.replace("_", "::")
Packit Service 20376f
Packit Service 20376f
    def _skip_comments(self, text):
Packit Service 20376f
        SKIP_COMMENTS_REGEX = re.compile(
Packit Service 20376f
            r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"',
Packit Service 20376f
            re.DOTALL | re.MULTILINE)
Packit Service 20376f
Packit Service 20376f
        def _replacer(match):
Packit Service 20376f
            s = match.group(0)
Packit Service 20376f
            return "" if s.startswith('/') else s
Packit Service 20376f
Packit Service 20376f
        return re.sub(SKIP_COMMENTS_REGEX, _replacer, text)
Packit Service 20376f
Packit Service 20376f
    def parse(self, contents):
Packit Service 20376f
        TEST_FUNC_REGEX = r"^(void\s+(test_%s__(\w+))\s*\(\s*void\s*\))\s*\{"
Packit Service 20376f
Packit Service 20376f
        contents = self._skip_comments(contents)
Packit Service 20376f
        regex = re.compile(TEST_FUNC_REGEX % self.name, re.MULTILINE)
Packit Service 20376f
Packit Service 20376f
        self.callbacks = []
Packit Service 20376f
        self.initialize = None
Packit Service 20376f
        self.cleanup = None
Packit Service 20376f
Packit Service 20376f
        for (declaration, symbol, short_name) in regex.findall(contents):
Packit Service 20376f
            data = {
Packit Service 20376f
                "short_name" : short_name,
Packit Service 20376f
                "declaration" : declaration,
Packit Service 20376f
                "symbol" : symbol
Packit Service 20376f
            }
Packit Service 20376f
Packit Service 20376f
            if short_name == 'initialize':
Packit Service 20376f
                self.initialize = data
Packit Service 20376f
            elif short_name == 'cleanup':
Packit Service 20376f
                self.cleanup = data
Packit Service 20376f
            else:
Packit Service 20376f
                self.callbacks.append(data)
Packit Service 20376f
Packit Service 20376f
        return self.callbacks != []
Packit Service 20376f
Packit Service 20376f
    def refresh(self, path):
Packit Service 20376f
        self.modified = False
Packit Service 20376f
Packit Service 20376f
        try:
Packit Service 20376f
            st = os.stat(path)
Packit Service 20376f
Packit Service 20376f
            # Not modified
Packit Service 20376f
            if st.st_mtime == self.mtime:
Packit Service 20376f
                return True
Packit Service 20376f
Packit Service 20376f
            self.modified = True
Packit Service 20376f
            self.mtime = st.st_mtime
Packit Service 20376f
Packit Service 20376f
            with codecs.open(path, encoding='utf-8') as fp:
Packit Service 20376f
                raw_content = fp.read()
Packit Service 20376f
Packit Service 20376f
        except IOError:
Packit Service 20376f
            return False
Packit Service 20376f
Packit Service 20376f
        return self.parse(raw_content)
Packit Service 20376f
Packit Service 20376f
class TestSuite(object):
Packit Service 20376f
Packit Service 20376f
    def __init__(self, path):
Packit Service 20376f
        self.path = path
Packit Service 20376f
Packit Service 20376f
    def should_generate(self, path):
Packit Service 20376f
        if not os.path.isfile(path):
Packit Service 20376f
            return True
Packit Service 20376f
Packit Service 20376f
        if any(module.modified for module in self.modules.values()):
Packit Service 20376f
            return True
Packit Service 20376f
Packit Service 20376f
        return False
Packit Service 20376f
Packit Service 20376f
    def find_modules(self):
Packit Service 20376f
        modules = []
Packit Service 20376f
        for root, _, files in os.walk(self.path):
Packit Service 20376f
            module_root = root[len(self.path):]
Packit Service 20376f
            module_root = [c for c in module_root.split(os.sep) if c]
Packit Service 20376f
Packit Service 20376f
            tests_in_module = fnmatch.filter(files, "*.c")
Packit Service 20376f
Packit Service 20376f
            for test_file in tests_in_module:
Packit Service 20376f
                full_path = os.path.join(root, test_file)
Packit Service 20376f
                module_name = "_".join(module_root + [test_file[:-2]]).replace("-", "_")
Packit Service 20376f
Packit Service 20376f
                modules.append((full_path, module_name))
Packit Service 20376f
Packit Service 20376f
        return modules
Packit Service 20376f
Packit Service 20376f
    def load_cache(self):
Packit Service 20376f
        path = os.path.join(self.path, '.clarcache')
Packit Service 20376f
        cache = {}
Packit Service 20376f
Packit Service 20376f
        try:
Packit Service 20376f
            fp = open(path, 'rb')
Packit Service 20376f
            cache = pickle.load(fp)
Packit Service 20376f
            fp.close()
Packit Service 20376f
        except (IOError, ValueError):
Packit Service 20376f
            pass
Packit Service 20376f
Packit Service 20376f
        return cache
Packit Service 20376f
Packit Service 20376f
    def save_cache(self):
Packit Service 20376f
        path = os.path.join(self.path, '.clarcache')
Packit Service 20376f
        with open(path, 'wb') as cache:
Packit Service 20376f
            pickle.dump(self.modules, cache)
Packit Service 20376f
Packit Service 20376f
    def load(self, force = False):
Packit Service 20376f
        module_data = self.find_modules()
Packit Service 20376f
        self.modules = {} if force else self.load_cache()
Packit Service 20376f
Packit Service 20376f
        for path, name in module_data:
Packit Service 20376f
            if name not in self.modules:
Packit Service 20376f
                self.modules[name] = Module(name)
Packit Service 20376f
Packit Service 20376f
            if not self.modules[name].refresh(path):
Packit Service 20376f
                del self.modules[name]
Packit Service 20376f
Packit Service 20376f
    def disable(self, excluded):
Packit Service 20376f
        for exclude in excluded:
Packit Service 20376f
            for module in self.modules.values():
Packit Service 20376f
                name = module.clean_name()
Packit Service 20376f
                if name.startswith(exclude):
Packit Service 20376f
                    module.enabled = False
Packit Service 20376f
                    module.modified = True
Packit Service 20376f
Packit Service 20376f
    def suite_count(self):
Packit Service 20376f
        return len(self.modules)
Packit Service 20376f
Packit Service 20376f
    def callback_count(self):
Packit Service 20376f
        return sum(len(module.callbacks) for module in self.modules.values())
Packit Service 20376f
Packit Service 20376f
    def write(self):
Packit Service 20376f
        output = os.path.join(self.path, 'clar.suite')
Packit Service 20376f
Packit Service 20376f
        if not self.should_generate(output):
Packit Service 20376f
            return False
Packit Service 20376f
Packit Service 20376f
        with open(output, 'w') as data:
Packit Service 20376f
            for module in self.modules.values():
Packit Service 20376f
                t = Module.DeclarationTemplate(module)
Packit Service 20376f
                data.write(t.render())
Packit Service 20376f
Packit Service 20376f
            for module in self.modules.values():
Packit Service 20376f
                t = Module.CallbacksTemplate(module)
Packit Service 20376f
                data.write(t.render())
Packit Service 20376f
Packit Service 20376f
            suites = "static struct clar_suite _clar_suites[] = {" + ','.join(
Packit Service 20376f
                Module.InfoTemplate(module).render() for module in sorted(self.modules.values(), key=lambda module: module.name)
Packit Service 20376f
            ) + "\n};\n"
Packit Service 20376f
Packit Service 20376f
            data.write(suites)
Packit Service 20376f
Packit Service 20376f
            data.write("static const size_t _clar_suite_count = %d;\n" % self.suite_count())
Packit Service 20376f
            data.write("static const size_t _clar_callback_count = %d;\n" % self.callback_count())
Packit Service 20376f
Packit Service 20376f
        self.save_cache()
Packit Service 20376f
        return True
Packit Service 20376f
Packit Service 20376f
if __name__ == '__main__':
Packit Service 20376f
    from optparse import OptionParser
Packit Service 20376f
Packit Service 20376f
    parser = OptionParser()
Packit Service 20376f
    parser.add_option('-f', '--force', action="store_true", dest='force', default=False)
Packit Service 20376f
    parser.add_option('-x', '--exclude', dest='excluded', action='append', default=[])
Packit Service 20376f
Packit Service 20376f
    options, args = parser.parse_args()
Packit Service 20376f
Packit Service 20376f
    for path in args or ['.']:
Packit Service 20376f
        suite = TestSuite(path)
Packit Service 20376f
        suite.load(options.force)
Packit Service 20376f
        suite.disable(options.excluded)
Packit Service 20376f
        if suite.write():
Packit Service 20376f
            print("Written `clar.suite` (%d tests in %d suites)" % (suite.callback_count(), suite.suite_count()))
Packit Service 20376f