def create_boot_table(file_path=None, os_host=""): r""" Read the boot table JSON file, convert it to an object and return it. Note that if the user is running without a global OS_HOST robot variable specified, this function will remove all of the "os_" start and end state requirements from the JSON data. Description of argument(s): file_path The path to the boot_table file. If this value is not specified, it will be obtained from the "BOOT_TABLE_PATH" environment variable, if set. Otherwise, it will default to "data/boot_table.json". If this value is a relative path, this function will use the code_base_dir_path as the base directory (see definition above). os_host The host name or IP address of the host associated with the machine being tested. If the user is running without an OS_HOST (i.e. if this argument is blank), we remove os starting and ending state requirements from the boot entries. """ if file_path is None: if redfish_support_trans_state: file_path = os.environ.get('BOOT_TABLE_PATH', 'data/boot_table_redfish.json') elif platform_arch_type == "x86": file_path = os.environ.get('BOOT_TABLE_PATH', 'data/boot_table_x86.json') else: file_path = os.environ.get('BOOT_TABLE_PATH', 'data/boot_table.json') if not file_path.startswith("/"): file_path = code_base_dir_path + file_path # Pre-process the file by removing blank lines and comment lines. temp = tempfile.NamedTemporaryFile() temp_file_path = temp.name cmd_buf = "egrep -v '^[ ]*$|^[ ]*#' " + file_path + " > " + temp_file_path gc.cmd_fnc_u(cmd_buf, quiet=1) boot_file = open(temp_file_path) boot_table = json.load(boot_file, object_hook=DotDict) # If the user is running without an OS_HOST, we remove os starting and ending state requirements from # the boot entries. if os_host == "": for boot in boot_table: state_keys = ['start', 'end'] for state_key in state_keys: for sub_state in list(boot_table[boot][state_key]): if sub_state.startswith("os_"): boot_table[boot][state_key].pop(sub_state, None) # For every boot_type we should have a corresponding mfg mode boot type. enhanced_boot_table = DotDict() for key, value in boot_table.items(): enhanced_boot_table[key] = value enhanced_boot_table[key + " (mfg)"] = value return enhanced_boot_table
def create_boot_table(file_path=None): r""" Read the boot table JSON file, convert it to an object and return it. Note that if the user is running without a global OS_HOST robot variable specified, this function will remove all of the "os_" start and end state requirements from the JSON data. Description of arguments: file_path The path to the boot_table file. If this value is not specified, it will be obtained from the "BOOT_TABLE_PATH" environment variable, if set. Otherwise, it will default to "data/boot_table.json". If this value is a relative path, this function will use the code_base_dir_path as the base directory (see definition above). """ if file_path is None: file_path = os.environ.get('BOOT_TABLE_PATH', 'data/boot_table.json') if not file_path.startswith("/"): file_path = code_base_dir_path + file_path # Pre-process the file by removing blank lines and comment lines. temp = tempfile.NamedTemporaryFile() temp_file_path = temp.name cmd_buf = "egrep -v '^[ ]*$|^[ ]*#' " + file_path + " > " + temp_file_path gc.cmd_fnc_u(cmd_buf, quiet=1) boot_file = open(temp_file_path) boot_table = json.load(boot_file, object_hook=DotDict) # If the user is running without an OS_HOST, we remove os starting and # ending state requirements from the boot entries. os_host = BuiltIn().get_variable_value("${OS_HOST}", default="") if os_host == "": for boot in boot_table: state_keys = ['start', 'end'] for state_key in state_keys: for sub_state in boot_table[boot][state_key]: if sub_state.startswith("os_"): boot_table[boot][state_key].pop(sub_state, None) # For every boot_type we should have a corresponding mfg mode boot type. enhanced_boot_table = DotDict() for key, value in boot_table.iteritems(): enhanced_boot_table[key] = value enhanced_boot_table[key + " (mfg)"] = value return enhanced_boot_table
def setup(): r""" Do general program setup tasks. """ global cp_setup_called gp.qprintn() robot_pgm_dir_path = os.path.dirname(__file__) + os.sep repo_bin_path = robot_pgm_dir_path.replace("/lib/", "/bin/") # If we can't find process_plug_in_packages.py, ssh_pw or # validate_plug_ins.py, then we don't have our repo bin in PATH. shell_rc, out_buf = gc.cmd_fnc_u("which process_plug_in_packages.py" + " ssh_pw validate_plug_ins.py", quiet=1, print_output=0, show_err=0) if shell_rc != 0: os.environ['PATH'] = repo_bin_path + ":" + os.environ.get('PATH', "") # Likewise, our repo lib subdir needs to be in sys.path and PYTHONPATH. if robot_pgm_dir_path not in sys.path: sys.path.append(robot_pgm_dir_path) PYTHONPATH = os.environ.get("PYTHONPATH", "") if PYTHONPATH == "": os.environ['PYTHONPATH'] = robot_pgm_dir_path else: os.environ['PYTHONPATH'] = robot_pgm_dir_path + ":" + PYTHONPATH validate_parms() grp.rqprint_pgm_header() grk.run_key("Set BMC Power Policy RESTORE_LAST_STATE") initial_plug_in_setup() plug_in_setup() rc, shell_rc, failed_plug_in_name = grpi.rprocess_plug_in_packages( call_point='setup') if rc != 0: error_message = "Plug-in setup failed.\n" grp.rprint_error_report(error_message) BuiltIn().fail(error_message) # Setting cp_setup_called lets our Teardown know that it needs to call # the cleanup plug-in call point. cp_setup_called = 1 # Keyword "FFDC" will fail if TEST_MESSAGE is not set. BuiltIn().set_global_variable("${TEST_MESSAGE}", "${EMPTY}") # FFDC_LOG_PATH is used by "FFDC" keyword. BuiltIn().set_global_variable("${FFDC_LOG_PATH}", ffdc_dir_path) # Also printed by FFDC. global host_name global host_ip host = socket.gethostname() host_name, host_ip = gm.get_host_name_ip(host) gp.dprint_var(boot_table, 1) gp.dprint_var(boot_lists)
def which(file_path): r""" Find the full path of an executable file and return it. The PATH environment variable dictates the results of this function. Description of arguments: file_path The relative file path (e.g. "my_file" or "lib/my_file"). """ shell_rc, out_buf = gc.cmd_fnc_u("which " + file_path, quiet=1, print_output=0, show_err=0) if shell_rc != 0: error_message = "Failed to find complete path for file \"" +\ file_path + "\".\n" error_message += gp.sprint_var(shell_rc, 1) error_message += out_buf if robot_env: BuiltIn().fail(gp.sprint_error(error_message)) else: gp.print_error_report(error_message) return False file_path = out_buf.rstrip("\n") return file_path
def which(file_path): r""" Find the full path of an executable file and return it. The PATH environment variable dictates the results of this function. Description of arguments: file_path The relative file path (e.g. "my_file" or "lib/my_file"). """ shell_rc, out_buf = gc.cmd_fnc_u("which " + file_path, quiet=1, print_output=0, show_err=0) if shell_rc != 0: error_message = "Failed to find complete path for file \"" +\ file_path + "\".\n" error_message += gp.sprint_var(shell_rc, 1) error_message += out_buf if robot_env: BuiltIn().fail(gp.sprint_error(error_message)) else: gp.print_error_report(error_message) return False file_path = out_buf.rstrip("\n") return file_path
def plug_in_setup(): r""" Initialize all changing plug-in environment variables for use by the plug-in programs. """ global LOG_LEVEL global test_really_running BuiltIn().set_log_level("NONE") boot_pass, boot_fail = boot_results.return_total_pass_fail() if boot_pass > 1: test_really_running = 1 else: test_really_running = 0 seconds = time.time() loc_time = time.localtime(seconds) time_string = time.strftime("%y%m%d.%H%M%S.", loc_time) ffdc_prefix = openbmc_nickname + "." + time_string BuiltIn().set_global_variable("${test_really_running}", test_really_running) BuiltIn().set_global_variable("${boot_type_desc}", next_boot) BuiltIn().set_global_variable("${boot_pass}", boot_pass) BuiltIn().set_global_variable("${boot_fail}", boot_fail) BuiltIn().set_global_variable("${boot_success}", boot_success) BuiltIn().set_global_variable("${ffdc_prefix}", ffdc_prefix) # For each program parameter, set the corresponding AUTOBOOT_ environment # variable value. Also, set an AUTOBOOT_ environment variable for every # element in additional_values. additional_values = [ "boot_type_desc", "boot_success", "boot_pass", "boot_fail", "test_really_running", "ffdc_prefix" ] plug_in_vars = additional_values for var_name in plug_in_vars: var_value = BuiltIn().get_variable_value("${" + var_name + "}") var_name = var_name.upper() if var_value is None: var_value = "" os.environ["AUTOBOOT_" + var_name] = str(var_value) if debug: shell_rc, out_buf = \ gc.cmd_fnc_u("printenv | egrep AUTOBOOT_ | sort -u") BuiltIn().set_log_level(LOG_LEVEL)
def plug_in_setup(): r""" Initialize all changing plug-in environment variables for use by the plug-in programs. """ global LOG_LEVEL global test_really_running BuiltIn().set_log_level("NONE") boot_pass, boot_fail = boot_results.return_total_pass_fail() if boot_pass > 1: test_really_running = 1 else: test_really_running = 0 seconds = time.time() loc_time = time.localtime(seconds) time_string = time.strftime("%y%m%d.%H%M%S.", loc_time) ffdc_prefix = openbmc_nickname + "." + time_string BuiltIn().set_global_variable("${test_really_running}", test_really_running) BuiltIn().set_global_variable("${boot_type_desc}", next_boot) BuiltIn().set_global_variable("${boot_pass}", boot_pass) BuiltIn().set_global_variable("${boot_fail}", boot_fail) BuiltIn().set_global_variable("${boot_success}", boot_success) BuiltIn().set_global_variable("${ffdc_prefix}", ffdc_prefix) # For each program parameter, set the corresponding AUTOBOOT_ environment # variable value. Also, set an AUTOBOOT_ environment variable for every # element in additional_values. additional_values = ["boot_type_desc", "boot_success", "boot_pass", "boot_fail", "test_really_running", "ffdc_prefix"] plug_in_vars = additional_values for var_name in plug_in_vars: var_value = BuiltIn().get_variable_value("${" + var_name + "}") var_name = var_name.upper() if var_value is None: var_value = "" os.environ["AUTOBOOT_" + var_name] = str(var_value) if debug: shell_rc, out_buf = \ gc.cmd_fnc_u("printenv | egrep AUTOBOOT_ | sort -u") BuiltIn().set_log_level(LOG_LEVEL)
def get_state(openbmc_host="", openbmc_username="", openbmc_password="", os_host="", os_username="", os_password="", req_states=default_req_states, quiet=None): r""" Get component states such as chassis state, bmc state, etc, put them into a dictionary and return them to the caller. Note that all substate values are strings. Note: If elapsed_boot_time is included in req_states, it is the caller's duty to call set_start_boot_seconds() in order to set global start_boot_seconds. elapsed_boot_time is the current time minus start_boot_seconds. Description of argument(s): openbmc_host The DNS name or IP address of the BMC. This defaults to global ${OPENBMC_HOST}. openbmc_username The username to be used to login to the BMC. This defaults to global ${OPENBMC_USERNAME}. openbmc_password The password to be used to login to the BMC. This defaults to global ${OPENBMC_PASSWORD}. os_host The DNS name or IP address of the operating system. This defaults to global ${OS_HOST}. os_username The username to be used to login to the OS. This defaults to global ${OS_USERNAME}. os_password The password to be used to login to the OS. This defaults to global ${OS_PASSWORD}. req_states This is a list of states whose values are being requested by the caller. quiet Indicates whether status details (e.g. curl commands) should be written to the console. Defaults to either global value of ${QUIET} or to 1. """ quiet = int(gp.get_var_value(quiet, 0)) # Set parm defaults where necessary and validate all parms. if openbmc_host == "": openbmc_host = BuiltIn().get_variable_value("${OPENBMC_HOST}") error_message = gv.valid_value(openbmc_host, invalid_values=[None, ""]) if error_message != "": BuiltIn().fail(gp.sprint_error(error_message)) if openbmc_username == "": openbmc_username = BuiltIn().get_variable_value("${OPENBMC_USERNAME}") error_message = gv.valid_value(openbmc_username, invalid_values=[None, ""]) if error_message != "": BuiltIn().fail(gp.sprint_error(error_message)) if openbmc_password == "": openbmc_password = BuiltIn().get_variable_value("${OPENBMC_PASSWORD}") error_message = gv.valid_value(openbmc_password, invalid_values=[None, ""]) if error_message != "": BuiltIn().fail(gp.sprint_error(error_message)) # NOTE: OS parms are optional. if os_host == "": os_host = BuiltIn().get_variable_value("${OS_HOST}") if os_host is None: os_host = "" if os_username is "": os_username = BuiltIn().get_variable_value("${OS_USERNAME}") if os_username is None: os_username = "" if os_password is "": os_password = BuiltIn().get_variable_value("${OS_PASSWORD}") if os_password is None: os_password = "" invalid_req_states = [sub_state for sub_state in req_states if sub_state not in valid_req_states] if len(invalid_req_states) > 0: error_message = "The following req_states are not supported:\n" +\ gp.sprint_var(invalid_req_states) BuiltIn().fail(gp.sprint_error(error_message)) # Initialize all substate values supported by this function. ping = 0 packet_loss = '' uptime = '' epoch_seconds = '' elapsed_boot_time = '' rest = '' chassis = '' requested_chassis = '' bmc = '' requested_bmc = '' boot_progress = '' operating_system = '' host = '' requested_host = '' attempts_left = '' # Get the component states. if 'ping' in req_states: # See if the OS pings. rc, out_buf = gc.shell_cmd("ping -c 1 -w 2 " + openbmc_host, print_output=0, show_err=0, ignore_err=1) if rc == 0: ping = 1 if 'packet_loss' in req_states: # See if the OS pings. cmd_buf = "ping -c 5 -w 5 " + openbmc_host +\ " | egrep 'packet loss' | sed -re 's/.* ([0-9]+)%.*/\\1/g'" rc, out_buf = gc.shell_cmd(cmd_buf, print_output=0, show_err=0, ignore_err=1) if rc == 0: packet_loss = out_buf.rstrip("\n") if 'uptime' in req_states: # Sometimes reading uptime results in a blank value. Call with # wait_until_keyword_succeeds to ensure a non-blank value is obtained. remote_cmd_buf = "read uptime filler 2>/dev/null < /proc/uptime" +\ " && [ ! -z \"${uptime}\" ] && echo ${uptime}" cmd_buf = ["BMC Execute Command", re.sub('\\$', '\\$', remote_cmd_buf), 'quiet=1', 'test_mode=0'] gp.qprint_issuing(cmd_buf, 0) gp.qprint_issuing(remote_cmd_buf, 0) try: stdout, stderr, rc =\ BuiltIn().wait_until_keyword_succeeds("10 sec", "0 sec", *cmd_buf) if rc == 0 and stderr == "": uptime = stdout except AssertionError as my_assertion_error: pass if 'epoch_seconds' in req_states or 'elapsed_boot_time' in req_states: date_cmd_buf = "date -u +%s" if USE_BMC_EPOCH_TIME: cmd_buf = ["BMC Execute Command", date_cmd_buf, 'quiet=${1}'] if not quiet: gp.print_issuing(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": stdout, stderr, rc = ret_values if rc == 0 and stderr == "": epoch_seconds = stdout.rstrip("\n") else: shell_rc, out_buf = gc.cmd_fnc_u(date_cmd_buf, quiet=quiet, print_output=0) if shell_rc == 0: epoch_seconds = out_buf.rstrip("\n") if 'elapsed_boot_time' in req_states: global start_boot_seconds elapsed_boot_time = int(epoch_seconds) - start_boot_seconds master_req_rest = ['rest', 'host', 'requested_host', 'operating_system', 'attempts_left', 'boot_progress', 'chassis', 'requested_chassis' 'bmc' 'requested_bmc'] req_rest = [sub_state for sub_state in req_states if sub_state in master_req_rest] need_rest = (len(req_rest) > 0) state = DotDict() if need_rest: cmd_buf = ["Read Properties", SYSTEM_STATE_URI + "enumerate", "quiet=${" + str(quiet) + "}"] gp.dprint_issuing(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": state['rest'] = '1' else: state['rest'] = '0' if int(state['rest']): for url_path in ret_values: for attr_name in ret_values[url_path]: # Create a state key value based on the attr_name. try: ret_values[url_path][attr_name] = \ re.sub(r'.*\.', "", ret_values[url_path][attr_name]) except TypeError: pass # Do some key name manipulations. new_attr_name = re.sub(r'^Current|(State|Transition)$', "", attr_name) new_attr_name = re.sub(r'BMC', r'Bmc', new_attr_name) new_attr_name = re.sub(r'([A-Z][a-z])', r'_\1', new_attr_name) new_attr_name = new_attr_name.lower().lstrip("_") new_attr_name = re.sub(r'power', r'chassis', new_attr_name) if new_attr_name in req_states: state[new_attr_name] = ret_values[url_path][attr_name] for sub_state in req_states: if sub_state in state: continue if sub_state.startswith("os_"): # We pass "os_" requests on to get_os_state. continue cmd_buf = "state['" + sub_state + "'] = str(" + sub_state + ")" exec(cmd_buf) if os_host == "": # The caller has not specified an os_host so as far as we're concerned, # it doesn't exist. return state os_req_states = [sub_state for sub_state in req_states if sub_state.startswith('os_')] if len(os_req_states) > 0: # The caller has specified an os_host and they have requested # information on os substates. # Based on the information gathered on bmc, we'll try to make a # determination of whether the os is even up. We'll pass the result # of that assessment to get_os_state to enhance performance. os_up_match = DotDict() for sub_state in master_os_up_match: if sub_state in req_states: os_up_match[sub_state] = master_os_up_match[sub_state] os_up = compare_states(state, os_up_match) os_state = get_os_state(os_host=os_host, os_username=os_username, os_password=os_password, req_states=os_req_states, os_up=os_up, quiet=quiet) # Append os_state dictionary to ours. state.update(os_state) return state
def setup(): r""" Do general program setup tasks. """ global cp_setup_called gp.qprintn() robot_pgm_dir_path = os.path.dirname(__file__) + os.sep repo_bin_path = robot_pgm_dir_path.replace("/lib/", "/bin/") # If we can't find process_plug_in_packages.py, ssh_pw or # validate_plug_ins.py, then we don't have our repo bin in PATH. shell_rc, out_buf = gc.cmd_fnc_u("which process_plug_in_packages.py" + " ssh_pw validate_plug_ins.py", quiet=1, print_output=0, show_err=0) if shell_rc != 0: os.environ['PATH'] = repo_bin_path + ":" + os.environ.get('PATH', "") # Likewise, our repo lib subdir needs to be in sys.path and PYTHONPATH. if robot_pgm_dir_path not in sys.path: sys.path.append(robot_pgm_dir_path) PYTHONPATH = os.environ.get("PYTHONPATH", "") if PYTHONPATH == "": os.environ['PYTHONPATH'] = robot_pgm_dir_path else: os.environ['PYTHONPATH'] = robot_pgm_dir_path + ":" + PYTHONPATH validate_parms() grp.rqprint_pgm_header() grk.run_key("Set BMC Power Policy RESTORE_LAST_STATE") initial_plug_in_setup() plug_in_setup() rc, shell_rc, failed_plug_in_name = grpi.rprocess_plug_in_packages( call_point='setup') if rc != 0: error_message = "Plug-in setup failed.\n" grp.rprint_error_report(error_message) BuiltIn().fail(error_message) # Setting cp_setup_called lets our Teardown know that it needs to call # the cleanup plug-in call point. cp_setup_called = 1 # Keyword "FFDC" will fail if TEST_MESSAGE is not set. BuiltIn().set_global_variable("${TEST_MESSAGE}", "${EMPTY}") # FFDC_LOG_PATH is used by "FFDC" keyword. BuiltIn().set_global_variable("${FFDC_LOG_PATH}", ffdc_dir_path) # Also printed by FFDC. global host_name global host_ip host = socket.gethostname() host_name, host_ip = gm.get_host_name_ip(host) gp.dprint_var(boot_table, 1) gp.dprint_var(boot_lists)
def print_defect_report(): r""" Print a defect report. """ # Making deliberate choice to NOT run plug_in_setup(). We don't want # ffdc_prefix updated. rc, shell_rc, failed_plug_in_name = grpi.rprocess_plug_in_packages( call_point='ffdc_report', stop_on_plug_in_failure=0) # At some point I'd like to have the 'Call FFDC Methods' return a list # of files it has collected. In that case, the following "ls" command # would no longer be needed. For now, however, glob shows the files # named in FFDC_LIST_FILE_PATH so I will refrain from printing those # out (so we don't see duplicates in the list). # Get additional header data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_report_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, more_header_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) # Get additional header data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_summary_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, ffdc_summary_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) LOG_PREFIX = BuiltIn().get_variable_value("${LOG_PREFIX}") output = '\n'.join(sorted(glob.glob(LOG_PREFIX + '*'))) try: ffdc_list = open(ffdc_list_file_path, 'r') except IOError: ffdc_list = "" # Open ffdc_file_list for writing. We will write a complete list of # FFDC files to it for possible use by plug-ins like cp_stop_check. ffdc_list_file = open(ffdc_list_file_path, 'w') gp.qprintn() # indent=0, width=90, linefeed=1, char="=" gp.qprint_dashes(0, 90, 1, "=") gp.qprintn("Copy this data to the defect:\n") if len(more_header_info) > 0: gp.qprintn(more_header_info) gp.qpvars(host_name, host_ip, openbmc_nickname, openbmc_host, openbmc_host_name, openbmc_ip, openbmc_username, openbmc_password, os_host, os_host_name, os_ip, os_username, os_password, pdu_host, pdu_host_name, pdu_ip, pdu_username, pdu_password, pdu_slot_no, openbmc_serial_host, openbmc_serial_host_name, openbmc_serial_ip, openbmc_serial_port) gp.qprintn() print_last_boots() gp.qprintn() gp.qprint_var(state) gp.qprintn() gp.qprintn("FFDC data files:") if status_file_path != "": gp.qprintn(status_file_path) ffdc_list_file.write(status_file_path + "\n") gp.qprintn(output) # gp.qprintn(ffdc_list) gp.qprintn() if len(ffdc_summary_info) > 0: gp.qprintn(ffdc_summary_info) gp.qprint_dashes(0, 90, 1, "=") ffdc_list_file.write(output + "\n") ffdc_list_file.close()
def rprocess_plug_in_packages(plug_in_packages_list=None, call_point="setup", shell_rc="0x00000000", stop_on_plug_in_failure=1, stop_on_non_zero_rc=0, release_type="obmc", quiet=None, debug=None): r""" Call the external process_plug_in_packages.py to process the plug-in packages. Return the following: rc The return code - 0 = PASS, 1 = FAIL. shell_rc The shell return code returned by process_plug_in_packages.py. failed_plug_in_name The failed plug in name (if any). Description of arguments: plug_in_packages_list A python list of plug-in directory paths. call_point The call point program to be called for each plug-in package (e.g. post_boot). This name should not include the "cp_" prefix. shell_rc The user may supply a value other than zero to indicate an acceptable non-zero return code. For example, if this value equals 0x00000200, it means that for each plug-in call point that runs, a 0x00000200 will not be counted as a failure. stop_on_plug_in_failure If this parameter is set to 1, this program will stop and return non-zero if the call point program from any plug-in directory fails. Conversely, if it is set to false, this program will run the call point program from each and every plug-in directory regardless of their return values. Typical example cases where you'd want to run all plug-in call points regardless of success or failure would be "cleanup" or "ffdc" call points. stop_on_non_zero_rc If this parm is set to 1 and a plug-in call point program returns a valid non-zero return code (see "shell_rc" parm above), this program will stop processing and return 0 (success). Since this constitutes a successful exit, this would normally be used where the caller wishes to stop processing if one of the plug-in directory call point programs returns a special value indicating that some special case has been found. An example might be in calling some kind of "check_errl" call point program. Such a call point program might return a 2 (i.e. 0x00000200) to indicate that a given error log entry was found in an "ignore" list and is therefore to be ignored. That being the case, no other "check_errl" call point program would need to be called. release_type The type of release being tested (e.g. "obmc", "op", "fips"). This influences which integrated plug-ins are selected. quiet If quiet is set to 1, this function will NOT write status messages to stdout. This will default to the global quiet program parm or to 0. debug If this parameter is set to 1, this function will print additional debug information. This is mainly to be used by the developer of this function. This will default to the global quiet program parm or to 0. """ rc = 0 if plug_in_packages_list is None: plug_in_packages_list = BuiltIn().get_variable_value( "${plug_in_packages_list}") # If there are no plug-in packages to process, return successfully. if len(plug_in_packages_list) == 0: return 0, 0, "" if quiet is None: try: quiet = int(BuiltIn().get_variable_value("${quiet}")) except TypeError: quiet = 0 if debug is None: try: debug = int(BuiltIn().get_variable_value("${debug}")) except TypeError: debug = 0 # Create string from list. plug_in_dir_paths = ':'.join(plug_in_packages_list) temp = tempfile.NamedTemporaryFile() temp_file_path = temp.name temp2 = tempfile.NamedTemporaryFile() temp_properties_file_path = temp2.name if int(debug) == 1: os.environ["PERF_TRACE"] = "1" debug_string = " --quiet=0" else: debug_string = "" loc_shell_rc = 0 sub_cmd_buf = "process_plug_in_packages.py" + debug_string +\ " --call_point=" + call_point + " --shell_rc=" +\ str(shell_rc) + " --stop_on_plug_in_failure=" +\ str(stop_on_plug_in_failure) + " --stop_on_non_zero_rc=" +\ str(stop_on_non_zero_rc) + " " + plug_in_dir_paths if int(quiet) == 1: cmd_buf = sub_cmd_buf + " > " + temp_file_path + " 2>&1" else: cmd_buf = "set -o pipefail ; " + sub_cmd_buf + " 2>&1 | tee " +\ temp_file_path if int(debug) == 1: grp.rpissuing(cmd_buf) else: grp.rprint_timen("Processing " + call_point + " call point programs.") proc_plug_pkg_rc = subprocess.call(cmd_buf, shell=True) # As process_plug_in_packages.py help text states, it will print the # values of failed_plug_in_name and shell_rc in the following format: # failed_plug_in_name: <failed plug-in value, if any> # shell_rc: <shell return code value of last # call point program> # We want to obtain those values from the output. To make the task # simpler, we'll start by grepping the output for lines that might fit # such a format: # A valid bash variable against the left margin # - A colon # - Zero or more spaces bash_var_regex = "[_[:alpha:]][_[:alnum:]]*" regex = "^" + bash_var_regex + ":[ ]*" cmd_buf = "egrep '" + regex + "' " + temp_file_path + " > " +\ temp_properties_file_path if int(debug) == 1: grp.rpissuing(cmd_buf) grep_rc = os.system(cmd_buf) # Next we call my_parm_file to create a properties dictionary. properties = gm.my_parm_file(temp_properties_file_path) # Finally, we access the 2 values that we need. try: shell_rc = int(properties['shell_rc'], 16) except KeyError: shell_rc = 0 try: failed_plug_in_name = properties['failed_plug_in_name'] except KeyError: failed_plug_in_name = "" if proc_plug_pkg_rc != 0: hex = 1 grp.rprint_error("Call to process_plug_in_packages failed.\n") grp.rprint_varx("grep_rc", grep_rc, hex) grp.rprint_varx("proc_plug_pkg_rc", proc_plug_pkg_rc, hex) # Show all of the failed plug in names and shell_rcs. gc.cmd_fnc_u("egrep -A 1 '^failed_plug_in_name:[ ]+' " + temp_properties_file_path, quiet=1, show_err=0) rc = 1 return rc, shell_rc, failed_plug_in_name
def print_defect_report(ffdc_file_list): r""" Print a defect report. Description of argument(s): ffdc_file_list A list of files which were collected by our ffdc functions. """ # Making deliberate choice to NOT run plug_in_setup(). We don't want # ffdc_prefix updated. rc, shell_rc, failed_plug_in_name = grpi.rprocess_plug_in_packages( call_point='ffdc_report', stop_on_plug_in_failure=0) # Get additional header data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_report_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, more_header_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) # Get additional summary data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_summary_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, ffdc_summary_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) # ffdc_list_file_path contains a list of any ffdc files created by plug- # ins, etc. Read that data into a list. try: plug_in_ffdc_list = \ open(ffdc_list_file_path, 'r').read().rstrip("\n").split("\n") plug_in_ffdc_list = filter(None, plug_in_ffdc_list) except IOError: plug_in_ffdc_list = [] # Combine the files from plug_in_ffdc_list with the ffdc_file_list passed # in. Eliminate duplicates and sort the list. ffdc_file_list = sorted(set(ffdc_file_list + plug_in_ffdc_list)) if status_file_path != "": ffdc_file_list.insert(0, status_file_path) # Convert the list to a printable list. printable_ffdc_file_list = "\n".join(ffdc_file_list) # Open ffdc_file_list for writing. We will write a complete list of # FFDC files to it for possible use by plug-ins like cp_stop_check. ffdc_list_file = open(ffdc_list_file_path, 'w') ffdc_list_file.write(printable_ffdc_file_list + "\n") ffdc_list_file.close() indent = 0 width = 90 linefeed = 1 char = "=" gp.qprintn() gp.qprint_dashes(indent, width, linefeed, char) gp.qprintn("Copy this data to the defect:\n") if len(more_header_info) > 0: gp.qprintn(more_header_info) gp.qpvars(host_name, host_ip, openbmc_nickname, openbmc_host, openbmc_host_name, openbmc_ip, openbmc_username, openbmc_password, os_host, os_host_name, os_ip, os_username, os_password, pdu_host, pdu_host_name, pdu_ip, pdu_username, pdu_password, pdu_slot_no, openbmc_serial_host, openbmc_serial_host_name, openbmc_serial_ip, openbmc_serial_port) gp.qprintn() print_last_boots() gp.qprintn() gp.qprint_var(state) gp.qprintn() gp.qprintn("FFDC data files:") gp.qprintn(printable_ffdc_file_list) gp.qprintn() if len(ffdc_summary_info) > 0: gp.qprintn(ffdc_summary_info) gp.qprint_dashes(indent, width, linefeed, char)
def file_diff(file1_path, file2_path, diff_file_path, skip_string): r""" Compare the contents of two text files. The comparison uses the Unix 'diff' command. Differences can be selectively ignored by use of the skip_string parameter. The output of diff command is written to a user-specified file and is also written (logged) to the console. Description of arguments: file1_path File containing text data. file2_path Text file to compare to file1. diff_file_path Text file which will contain the diff output. skip_string To allow for differences which may expected or immaterial, skip_string parameter is a word or a string of comma separated words which specify what should be ignored. For example, "size,speed". Any line containing the word size or the word speed will be ignored when the diff is performed. This parameter is optional. Returns: 0 if both files contain the same information or they differ only in items specified by the skip_string. 2 if FILES_DO_NOT_MATCH. 3 if INPUT_FILE_DOES_NOT_EXIST. 4 if IO_EXCEPTION_READING_FILE. 5 if IO_EXCEPTION_WRITING_FILE. 6 if INPUT_FILE_MALFORMED """ FILES_MATCH = 0 FILES_DO_NOT_MATCH = 2 INPUT_FILE_DOES_NOT_EXIST = 3 IO_EXCEPTION_READING_FILE = 4 IO_EXCEPTION_WRITING_FILE = 5 INPUT_FILE_MALFORMED = 6 # The minimum size in bytes a file must be. min_file_byte_size = 1 now = time.strftime("%Y-%m-%d %H:%M:%S") if (not os.path.exists(file1_path) or (not os.path.exists(file2_path))): return INPUT_FILE_DOES_NOT_EXIST try: with open(file1_path, 'r') as file: initial = file.readlines() with open(file2_path, 'r') as file: final = file.readlines() except IOError: file.close() return IO_EXCEPTION_READING_FILE except ValueError: file.close() return INPUT_FILE_MALFORMED else: file.close() # Must have more than a trivial number of bytes. if len(initial) < min_file_byte_size: return INPUT_FILE_MALFORMED if (initial == final): try: file = open(diff_file_path, 'w') except IOError: file.close() line_to_print = "Specified skip (ignore) string = " + \ skip_string + "\n\n" file.write(line_to_print) line_to_print = now + " found no difference between file " + \ file1_path + " and " + \ file2_path + "\n" file.write(line_to_print) file.close() return FILES_MATCH # Find the differences and write difference report to diff_file_path file try: file = open(diff_file_path, 'w') except IOError: file.close() return IO_EXCEPTION_WRITING_FILE # Form a UNIX diff command and its parameters as a string. For example, # if skip_string="size,capacity", command = 'diff -I "size" # -I "capacity" file1_path file2_path'. skip_list = filter(None, re.split(r"[ ]*,[ ]*", skip_string)) ignore_string = ' '.join([("-I " + '"' + x + '"') for x in skip_list]) command = ' '.join( filter(None, ["diff", ignore_string, file1_path, file2_path])) line_to_print = now + " " + command + "\n" file.write(line_to_print) # Run the command and get the differences rc, out_buf = cmd_fnc_u(command, quiet=0, print_output=0, show_err=0) # Write the differences to the specified diff_file and console. if robot_env == 1: BuiltIn().log_to_console("DIFF:\n" + out_buf) else: print "DIFF:\n", out_buf file.write(out_buf) file.close() if rc == 0: # Any differences found were on the skip_string. return FILES_MATCH else: # We have at least one difference not in the skip_string. return FILES_DO_NOT_MATCH
def rprocess_plug_in_packages(plug_in_packages_list=None, call_point="setup", shell_rc="0x00000000", stop_on_plug_in_failure=1, stop_on_non_zero_rc=0, release_type="obmc", quiet=None, debug=None): r""" Call the external process_plug_in_packages.py to process the plug-in packages. Return the following: rc The return code - 0 = PASS, 1 = FAIL. shell_rc The shell return code returned by process_plug_in_packages.py. failed_plug_in_name The failed plug in name (if any). Description of arguments: plug_in_packages_list A python list of plug-in directory paths. call_point The call point program to be called for each plug-in package (e.g. post_boot). This name should not include the "cp_" prefix. shell_rc The user may supply a value other than zero to indicate an acceptable non-zero return code. For example, if this value equals 0x00000200, it means that for each plug-in call point that runs, a 0x00000200 will not be counted as a failure. stop_on_plug_in_failure If this parameter is set to 1, this program will stop and return non-zero if the call point program from any plug-in directory fails. Conversely, if it is set to false, this program will run the call point program from each and every plug-in directory regardless of their return values. Typical example cases where you'd want to run all plug-in call points regardless of success or failure would be "cleanup" or "ffdc" call points. stop_on_non_zero_rc If this parm is set to 1 and a plug-in call point program returns a valid non-zero return code (see "shell_rc" parm above), this program will stop processing and return 0 (success). Since this constitutes a successful exit, this would normally be used where the caller wishes to stop processing if one of the plug-in directory call point programs returns a special value indicating that some special case has been found. An example might be in calling some kind of "check_errl" call point program. Such a call point program might return a 2 (i.e. 0x00000200) to indicate that a given error log entry was found in an "ignore" list and is therefore to be ignored. That being the case, no other "check_errl" call point program would need to be called. release_type The type of release being tested (e.g. "obmc", "op", "fips"). This influences which integrated plug-ins are selected. quiet If quiet is set to 1, this function will NOT write status messages to stdout. This will default to the global quiet program parm or to 0. debug If this parameter is set to 1, this function will print additional debug information. This is mainly to be used by the developer of this function. This will default to the global quiet program parm or to 0. """ rc = 0 if plug_in_packages_list is None: plug_in_packages_list = BuiltIn().get_variable_value( "${plug_in_packages_list}") # If there are no plug-in packages to process, return successfully. if len(plug_in_packages_list) == 0: return 0, 0, "" if quiet is None: try: quiet = int(BuiltIn().get_variable_value("${quiet}")) except TypeError: quiet = 0 if debug is None: try: debug = int(BuiltIn().get_variable_value("${debug}")) except TypeError: debug = 0 # Create string from list. plug_in_dir_paths = ':'.join(plug_in_packages_list) temp = tempfile.NamedTemporaryFile() temp_file_path = temp.name temp2 = tempfile.NamedTemporaryFile() temp_properties_file_path = temp2.name if int(debug) == 1: os.environ["PERF_TRACE"] = "1" debug_string = " --quiet=0" else: debug_string = "" loc_shell_rc = 0 sub_cmd_buf = "process_plug_in_packages.py" + debug_string +\ " --call_point=" + call_point + " --allow_shell_rc=" +\ str(shell_rc) + " --stop_on_plug_in_failure=" +\ str(stop_on_plug_in_failure) + " --stop_on_non_zero_rc=" +\ str(stop_on_non_zero_rc) + " " + plug_in_dir_paths if int(quiet) == 1: cmd_buf = sub_cmd_buf + " > " + temp_file_path + " 2>&1" else: cmd_buf = "set -o pipefail ; " + sub_cmd_buf + " 2>&1 | tee " +\ temp_file_path if int(debug) == 1: grp.rpissuing(cmd_buf) else: grp.rprint_timen("Processing " + call_point + " call point programs.") proc_plug_pkg_rc = subprocess.call(cmd_buf, shell=True, executable='/bin/bash') # As process_plug_in_packages.py help text states, it will print the # values of failed_plug_in_name and shell_rc in the following format: # failed_plug_in_name: <failed plug-in value, if any> # shell_rc: <shell return code value of last # call point program> # We want to obtain those values from the output. To make the task # simpler, we'll start by grepping the output for lines that might fit # such a format: # A valid bash variable against the left margin # - A colon # - Zero or more spaces bash_var_regex = "[_[:alpha:]][_[:alnum:]]*" regex = "^" + bash_var_regex + ":[ ]*" cmd_buf = "egrep '" + regex + "' " + temp_file_path + " > " +\ temp_properties_file_path if int(debug) == 1: grp.rpissuing(cmd_buf) grep_rc = os.system(cmd_buf) # Next we call my_parm_file to create a properties dictionary. properties = gm.my_parm_file(temp_properties_file_path) # Finally, we access the 2 values that we need. try: shell_rc = int(properties['shell_rc'], 16) except KeyError: shell_rc = 0 try: failed_plug_in_name = properties['failed_plug_in_name'] except KeyError: failed_plug_in_name = "" if proc_plug_pkg_rc != 0: hex = 1 grp.rprint_error("Call to process_plug_in_packages failed.\n") grp.rprint_varx("grep_rc", grep_rc, hex) grp.rprint_varx("proc_plug_pkg_rc", proc_plug_pkg_rc, hex) # Show all of the failed plug in names and shell_rcs. gc.cmd_fnc_u("egrep -A 1 '^failed_plug_in_name:[ ]+' " + temp_properties_file_path, quiet=1, show_err=0) rc = 1 return rc, shell_rc, failed_plug_in_name
def print_defect_report(): r""" Print a defect report. """ # Making deliberate choice to NOT run plug_in_setup(). We don't want # ffdc_prefix updated. rc, shell_rc, failed_plug_in_name = grpi.rprocess_plug_in_packages( call_point='ffdc_report', stop_on_plug_in_failure=0) # At some point I'd like to have the 'Call FFDC Methods' return a list # of files it has collected. In that case, the following "ls" command # would no longer be needed. For now, however, glob shows the files # named in FFDC_LIST_FILE_PATH so I will refrain from printing those # out (so we don't see duplicates in the list). # Get additional header data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_report_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, more_header_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) # Get additional header data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_summary_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, ffdc_summary_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) LOG_PREFIX = BuiltIn().get_variable_value("${LOG_PREFIX}") output = '\n'.join(sorted(glob.glob(LOG_PREFIX + '*'))) try: ffdc_list = open(ffdc_list_file_path, 'r') except IOError: ffdc_list = "" # Open ffdc_file_list for writing. We will write a complete list of # FFDC files to it for possible use by plug-ins like cp_stop_check. ffdc_list_file = open(ffdc_list_file_path, 'w') gp.qprintn() # indent=0, width=90, linefeed=1, char="=" gp.qprint_dashes(0, 90, 1, "=") gp.qprintn("Copy this data to the defect:\n") if len(more_header_info) > 0: gp.printn(more_header_info) gp.qpvars(host_name, host_ip, openbmc_nickname, openbmc_host, openbmc_host_name, openbmc_ip, openbmc_username, openbmc_password, os_host, os_host_name, os_ip, os_username, os_password, pdu_host, pdu_host_name, pdu_ip, pdu_username, pdu_password, pdu_slot_no, openbmc_serial_host, openbmc_serial_host_name, openbmc_serial_ip, openbmc_serial_port) gp.qprintn() print_last_boots() gp.qprintn() gp.qprint_var(state) gp.qprintn() gp.qprintn("FFDC data files:") if status_file_path != "": gp.qprintn(status_file_path) ffdc_list_file.write(status_file_path + "\n") gp.qprintn(output) # gp.qprintn(ffdc_list) gp.qprintn() if len(ffdc_summary_info) > 0: gp.printn(ffdc_summary_info) gp.qprint_dashes(0, 90, 1, "=") ffdc_list_file.write(output + "\n") ffdc_list_file.close()
def file_diff(file1_path, file2_path, diff_file_path, skip_string): r""" Compare the contents of two text files. The comparison uses the Unix 'diff' command. Differences can be selectively ignored by use of the skip_string parameter. The output of diff command is written to a user-specified file and is also written (logged) to the console. Description of arguments: file1_path File containing text data. file2_path Text file to compare to file1. diff_file_path Text file which will contain the diff output. skip_string To allow for differences which may expected or immaterial, skip_string parameter is a word or a string of comma separated words which specify what should be ignored. For example, "size,speed". Any line containing the word size or the word speed will be ignored when the diff is performed. This parameter is optional. Returns: 0 if both files contain the same information or they differ only in items specified by the skip_string. 2 if FILES_DO_NOT_MATCH. 3 if INPUT_FILE_DOES_NOT_EXIST. 4 if IO_EXCEPTION_READING_FILE. 5 if IO_EXCEPTION_WRITING_FILE. 6 if INPUT_FILE_MALFORMED """ FILES_MATCH = 0 FILES_DO_NOT_MATCH = 2 INPUT_FILE_DOES_NOT_EXIST = 3 IO_EXCEPTION_READING_FILE = 4 IO_EXCEPTION_WRITING_FILE = 5 INPUT_FILE_MALFORMED = 6 # The minimum size in bytes a file must be. min_file_byte_size = 1 now = time.strftime("%Y-%m-%d %H:%M:%S") if (not os.path.exists(file1_path) or (not os.path.exists(file2_path))): return INPUT_FILE_DOES_NOT_EXIST try: with open(file1_path, 'r') as file: initial = file.readlines() with open(file2_path, 'r') as file: final = file.readlines() except IOError: file.close() return IO_EXCEPTION_READING_FILE except ValueError: file.close() return INPUT_FILE_MALFORMED else: file.close() # Must have more than a trivial number of bytes. if len(initial) < min_file_byte_size: return INPUT_FILE_MALFORMED if (initial == final): try: file = open(diff_file_path, 'w') except IOError: file.close() line_to_print = "Specified skip (ignore) string = " + \ skip_string + "\n\n" file.write(line_to_print) line_to_print = now + " found no difference between file " + \ file1_path + " and " + \ file2_path + "\n" file.write(line_to_print) file.close() return FILES_MATCH # Find the differences and write difference report to diff_file_path file try: file = open(diff_file_path, 'w') except IOError: file.close() return IO_EXCEPTION_WRITING_FILE # Form a UNIX diff command and its parameters as a string. For example, # if skip_string="size,capacity", command = 'diff -I "size" # -I "capacity" file1_path file2_path'. skip_list = filter(None, re.split(r"[ ]*,[ ]*", skip_string)) ignore_string = ' '.join([("-I " + '"' + x + '"') for x in skip_list]) command = ' '.join(filter(None, ["diff", ignore_string, file1_path, file2_path])) line_to_print = now + " " + command + "\n" file.write(line_to_print) # Run the command and get the differences rc, out_buf = cmd_fnc_u(command, quiet=0, print_output=0, show_err=0) # Write the differences to the specified diff_file and console. if robot_env == 1: BuiltIn().log_to_console("DIFF:\n" + out_buf) else: print "DIFF:\n", out_buf file.write(out_buf) file.close() if rc == 0: # Any differences found were on the skip_string. return FILES_MATCH else: # We have at least one difference not in the skip_string. return FILES_DO_NOT_MATCH
def print_defect_report(ffdc_file_list): r""" Print a defect report. Description of argument(s): ffdc_file_list A list of files which were collected by our ffdc functions. """ # Making deliberate choice to NOT run plug_in_setup(). We don't want # ffdc_prefix updated. rc, shell_rc, failed_plug_in_name = grpi.rprocess_plug_in_packages( call_point='ffdc_report', stop_on_plug_in_failure=0) # Get additional header data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_report_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, more_header_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) # Get additional summary data which may have been created by ffdc plug-ins. # Also, delete the individual header files to cleanup. cmd_buf = "file_list=$(cat " + ffdc_summary_list_path + " 2>/dev/null)" +\ " ; [ ! -z \"${file_list}\" ] && cat ${file_list}" +\ " 2>/dev/null ; rm -rf ${file_list} 2>/dev/null || :" shell_rc, ffdc_summary_info = gc.cmd_fnc_u(cmd_buf, print_output=0, show_err=0) # ffdc_list_file_path contains a list of any ffdc files created by plug- # ins, etc. Read that data into a list. try: plug_in_ffdc_list = \ open(ffdc_list_file_path, 'r').read().rstrip("\n").split("\n") plug_in_ffdc_list = filter(None, plug_in_ffdc_list) except IOError: plug_in_ffdc_list = [] # Combine the files from plug_in_ffdc_list with the ffdc_file_list passed # in. Eliminate duplicates and sort the list. ffdc_file_list = sorted(set(ffdc_file_list + plug_in_ffdc_list)) if status_file_path != "": ffdc_file_list.insert(0, status_file_path) # Convert the list to a printable list. printable_ffdc_file_list = "\n".join(ffdc_file_list) # Open ffdc_file_list for writing. We will write a complete list of # FFDC files to it for possible use by plug-ins like cp_stop_check. ffdc_list_file = open(ffdc_list_file_path, 'w') ffdc_list_file.write(printable_ffdc_file_list + "\n") ffdc_list_file.close() indent = 0 width = 90 linefeed = 1 char = "=" gp.qprintn() gp.qprint_dashes(indent, width, linefeed, char) gp.qprintn("Copy this data to the defect:\n") if len(more_header_info) > 0: gp.qprintn(more_header_info) gp.qpvars(host_name, host_ip, openbmc_nickname, openbmc_host, openbmc_host_name, openbmc_ip, openbmc_username, openbmc_password, os_host, os_host_name, os_ip, os_username, os_password, pdu_host, pdu_host_name, pdu_ip, pdu_username, pdu_password, pdu_slot_no, openbmc_serial_host, openbmc_serial_host_name, openbmc_serial_ip, openbmc_serial_port) gp.qprintn() print_last_boots() gp.qprintn() gp.qprint_var(state) gp.qprintn() gp.qprintn("FFDC data files:") gp.qprintn(printable_ffdc_file_list) gp.qprintn() if len(ffdc_summary_info) > 0: gp.qprintn(ffdc_summary_info) gp.qprint_dashes(indent, width, linefeed, char)
def get_state(openbmc_host="", openbmc_username="", openbmc_password="", os_host="", os_username="", os_password="", req_states=default_req_states, quiet=None): r""" Get component states such as chassis state, bmc state, etc, put them into a dictionary and return them to the caller. Note that all substate values are strings. Description of arguments: openbmc_host The DNS name or IP address of the BMC. This defaults to global ${OPENBMC_HOST}. openbmc_username The username to be used to login to the BMC. This defaults to global ${OPENBMC_USERNAME}. openbmc_password The password to be used to login to the BMC. This defaults to global ${OPENBMC_PASSWORD}. os_host The DNS name or IP address of the operating system. This defaults to global ${OS_HOST}. os_username The username to be used to login to the OS. This defaults to global ${OS_USERNAME}. os_password The password to be used to login to the OS. This defaults to global ${OS_PASSWORD}. req_states This is a list of states whose values are being requested by the caller. quiet Indicates whether status details (e.g. curl commands) should be written to the console. Defaults to either global value of ${QUIET} or to 1. """ quiet = int(gp.get_var_value(quiet, 0)) # Set parm defaults where necessary and validate all parms. if openbmc_host == "": openbmc_host = BuiltIn().get_variable_value("${OPENBMC_HOST}") error_message = gv.svalid_value(openbmc_host, var_name="openbmc_host", invalid_values=[None, ""]) if error_message != "": BuiltIn().fail(gp.sprint_error(error_message)) if openbmc_username == "": openbmc_username = BuiltIn().get_variable_value("${OPENBMC_USERNAME}") error_message = gv.svalid_value(openbmc_username, var_name="openbmc_username", invalid_values=[None, ""]) if error_message != "": BuiltIn().fail(gp.sprint_error(error_message)) if openbmc_password == "": openbmc_password = BuiltIn().get_variable_value("${OPENBMC_PASSWORD}") error_message = gv.svalid_value(openbmc_password, var_name="openbmc_password", invalid_values=[None, ""]) if error_message != "": BuiltIn().fail(gp.sprint_error(error_message)) # NOTE: OS parms are optional. if os_host == "": os_host = BuiltIn().get_variable_value("${OS_HOST}") if os_host is None: os_host = "" if os_username is "": os_username = BuiltIn().get_variable_value("${OS_USERNAME}") if os_username is None: os_username = "" if os_password is "": os_password = BuiltIn().get_variable_value("${OS_PASSWORD}") if os_password is None: os_password = "" invalid_req_states = [ sub_state for sub_state in req_states if sub_state not in valid_req_states ] if len(invalid_req_states) > 0: error_message = "The following req_states are not supported:\n" +\ gp.sprint_var(invalid_req_states) BuiltIn().fail(gp.sprint_error(error_message)) # Initialize all substate values supported by this function. ping = 0 packet_loss = '' uptime = '' epoch_seconds = '' rest = '1' chassis = '' bmc = '' boot_progress = '' host = '' # Get the component states. if 'ping' in req_states: # See if the OS pings. cmd_buf = "ping -c 1 -w 2 " + openbmc_host if not quiet: gp.pissuing(cmd_buf) rc, out_buf = commands.getstatusoutput(cmd_buf) if rc == 0: ping = 1 if 'packet_loss' in req_states: # See if the OS pings. cmd_buf = "ping -c 5 -w 5 " + openbmc_host +\ " | egrep 'packet loss' | sed -re 's/.* ([0-9]+)%.*/\\1/g'" if not quiet: gp.pissuing(cmd_buf) rc, out_buf = commands.getstatusoutput(cmd_buf) if rc == 0: packet_loss = out_buf.rstrip("\n") if 'uptime' in req_states: cmd_buf = [ "BMC Execute Command", "cat /proc/uptime | cut -f 1 -d ' '", 'quiet=${1}' ] if not quiet: grp.rpissuing_keyword(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": stdout, stderr, rc = ret_values if rc == 0 and stderr == "": uptime = stdout if 'epoch_seconds' in req_states: date_cmd_buf = "date -u +%s" if USE_BMC_EPOCH_TIME: cmd_buf = ["BMC Execute Command", date_cmd_buf, 'quiet=${1}'] if not quiet: grp.rpissuing_keyword(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": stdout, stderr, rc = ret_values if rc == 0 and stderr == "": epoch_seconds = stdout.rstrip("\n") else: shell_rc, out_buf = gc.cmd_fnc_u(date_cmd_buf, quiet=1, print_output=0) if shell_rc == 0: epoch_seconds = out_buf.rstrip("\n") master_req_rest = ['rest', 'chassis', 'bmc', 'boot_progress', 'host'] req_rest = [ sub_state for sub_state in req_states if sub_state in master_req_rest ] need_rest = (len(req_rest) > 0) # Though we could try to determine 'rest' state on any of several calls, # for simplicity, we'll use 'chassis' to figure it out (even if the caller # hasn't explicitly asked for 'chassis'). if 'chassis' in req_states or need_rest: cmd_buf = ["Get Chassis Power State", "quiet=${" + str(quiet) + "}"] grp.rdpissuing_keyword(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": chassis = ret_values chassis = re.sub(r'.*\.', "", chassis) rest = '1' else: rest = ret_values if rest == '1': if 'bmc' in req_states: if OBMC_STATES_VERSION == 0: qualifier = "utils" else: # This will not be supported much longer. qualifier = "state_manager" cmd_buf = [ qualifier + ".Get BMC State", "quiet=${" + str(quiet) + "}" ] grp.rdpissuing_keyword(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": bmc = ret_values if 'boot_progress' in req_states: cmd_buf = ["Get Boot Progress", "quiet=${" + str(quiet) + "}"] grp.rdpissuing_keyword(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": boot_progress = ret_values if 'host' in req_states: if OBMC_STATES_VERSION > 0: cmd_buf = ["Get Host State", "quiet=${" + str(quiet) + "}"] grp.rdpissuing_keyword(cmd_buf) status, ret_values = \ BuiltIn().run_keyword_and_ignore_error(*cmd_buf) if status == "PASS": host = ret_values # Strip everything up to the final period. host = re.sub(r'.*\.', "", host) state = DotDict() for sub_state in req_states: if sub_state.startswith("os_"): # We pass "os_" requests on to get_os_state. continue cmd_buf = "state['" + sub_state + "'] = str(" + sub_state + ")" exec(cmd_buf) if os_host == "": # The caller has not specified an os_host so as far as we're concerned, # it doesn't exist. return state os_req_states = [ sub_state for sub_state in req_states if sub_state.startswith('os_') ] if len(os_req_states) > 0: # The caller has specified an os_host and they have requested # information on os substates. # Based on the information gathered on bmc, we'll try to make a # determination of whether the os is even up. We'll pass the result # of that assessment to get_os_state to enhance performance. os_up_match = DotDict() for sub_state in master_os_up_match: if sub_state in req_states: os_up_match[sub_state] = master_os_up_match[sub_state] os_up = compare_states(state, os_up_match) os_state = get_os_state(os_host=os_host, os_username=os_username, os_password=os_password, req_states=os_req_states, os_up=os_up, quiet=quiet) # Append os_state dictionary to ours. state.update(os_state) return state
def rprocess_plug_in_packages(plug_in_packages_list=None, call_point="setup", shell_rc="0x00000000", stop_on_plug_in_failure=1, stop_on_non_zero_rc=0, release_type="obmc", quiet=None, debug=None, return_history=False): r""" Call the external process_plug_in_packages.py to process the plug-in packages. Return the following: rc The return code - 0 = PASS, 1 = FAIL. shell_rc The shell return code returned by process_plug_in_packages.py. failed_plug_in_name The failed plug in name (if any). Description of arguments: plug_in_packages_list A python list of plug-in directory paths. call_point The call point program to be called for each plug-in package (e.g. post_boot). This name should not include the "cp_" prefix. shell_rc The user may supply a value other than zero to indicate an acceptable non-zero return code. For example, if this value equals 0x00000200, it means that for each plug-in call point that runs, a 0x00000200 will not be counted as a failure. stop_on_plug_in_failure If this parameter is set to 1, this program will stop and return non-zero if the call point program from any plug-in directory fails. Conversely, if it is set to false, this program will run the call point program from each and every plug-in directory regardless of their return values. Typical example cases where you'd want to run all plug-in call points regardless of success or failure would be "cleanup" or "ffdc" call points. stop_on_non_zero_rc If this parm is set to 1 and a plug-in call point program returns a valid non-zero return code (see "shell_rc" parm above), this program will stop processing and return 0 (success). Since this constitutes a successful exit, this would normally be used where the caller wishes to stop processing if one of the plug-in directory call point programs returns a special value indicating that some special case has been found. An example might be in calling some kind of "check_errl" call point program. Such a call point program might return a 2 (i.e. 0x00000200) to indicate that a given error log entry was found in an "ignore" list and is therefore to be ignored. That being the case, no other "check_errl" call point program would need to be called. release_type The type of release being tested (e.g. "obmc", "op", "fips"). This influences which integrated plug-ins are selected. quiet If quiet is set to 1, this function will NOT write status messages to stdout. This will default to the global quiet program parm or to 0. debug If this parameter is set to 1, this function will print additional debug information. This is mainly to be used by the developer of this function. This will default to the global quiet program parm or to 0. return_history In addition to rc, shell_rc and failed_plug_in_name, return a list containing historical output that looks like the following: history: history[0]: #(CDT) 2018/10/30 12:25:49 - Running OBMC_Sample/cp_post_stack """ rc = 0 plug_in_packages_list = gp.get_var_value(plug_in_packages_list, []) # If there are no plug-in packages to process, return successfully. if len(plug_in_packages_list) == 0: if return_history: return 0, 0, "", [] else: return 0, 0, "" quiet = int(gp.get_var_value(quiet, 0)) debug = int(gp.get_var_value(debug, 0)) # Create string from list. plug_in_dir_paths = ':'.join(plug_in_packages_list) temp = tempfile.NamedTemporaryFile() temp_file_path = temp.name temp2 = tempfile.NamedTemporaryFile() temp_properties_file_path = temp2.name if debug: os.environ["PERF_TRACE"] = "1" debug_string = " --quiet=0" else: debug_string = "" loc_shell_rc = 0 sub_cmd_buf = "process_plug_in_packages.py" + debug_string +\ " --call_point=" + call_point + " --allow_shell_rc=" +\ str(shell_rc) + " --stop_on_plug_in_failure=" +\ str(stop_on_plug_in_failure) + " --stop_on_non_zero_rc=" +\ str(stop_on_non_zero_rc) + " " + plug_in_dir_paths if quiet: cmd_buf = sub_cmd_buf + " > " + temp_file_path + " 2>&1" else: cmd_buf = "set -o pipefail ; " + sub_cmd_buf + " 2>&1 | tee " +\ temp_file_path if debug: gp.print_issuing(cmd_buf) else: gp.print_timen("Processing " + call_point + " call point programs.") sub_proc = subprocess.Popen(cmd_buf, shell=True, executable='/bin/bash') sub_proc.communicate() proc_plug_pkg_rc = sub_proc.returncode if return_history: # Get the "Running" statements from the output. regex = " Running [^/]+/cp_" cmd_buf = "egrep '" + regex + "' " + temp_file_path _, history = gc.shell_cmd(cmd_buf, quiet=(not debug), print_output=0, show_err=0, ignore_err=1) history = [x + "\n" for x in filter(None, history.split("\n"))] else: history = [] # As process_plug_in_packages.py help text states, it will print the values of failed_plug_in_name and # shell_rc in the following format: # failed_plug_in_name: <failed plug-in value, if any> # shell_rc: <shell return code value of last call point program> # We want to obtain those values from the output. To make the task simpler, we'll start by grepping the # output for lines that might fit such a format: # A valid bash variable against the left margin followed by... # - A colon followed by... # - Zero or more spaces bash_var_regex = "[_[:alpha:]][_[:alnum:]]*" regex = "^" + bash_var_regex + ":[ ]*" cmd_buf = "egrep '" + regex + "' " + temp_file_path + " > " +\ temp_properties_file_path gp.dprint_issuing(cmd_buf) grep_rc = os.system(cmd_buf) # Next we call my_parm_file to create a properties dictionary. properties = gm.my_parm_file(temp_properties_file_path) # Finally, we access the 2 values that we need. shell_rc = int(properties.get('shell_rc', '0x0000000000000000'), 16) failed_plug_in_name = properties.get('failed_plug_in_name', '') if proc_plug_pkg_rc != 0: if quiet: os.system("cat " + temp_file_path + " >&2") if grep_rc != 0: gp.print_var(grep_rc, gp.hexa()) gp.print_var(proc_plug_pkg_rc, gp.hexa()) gp.print_timen("Re-cap of plug-in failures:") gc.cmd_fnc_u("egrep -A 1 '^failed_plug_in_name:[ ]+' " + temp_properties_file_path + " | egrep -v '^\\--'", quiet=1, show_err=0) rc = 1 if return_history: return rc, shell_rc, failed_plug_in_name, history else: return rc, shell_rc, failed_plug_in_name