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