1#!/usr/bin/env python
2
3r"""
4Check for stop conditions.  Return code of 2 if stop conditions are found.
5"""
6
7import sys
8import subprocess
9
10save_path_0 = sys.path[0]
11del sys.path[0]
12
13from gen_print import *
14from gen_valid import *
15from gen_arg import *
16from gen_misc import *
17from gen_cmd import *
18from gen_plug_in_utils import *
19from gen_call_robot import *
20
21# Restore sys.path[0].
22sys.path.insert(0, save_path_0)
23
24# Set exit_on_error for gen_valid functions.
25set_exit_on_error(True)
26
27# Initialize.
28STOP_REST_FAIL = ''
29STOP_COMMAND = ''
30stop_test_rc = 2
31
32# Create parser object to process command line parameters and args.
33
34# Create parser object.
35parser = argparse.ArgumentParser(
36    usage='%(prog)s [OPTIONS]',
37    description="If the \"Stop\" plug-in is selected by the user, %(prog)s" +
38    " is called by OBMC Boot Test after each boot test.  If %(prog)s returns" +
39    " " + str(stop_test_rc) + ", then OBMC Boot Test will stop.  The user" +
40    " may set environment variable STOP_COMMAND to contain any valid bash" +
41    " command or program.  %(prog)s will run this stop command.  If the stop" +
42    " command returns non-zero, then %(prog)s will return " +
43    str(stop_test_rc) + ".  %(prog)s recognizes some special values for" +
44    " STOP_COMMAND: 1) \"FAIL\" means that OBMC Boot Test should stop" +
45    " whenever a boot test fails. 2) \"ALL\" means that OBMC Boot Test" +
46    " should stop after any boot test.  If environment variable" +
47    " STOP_REST_FAIL is set, OBMC Boot Test will stop if REST commands are" +
48    " no longer working.",
49    formatter_class=argparse.RawTextHelpFormatter,
50    prefix_chars='-+')
51
52# The stock_list will be passed to gen_get_options.  We populate it with the names of stock parm options we
53# want.  These stock parms are pre-defined by gen_get_options.
54stock_list = [("test_mode", 0),
55              ("quiet", get_plug_default("quiet", 0)),
56              ("debug", get_plug_default("debug", 0))]
57
58
59def exit_function(signal_number=0,
60                  frame=None):
61    r"""
62    Execute whenever the program ends normally or with the signals that we catch (i.e. TERM, INT).
63    """
64
65    dprint_executing()
66    dprint_var(signal_number)
67
68    process_robot_output_files()
69
70    qprint_pgm_footer()
71
72
73def signal_handler(signal_number,
74                   frame):
75    r"""
76    Handle signals.  Without a function to catch a SIGTERM or SIGINT, our program would terminate immediately
77    with return code 143 and without calling our exit_function.
78    """
79
80    # Our convention is to set up exit_function with atexit.register() so there is no need to explicitly
81    # call exit_function from here.
82
83    dprint_executing()
84
85    # Calling exit prevents us from returning to the code that was running when we received the signal.
86    exit(0)
87
88
89def validate_parms():
90    r"""
91    Validate program parameters, etc.  Return True or False (i.e. pass/fail) accordingly.
92    """
93
94    get_plug_vars()
95
96    valid_value(AUTOBOOT_OPENBMC_HOST)
97
98    gen_post_validation(exit_function, signal_handler)
99
100    return True
101
102
103def stop_check():
104    r"""
105    Stop this program with the stop check return code.
106    """
107
108    if MASTER_PID != PROGRAM_PID:
109        stop_check_rc = stop_test_rc
110        save_plug_in_value(stop_check_rc)
111    exit(stop_test_rc)
112
113
114def rest_fail():
115    r"""
116    If STOP_REST_FAIL, then this function will determine whether REST commands to the target are working.  If
117    not, this function will stop the program by returning stop_test_rc.
118    """
119
120    if STOP_REST_FAIL != '1':
121        return
122
123    print_timen("Checking to see whether REST commands are working.")
124    init_robot_out_parms(get_plug_in_package_name() + "." + pgm_name + ".")
125    lib_file_path = init_robot_file_path("lib/state.py") + ":"\
126        + init_robot_file_path("lib/gen_robot_print.py")
127    set_mod_global(lib_file_path)
128    timeout = '0 seconds'
129    interval = '1 second'
130    keyword_string = "${match_state}=  Create Dictionary  rest=1 ;" +\
131        " ${state}=  Wait State  ${match_state}  " + timeout + "  " +\
132        interval + "  quiet=${1} ; Rpvar  state"
133    set_mod_global(keyword_string)
134
135    cmd_buf = create_robot_cmd_string("extended/run_keyword.robot",
136                                      OPENBMC_HOST, REST_USERNAME,
137                                      REST_PASSWORD, keyword_string,
138                                      lib_file_path, quiet, test_mode, debug,
139                                      outputdir, output, log, report, loglevel)
140    if not robot_cmd_fnc(cmd_buf):
141        print_timen("The caller wishes to stop test execution if REST" +
142                    " commands are failing.")
143        stop_check()
144    print_timen("REST commands are working so no reason as of yet to stop" +
145                " the test.")
146
147
148def esel_stop_check():
149    r"""
150    Run the esel_stop_check program to determine whether any eSEL entries found warrant stopping the test
151    run.  See esel_stop_check help text for details.
152    """
153
154    if STOP_ESEL_STOP_FILE_PATH == "":
155        return
156
157    cmd_buf = "esel_stop_check --esel_stop_file_path=" +\
158        STOP_ESEL_STOP_FILE_PATH
159    shell_rc, out_buf = cmd_fnc_u(cmd_buf, show_err=0)
160    if shell_rc == stop_test_rc:
161        print_timen("The caller wishes to stop test execution based on the" +
162                    " presence of certain esel entries.")
163        stop_check()
164
165
166def main():
167
168    if not gen_get_options(parser, stock_list):
169        return False
170
171    if not validate_parms():
172        return False
173
174    qprint_pgm_header()
175
176    if not debug:
177        qprint_vars(STOP_REST_FAIL, STOP_COMMAND, AUTOBOOT_BOOT_SUCCESS)
178
179    print_plug_in_header()
180
181    if STOP_COMMAND.upper() == "FAIL":
182        if AUTOBOOT_BOOT_SUCCESS == "0":
183            print_timen("The caller wishes to stop after each boot failure.")
184            stop_check()
185    elif STOP_COMMAND.upper() == "ALL":
186        print_timen("The caller wishes to stop after each boot test.")
187        stop_check()
188    elif len(STOP_COMMAND) > 0:
189        shell_rc, out_buf = cmd_fnc_u(STOP_COMMAND, quiet=quiet, show_err=0)
190        if shell_rc != 0:
191            print_timen("The caller wishes to stop test execution.")
192            stop_check()
193
194    rest_fail()
195
196    esel_stop_check()
197
198    qprint_timen("The caller does not wish to stop the test run.")
199    return True
200
201
202# Main
203
204if not main():
205    exit(1)
206