openbmc-test-automation/ffdc/ffdc_collector.py

35 This is for plugin functions returning data or responses to the caller
36 in YAML plugin setup.
40     - plugin:
41       - plugin_name: plugin.ssh_execution
48      - plugin:
49         - plugin_name: plugin.print_vars
54 where first plugin "version" var is used by another plugin in the YAML
55 block or plugin
58 # Global variables for storing plugin return values, plugin return variables,
66 # Hold the plugin return values in a dictionary and plugin return variables in
69 # from the plugin block that need processing.
73 # Hold the plugin return named variables if the function returned values are
74 # lists or dictionaries. This list is used to reference the plugin dictionary
82 # Plugin error state defaults.
122         # Set the plugin error state.
678                 if "plugin" in each_cmd:
679                     # If the error is set and plugin explicitly
683                     ] and self.plugin_error_check(each_cmd["plugin"]):
685                             "\n\t[PLUGIN-ERROR] exit_on_error: %s"
689                             "\t[PLUGIN-SKIP] %s" % each_cmd["plugin"][0]
693                     # call the plugin
694                     self.logger.info("\n\t[PLUGIN-START]")
695                     result = self.execute_plugin_block(each_cmd["plugin"])
696                     self.logger.info("\t[PLUGIN-END]\n")
1398         Pack the plugin commands into qualified Python string objects.
1401         to contain a list of plugin commands read from a YAML file. The method
1403         for each plugin command, and returns a list of these string objects.
1406             plugin_cmd_list (list): A list of plugin commands containing
1407                                     plugin names and arguments.
1408                                     Plugin block read from YAML
1410                                      {'plugin_name':'plugin.foo_func.my_func'},
1416                 - plugin:
1417                   - plugin_name: plugin.foo_func.my_func
1423                 - plugin:
1424                     - plugin_name: result = plugin.foo_func.my_func
1430                 - plugin:
1431                     - plugin_name: result1,result2 = plugin.foo_func.my_func
1441         # Declare a variable plugin resp that can accept any data type.
1447             # Get plugin module name
1450             # Get plugin function name
1454             # Equal separator means plugin function returns result.
1456                 # Ex. ['result', 'plugin.foo_func.my_func']
1458                 # plugin func return data.
1469             # Walk the plugin args ['arg1,'arg2']
1470             # If the YAML plugin statement 'plugin_args' is not declared.
1486                 plugin.redfish.enumerate_request(
1499                 f"\tDebug Plugin function: \n\t\t{plugin_name}."
1503             # For generic logging plugin info.
1514             # Update plugin vars dict if there is any.
1518             # Set the plugin error state.
1523         # There is a real error executing the plugin function.
1539                         self.logger.error("\tWARN: Plugin error check skipped")
1542                             "\tERROR: Plugin expects return data: %s"
1548                         "\tERROR: Plugin func failed to return data"
1591             # exact or in the string. If matches update the plugin element
1611         Generate a string representation of plugin arguments, replacing the
1614         This method generates a string representation of the provided plugin
1621             plugin_args (list): A list of plugin arguments.
1624             str: The generated string representation of the plugin arguments.
1642         Parse the plugin function response and update plugin return variables.
1644         This method parses the response data from a plugin function and
1645         updates the plugin return variables accordingly. The method takes the
1647         plugin function.
1653         plugin block execution.
1656            plugin_resp (Any): The response data from the plugin function.
1664         # There is nothing to update the plugin response.
1688         # Iterate if there is a list of plugin return vars to update.
1702         # Done updating plugin dict irrespective of pass or failed,
1703         # clear all the list element for next plugin block execute.
1708         Decode environment and plugin variables and populate the argument list.
1712         through the list, decodes environment and plugin variables, and
1723         Returns the populated plugin list
1728                                     and plugin variables.
1732                     plugin variables.
1749         Update environment variables and plugin variables based on the
1753         to contain a string representing environment variables and plugin
1762         the corresponding environment variables and plugin variables.
1765             yaml_arg_str (str):   A string containing environment and plugin
1769             str:   The updated YAML argument string with plugin variables
1773         # Parse and convert the Plugin YAML vars string to python vars
1796         Parse the string for plugin vars.
1801             # Example, list of plugin vars env_var_names_list
1815                     If this plugin var exist but empty in dict, don't replace.
1816                     his is either a YAML plugin statement incorrectly used or
1817                     user added a plugin var which is not going to be populated.
1822                         directly in plugin function call.
1840         Process plugin error dictionary and return the corresponding error
1851                                         plugin error information.