environment.py 7.95 KB
Newer Older
Johannes Bechberger's avatar
Johannes Bechberger committed
1
2
import logging
import os
Johannes Bechberger's avatar
Johannes Bechberger committed
3
import random
Johannes Bechberger's avatar
Fix #47    
Johannes Bechberger committed
4
import shlex
Johannes Bechberger's avatar
Johannes Bechberger committed
5
6
import shutil
import tempfile
Johannes Bechberger's avatar
Johannes Bechberger committed
7
8
from datetime import datetime
import time
Johannes Bechberger's avatar
Fix #47    
Johannes Bechberger committed
9
from threading import Timer
10
11
from typing import Dict

Johannes Bechberger's avatar
Fix #47    
Johannes Bechberger committed
12
13
import subprocess

Johannes Bechberger's avatar
Johannes Bechberger committed
14
from mjtest.util.shell import execute
15
from mjtest.util.utils import get_mjtest_basedir, force_colored_output
16
import mjtest.util.utils
Johannes Bechberger's avatar
Johannes Bechberger committed
17
from typing import Tuple, List
18
from preproc.preproc.preprocessor import PreProcessor, PreProcessorError, is_importable_file
Johannes Bechberger's avatar
Johannes Bechberger committed
19

20
_LOG = logging.getLogger("env")
Johannes Bechberger's avatar
Johannes Bechberger committed
21
22

class TestMode:
23
24
25

    lexer = "lexer"

Johannes Bechberger's avatar
Johannes Bechberger committed
26
27
    syntax = "syntax"

Johannes Bechberger's avatar
Johannes Bechberger committed
28
29
    ast = "ast"

Johannes Bechberger's avatar
Johannes Bechberger committed
30
31
    semantic = "semantic"

32
    compile_firm = "compile-firm"
33

Johannes Bechberger's avatar
Johannes Bechberger committed
34
35
    exec = "exec"

Johannes Bechberger's avatar
Johannes Bechberger committed
36
    USE_TESTS_OF_OTHER = {
37
38
        ast: [syntax],
        compile_firm: [exec]
Johannes Bechberger's avatar
Johannes Bechberger committed
39
40
    }

Johannes Bechberger's avatar
Johannes Bechberger committed
41
""" All 'success' tests of the n.th mode can used as 'success' tests for the n-1.th mode"""
42
43
44
45
46
TEST_MODES = [TestMode.lexer, TestMode.syntax, TestMode.ast, TestMode.semantic, TestMode.compile_firm, TestMode.exec]


def get_test_dirname(mode: str) -> str:
    d = {
47
    #    TestMode.compile_firm: "exec"
48
49
50
51
52
    }
    if mode not in d:
        return mode
    return d[mode]

Johannes Bechberger's avatar
Johannes Bechberger committed
53
54
55
56
57
58
59
60
61
62

class Environment:

    LOG_LEVELS = {
        "info": logging.INFO,
        "error": logging.ERROR,
        "warn": logging.WARN,
        "debug": logging.DEBUG
    }

63
    def __init__(self, mode, mj_run: str, tmp_dir: str = "", test_dir: str = "",
Johannes Bechberger's avatar
Johannes Bechberger committed
64
                 only_incorrect_tests: bool = False, parallel: bool = False,
65
                 timeout: int = 30, report_dir: str = "", log_level: str = "warn",
66
                 produce_no_reports: bool = True, output_no_incorrect_reports: bool = False,
67
                 produce_all_reports: bool = False, report_subdir: str = None,
68
69
                 ci_testing: bool = False, color: bool = False,
                 all_exec_tests: bool = True):
70
71
        if color:
            force_colored_output()
Johannes Bechberger's avatar
Johannes Bechberger committed
72
        self.mode = mode
73
        self.mj_run_cmd = os.path.realpath(mj_run)
