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# Set this flag if there is any session info dumped during the test run. 80sdir_has_content = False 81# svn_info stores the output from 'svn info lldb.base.dir'. 82svn_info = '' 83 84# Default verbosity is 0. 85verbose = 0 86 87# By default, search from the script directory. 88# We can't use sys.path[0] to determine the script directory 89# because it doesn't work under a debugger 90testdirs = [lldbsuite.lldb_test_root] 91 92# The root of the test case tree (where the actual tests reside, not the test 93# infrastructure). 94test_src_root = lldbsuite.lldb_test_root 95 96# Separator string. 97separator = '-' * 70 98 99failed = False 100 101# LLDB Remote platform setting 102lldb_platform_name = None 103lldb_platform_url = None 104lldb_platform_working_dir = None 105 106# Apple SDK 107apple_sdk = None 108 109# The base directory in which the tests are being built. 110test_build_dir = None 111 112# The clang module cache directory used by lldb. 113lldb_module_cache_dir = None 114# The clang module cache directory used by clang. 115clang_module_cache_dir = None 116 117# Test results handling globals 118test_result = None 119 120# Reproducers 121capture_path = None 122replay_path = None 123 124# The names of all tests. Used to assert we don't have two tests with the 125# same base name. 126all_tests = set() 127 128# LLDB library directory. 129lldb_libs_dir = None 130 131# A plugin whose tests will be enabled, like intel-pt. 132enabled_plugins = [] 133 134 135def shouldSkipBecauseOfCategories(test_categories): 136 if use_categories: 137 if len(test_categories) == 0 or len( 138 categories_list & set(test_categories)) == 0: 139 return True 140 141 for category in skip_categories: 142 if category in test_categories: 143 return True 144 145 return False 146 147 148def get_filecheck_path(): 149 """ 150 Get the path to the FileCheck testing tool. 151 """ 152 if filecheck and os.path.lexists(filecheck): 153 return filecheck 154 155def get_yaml2obj_path(): 156 """ 157 Get the path to the yaml2obj tool. 158 """ 159 if yaml2obj and os.path.lexists(yaml2obj): 160 return yaml2obj 161 162def is_reproducer_replay(): 163 """ 164 Returns true when dotest is being replayed from a reproducer. Never use 165 this method to guard SB API calls as it will cause a divergence between 166 capture and replay. 167 """ 168 return replay_path is not None 169 170def is_reproducer(): 171 """ 172 Returns true when dotest is capturing a reproducer or is being replayed 173 from a reproducer. Use this method to guard SB API calls. 174 """ 175 return capture_path or replay_path 176