tests.py 11.3 KB
Newer Older
Johannes Bechberger's avatar
Johannes Bechberger committed
1 2
from collections import namedtuple
import shutil
3
from typing import Optional, List, Tuple, T, Union, Dict
4
import collections
Johannes Bechberger's avatar
Johannes Bechberger committed
5 6 7 8 9 10
from mjtest.environment import Environment, TestMode, TEST_MODES
from os.path import join, exists, basename
import logging
import os
import multiprocessing
from mjtest.util.parallelism import available_cpu_count
11
from mjtest.util.utils import cprint, colored
Johannes Bechberger's avatar
Johannes Bechberger committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
from pprint import pprint
import shutil

_LOG = logging.getLogger("tests")


RunResult = namedtuple("RunResult", ['count', 'failed'])


class TestSuite:
    """
    The whole set of tests.
    """

    def __init__(self, env: Environment):
        self.env = env
        self.test_cases = {} # type: Dict[str, List[TestCase]]
29
        self.correct_test_cases = collections.defaultdict(set) # type: Dict[str, Set[str]]
Johannes Bechberger's avatar
Johannes Bechberger committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
        self._load_test_cases()

    def _load_test_cases(self):
        types = TEST_MODES[TEST_MODES.index(self.env.mode):]
        for type in types:
            self._load_test_case_type(type)


    def _load_test_case_type(self, type: str):
        dir = join(self.env.test_dir, type)
        if exists(dir):
            self._load_test_case_dir(type, dir)
        else:
            _LOG.warn("Test folder {} doesn't exist".format(dir))

    def _load_test_case_dir(self, mode: str, dir: str):
        self.test_cases[mode] = []
        correct_test_cases = set()
        log_file = self._log_file_for_type(mode)
        if exists(log_file):
            with open(log_file) as f:
51 52 53 54 55 56
                correct_test_cases = set()
                for t in f.readlines():
                    t = t.strip()
                    if len(t) > 0:
                        self.correct_test_cases[mode].add(t)
                        correct_test_cases.add(t)
Johannes Bechberger's avatar
Johannes Bechberger committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
        for file in sorted(os.listdir(dir)):
            if not TestCase.has_valid_file_ending(mode, file):
                _LOG.debug("Skip file " + file)
            elif self.env.only_incorrect_tests and file in correct_test_cases:
                _LOG.info("Skip file {} as its test case was executed correctly the last run")
            else:
                test_case = TestCase.create_from_file(self.env, self.env.mode, join(dir, file))
                if not test_case.can_run():
                    _LOG.debug("Skip test case '{}' because it isn't suited".format(test_case.name()))
                else:
                    self.test_cases[mode].append(test_case)
        if len(self.test_cases[mode]) == 0:
            del self.test_cases[mode]

    def _log_file_for_type(self, type: str):
        return join(self.env.test_dir, type, ".mjtest_correct_testcases")

    def _add_correct_test_case(self, test_case: 'TestCase'):
75
        self.correct_test_cases[test_case.type].add(basename(test_case.file))
Johannes Bechberger's avatar
Johannes Bechberger committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

    def run(self) -> RunResult:
        ret = RunResult(0, 0)
        try:
            for mode in self.test_cases.keys():
                single_ret = RunResult(0, 0)
                if self.env.parallel:
                    single_ret = self._run_parallel(mode, available_cpu_count())
                else:
                    single_ret = self._run_sequential(mode)
                ret = RunResult(ret.count + single_ret.count, ret.failed + single_ret.failed)
        except BaseException:
            logging.exception("")
        finally:
            print("-" * 40)
            if ret.failed > 0:  # some tests failed
                print(colored("Ran {} tests, of which ".format(ret.count), "red") +
                      colored("{} failed.".format(ret.failed), "red", attrs=["bold"]))
            else:
                cprint("All {} run tests succeeded".format(ret.count), "green")
