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