xref: /llvm-project/lldb/packages/Python/lldbsuite/test/test_categories.py (revision 894c147104fad62c2fd33b977207d3640a7ce8a8) 
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    'objc': 'Tests related to the Objective-C programming language support',
30    'pyapi': 'Tests related to the Python API',
31    'basic_process': 'Basic process execution sniff tests.',
32    'cmdline': 'Tests related to the LLDB command-line interface',
33    'dyntype': 'Tests related to dynamic type support',
34    'stresstest': 'Tests related to stressing lldb limits',
35    'flakey': 'Flakey test cases, i.e. tests that do not reliably pass at each execution',
36    'lldb-mi': 'lldb-mi tests',
37    'darwin-log': 'Darwin log tests'}
38
39
40def unique_string_match(yourentry, list):
41    candidate = None
42    for item in list:
43        if not item.startswith(yourentry):
44            continue
45        if candidate:
46            return None
47        candidate = item
48    return candidate
49
50
51def is_supported_on_platform(category, platform, compiler_path):
52    if category == "dwo":
53        # -gsplit-dwarf is not implemented by clang on Windows.
54        return platform in ["linux", "freebsd"]
55    elif category == "dsym":
56        return platform in ["darwin", "macosx", "ios"]
57    elif category == "gmodules":
58        # First, check to see if the platform can even support gmodules.
59        if platform not in ["linux", "freebsd", "darwin", "macosx", "ios"]:
60            return False
61        return gmodules.is_compiler_clang_with_gmodules(compiler_path)
62    return True
63
64
65def validate(categories, exact_match):
66    """
67    For each category in categories, ensure that it's a valid category (if exact_match is false,
68    unique prefixes are also accepted). If a category is invalid, print a message and quit.
69       If all categories are valid, return the list of categories. Prefixes are expanded in the
70       returned list.
71    """
72    result = []
73    for category in categories:
74        origCategory = category
75        if category not in all_categories and not exact_match:
76            category = unique_string_match(category, all_categories)
77        if (category not in all_categories) or category is None:
78            print(
79                "fatal error: category '" +
80                origCategory +
81                "' is not a valid category")
82            print("if you have added a new category, please edit test_categories.py, adding your new category to all_categories")
83            print("else, please specify one or more of the following: " +
84                  str(list(all_categories.keys())))
85            sys.exit(1)
86        result.append(category)
87    return result
88