96 97 98 99 100
            if self.env.produce_reports:
                report_dir = self.env.report_dir + "." + ("successful" if ret.failed == 0 else "failed")
                os.rename(self.env.report_dir, report_dir)
                print("A full report for each test can be found at {}".format(
                    os.path.relpath(report_dir)))
Johannes Bechberger's avatar
Johannes Bechberger committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117

            return ret

    def _run_sequential(self, mode: str) -> RunResult:
        failed = 0
        count = 0
        for test_case in self.test_cases[mode]:
            ret = self._run_test_case(test_case)
            if ret is False or not ret.is_correct():
                failed += 1
            else:
                self._add_correct_test_case(test_case)
            count += 1
        return RunResult(count, failed)

    def _func(self, test_case: 'TestCase'):
        ret = self._run_test_case(test_case)
118
        if ret is not False and ret.is_correct():
119 120
            return 0, test_case
        return 1, test_case
Johannes Bechberger's avatar
Johannes Bechberger committed
121 122 123 124

    def _run_parallel(self, mode: str, parallel_jobs: int) -> RunResult:
        pool = multiprocessing.Pool(parallel_jobs)
        rets = pool.map(self._func, self.test_cases[mode])
125 126 127 128 129 130
        result = RunResult(len(rets), sum(map(lambda x: x[0], rets)))
        for (suc, test_case) in rets:
            if suc == 0:
                self._add_correct_test_case(test_case)
        return result

Johannes Bechberger's avatar
Johannes Bechberger committed
131 132 133 134 135 136 137 138 139 140

    def _run_test_case(self, test_case: 'TestCase') -> Optional['TestResult']:
        try:
            ret = test_case.run()
            color = "green" if ret.is_correct() else "red"
            print(colored("[{result:7s}] {tc:40s}".format(
                result="SUCCESS" if ret.is_correct() else "FAIL",
                tc=test_case.name()), color, attrs=["bold"]) +
                  colored("" if ret.is_correct() else ret.short_message(), color))
            try:
141 142 143 144 145 146 147 148
                if self.env.produce_reports:
                    if not exists(self.env.report_dir):
                        os.mkdir(self.env.report_dir)
                    rep_dir = join(self.env.report_dir, test_case.type)
                    if not exists(rep_dir):
                        os.mkdir(rep_dir)
                    suffix = ".correct" if ret.is_correct() else ".incorrect"
                    ret.store_at(join(rep_dir, test_case.short_name() + suffix))
149 150 151
                if self.env.output_incorrect_reports and not ret.is_correct():
                    print(colored("Report for failing test case {}".format(test_case.short_name()), "red", attrs=["bold"]))
                    print(colored(ret.long_message(), "red"))
Johannes Bechberger's avatar
Johannes Bechberger committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
                return ret
            except IOError:
                _LOG.exception("Caught i/o error while trying to store the report for '{}'"
                               .format(test_case.name()))
                return False
        except KeyboardInterrupt:
            raise
        except BaseException:
            _LOG.exception("At test case '{}'".format(test_case.short_name()))
            return False

    def store(self):
        for mode in self.correct_test_cases.keys():
            log_file = self._log_file_for_type(mode)
            try:
                with open(log_file, "w") as f:
                    f.write("\n".join(self.correct_test_cases[mode]))
            except IOError as e:
                _LOG.exception("Caught i/o error while storing {}".format(log_file))