Johannes Bechberger's avatar
Johannes Bechberger committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

        if tmp_dir:
            self.own_tmp_dir = True
            self.tmp_dir = os.path.abspath(os.path.expandvars(tmp_dir))
            if not os.path.exists(tmp_dir):
                os.mkdir(self.tmp_dir)
        else:
            self.own_tmp_dir = False
            self.tmp_dir = tempfile.mkdtemp("mjtest")

        if test_dir:
            self.test_dir = os.path.abspath(os.path.realpath(test_dir))
        else:
            self.test_dir = os.path.join(get_mjtest_basedir(), "tests")
        if not os.path.exists(self.test_dir):
            os.mkdir(self.test_dir)
Johannes Bechberger's avatar
Johannes Bechberger committed
90
            for d in TEST_MODES:
Johannes Bechberger's avatar
Johannes Bechberger committed
91
92
93
94
                os.mkdir(os.path.join(self.test_dir, d))

        self.only_incorrect_tests = only_incorrect_tests
        self.parallel = parallel
95
96
97
98
99
        if not produce_no_reports:
            if report_dir:
                self.report_dir = os.path.abspath(os.path.expandvars(report_dir))
            else:
                self.report_dir = os.path.join(get_mjtest_basedir(), "reports")
100
101
102
103
            try:
                os.mkdir(self.report_dir)
            except IOError:
                pass
104
            self.report_dir = os.path.join(self.report_dir, report_subdir or datetime.now().strftime("%d-%m-%y_%H-%M-%S"))
105
106
            if not os.path.exists(self.report_dir):
                os.mkdir(self.report_dir)
Johannes Bechberger's avatar
Johannes Bechberger committed
107
        else:
108
            self.report_dir = None
Johannes Bechberger's avatar
Johannes Bechberger committed
109
        logging.basicConfig(level=self.LOG_LEVELS[log_level])
110
        self.produce_reports = not produce_no_reports # type: bool
111
112
        self.output_incorrect_reports = not output_no_incorrect_reports
        self.produce_all_reports = produce_all_reports
113
        self.ci_testing = ci_testing
Johannes Bechberger's avatar
Johannes Bechberger committed
114
        self._tmp_file_ctr = 0
115
        self._already_preprocessed_files = set()
116
        self._pid_tmpdirs = {}  # type: Dict[int, str]
117
        self.only_small_exec_tests = not all_exec_tests
Johannes Bechberger's avatar
Johannes Bechberger committed
118

119
120
        self.timeout = float(os.getenv("MJ_TIMEOUT", "10"))
        self.big_timeout = float(os.getenv("MJ_BIG_TIMEOUT", "60"))
121

Johannes Bechberger's avatar
Johannes Bechberger committed
122
    def create_tmpfile(self) -> str:
Johannes Bechberger's avatar
Johannes Bechberger committed
123
124
125
        self._tmp_file_ctr += 1
        return os.path.join(self.tmp_dir, str(round(time.time() * 100000))
                            + str(random.randrange(0, 10000, 1)) + str(self._tmp_file_ctr))
126
127
128
129
130

    def create_tmpdir(self) -> str:
        dir = self.create_tmpfile()
        os.mkdir(dir)
        return dir
Johannes Bechberger's avatar
Johannes Bechberger committed
131

132
133
134
135
136
137
    def create_pid_local_tmpdir(self) -> str:
        pid = os.getpid()
        if pid not in self._pid_tmpdirs:
            self._pid_tmpdirs[pid] = self.create_tmpdir()
        return self._pid_tmpdirs[pid]

Johannes Bechberger's avatar
Johannes Bechberger committed
138
139
140
141
    def clean_up(self):
        if not self.own_tmp_dir:
            shutil.rmtree(self.tmp_dir)

142
    def run_mj_command(self, mode: str, *args: Tuple[str], timeout: float = None) -> Tuple[bytes, bytes, int]:
