def exit_not_master():
r"""
Exit the program with return code zero if this program was NOT called by the master program.
There are cases where plug-ins are called by a multi-layered stack:
master_wrapper
obmc_boot_test.py
Example_plug_in/cp_setup
In a scenario like this, Example_plug_in/cp_setup may be called once directly by master_wrapper (the
master) and and then called again directly by obmc_boot_test.py (the child). Some plug-in programs may
wish to avoid doing any processing on the second such call. This function will achieve that purpose.
This function will print a standard message to stdout prior to exiting.
"""
AUTOBOOT_MASTER_PID = gm.get_mod_global("AUTOBOOT_MASTER_PID")
AUTOBOOT_PROGRAM_PID = gm.get_mod_global("AUTOBOOT_PROGRAM_PID")
if AUTOBOOT_MASTER_PID != AUTOBOOT_PROGRAM_PID:
message = get_plug_in_package_name() + "/" + gp.pgm_name + " is not" \
+ " being called by the master program in the stack so no action" \
+ " will be taken."
gp.qprint_timen(message)
gp.qprint_vars(AUTOBOOT_MASTER_PID, AUTOBOOT_PROGRAM_PID)
exit(0)
def add_tarball_tools_dir_to_path(quiet=0):
r"""
Find the directory containing the tarball tools and pre-pend it to PATH.
The calling program is responsible for making sure that the tarball has been unpacked.
"""
AUTOBOOT_BASE_TOOL_DIR_PATH = gm.get_mod_global("AUTOBOOT_BASE_TOOL_DIR_PATH")
AUTOBOOT_OPENBMC_NICKNAME = gm.get_mod_global("AUTOBOOT_OPENBMC_NICKNAME")
tool_dir_path = AUTOBOOT_BASE_TOOL_DIR_PATH + os.environ.get('USER') + os.sep \
+ AUTOBOOT_OPENBMC_NICKNAME + os.sep
tarball_tools_dir_path = tool_dir_path + 'tarball/x86/bin'
os.environ['PATH'] = gm.add_path(tarball_tools_dir_path, os.environ.get('PATH', ''))
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 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 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.
"""
AUTOBOOT_OPENBMC_NICKNAME = gm.get_mod_global("AUTOBOOT_OPENBMC_NICKNAME")
FFDC_DIR_PATH_STYLE = os.environ.get('FFDC_DIR_PATH_STYLE', '0')
if FFDC_DIR_PATH_STYLE == '1':
default_ffdc_dir_path = "/tmp/"
else:
default_ffdc_dir_path = base_path
# Set values for call to create_robot_cmd_string.
outputdir = gm.add_trailing_slash(
os.environ.get("FFDC_DIR_PATH", default_ffdc_dir_path))
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 + "."
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 return_plug_vars(general=True, custom=True, plug_in_package_name=None):
r"""
Return an OrderedDict which is sorted by key and which contains all of the plug-in environment variables.
Example excerpt of resulting dictionary:
plug_var_dict:
[AUTOBOOT_BASE_TOOL_DIR_PATH]: /tmp/
[AUTOBOOT_BB_LEVEL]: <blank>
[AUTOBOOT_BOOT_FAIL]: 0
...
This function also does the following:
- Set a default value for environment variable AUTOBOOT_OPENBMC_NICKNAME/AUTOIPL_FSP1_NICKNAME if it is
not already set.
- Register PASSWORD variables to prevent their values from being printed.
Note: The programmer may set a default for any given environment variable by declaring a global variable
of the same name and setting its value. For example, let's say the calling program has this global
declaration:
PERF_EXERCISERS_TOTAL_TIMEOUT = '180'
If environment variable PERF_EXERCISERS_TOTAL_TIMEOUT is blank or not set, this function will set it to
'180'.
Furthermore, if such a default variable declaration is not a string, this function will preserve that
non-string type in setting global variables (with the exception of os.environ values which must be
string). Example:
NVDIMM_ENCRYPT = 0
Description of argument(s):
general Return general plug-in parms (e.g. those beginning with "AUTOBOOT" or
"AUTOGUI").
custom Return custom plug-in parms (i.e. those beginning with the upper case
name of the plug-in package, for example "OBMC_SAMPLE_PARM1").
plug_in_package_name The name of the plug-in package for which custom parms are to be
returned. The default is the current plug in package name.
"""
regex_list = []
if not (general or custom):
return collections.OrderedDict()
plug_in_package_name = gm.dft(plug_in_package_name,
get_plug_in_package_name())
if general:
regex_list = [PLUG_VAR_PREFIX, "AUTOGUI"]
if custom:
regex_list.append(plug_in_package_name.upper())
regex = "^(" + "|".join(regex_list) + ")_"
# Set a default for nickname.
if os.environ.get("AUTOBOOT_OPENBMC_NICKNAME", "") == "":
os.environ['AUTOBOOT_OPENBMC_NICKNAME'] = \
os.environ.get("AUTOBOOT_OPENBMC_HOST", "")
if os.environ.get("AUTOIPL_FSP1_NICKNAME", "") == "":
os.environ['AUTOIPL_FSP1_NICKNAME'] = \
os.environ.get("AUTOIPL_FSP1_NAME", "").split(".")[0]
# For all variables specified in the parm_def file, we want them to default to "" rather than being unset.
# Process the parm_def file if it exists.
parm_def_file_path = os.path.dirname(gp.pgm_dir_path.rstrip("/")) + "/" + plug_in_package_name \
+ "/parm_def"
if os.path.exists(parm_def_file_path):
parm_defs = gm.my_parm_file(parm_def_file_path)
else:
parm_defs = collections.OrderedDict()
# Example parm_defs:
# parm_defs:
# parm_defs[rest_fail]: boolean
# parm_defs[command]: string
# parm_defs[esel_stop_file_path]: string
# Create a list of plug-in environment variables by pre-pending <all caps plug-in package name>_<all
# caps var name>
plug_in_parm_names = [
plug_in_package_name.upper() + "_" + x
for x in map(str.upper, parm_defs.keys())
]
# Example plug_in_parm_names:
# plug_in_parm_names:
# plug_in_parm_names[0]: STOP_REST_FAIL
# plug_in_parm_names[1]: STOP_COMMAND
# plug_in_parm_names[2]: STOP_ESEL_STOP_FILE_PATH
# os.environ only accepts string values. However, if the user defines default values of other types
# (e.g. int), we wish to preserve the type.
non_string_defaults = {}
# Initialize unset plug-in vars.
for var_name in plug_in_parm_names:
# If there is a global variable with the same name as the environment variable, use its value as a
# default.
default_value = gm.get_mod_global(var_name, "")
if type(default_value) is not str:
non_string_defaults[var_name] = type(default_value)
os.environ[var_name] = os.environ.get(var_name, str(default_value))
if os.environ[var_name] == "":
os.environ[var_name] = str(default_value)
plug_var_dict = \
collections.OrderedDict(sorted({k: v for (k, v) in
os.environ.items()
if re.match(regex, k)}.items()))
# Restore the types of any variables where the caller had defined default values.
for key, value in non_string_defaults.items():
cmd_buf = "plug_var_dict[key] = " + str(value).split(
"'")[1] + "(plug_var_dict[key]"
if value is int:
# Use int base argument of 0 to allow it to interpret hex strings.
cmd_buf += ", 0)"
else:
cmd_buf += ")"
exec(cmd_buf) in globals(), locals()
# Register password values to prevent printing them out. Any plug var whose name ends in PASSWORD will
# be registered.
password_vals = {
k: v
for (k, v) in plug_var_dict.items() if re.match(r".*_PASSWORD$", k)
}.values()
map(gp.register_passwords, password_vals)
return plug_var_dict
def return_plug_vars(general=True, custom=True):
r"""
Return an OrderedDict which is sorted by key and which contains all of the
plug-in environment variables.
Example excerpt of resulting dictionary:
plug_var_dict:
[AUTOBOOT_BASE_TOOL_DIR_PATH]: /tmp/
[AUTOBOOT_BB_LEVEL]: <blank>
[AUTOBOOT_BOOT_FAIL]: 0
...
This function also does the following:
- Set a default value for environment variable
AUTOBOOT_OPENBMC_NICKNAME/AUTOIPL_FSP1_NICKNAME if it is not already set.
- Register PASSWORD variables to prevent their values from being printed.
Note: The programmer may set a default for any given environment variable
by declaring a global variable of the same name and setting its value.
For example, let's say the calling program has this global declaration:
PERF_EXERCISERS_TOTAL_TIMEOUT = '180'
If environment variable PERF_EXERCISERS_TOTAL_TIMEOUT is blank or not set,
this function will set it to 180.
Description of argument(s):
general Return general plug-in parms (e.g. those
beginning with "AUTOBOOT" or "AUTOGUI").
custom Return custom plug-in parms (i.e. those
beginning with the upper case name of the
plug-in package, for example
"OBMC_SAMPLE_PARM1").
"""
regex_list = []
if not (general or custom):
return collections.OrderedDict()
plug_in_package_name = get_plug_in_package_name(case="upper")
if general:
regex_list = [PLUG_VAR_PREFIX, "AUTOGUI"]
if custom:
regex_list.append(plug_in_package_name)
regex = "^(" + "|".join(regex_list) + ")_"
# Set a default for nickname.
if os.environ.get("AUTOBOOT_OPENBMC_NICKNAME", "") == "":
os.environ['AUTOBOOT_OPENBMC_NICKNAME'] = \
os.environ.get("AUTOBOOT_OPENBMC_HOST", "")
if os.environ.get("AUTOIPL_FSP1_NICKNAME", "") == "":
os.environ['AUTOIPL_FSP1_NICKNAME'] = \
os.environ.get("AUTOIPL_FSP1_NAME", "").split(".")[0]
# For all variables specified in the parm_def file, we want them to
# default to "" rather than being unset.
# Process the parm_def file if it exists.
parm_def_file_path = gp.pgm_dir_path + "parm_def"
if os.path.exists(parm_def_file_path):
parm_defs = gm.my_parm_file(parm_def_file_path)
else:
parm_defs = collections.OrderedDict()
# Example parm_defs:
# parm_defs:
# parm_defs[rest_fail]: boolean
# parm_defs[command]: string
# parm_defs[esel_stop_file_path]: string
# Create a list of plug-in environment variables by pre-pending <all caps
# plug-in package name>_<all caps var name>
plug_in_parm_names = [
plug_in_package_name + "_" + x
for x in map(str.upper, parm_defs.keys())
]
# Example plug_in_parm_names:
# plug_in_parm_names:
# plug_in_parm_names[0]: STOP_REST_FAIL
# plug_in_parm_names[1]: STOP_COMMAND
# plug_in_parm_names[2]: STOP_ESEL_STOP_FILE_PATH
# Initialize unset plug-in vars.
for var_name in plug_in_parm_names:
# If there is a global variable with the same name as the environment
# variable, use its value as a default.
default_value = gm.get_mod_global(var_name, "")
os.environ[var_name] = os.environ.get(var_name, default_value)
if os.environ[var_name] == "":
os.environ[var_name] = default_value
plug_var_dict = \
collections.OrderedDict(sorted({k: v for (k, v) in
os.environ.items()
if re.match(regex, k)}.items()))
# Register password values to prevent printing them out. Any plug var
# whose name ends in PASSWORD will be registered.
password_vals = {
k: v
for (k, v) in plug_var_dict.items() if re.match(r".*_PASSWORD$", k)
}.values()
map(gp.register_passwords, password_vals)
return plug_var_dict
def robot_cmd_fnc(robot_cmd_buf,
robot_jail=os.environ.get('ROBOT_JAIL', ''),
gzip=1):
r"""
Run the robot command string.
This function will set the various PATH variables correctly so that you
are running the proper version of all imported files, etc.
Description of argument(s):
robot_cmd_buf The complete robot command string.
robot_jail Indicates that this is to run in "robot
jail" meaning without visibility to any
apolloxxx import files, programs, etc.
gqip This indicates that the log, report and
output files produced by robot should be
gzipped to save space.
"""
if not gv.valid_value(robot_cmd_buf):
return False
# Set global variables to aid in cleanup with process_robot_output_files.
global gcr_last_robot_cmd_buf
global gcr_last_robot_rc
gcr_last_robot_cmd_buf = robot_cmd_buf
# Get globals set by init_robot_test_base_dir_path().
module = sys.modules["__main__"]
try:
ROBOT_TEST_BASE_DIR_PATH = getattr(module, "ROBOT_TEST_BASE_DIR_PATH")
except NameError:
init_robot_test_base_dir_path()
ROBOT_TEST_BASE_DIR_PATH = getattr(module, "ROBOT_TEST_BASE_DIR_PATH")
ROBOT_TEST_RUNNING_FROM_SB = \
gm.get_mod_global("ROBOT_TEST_RUNNING_FROM_SB")
if robot_jail == "":
if ROBOT_TEST_RUNNING_FROM_SB:
robot_jail = 0
else:
robot_jail = 1
robot_jail = int(robot_jail)
ROBOT_JAIL = os.environ.get('ROBOT_JAIL', '')
gp.dprint_vars(ROBOT_TEST_BASE_DIR_PATH, ROBOT_TEST_RUNNING_FROM_SB,
ROBOT_JAIL, robot_jail)
# Save PATH and PYTHONPATH to be restored later.
os.environ["SAVED_PYTHONPATH"] = os.environ.get("PYTHONPATH", "")
os.environ["SAVED_PATH"] = os.environ.get("PATH", "")
if robot_jail:
PYTHONPATH = ROBOT_TEST_BASE_DIR_PATH + "lib"
NEW_PATH_LIST = [ROBOT_TEST_BASE_DIR_PATH + "bin"]
# Coding special case to preserve python27_path.
python27_path = "/opt/rh/python27/root/usr/bin"
PATH_LIST = os.environ.get("PATH", "").split(":")
if python27_path in PATH_LIST:
NEW_PATH_LIST.append(python27_path)
NEW_PATH_LIST.extend(["/usr/local/sbin", "/usr/local/bin", "/usr/sbin",
"/usr/bin", "/sbin", "/bin"])
PATH = ":".join(NEW_PATH_LIST)
else:
PYTHONPATH = os.environ.get('PYTHONPATH', '') + ":" +\
ROBOT_TEST_BASE_DIR_PATH + "lib/"
PATH = os.environ.get('PATH', '') + ":" + ROBOT_TEST_BASE_DIR_PATH +\
"bin/"
os.environ['PYTHONPATH'] = PYTHONPATH
os.environ['PATH'] = PATH
gp.dprint_vars(PATH, PYTHONPATH)
os.environ['FFDC_DIR_PATH_STYLE'] = os.environ.get('FFDC_DIR_PATH_STYLE',
'1')
test_mode = getattr(module, "test_mode")
gp.qpissuing(robot_cmd_buf, test_mode)
if test_mode:
os.environ["PATH"] = os.environ.get("SAVED_PATH", "")
os.environ["PYTHONPATH"] = os.environ.get("SAVED_PYTHONPATH", "")
return True
if quiet:
DEVNULL = open(os.devnull, 'wb')
stdout = DEVNULL
else:
stdout = None
sub_proc = subprocess.Popen(robot_cmd_buf, stdout=stdout, shell=True)
sub_proc.communicate()
shell_rc = sub_proc.returncode
os.environ["PATH"] = os.environ.get("SAVED_PATH", "")
os.environ["PYTHONPATH"] = os.environ.get("SAVED_PYTHONPATH", "")
gcr_last_robot_rc = shell_rc
process_robot_output_files()
if shell_rc != 0:
hex = 1
gp.print_var(shell_rc, hex)
return False
return True
def robot_cmd_fnc(robot_cmd_buf,
robot_jail=os.environ.get('ROBOT_JAIL', ''),
quiet=None,
test_mode=0):
r"""
Run the robot command string.
This function will set the various PATH variables correctly so that you are running the proper version of
all imported files, etc.
Description of argument(s):
robot_cmd_buf The complete robot command string.
robot_jail Indicates that this is to run in "robot jail" meaning without visibility
to any apolloxxx import files, programs, etc.
test_mode If test_mode is set, this function will not actually run the command.
"""
quiet = int(gm.dft(quiet, gp.get_stack_var('quiet', 0)))
gv.valid_value(robot_cmd_buf)
# Set global variables to aid in cleanup with process_robot_output_files.
global gcr_last_robot_cmd_buf
global gcr_last_robot_rc
gcr_last_robot_cmd_buf = robot_cmd_buf
# Get globals set by init_robot_test_base_dir_path().
module = sys.modules["__main__"]
try:
ROBOT_TEST_BASE_DIR_PATH = getattr(module, "ROBOT_TEST_BASE_DIR_PATH")
except NameError:
init_robot_test_base_dir_path()
ROBOT_TEST_BASE_DIR_PATH = getattr(module, "ROBOT_TEST_BASE_DIR_PATH")
ROBOT_TEST_RUNNING_FROM_SB = gm.get_mod_global(
"ROBOT_TEST_RUNNING_FROM_SB")
OPENBMCTOOL_DIR_PATH = gm.get_mod_global("OPENBMCTOOL_DIR_PATH")
if robot_jail == "":
if ROBOT_TEST_RUNNING_FROM_SB:
robot_jail = 0
else:
robot_jail = 1
robot_jail = int(robot_jail)
ROBOT_JAIL = os.environ.get('ROBOT_JAIL', '')
gp.dprint_vars(ROBOT_TEST_BASE_DIR_PATH, ROBOT_TEST_RUNNING_FROM_SB,
ROBOT_JAIL, robot_jail)
# Save PATH and PYTHONPATH to be restored later.
os.environ["SAVED_PYTHONPATH"] = os.environ.get("PYTHONPATH", "")
os.environ["SAVED_PATH"] = os.environ.get("PATH", "")
if robot_jail:
# Make sure required programs like python and robot can be found in the new restricted PATH.
required_programs = "python robot"
# It is expected that there will be a "python" program in the tool base bin path which is really a
# link to select_version. Ditto for "robot". Call each with the --print_only option to get the
# paths to the "real" programs.
cmd_buf = "for program in " + required_programs \
+ " ; do dirname $(${program} --print_only) ; done 2>/dev/null"
rc, out_buf = gc.shell_cmd(cmd_buf, quiet=1, print_output=0)
PYTHONPATH = ROBOT_TEST_BASE_DIR_PATH + "lib"
NEW_PATH_LIST = [ROBOT_TEST_BASE_DIR_PATH + "bin"]
NEW_PATH_LIST.extend(list(set(out_buf.rstrip("\n").split("\n"))))
NEW_PATH_LIST.extend([
"/usr/local/sbin", "/usr/local/bin", "/usr/sbin", "/usr/bin",
"/sbin", "/bin",
OPENBMCTOOL_DIR_PATH.rstrip('/')
])
PATH = ":".join(NEW_PATH_LIST)
else:
PYTHONPATH = os.environ.get('PYTHONPATH', '') + ":" +\
ROBOT_TEST_BASE_DIR_PATH + "lib"
PATH = os.environ.get('PATH', '') + ":" + ROBOT_TEST_BASE_DIR_PATH +\
"bin" + ":" + OPENBMCTOOL_DIR_PATH.rstrip('/')
os.environ['PYTHONPATH'] = PYTHONPATH
os.environ['PATH'] = PATH
gp.dprint_vars(PATH, PYTHONPATH)
os.environ['FFDC_DIR_PATH_STYLE'] = os.environ.get('FFDC_DIR_PATH_STYLE',
'1')
gp.qpissuing(robot_cmd_buf, test_mode)
if test_mode:
os.environ["PATH"] = os.environ.get("SAVED_PATH", "")
os.environ["PYTHONPATH"] = os.environ.get("SAVED_PYTHONPATH", "")
return True
if quiet:
DEVNULL = open(os.devnull, 'wb')
stdout = DEVNULL
else:
stdout = None
sub_proc = subprocess.Popen(robot_cmd_buf, stdout=stdout, shell=True)
sub_proc.communicate()
shell_rc = sub_proc.returncode
os.environ["PATH"] = os.environ.get("SAVED_PATH", "")
os.environ["PYTHONPATH"] = os.environ.get("SAVED_PYTHONPATH", "")
gcr_last_robot_rc = shell_rc
process_robot_output_files()
if shell_rc != 0:
gp.print_var(shell_rc, gp.hexa())
return False
return True
def return_plug_vars():
r"""
Return an OrderedDict which is sorted by key and which contains all of the
plug-in environment variables.
Example excerpt of resulting dictionary:
plug_var_dict:
[AUTOBOOT_BASE_TOOL_DIR_PATH]: /fspmount/
[AUTOBOOT_BB_LEVEL]: <blank>
[AUTOBOOT_BOOT_FAIL]: 0
...
This function also does the following:
- Set a default value for environment variable
AUTOBOOT_OPENBMC_NICKNAME/AUTOIPL_FSP1_NICKNAME if it is not already set.
- Register PASSWORD variables to prevent their values from being printed.
Note: The programmer may set a default for any given environment variable
by declaring a global variable of the same name and setting its value.
For example, let's say the calling program has this global declaration:
PERF_EXERCISERS_TOTAL_TIMEOUT = '180'
If environment variable PERF_EXERCISERS_TOTAL_TIMEOUT is blank or not set,
this function will set it to 180.
"""
plug_in_package_name = get_plug_in_package_name(case="upper")
regex = "^(" + PLUG_VAR_PREFIX + "|AUTOGUI|" + plug_in_package_name + ")_"
# Set a default for nickname.
if os.environ.get("AUTOBOOT_OPENBMC_NICKNAME", "") == "":
os.environ['AUTOBOOT_OPENBMC_NICKNAME'] = \
os.environ.get("AUTOBOOT_OPENBMC_HOST", "")
if os.environ.get("AUTOIPL_FSP1_NICKNAME", "") == "":
os.environ['AUTOIPL_FSP1_NICKNAME'] = \
os.environ.get("AUTOIPL_FSP1_NAME", "").split(".")[0]
# For all variables specified in the parm_def file, we want them to
# default to "" rather than being unset.
# Process the parm_def file if it exists.
parm_def_file_path = gp.pgm_dir_path + "parm_def"
if os.path.exists(parm_def_file_path):
parm_defs = gm.my_parm_file(parm_def_file_path)
else:
parm_defs = collections.OrderedDict()
# Example parm_defs:
# parm_defs:
# parm_defs[rest_fail]: boolean
# parm_defs[command]: string
# parm_defs[esel_stop_file_path]: string
# Create a list of plug-in environment variables by pre-pending <all caps
# plug-in package name>_<all caps var name>
plug_in_parm_names = [plug_in_package_name + "_" + x for x in
map(str.upper, parm_defs.keys())]
# Example plug_in_parm_names:
# plug_in_parm_names:
# plug_in_parm_names[0]: STOP_REST_FAIL
# plug_in_parm_names[1]: STOP_COMMAND
# plug_in_parm_names[2]: STOP_ESEL_STOP_FILE_PATH
# Initialize unset plug-in vars.
for var_name in plug_in_parm_names:
# If there is a global variable with the same name as the environment
# variable, use its value as a default.
default_value = gm.get_mod_global(var_name, "")
os.environ[var_name] = os.environ.get(var_name, default_value)
if os.environ[var_name] == "":
os.environ[var_name] = default_value
plug_var_dict = \
collections.OrderedDict(sorted({k: v for (k, v) in
os.environ.items()
if re.match(regex, k)}.items()))
# Register password values to prevent printing them out. Any plug var
# whose name ends in PASSWORD will be registered.
password_vals = {k: v for (k, v) in plug_var_dict.items()
if re.match(r".*_PASSWORD$", k)}.values()
map(gp.register_passwords, password_vals)
return plug_var_dict
