summaryrefslogtreecommitdiff
path: root/llvm/utils/lit/lit/TestingConfig.py
blob: 76fd665020097dd60f34041aefd677efcc978c04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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
179
180
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
257
258
259
260
261
262
263
264
265
266
import os
import sys


class TestingConfig(object):
    """ "
    TestingConfig - Information on the tests inside a suite.
    """

    @staticmethod
    def fromdefaults(litConfig):
        """
        fromdefaults(litConfig) -> TestingConfig

        Create a TestingConfig object with default values.
        """
        # Set the environment based on the command line arguments.
        environment = {
            "PATH": os.pathsep.join(litConfig.path + [os.environ.get("PATH", "")]),
            "LLVM_DISABLE_CRASH_REPORT": "1",
        }

        pass_vars = [
            "LIBRARY_PATH",
            "LD_LIBRARY_PATH",
            "SYSTEMROOT",
            "TERM",
            "CLANG",
            "LLDB",
            "LD_PRELOAD",
            "LLVM_SYMBOLIZER_PATH",
            "LLVM_PROFILE_FILE",
            "ASAN_SYMBOLIZER_PATH",
            "HWASAN_SYMBOLIZER_PATH",
            "LSAN_SYMBOLIZER_PATH",
            "MSAN_SYMBOLIZER_PATH",
            "TSAN_SYMBOLIZER_PATH",
            "UBSAN_SYMBOLIZER_PATH",
            "ASAN_OPTIONS",
            "LSAN_OPTIONS",
            "HWASAN_OPTIONS",
            "MSAN_OPTIONS",
            "TSAN_OPTIONS",
            "UBSAN_OPTIONS",
            "ADB",
            "ANDROID_SERIAL",
            "SSH_AUTH_SOCK",
            "SANITIZER_IGNORE_CVE_2016_2143",
            "TMPDIR",
            "TMP",
            "TEMP",
            "TEMPDIR",
            "AVRLIT_BOARD",
            "AVRLIT_PORT",
            "FILECHECK_OPTS",
            "VCINSTALLDIR",
            "VCToolsinstallDir",
            "VSINSTALLDIR",
            "WindowsSdkDir",
            "WindowsSDKLibVersion",
            "SOURCE_DATE_EPOCH",
            "GTEST_FILTER",
            "DFLTCC",
        ]

        if sys.platform.startswith("aix"):
            pass_vars += ["LIBPATH"]
        elif sys.platform == "win32":
            pass_vars += [
                "COMSPEC",
                "INCLUDE",
                "LIB",
                "PATHEXT",
                "USERPROFILE",
            ]
            environment["PYTHONBUFFERED"] = "1"
            # Avoid Windows heuristics which try to detect potential installer
            # programs (which may need to run with elevated privileges) and ask
            # if the user wants to run them in that way. This heuristic may
            # match for executables containing the substrings "patch" (which is
            # a substring of "dispatch"), "update", "setup", etc. Set this
            # environment variable indicating that we want to execute them with
            # the current user.
            environment["__COMPAT_LAYER"] = "RunAsInvoker"

        for var in pass_vars:
            val = os.environ.get(var, "")
            # Check for empty string as some variables such as LD_PRELOAD cannot be empty
            # ('') for OS's such as OpenBSD.
            if val:
                environment[var] = val

        # Set the default available features based on the LitConfig.
        available_features = []
        if litConfig.useValgrind:
            available_features.append("valgrind")
            if litConfig.valgrindLeakCheck:
                available_features.append("vg_leak")

        return TestingConfig(
            None,
            name="<unnamed>",
            suffixes=set(),
            test_format=None,
            environment=environment,
            substitutions=[],
            unsupported=False,
            test_exec_root=None,
            test_source_root=None,
            excludes=[],
            available_features=available_features,
            pipefail=True,
            standalone_tests=False,
        )

    def load_from_path(self, path, litConfig):
        """
        load_from_path(path, litConfig)

        Load the configuration module at the provided path into the given config
        object.
        """

        # Load the config script data.
        data = None
        f = open(path)
        try:
            data = f.read()
        except:
            litConfig.fatal("unable to load config file: %r" % (path,))
        f.close()

        # Execute the config script to initialize the object.
        cfg_globals = dict(globals())
        cfg_globals["config"] = self
        cfg_globals["lit_config"] = litConfig
        cfg_globals["__file__"] = path
        try:
            exec(compile(data, path, "exec"), cfg_globals, None)
            if litConfig.debug:
                litConfig.note("... loaded config %r" % path)
        except SystemExit:
            e = sys.exc_info()[1]
            # We allow normal system exit inside a config file to just
            # return control without error.
            if e.args:
                raise
        except:
            import traceback

            litConfig.fatal(
                "unable to parse config file %r, traceback: %s"
                % (path, traceback.format_exc())
            )
        self.finish(litConfig)

    def __init__(
        self,
        parent,
        name,
        suffixes,
        test_format,
        environment,
        substitutions,
        unsupported,
        test_exec_root,
        test_source_root,
        excludes,
        available_features,
        pipefail,
        limit_to_features=[],
        is_early=False,
        parallelism_group=None,
        standalone_tests=False,
    ):
        self.parent = parent
        self.name = str(name)
        self.suffixes = set(suffixes)
        self.test_format = test_format
        self.environment = dict(environment)
        self.substitutions = list(substitutions)
        self.unsupported = unsupported
        self.test_exec_root = test_exec_root
        self.test_source_root = test_source_root
        self.excludes = set(excludes)
        self.available_features = set(available_features)
        self.pipefail = pipefail
        self.standalone_tests = standalone_tests
        # This list is used by TestRunner.py to restrict running only tests that
        # require one of the features in this list if this list is non-empty.
        # Configurations can set this list to restrict the set of tests to run.
        self.limit_to_features = set(limit_to_features)
        self.parallelism_group = parallelism_group
        self._recursiveExpansionLimit = None

    @property
    def recursiveExpansionLimit(self):
        return self._recursiveExpansionLimit

    @recursiveExpansionLimit.setter
    def recursiveExpansionLimit(self, value):
        if value is not None and not isinstance(value, int):
            raise ValueError(
                "recursiveExpansionLimit must be either None or an integer (got <{}>)".format(
                    value
                )
            )
        if isinstance(value, int) and value < 0:
            raise ValueError(
                "recursiveExpansionLimit must be a non-negative integer (got <{}>)".format(
                    value
                )
            )
        self._recursiveExpansionLimit = value

    def finish(self, litConfig):
        """finish() - Finish this config object, after loading is complete."""

        self.name = str(self.name)
        self.suffixes = set(self.suffixes)
        self.environment = dict(self.environment)
        self.substitutions = list(self.substitutions)
        if self.test_exec_root is not None:
            # FIXME: This should really only be suite in test suite config
            # files. Should we distinguish them?
            self.test_exec_root = str(self.test_exec_root)
        if self.test_source_root is not None:
            # FIXME: This should really only be suite in test suite config
            # files. Should we distinguish them?
            self.test_source_root = str(self.test_source_root)
        self.excludes = set(self.excludes)

    @property
    def root(self):
        """root attribute - The root configuration for the test suite."""
        if self.parent is None:
            return self
        else:
            return self.parent.root


class SubstituteCaptures:
    """
    Helper class to indicate that the substitutions contains backreferences.

    This can be used as the following in lit.cfg to mark subsitutions as having
    back-references::

        config.substutions.append(('\b[^ ]*.cpp', SubstituteCaptures('\0.txt')))

    """

    def __init__(self, substitution):
        self.substitution = substitution

    def replace(self, pattern, replacement):
        return self.substitution

    def __str__(self):
        return self.substitution

    def __len__(self):
        return len(self.substitution)

    def __getitem__(self, item):
        return self.substitution.__getitem__(item)