class TestCase:
    """
    A single test case.
    """

    TEST_CASE_CLASSES = {
179 180
        TestMode.syntax: [],
        TestMode.semantic: []
Johannes Bechberger's avatar
Johannes Bechberger committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
    }
    FILE_ENDINGS = []

    def __init__(self, env: Environment, type: str, file: str):
        self.env = env
        self.type = type
        self.file = file

    def should_succeed(self) -> bool:
        raise NotImplementedError()

    def can_run(self, mode: str = "") -> bool:
        mode = mode or self.env.mode

        if mode == TestMode.exec:
            return self.type == TestMode.exec
        if mode == TestMode.semantic:
            return self.type == TestMode.semantic \
                   or (self.type == TestMode.exec and self.should_succeed())
        if mode == TestMode.syntax:
            return self.type == TestMode.syntax or \
                   (self.can_run(TestMode.semantic) and self.should_succeed())

    def run(self) -> 'TestResult':
        raise NotImplementedError()

    @classmethod
    def create_from_file(cls, env: Environment, mode: str, file: str) -> Optional['TestCase']:
        if cls.has_valid_file_ending(mode, file):
            return cls._test_case_class_for_file(mode, file)(env, mode, file)
        return None

    def name(self):
        return "{}:{}".format(self.type, self.short_name())

    def short_name(self) -> str:
        raise NotImplementedError()

    @classmethod
    def _test_case_class_for_file(cls, type: str, file: str):
        for t in cls.TEST_CASE_CLASSES[type]:
            if any(file.endswith(e) for e in t.FILE_ENDINGS):
                return t
        return False


    @classmethod
    def has_valid_file_ending(cls, type: str, file: str):
        return cls._test_case_class_for_file(type, file) != False


class TestResult:

    def __init__(self, test_case: TestCase, error_code: int):
        self.test_case = test_case
        self.error_code = error_code

    def is_correct(self) -> bool:
        return self.succeeded() == self.test_case.should_succeed()

    def succeeded(self) -> bool:
        return self.error_code == 0

    def store_at(self, file: str):
        with open(file, "w") as f:
            print(self.long_message(), file=f)

    def short_message(self) -> str:
        raise NotImplementedError()

    def long_message(self) -> str:
        raise NotImplementedError()


class BasicTestResult(TestResult):

257
    def __init__(self, test_case: TestCase, error_code: int, output: str, error_output: str):
Johannes Bechberger's avatar
Johannes Bechberger committed
258 259 260 261
        super().__init__(test_case, error_code)
        self._contains_error_str = "error" in error_output
        self.error_output = error_output
        self.output = output
262
        self.other_texts = [] # type: List[Tuple[str, str, bool]]
Johannes Bechberger's avatar
Johannes Bechberger committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

    def is_correct(self):
        if self.succeeded():
            return super().is_correct()
        else:
            return super().is_correct() and self._contains_error_str

    def short_message(self) -> str:
        if self.is_correct():
            return "correct"
        else:
            if not self.succeeded() and not self.test_case.should_succeed() and not self._contains_error_str:
                return "the error output doesn't contain the word \"error\""
            return "incorrect return code"

    def long_message(self) -> str:
279
        file_content = []
Johannes Bechberger's avatar
Johannes Bechberger committed
280
        with open(self.test_case.file, "r") as f:
281
            file_content = [line.rstrip() for line in f]
282 283 284 285 286 287 288 289 290 291 292
        others = []
        for title, content, long_text in self.other_texts:
            if long_text:
                others.append("""
{}:

{}

""".format(title, self._ident(content)))
            else:
                others.append("""{}: {}\n""".format(title, content))
Johannes Bechberger's avatar
Johannes Bechberger committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
        return """{}

Source file:

{}

Output:

{}

Error output:

{}

Return code: {}
308 309

{}
Johannes Bechberger's avatar
Johannes Bechberger committed
310
""".format(self.short_message().capitalize(), self._ident(file_content),
311 312 313 314 315 316 317 318
           self._ident(self.output), self._ident(self.error_output), self.error_code,
           "\n".join(others))

    def add_additional_text(self, title: str, content: str):
        self.other_texts.append((title, content, True))

    def add_additional_text_line(self, title: str, content: str):
        self.other_texts.append((title, content, False))
Johannes Bechberger's avatar
Johannes Bechberger committed
319 320 321

    def _ident(self, text: Union[str,List[str]]) -> str:
        arr = text if isinstance(text, list) else text.split("\n")
322 323 324 325
        if len(arr) == 0 or text == "":
            return ""
        arr = ["[{:04d}]    {:s}".format(i + 1, l) for (i, l) in enumerate(arr)]
        return "\n".join(arr)
Johannes Bechberger's avatar
Johannes Bechberger committed
326 327

import mjtest.test.syntax_tests