01ad15d398997e2b21f4c84bf66d33579e3a9cb7
[lldb.git] / lldb / packages / Python / lldbsuite / test / test_categories.py
1 """
2 Provides definitions for various lldb test categories
3 """
4
5 from __future__ import absolute_import
6 from __future__ import print_function
7
8 # System modules
9 import sys
10
11 # Third-party modules
12
13 # LLDB modules
14 from lldbsuite.support import gmodules
15
16
17 debug_info_categories = [
18     'dwarf', 'dwo', 'dsym', 'gmodules', 'dts', 'dwz'
19 ]
20
21 all_categories = {
22     'basic_process': 'Basic process execution sniff tests.',
23     'cmdline': 'Tests related to the LLDB command-line interface',
24     'darwin-log': 'Darwin log tests',
25     'dataformatters': 'Tests related to the type command and the data formatters subsystem',
26     'dsym': 'Tests that can be run with DSYM debug information',
27     'dwarf': 'Tests that can be run with DWARF debug information',
28     'dwo': 'Tests that can be run with DWO debug information',
29     'dts': 'Tests using -fdebug-types-section',
30     'dwz': 'Tests using DWZ and its DWARF partial units',
31     'dyntype': 'Tests related to dynamic type support',
32     'expression': 'Tests related to the expression parser',
33     'flakey': 'Flakey test cases, i.e. tests that do not reliably pass at each execution',
34     'gmodules': 'Tests that can be run with -gmodules debug information',
35     'instrumentation-runtime': 'Tests for the instrumentation runtime plugins',
36     'libc++': 'Test for libc++ data formatters',
37     'libstdcxx': 'Test for libstdcxx data formatters',
38     'lldb-server': 'Tests related to lldb-server',
39     'lldb-vscode': 'Visual Studio Code debug adaptor tests',
40     'objc': 'Tests related to the Objective-C programming language support',
41     'pyapi': 'Tests related to the Python API',
42     'std-module': 'Tests related to importing the std module',
43     'stresstest': 'Tests related to stressing lldb limits',
44     'watchpoint': 'Watchpoint-related tests',
45 }
46
47
48 def unique_string_match(yourentry, list):
49     candidate = None
50     for item in list:
51         if not item.startswith(yourentry):
52             continue
53         if candidate:
54             return None
55         candidate = item
56     return candidate
57
58
59 def is_supported_on_platform(category, platform, compiler_path):
60     if category == "dwo":
61         # -gsplit-dwarf is not implemented by clang on Windows.
62         return platform in ["linux", "freebsd"]
63     elif category == "dsym":
64         return platform in ["darwin", "macosx", "ios", "watchos", "tvos", "bridgeos"]
65     elif category == "gmodules":
66         # First, check to see if the platform can even support gmodules.
67         if platform not in ["freebsd", "darwin", "macosx", "ios", "watchos", "tvos", "bridgeos"]:
68             return False
69         return gmodules.is_compiler_clang_with_gmodules(compiler_path)
70     elif category == "dwz":
71         return platform in ["linux"]
72     return True
73
74
75 def validate(categories, exact_match):
76     """
77     For each category in categories, ensure that it's a valid category (if exact_match is false,
78     unique prefixes are also accepted). If a category is invalid, print a message and quit.
79        If all categories are valid, return the list of categories. Prefixes are expanded in the
80        returned list.
81     """
82     result = []
83     for category in categories:
84         origCategory = category
85         if category not in all_categories and not exact_match:
86             category = unique_string_match(category, all_categories)
87         if (category not in all_categories) or category is None:
88             print(
89                 "fatal error: category '" +
90                 origCategory +
91                 "' is not a valid category")
92             print("if you have added a new category, please edit test_categories.py, adding your new category to all_categories")
93             print("else, please specify one or more of the following: " +
94                   str(list(all_categories.keys())))
95             sys.exit(1)
96         result.append(category)
97     return result