def init_robot_out_parms(extra_prefix=""):
r"""
Initialize robot output parms such as outputdir, output, etc.
This function will set global values for the following robot output parms.
outputdir, output, log, report, loglevel, consolecolors, consolemarkers
This function would typically be called prior to calling create_robot_cmd_string.
Description of argument(s):
extra_prefix An extra prefix to be appended to the default prefix for output file
names.
"""
gp.dprint_executing()
AUTOBOOT_OPENBMC_NICKNAME = gm.get_mod_global("AUTOBOOT_OPENBMC_NICKNAME")
# Set values for call to create_robot_cmd_string.
# Environment variable TMP_ROBOT_DIR_PATH can be set by the user to indicate that robot-generated output
# should initially be written to the specified temporary directory and then moved to the normal output
# location after completion.
outputdir =\
os.environ.get("TMP_ROBOT_DIR_PATH",
os.environ.get("STATUS_DIR_PATH",
os.environ.get("HOME", ".")
+ "/status"))
outputdir = gm.add_trailing_slash(outputdir)
seconds = time.time()
loc_time = time.localtime(seconds)
time_string = time.strftime("%y%m%d.%H%M%S", loc_time)
file_prefix = AUTOBOOT_OPENBMC_NICKNAME + "." + extra_prefix +\
time_string + "."
# Environment variable SAVE_STATUS_POLICY governs when robot-generated output files (e.g. the log.html)
# will be moved from TMP_ROBOT_DIR_PATH to FFDC_DIR_PATH. Valid values are "ALWAYS", "NEVER" and "FAIL".
SAVE_STATUS_POLICY = os.environ.get("SAVE_STATUS_POLICY", "ALWAYS")
if SAVE_STATUS_POLICY == "NEVER":
output = "NONE"
log = "NONE"
report = "NONE"
else:
output = file_prefix + "output.xml"
log = file_prefix + "log.html"
report = file_prefix + "report.html"
loglevel = "TRACE"
consolecolors = 'off'
consolemarkers = 'off'
# Make create_robot_cmd_string values global.
gm.set_mod_global(outputdir)
gm.set_mod_global(output)
gm.set_mod_global(log)
gm.set_mod_global(report)
gm.set_mod_global(loglevel)
gm.set_mod_global(consolecolors)
gm.set_mod_global(consolemarkers)
return outputdir, output, log, report, loglevel, consolecolors, consolemarkers
def gen_signal_handler(signal_number, frame):
r"""
Handle signals. Without a function to catch a SIGTERM or SIGINT, the program would terminate immediately
with return code 143 and without calling the exit_function.
"""
# The convention is to set up exit_function with atexit.register() so there is no need to explicitly
# call exit_function from here.
gp.dprint_executing()
# Calling exit prevents control from returning to the code that was running when the signal was received.
exit(0)
def init_robot_out_parms(extra_prefix=""):
r"""
Initialize robot output parms such as outputdir, output, etc.
This function will set global values for the following robot output parms.
outputdir, output, log, report, loglevel
This function would typically be called prior to calling
create_robot_cmd_string.
"""
gp.dprint_executing()
AUTOBOOT_OPENBMC_NICKNAME = gm.get_mod_global("AUTOBOOT_OPENBMC_NICKNAME")
# Set values for call to create_robot_cmd_string.
# Environment variable TMP_ROBOT_DIR_PATH can be set by the user to
# indicate that robot-generated output should initially be written to the
# specified temporary directory and then moved to the normal output
# location after completion.
outputdir =\
os.environ.get("TMP_ROBOT_DIR_PATH",
os.environ.get("STATUS_DIR_PATH",
os.environ.get("HOME", ".")
+ "/autoipl/status"))
outputdir = gm.add_trailing_slash(outputdir)
seconds = time.time()
loc_time = time.localtime(seconds)
time_string = time.strftime("%y%m%d.%H%M%S", loc_time)
file_prefix = AUTOBOOT_OPENBMC_NICKNAME + "." + extra_prefix +\
time_string + "."
# Environment variable SAVE_STATUS_POLICY governs when robot-generated
# output files (e.g. the log.html) will be moved from TMP_ROBOT_DIR_PATH
# to FFDC_DIR_PATH. Valid values are "ALWAYS", "NEVER" and "FAIL".
SAVE_STATUS_POLICY = os.environ.get("SAVE_STATUS_POLICY", "ALWAYS")
if SAVE_STATUS_POLICY == "NEVER":
output = "NONE"
log = "NONE"
report = "NONE"
else:
output = file_prefix + "output.xml"
log = file_prefix + "log.html"
report = file_prefix + "report.html"
loglevel = "TRACE"
# Make create_robot_cmd_string values global.
gm.set_mod_global(outputdir)
gm.set_mod_global(output)
gm.set_mod_global(log)
gm.set_mod_global(report)
gm.set_mod_global(loglevel)
def validate_plug_in_package(plug_in_dir_path,
mch_class="obmc"):
r"""
Validate the plug in package and return the normalized plug-in directory
path.
Description of arguments:
plug_in_dir_path The "relative" or absolute path to a plug
in package directory.
mch_class The class of machine that we are testing
(e.g. "op" = "open power", "obmc" = "open
bmc", etc).
"""
gp.dprint_executing()
if os.path.isabs(plug_in_dir_path):
# plug_in_dir_path begins with a slash so it is an absolute path.
candidate_plug_in_dir_path = os.path.normpath(plug_in_dir_path) +\
os.sep
if not os.path.isdir(candidate_plug_in_dir_path):
gp.print_error_report("Plug-in directory path \"" +
plug_in_dir_path + "\" does not exist.\n")
exit(1)
else:
# The plug_in_dir_path is actually a simple name (e.g.
# "OBMC_Sample")...
candidate_plug_in_dir_path = find_plug_in_package(plug_in_dir_path)
if candidate_plug_in_dir_path == "":
global PATH_LIST
gp.print_error_report("Plug-in directory path \"" +
plug_in_dir_path + "\" could not be found" +
" in any of the following directories:\n" +
gp.sprint_var(PATH_LIST))
exit(1)
# Make sure that this plug-in supports us...
supports_file_path = candidate_plug_in_dir_path + "supports_" + mch_class
if not os.path.exists(supports_file_path):
gp.print_error_report("The following file path could not be" +
" found:\n" +
gp.sprint_varx("supports_file_path",
supports_file_path) +
"\nThis file is necessary to indicate that" +
" the given plug-in supports the class of" +
" machine we are testing, namely \"" +
mch_class + "\".\n")
exit(1)
return candidate_plug_in_dir_path
def validate_plug_in_package(plug_in_dir_path,
mch_class="obmc"):
r"""
Validate the plug in package and return the normalized plug-in directory
path.
Description of arguments:
plug_in_dir_path The "relative" or absolute path to a plug
in package directory.
mch_class The class of machine that we are testing
(e.g. "op" = "open power", "obmc" = "open
bmc", etc).
"""
gp.dprint_executing()
if os.path.isabs(plug_in_dir_path):
# plug_in_dir_path begins with a slash so it is an absolute path.
candidate_plug_in_dir_path = os.path.normpath(plug_in_dir_path) +\
os.sep
if not os.path.isdir(candidate_plug_in_dir_path):
gp.print_error_report("Plug-in directory path \"" +
plug_in_dir_path + "\" does not exist.\n")
exit(1)
else:
# The plug_in_dir_path is actually a simple name (e.g.
# "OBMC_Sample")...
candidate_plug_in_dir_path = find_plug_in_package(plug_in_dir_path)
if candidate_plug_in_dir_path == "":
global PATH_LIST
gp.print_error_report("Plug-in directory path \"" +
plug_in_dir_path + "\" could not be found" +
" in any of the following directories:\n" +
gp.sprint_var(PATH_LIST))
exit(1)
# Make sure that this plug-in supports us...
supports_file_path = candidate_plug_in_dir_path + "supports_" + mch_class
if not os.path.exists(supports_file_path):
gp.print_error_report("The following file path could not be" +
" found:\n" +
gp.sprint_varx("supports_file_path",
supports_file_path) +
"\nThis file is necessary to indicate that" +
" the given plug-in supports the class of" +
" machine we are testing, namely \"" +
mch_class + "\".\n")
exit(1)
return candidate_plug_in_dir_path
def gen_exit_function(signal_number=0, frame=None):
r"""
Execute whenever the program ends normally or with the signals that we catch (i.e. TERM, INT).
"""
gp.dprint_executing()
gp.dprint_var(signal_number)
# Call the main module's exit_function if it is defined.
exit_function = getattr(module, "exit_function", None)
if exit_function:
exit_function(signal_number, frame)
gp.qprint_pgm_footer()
def shell_cmd_timed_out(signal_number, frame):
r"""
Handle an alarm signal generated during the shell_cmd function.
"""
gp.dprint_executing()
# Get subprocess pid from shell_cmd's call stack.
sub_proc = gp.get_stack_var('sub_proc', 0)
pid = sub_proc.pid
# Terminate the child process.
os.kill(pid, signal.SIGTERM)
# Restore the original SIGALRM handler.
signal.signal(signal.SIGALRM, original_sigalrm_handler)
return
def gen_exit_function(signal_number=0, frame=None):
r"""
Execute whenever the program ends normally or with the signals that we catch (i.e. TERM, INT).
"""
gp.dprint_executing()
gp.dprint_var(signal_number)
# ignore_err influences the way shell_cmd processes errors. Since we're doing exit processing, we don't
# want to stop the program due to a shell_cmd failure.
ignore_err = 1
# Call the main module's exit_function if it is defined.
exit_function = getattr(module, "exit_function", None)
if exit_function:
exit_function(signal_number, frame)
gp.qprint_pgm_footer()
def execute_ssh_command(cmd_buf,
open_connection_args={},
login_args={},
print_out=0,
print_err=0,
ignore_err=1,
fork=0,
quiet=None,
test_mode=None):
r"""
Run the given command in an SSH session and return the stdout, stderr and
the return code.
If there is no open SSH connection, this function will connect and login.
Likewise, if the caller has not yet logged in to the connection, this
function will do the login.
Description of arguments:
cmd_buf The command string to be run in an SSH
session.
open_connection_args A dictionary of arg names and values which
are legal to pass to the SSHLibrary
open_connection function as parms/args.
At a minimum, this should contain a 'host'
entry.
login_args A dictionary containing the key/value
pairs which are acceptable to the
SSHLibrary login function as parms/args.
At a minimum, this should contain a
'username' and a 'password' entry.
print_out If this is set, this function will print
the stdout/stderr generated by the shell
command.
print_err If show_err is set, this function will
print a standardized error report if the
shell command returns non-zero.
ignore_err Indicates that errors encountered on the
sshlib.execute_command are to be ignored.
fork Indicates that sshlib.start is to be used
rather than sshlib.execute_command.
quiet Indicates whether this function should run
the pissuing() function which prints an
"Issuing: <cmd string>" to stdout. This
defaults to the global quiet value.
test_mode If test_mode is set, this function will
not actually run the command. This
defaults to the global test_mode value.
"""
gp.dprint_executing()
# Obtain default values.
quiet = int(gp.get_var_value(quiet, 0))
test_mode = int(gp.get_var_value(test_mode, 0))
if not quiet:
gp.pissuing(cmd_buf, test_mode)
if test_mode:
return "", "", 0
global sshlib
# Look for existing SSH connection.
# Prepare a search connection dictionary.
search_connection_args = open_connection_args.copy()
# Remove keys that don't work well for searches.
search_connection_args.pop("timeout", None)
connection = find_connection(search_connection_args)
if connection:
gp.dprint_timen("Found the following existing connection:")
gp.dprintn(sprint_connection(connection))
if connection.alias == "":
index_or_alias = connection.index
else:
index_or_alias = connection.alias
gp.dprint_timen("Switching to existing connection: \"" +
str(index_or_alias) + "\".")
sshlib.switch_connection(index_or_alias)
else:
gp.dprint_timen("Connecting to " + open_connection_args['host'] + ".")
cix = sshlib.open_connection(**open_connection_args)
login_ssh(login_args)
max_exec_cmd_attempts = 2
for exec_cmd_attempt_num in range(1, max_exec_cmd_attempts + 1):
gp.dprint_var(exec_cmd_attempt_num)
try:
if fork:
sshlib.start_command(cmd_buf)
else:
stdout, stderr, rc = sshlib.execute_command(cmd_buf,
return_stdout=True,
return_stderr=True,
return_rc=True)
except Exception as execute_exception:
except_type, except_value, except_traceback = sys.exc_info()
gp.dprint_var(except_type)
gp.dprint_varx("except_value", str(except_value))
if except_type is exceptions.AssertionError and\
re.match(r"Connection not open", str(except_value)):
login_ssh(login_args)
# Now we must continue to next loop iteration to retry the
# execute_command.
continue
if (except_type is paramiko.ssh_exception.SSHException and
re.match(r"SSH session not active", str(except_value))) or\
(except_type is socket.error and
re.match(r"\[Errno 104\] Connection reset by peer",
str(except_value))):
# Close and re-open a connection.
# Note: close_connection() doesn't appear to get rid of the
# connection. It merely closes it. Since there is a concern
# about over-consumption of resources, we use
# close_all_connections() which also gets rid of all
# connections.
gp.dprint_timen("Closing all connections.")
sshlib.close_all_connections()
gp.dprint_timen("Connecting to " +
open_connection_args['host'] + ".")
cix = sshlib.open_connection(**open_connection_args)
login_ssh(login_args)
continue
# We do not handle any other RuntimeErrors so we will raise the
# exception again.
raise (execute_exception)
# If we get to this point, the command was executed.
break
if fork:
return
if rc != 0 and print_err:
gp.print_var(rc, 1)
if not print_out:
gp.print_var(stderr)
gp.print_var(stdout)
if print_out:
gp.printn(stderr + stdout)
if not ignore_err:
message = gp.sprint_error("The prior SSH" +
" command returned a non-zero return" +
" code:\n" + gp.sprint_var(rc, 1) + stderr +
"\n")
BuiltIn().should_be_equal(rc, 0, message)
return stdout, stderr, rc