Johannes Bechberger's avatar
Johannes Bechberger committed
143
144
145
146
147
148
        """
        Execute the MiniJava `run` script with the given arguments.

        :param args: arguments for the MiniJava `run` script
        :return: (out, err, return code)
        """
Johannes Bechberger's avatar
Johannes Bechberger committed
149
        mode_flag = {
150
            TestMode.lexer: "--lextest",
Johannes Bechberger's avatar
Johannes Bechberger committed
151
            TestMode.syntax: "--parsetest",
Johannes Bechberger's avatar
Johannes Bechberger committed
152
            TestMode.ast: "--print-ast",
153
            TestMode.semantic: "--check",
154
            TestMode.compile_firm: "--compile-firm"
Johannes Bechberger's avatar
Johannes Bechberger committed
155
156
        }[mode]
        cmd = [self.mj_run_cmd, mode_flag] + list(args)
157
        return execute(cmd, timeout=timeout or self.timeout)
158

159
    def run_command(self, cmd: str, *args: Tuple[str], timeout: float = None) -> Tuple[bytes, bytes, int]:
160
161
162
163
164
        """
        Execute the passend command with its arguments

        :return: (out, err, return code)
        """
165
        return execute([cmd] + list(args), timeout=timeout or self.timeout)
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

    def has_to_preprocess(self, file: str) -> bool:
        return os.path.relpath(file, self.test_dir).startswith("exec")

    def is_lib_file(self, file: str) -> bool:
        return is_importable_file(file)

    def preprocess(self, file: str) -> str:
        """
        Pre process the passed file if needed and return the resulting file
        """
        if not self.has_to_preprocess(file):
            return file
        if ".preprocessed" in os.path.relpath(file, self.test_dir):
            return file

        import_base_dir = os.path.join(self.test_dir, os.path.relpath(file, self.test_dir).lstrip(os.sep).split(os.sep)[0])
        dst_dir = os.path.join(import_base_dir, ".preprocessed", os.path.split(os.path.relpath(file, import_base_dir))[0])
        dst_file = os.path.join(dst_dir, os.path.basename(file))
        if dst_file.endswith(".mj"):
            dst_file = dst_file.replace(".mj", ".java")
        if dst_file in self._already_preprocessed_files:
            return dst_file
        self._already_preprocessed_files.add(dst_file)

191
        if os.path.exists(dst_file) and os.path.isfile(dst_file) and os.path.getmtime(file) < os.path.getmtime(dst_file) and False:
192
193
194
            _LOG.debug("File '{}' already exists in a pre processed form".format(os.path.relpath(file)))
            return dst_file
        if not os.path.exists(dst_dir):
Johannes Bechberger's avatar
Johannes Bechberger committed
195
            os.makedirs(dst_dir, exist_ok=True)
196
197
198
199
200
201
202
        try:
            PreProcessor(file, import_base_dir, dst_file).preprocess()
        except:
            _LOG.exception("Pre processing file '{}'".format(file))
            raise
        return dst_file

Johannes Bechberger's avatar
Fix #47    
Johannes Bechberger committed
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
    def run_command_till_timeout(self, cmd: str, *args: Tuple[str], timeout: float = 0) -> Tuple[bytes, bytes, int, bool]:
        """
        Much slower than `run_command` but captures the command output even when a
        timeout occurs.

        Inspired by http://stackoverflow.com/a/10768774
        """
        cmds = [cmd] + list(args)
        cmds = [shlex.quote(c) for c in cmds]
        proc = subprocess.Popen(cmds, stdout=subprocess.PIPE,
                                stderr=subprocess.PIPE)
        timeouted = False

        def kill_proc(proc):
            timeouted = True
            proc.kill()

        stdout, stderr = None, None
        if timeout >= 0.0:
            timer = Timer(timeout, kill_proc, [proc])
            timer.start()
            stdout, stderr = proc.communicate()
            timer.cancel()
        else:
            stdout, stderr = proc.communicate()
        return stdout, stderr, proc.returncode, timeouted