Revert ""
[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', '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     'dwz': 'Tests using DWZ and its DWARF partial units',
30     'dyntype': 'Tests related to dynamic type support',
31     'expression': 'Tests related to the expression parser',
32     'flakey': 'Flakey test cases, i.e. tests that do not reliably pass at each execution',
33     'gmodules': 'Tests that can be run with -gmodules debug information',
34     'instrumentation-runtime': 'Tests for the instrumentation runtime plugins',
35     'libc++': 'Test for libc++ data formatters',
36     'libstdcxx': 'Test for libstdcxx data formatters',
37     'lldb-server': 'Tests related to lldb-server',
38     'lldb-vscode': 'Visual Studio Code debug adaptor tests',
39     'objc': 'Tests related to the Objective-C programming language support',
40     'pyapi': 'Tests related to the Python API',
41     'std-module': 'Tests related to importing the std module',
42     'stresstest': 'Tests related to stressing lldb limits',
43     'watchpoint': 'Watchpoint-related tests',
44 }
45
46
47 def unique_string_match(yourentry, list):
48     candidate = None
49     for item in list:
50         if not item.startswith(yourentry):
51             continue
52         if candidate:
53             return None
54         candidate = item
55     return candidate
56
57
58 def is_supported_on_platform(category, platform, compiler_path):
59     if category == "dwo":
60         # -gsplit-dwarf is not implemented by clang on Windows.
61         return platform in ["linux", "freebsd"]
62     elif category == "dsym":
63         return platform in ["darwin", "macosx", "ios", "watchos", "tvos", "bridgeos"]
64     elif category == "gmodules":
65         # First, check to see if the platform can even support gmodules.
66         if platform not in ["freebsd", "darwin", "macosx", "ios", "watchos", "tvos", "bridgeos"]:
67             return False
68         return gmodules.is_compiler_clang_with_gmodules(compiler_path)
69     elif category == "dwz":
70         return platform in ["linux"]
71     return True
72
73
74 def validate(categories, exact_match):
75     """
76     For each category in categories, ensure that it's a valid category (if exact_match is false,
77     unique prefixes are also accepted). If a category is invalid, print a message and quit.
78        If all categories are valid, return the list of categories. Prefixes are expanded in the
79        returned list.
80     """
81     result = []
82     for category in categories:
83         origCategory = category
84         if category not in all_categories and not exact_match:
85             category = unique_string_match(category, all_categories)
86         if (category not in all_categories) or category is None:
87             print(
88                 "fatal error: category '" +
89                 origCategory +
90                 "' is not a valid category")
91             print("if you have added a new category, please edit test_categories.py, adding your new category to all_categories")
92             print("else, please specify one or more of the following: " +
93                   str(list(all_categories.keys())))
94             sys.exit(1)
95         result.append(category)
96     return result