blob: bd389c84308716b88b0eca7eef508ff75e597830 [file] [log] [blame]
George Keishinge7e91712021-09-03 11:28:44 -05001#!/usr/bin/env python3
Michael Walsh7423c012016-10-04 10:27:21 -05002
Michael Walsh60d08f32019-11-25 16:51:39 -06003r"""
4See help text for details.
5"""
6
Patrick Williams57318182022-12-08 06:18:26 -06007import sys
George Keishinge635ddc2022-12-08 07:38:02 -06008import subprocess
9import os
Michael Walsh7423c012016-10-04 10:27:21 -050010
Michael Walsh60d08f32019-11-25 16:51:39 -060011save_dir_path = sys.path.pop(0)
Michael Walsh7423c012016-10-04 10:27:21 -050012
George Keishinge635ddc2022-12-08 07:38:02 -060013modules = ['gen_arg', 'gen_print', 'gen_valid', 'gen_plug_in', 'gen_cmd', 'gen_misc']
Michael Walsh60d08f32019-11-25 16:51:39 -060014for module in modules:
15 exec("from " + module + " import *")
Michael Walsh7423c012016-10-04 10:27:21 -050016
Michael Walsh60d08f32019-11-25 16:51:39 -060017sys.path.insert(0, save_dir_path)
Michael Walsh7423c012016-10-04 10:27:21 -050018
19# Create parser object.
20parser = argparse.ArgumentParser(
George Keishinge635ddc2022-12-08 07:38:02 -060021 usage='%(prog)s [OPTIONS]',
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050022 description="%(prog)s will process the plug-in packages passed to it."
George Keishinge635ddc2022-12-08 07:38:02 -060023 + " A plug-in package is essentially a directory containing"
24 + " one or more call point programs. Each of these call point"
25 + " programs must have a prefix of \"cp_\". When calling"
26 + " %(prog)s, a user must provide a call_point parameter"
27 + " (described below). For each plug-in package passed,"
28 + " %(prog)s will check for the presence of the specified call"
29 + " point program in the plug-in directory. If it is found,"
30 + " %(prog)s will run it. It is the responsibility of the"
31 + " caller to set any environment variables needed by the call"
32 + " point programs.\n\nAfter each call point program"
33 + " has been run, %(prog)s will print the following values in"
34 + " the following formats for use by the calling program:\n"
35 + " failed_plug_in_name: <failed plug-in value,"
36 + " if any>\n shell_rc: "
37 + "<shell return code value of last call point program - this"
38 + " will be printed in hexadecimal format. Also, be aware"
39 + " that if a call point program returns a value it will be"
40 + " shifted left 2 bytes (e.g. rc of 2 will be printed as"
41 + " 0x00000200). That is because the rightmost byte is"
42 + " reserved for errors in calling the call point program"
43 + " rather than errors generated by the call point program.>",
Michael Walshd0741f82017-12-21 14:04:21 -060044 formatter_class=argparse.ArgumentDefaultsHelpFormatter,
George Keishinge635ddc2022-12-08 07:38:02 -060045 prefix_chars='-+')
Michael Walsh7423c012016-10-04 10:27:21 -050046
47# Create arguments.
48parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060049 'plug_in_dir_paths',
50 nargs='?',
Michael Walsh7423c012016-10-04 10:27:21 -050051 default="",
George Keishinge635ddc2022-12-08 07:38:02 -060052 help=plug_in_dir_paths_help_text + default_string)
Michael Walsh7423c012016-10-04 10:27:21 -050053
54parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060055 '--call_point',
Michael Walsh7423c012016-10-04 10:27:21 -050056 default="setup",
57 required=True,
George Keishinge635ddc2022-12-08 07:38:02 -060058 help='The call point program name. This value must not include the'
59 + ' "cp_" prefix. For each plug-in package passed to this program,'
60 + ' the specified call_point program will be called if it exists in'
61 + ' the plug-in directory.' + default_string)
Michael Walsh7423c012016-10-04 10:27:21 -050062
63parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060064 '--allow_shell_rc',
Michael Walsh7423c012016-10-04 10:27:21 -050065 default="0x00000000",
George Keishinge635ddc2022-12-08 07:38:02 -060066 help='The user may supply a value other than zero to indicate an'
67 + ' acceptable non-zero return code. For example, if this value'
68 + ' equals 0x00000200, it means that for each plug-in call point that'
69 + ' runs, a 0x00000200 will not be counted as a failure. See note'
70 + ' above regarding left-shifting of return codes.' + default_string)
Michael Walsh7423c012016-10-04 10:27:21 -050071
72parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060073 '--stop_on_plug_in_failure',
Michael Walsh7423c012016-10-04 10:27:21 -050074 default=1,
75 type=int,
76 choices=[1, 0],
George Keishinge635ddc2022-12-08 07:38:02 -060077 help='If this parameter is set to 1, this program will stop and return '
78 + 'non-zero if the call point program from any plug-in directory '
79 + 'fails. Conversely, if it is set to false, this program will run '
80 + 'the call point program from each and every plug-in directory '
81 + 'regardless of their return values. Typical example cases where '
82 + 'you\'d want to run all plug-in call points regardless of success '
83 + 'or failure would be "cleanup" or "ffdc" call points.')
Michael Walsh7423c012016-10-04 10:27:21 -050084
85parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060086 '--stop_on_non_zero_rc',
Michael Walsh7423c012016-10-04 10:27:21 -050087 default=0,
88 type=int,
89 choices=[1, 0],
George Keishinge635ddc2022-12-08 07:38:02 -060090 help='If this parm is set to 1 and a plug-in call point program returns '
91 + 'a valid non-zero return code (see "allow_shell_rc" parm above),'
92 + ' this program will stop processing and return 0 (success). Since'
93 + ' this constitutes a successful exit, this would normally be used'
94 + ' where the caller wishes to stop processing if one of the plug-in'
95 + ' directory call point programs returns a special value indicating'
96 + ' that some special case has been found. An example might be in'
97 + ' calling some kind of "check_errl" call point program. Such a'
98 + ' call point program might return a 2 (i.e. 0x00000200) to indicate'
99 + ' that a given error log entry was found in an "ignore" list and is'
100 + ' therefore to be ignored. That being the case, no other'
101 + ' "check_errl" call point program would need to be called.'
102 + default_string)
Michael Walsh7423c012016-10-04 10:27:21 -0500103
104parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -0600105 '--mch_class',
106 default="obmc",
107 help=mch_class_help_text + default_string)
Michael Walsh7423c012016-10-04 10:27:21 -0500108
Michael Walsh60d08f32019-11-25 16:51:39 -0600109# Populate stock_list with options we want.
Michael Walsh7423c012016-10-04 10:27:21 -0500110stock_list = [("test_mode", 0), ("quiet", 1), ("debug", 0)]
Michael Walsh7423c012016-10-04 10:27:21 -0500111
George Keishinge635ddc2022-12-08 07:38:02 -0600112original_path = os.environ.get('PATH')
Michael Walshde093d22019-12-05 17:00:07 -0600113
Michael Walsh7423c012016-10-04 10:27:21 -0500114
Michael Walsh7423c012016-10-04 10:27:21 -0500115def validate_parms():
Michael Walsh7423c012016-10-04 10:27:21 -0500116 r"""
117 Validate program parameters, etc. Return True or False accordingly.
118 """
119
Michael Walsh60d08f32019-11-25 16:51:39 -0600120 valid_value(call_point)
Michael Walsh7423c012016-10-04 10:27:21 -0500121
Michael Walshed18ec72017-06-27 10:15:31 -0500122 global allow_shell_rc
Michael Walsh60d08f32019-11-25 16:51:39 -0600123 valid_integer(allow_shell_rc)
Michael Walshc33ef372017-01-10 11:46:29 -0600124
125 # Convert to hex string for consistency in printout.
Michael Walshed18ec72017-06-27 10:15:31 -0500126 allow_shell_rc = "0x%08x" % int(allow_shell_rc, 0)
127 set_pgm_arg(allow_shell_rc)
Michael Walshc33ef372017-01-10 11:46:29 -0600128
Michael Walsh7423c012016-10-04 10:27:21 -0500129
George Keishinge635ddc2022-12-08 07:38:02 -0600130def run_pgm(plug_in_dir_path,
131 call_point,
132 allow_shell_rc):
Michael Walsh7423c012016-10-04 10:27:21 -0500133 r"""
Michael Walsh410b1782019-10-22 15:56:18 -0500134 Run the call point program in the given plug_in_dir_path. Return the following:
Michael Walsh7423c012016-10-04 10:27:21 -0500135 rc The return code - 0 = PASS, 1 = FAIL.
Michael Walsh410b1782019-10-22 15:56:18 -0500136 shell_rc The shell return code returned by process_plug_in_packages.py.
Michael Walsh7423c012016-10-04 10:27:21 -0500137 failed_plug_in_name The failed plug in name (if any).
138
139 Description of arguments:
Michael Walsh410b1782019-10-22 15:56:18 -0500140 plug_in_dir_path The directory path where the call_point program may be located.
141 call_point The call point (e.g. "setup"). This program will look for a program
142 named "cp_" + call_point in the plug_in_dir_path. If no such call point
143 program is found, this function returns an rc of 0 (i.e. success).
144 allow_shell_rc The user may supply a value other than zero to indicate an acceptable
145 non-zero return code. For example, if this value equals 0x00000200, it
146 means that for each plug-in call point that runs, a 0x00000200 will not
147 be counted as a failure. See note above regarding left-shifting of
Michael Walsh7423c012016-10-04 10:27:21 -0500148 return codes.
149 """
150
151 rc = 0
152 failed_plug_in_name = ""
153 shell_rc = 0x00000000
154
Michael Walsh97d5b362017-05-30 17:57:38 -0500155 plug_in_name = os.path.basename(os.path.normpath(plug_in_dir_path))
Michael Walsh7423c012016-10-04 10:27:21 -0500156 cp_prefix = "cp_"
157 plug_in_pgm_path = plug_in_dir_path + cp_prefix + call_point
158 if not os.path.exists(plug_in_pgm_path):
Michael Walsh410b1782019-10-22 15:56:18 -0500159 # No such call point in this plug in dir path. This is legal so we return 0, etc.
Michael Walsh7423c012016-10-04 10:27:21 -0500160 return rc, shell_rc, failed_plug_in_name
161
George Keishinge635ddc2022-12-08 07:38:02 -0600162 print("------------------------------------------------- Starting plug-"
163 + "in -----------------------------------------------")
Michael Walsh8c5a8a82018-10-30 13:17:23 -0500164
165 print_timen("Running " + plug_in_name + "/" + cp_prefix + call_point + ".")
Michael Walshb3beaa82019-03-26 16:35:30 -0500166
167 stdout = 1 - quiet
168 if AUTOBOOT_OPENBMC_NICKNAME != "":
169 auto_status_file_prefix = AUTOBOOT_OPENBMC_NICKNAME + "."
Michael Walsh97d5b362017-05-30 17:57:38 -0500170 else:
Michael Walshb3beaa82019-03-26 16:35:30 -0500171 auto_status_file_prefix = ""
172 auto_status_file_prefix += plug_in_name + ".cp_" + call_point
George Keishinge635ddc2022-12-08 07:38:02 -0600173 status_dir_path =\
174 add_trailing_slash(os.environ.get("STATUS_DIR_PATH",
175 os.environ['HOME']
176 + "/status/"))
Michael Walshb3beaa82019-03-26 16:35:30 -0500177 if not os.path.isdir(status_dir_path):
George Keishinge635ddc2022-12-08 07:38:02 -0600178 AUTOBOOT_EXECDIR = \
179 add_trailing_slash(os.environ.get("AUTOBOOT_EXECDIR", ""))
Michael Walshb3beaa82019-03-26 16:35:30 -0500180 status_dir_path = AUTOBOOT_EXECDIR + "logs/"
181 if not os.path.exists(status_dir_path):
182 os.makedirs(status_dir_path)
George Keishinge635ddc2022-12-08 07:38:02 -0600183 status_file_name = auto_status_file_prefix + "." + file_date_time_stamp() \
184 + ".status"
185 auto_status_file_subcmd = "auto_status_file.py --status_dir_path=" \
186 + status_dir_path + " --status_file_name=" + status_file_name \
187 + " --quiet=1 --show_url=1 --prefix=" \
188 + auto_status_file_prefix + " --stdout=" + str(stdout) + " "
Michael Walsh97d5b362017-05-30 17:57:38 -0500189
Michael Walshde093d22019-12-05 17:00:07 -0600190 cmd_buf = "PATH=" + plug_in_dir_path.rstrip("/") + ":${PATH}"
191 print_issuing(cmd_buf)
George Keishinge635ddc2022-12-08 07:38:02 -0600192 os.environ['PATH'] = plug_in_dir_path.rstrip("/") + os.pathsep + original_path
Michael Walshde093d22019-12-05 17:00:07 -0600193 cmd_buf = auto_status_file_subcmd + cp_prefix + call_point
Michael Walsh8c5a8a82018-10-30 13:17:23 -0500194 print_issuing(cmd_buf)
Michael Walsh7423c012016-10-04 10:27:21 -0500195
Michael Walshbe6153b2016-12-09 13:36:22 -0600196 sub_proc = subprocess.Popen(cmd_buf, shell=True)
197 sub_proc.communicate()
Michael Walsh7423c012016-10-04 10:27:21 -0500198 shell_rc = sub_proc.returncode
Michael Walshc33ef372017-01-10 11:46:29 -0600199 # Shift to left.
200 shell_rc *= 0x100
Michael Walshed18ec72017-06-27 10:15:31 -0500201 if shell_rc != 0 and shell_rc != allow_shell_rc:
Michael Walsh7423c012016-10-04 10:27:21 -0500202 rc = 1
Michael Walsh8c5a8a82018-10-30 13:17:23 -0500203 failed_plug_in_name = plug_in_name + "/" + cp_prefix + call_point
Michael Walsh3ba8ecd2018-04-24 11:33:25 -0500204 if shell_rc != 0:
Michael Walsh8c5a8a82018-10-30 13:17:23 -0500205 failed_plug_in_name = plug_in_name + "/" + cp_prefix + call_point
Michael Walshb3beaa82019-03-26 16:35:30 -0500206 if failed_plug_in_name != "" and not stdout:
207 # Use tail to avoid double-printing of status_file_url.
George Keishinge635ddc2022-12-08 07:38:02 -0600208 shell_cmd("tail -n +2 " + status_dir_path + status_file_name, quiet=1,
209 print_output=1)
Michael Walsh7423c012016-10-04 10:27:21 -0500210
George Keishinge635ddc2022-12-08 07:38:02 -0600211 print("------------------------------------------------- Ending plug-in"
212 + " -------------------------------------------------")
Michael Walsh97d5b362017-05-30 17:57:38 -0500213 if failed_plug_in_name != "":
214 print_var(failed_plug_in_name)
Michael Walsh0d5f96a2019-05-20 10:09:57 -0500215 print_var(shell_rc, hexa())
Michael Walsh7423c012016-10-04 10:27:21 -0500216
217 return rc, shell_rc, failed_plug_in_name
218
Michael Walsh7423c012016-10-04 10:27:21 -0500219
Michael Walsh7423c012016-10-04 10:27:21 -0500220def main():
George Keishinge635ddc2022-12-08 07:38:02 -0600221
Michael Walsh60d08f32019-11-25 16:51:39 -0600222 gen_setup()
Michael Walsh7423c012016-10-04 10:27:21 -0500223
George Keishinge635ddc2022-12-08 07:38:02 -0600224 set_term_options(term_requests='children')
Michael Walshde093d22019-12-05 17:00:07 -0600225
Michael Walsh7423c012016-10-04 10:27:21 -0500226 # Access program parameter globals.
227 global plug_in_dir_paths
228 global mch_class
Michael Walshed18ec72017-06-27 10:15:31 -0500229 global allow_shell_rc
Michael Walsh7423c012016-10-04 10:27:21 -0500230 global stop_on_plug_in_failure
231 global stop_on_non_zero_rc
232
George Keishinge635ddc2022-12-08 07:38:02 -0600233 plug_in_packages_list = return_plug_in_packages_list(plug_in_dir_paths,
234 mch_class)
Michael Walsh7423c012016-10-04 10:27:21 -0500235
Michael Walsh0d5f96a2019-05-20 10:09:57 -0500236 qprint_var(plug_in_packages_list)
Michael Walsh7423c012016-10-04 10:27:21 -0500237 qprint("\n")
238
Michael Walshed18ec72017-06-27 10:15:31 -0500239 allow_shell_rc = int(allow_shell_rc, 0)
Michael Walsha6723f22016-11-22 11:12:01 -0600240 shell_rc = 0
Michael Walsh7423c012016-10-04 10:27:21 -0500241 failed_plug_in_name = ""
242
Michael Walsh97d5b362017-05-30 17:57:38 -0500243 global AUTOBOOT_OPENBMC_NICKNAME
Michael Walshb3beaa82019-03-26 16:35:30 -0500244 AUTOBOOT_OPENBMC_NICKNAME = os.environ.get("AUTOBOOT_OPENBMC_NICKNAME", "")
245
Michael Walsh7423c012016-10-04 10:27:21 -0500246 ret_code = 0
247 for plug_in_dir_path in plug_in_packages_list:
George Keishinge635ddc2022-12-08 07:38:02 -0600248 rc, shell_rc, failed_plug_in_name = \
249 run_pgm(plug_in_dir_path, call_point, allow_shell_rc)
Michael Walsh7423c012016-10-04 10:27:21 -0500250 if rc != 0:
251 ret_code = 1
252 if stop_on_plug_in_failure:
253 break
254 if shell_rc != 0 and stop_on_non_zero_rc:
George Keishinge635ddc2022-12-08 07:38:02 -0600255 qprint_time("Stopping on non-zero shell return code as requested"
256 + " by caller.\n")
Michael Walsh7423c012016-10-04 10:27:21 -0500257 break
258
Michael Walsh60d08f32019-11-25 16:51:39 -0600259 if ret_code != 0:
Michael Walsh8c5a8a82018-10-30 13:17:23 -0500260 print_error("At least one plug-in failed.\n")
Michael Walsh60d08f32019-11-25 16:51:39 -0600261 exit(1)
Michael Walsh7423c012016-10-04 10:27:21 -0500262
Michael Walsh7423c012016-10-04 10:27:21 -0500263
Michael Walsh60d08f32019-11-25 16:51:39 -0600264main()