1#!/usr/bin/env python3
2
3r"""
4See help text for details.
5"""
6
7import sys
8
9save_path_0 = sys.path[0]
10del sys.path[0]
11
12from gen_arg import *  # NOQA
13from gen_print import *  # NOQA
14from gen_valid import *  # NOQA
15from openbmc_ffdc_list import *  # NOQA
16
17# Restore sys.path[0].
18sys.path.insert(0, save_path_0)
19
20# Set exit_on_error for gen_valid functions.
21set_exit_on_error(True)
22
23parser = argparse.ArgumentParser(
24    usage="%(prog)s [OPTIONS]",
25    description=(
26        "%(prog)s will print a colon-delimited list of all valid OBMC FFDC"
27        " functions.\n\nExample:"
28    )
29    + "\n\n\nDump Log:FFDC Generic Report:Get Request FFDC:SEL Log:BMC"
30    " Specific Files:Sys Inventory Files"
31    + ":Core Files:OS FFDC:Dump Files",
32    formatter_class=argparse.RawDescriptionHelpFormatter,
33    prefix_chars="-+",
34)
35
36# Populate stock_list with options we want.
37stock_list = [("test_mode", 0), ("quiet", 1), ("debug", 0)]
38
39
40def exit_function(signal_number=0, frame=None):
41    r"""
42    Execute whenever the program ends normally or with the signals that we catch (i.e. TERM, INT).
43    """
44
45    dprint_executing()
46    dprint_var(signal_number)
47
48    qprint_pgm_footer()
49
50
51def signal_handler(signal_number, frame):
52    r"""
53    Handle signals.  Without a function to catch a SIGTERM or SIGINT, our program would terminate immediately
54    with return code 143 and without calling our exit_function.
55    """
56
57    # Our convention is to set up exit_function with atexit.register() so there is no need to explicitly
58    # call exit_function from here.
59
60    dprint_executing()
61
62    # Calling exit prevents us from returning to the code that was running when we received the signal.
63    exit(0)
64
65
66def validate_parms():
67    r"""
68    Validate program parameters, etc.
69    """
70
71    gen_post_validation(exit_function, signal_handler)
72
73
74def main():
75    gen_get_options(parser, stock_list)
76
77    validate_parms()
78
79    qprint_pgm_header()
80
81    my_openbmc_ffdc_list = openbmc_ffdc_list()
82    ffdc_function_list = my_openbmc_ffdc_list.get_ffdc_method_desc("BMC LOGS")
83    # Convert from list to colon-delimited string.
84    ffdc_function_list = ":".join(ffdc_function_list)
85    print(ffdc_function_list)
86
87
88main()
89