1"""
2Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
3See https://llvm.org/LICENSE.txt for license information.
4SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
5
6Provides the configuration class, which holds all information related to
7how this invocation of the test suite should be run.
8"""
9
10from __future__ import absolute_import
11from __future__ import print_function
12
13# System modules
14import os
15
16
17# Third-party modules
18import unittest2
19
20# LLDB Modules
21import lldbsuite
22
23
24# The test suite.
25suite = unittest2.TestSuite()
26
27# The list of categories we said we care about
28categories_list = None
29# set to true if we are going to use categories for cherry-picking test cases
30use_categories = False
31# Categories we want to skip
32skip_categories = ["darwin-log"]
33# Categories we expect to fail
34xfail_categories = []
35# use this to track per-category failures
36failures_per_category = {}
37
38# The path to LLDB.framework is optional.
39lldb_framework_path = None
40
41# Test suite repeat count.  Can be overwritten with '-# count'.
42count = 1
43
44# The 'arch' and 'compiler' can be specified via command line.
45arch = None
46compiler = None
47dsymutil = None
48sdkroot = None
49
50# The overriden dwarf verison.
51dwarf_version = 0
52
53# Any overridden settings.
54# Always disable default dynamic types for testing purposes.
55settings = [('target.prefer-dynamic-value', 'no-dynamic-values')]
56
57# Path to the FileCheck testing tool. Not optional.
58filecheck = None
59
60# Path to the yaml2obj tool. Not optional.
61yaml2obj = None
62
63# The arch might dictate some specific CFLAGS to be passed to the toolchain to build
64# the inferior programs.  The global variable cflags_extras provides a hook to do
65# just that.
66cflags_extras = ''
67
68# The filters (testclass.testmethod) used to admit tests into our test suite.
69filters = []
70
71# The regular expression pattern to match against eligible filenames as
72# our test cases.
73regexp = None
74
75# Sets of tests which are excluded at runtime
76skip_tests = None
77xfail_tests = None
78
79# By default, recorded session info for errored/failed test are dumped into its
80# own file under a session directory named after the timestamp of the test suite
81# run.  Use '-s session-dir-name' to specify a specific dir name.
82sdir_name = None
83
84# Valid options:
85# f - test file name (without extension)
86# n - test class name
87# m - test method name
88# a - architecture
89# c - compiler path
90# The default is to write all fields.
91session_file_format = 'fnmac'
92
93# Set this flag if there is any session info dumped during the test run.
94sdir_has_content = False
95# svn_info stores the output from 'svn info lldb.base.dir'.
96svn_info = ''
97
98# Default verbosity is 0.
99verbose = 0
100
101# By default, search from the script directory.
102# We can't use sys.path[0] to determine the script directory
103# because it doesn't work under a debugger
104testdirs = [lldbsuite.lldb_test_root]
105
106# The root of the test case tree (where the actual tests reside, not the test
107# infrastructure).
108test_src_root = lldbsuite.lldb_test_root
109
110# Separator string.
111separator = '-' * 70
112
113failed = False
114
115# LLDB Remote platform setting
116lldb_platform_name = None
117lldb_platform_url = None
118lldb_platform_working_dir = None
119
120# Apple SDK
121apple_sdk = None
122
123# The base directory in which the tests are being built.
124test_build_dir = None
125
126# The clang module cache directory used by lldb.
127lldb_module_cache_dir = None
128# The clang module cache directory used by clang.
129clang_module_cache_dir = None
130
131# Test results handling globals
132test_result = None
133
134# Reproducers
135capture_path = None
136replay_path = None
137
138# The names of all tests. Used to assert we don't have two tests with the
139# same base name.
140all_tests = set()
141
142# LLDB library directory.
143lldb_libs_dir = None
144
145# A plugin whose tests will be enabled, like intel-pt.
146enabled_plugins = []
147
148
149def shouldSkipBecauseOfCategories(test_categories):
150    if use_categories:
151        if len(test_categories) == 0 or len(
152                categories_list & set(test_categories)) == 0:
153            return True
154
155    for category in skip_categories:
156        if category in test_categories:
157            return True
158
159    return False
160
161
162def get_filecheck_path():
163    """
164    Get the path to the FileCheck testing tool.
165    """
166    if filecheck and os.path.lexists(filecheck):
167        return filecheck
168
169def get_yaml2obj_path():
170    """
171    Get the path to the yaml2obj tool.
172    """
173    if yaml2obj and os.path.lexists(yaml2obj):
174        return yaml2obj
175
176def is_reproducer_replay():
177    """
178    Returns true when dotest is being replayed from a reproducer. Never use
179    this method to guard SB API calls as it will cause a divergence between
180    capture and replay.
181    """
182    return replay_path is not None
183
184def is_reproducer():
185    """
186    Returns true when dotest is capturing a reproducer or is being replayed
187    from a reproducer. Use this method to guard SB API calls.
188    """
189    return capture_path or replay_path
190