openbmc-test-automation/lib/gen_plug_in_utils.py

4 This module provides functions which are useful to plug-in call point programs.
23     Return the plug-in package name (e.g. "OS_Console", "DB_Logging").
30     plug_in_package_name = os.path.basename(gp.pgm_dir_path[:-1])
41 …Return an OrderedDict which is sorted by key and which contains all of the plug-in environment var…
52 …- Set a default value for environment variable AUTOBOOT_OPENBMC_NICKNAME/AUTOIPL_FSP1_NICKNAME if …
54     - Register PASSWORD variables to prevent their values from being printed.
66 … non-string type in setting global variables (with the exception of os.environ values which must be
72 …general                         Return general plug-in parms (e.g. those beginning with "AUTOBOOT"…
74 …custom                          Return custom plug-in parms (i.e. those beginning with the upper c…
75                                     name of the plug-in package, for example "OBMC_SAMPLE_PARM1").
76     plug_in_package_name            The name of the plug-in package for which custom parms are to be
122 …# Create a list of plug-in environment variables by pre-pending <all caps plug-in package name>_<a…
132     #  plug_in_parm_names[2]: STOP_ESEL_STOP_FILE_PATH
137     # Initialize unset plug-in vars.
182 …Sprint the plug-in environment variables (i.e. those that begin with the global PLUG_VAR_PREFIX va…
183     those that begin with <plug-in package_name>_ in upper case letters.).
210     Print plug-in header.
212 …en debug is set, print all plug_prefix variables (e.g. AUTOBOOT_OPENBMC_HOST, etc.) and all plug-in
214 …print only the plug-in environment variables (e.g. OBMC_SAMPLE_PARM1) with no surrounding dashed l…
216 …NOTE: plug-in environment variables means any variable defined in the <plug-in dir>/parm_def file …
217     any environment variables whose names begin with the upper-case plug-in package name.
227     Get all plug-in variables and put them in corresponding global variables.
230 …with the upper case version of the plug-in package name + underscore (e.g. OP_SAMPLE_VAR1 for plug…
238 …mod_name                        The name of the module whose global plug-in variables should be re…
261     - <upper case package_name>_<var_name>
262     - <PLUG_VAR_PREFIX>_OVERRIDE_<var_name>
263     - <PLUG_VAR_PREFIX>_<var_name>
270     Let's say your plug-in is named "OS_Console" and you call this function as follows:
276     - OS_CONSOLE_QUIET
277     - AUTOBOOT_OVERRIDE_QUIET
278     - AUTOBOOT_QUIET
283 …plug-ins.  Let's further suppose that the user wishes to run the master program with --debug=0 but…
284     to have all plug-ins run with --debug=1.  This could be accomplished with the following call:
285     export AUTOBOOT_OVERRIDE_DEBUG=1 ; obmc_boot --debug=0 --plug_in_dir_paths=<list of plug ins>
287 …As another example, let's suppose that the user wishes to have just the OS_Console plug-in run wit…
289     export OS_CONSOLE_DEBUG=1 ; obmc_boot --debug=0 --plug_in_dir_paths=<list of plug ins>
292     have all other plug-ins run with debug:
293     export AUTOBOOT_OVERRIDE_DEBUG=1 ; export OS_CONSOLE_DEBUG=0 ; obmc_boot --debug=0
294     --plug_in_dir_paths=<list of plug ins>
307         # A package-name version of the variable was found so return its value.
330 …In addition, for each plug-in in required_plug_in_names, set the global plug-in variables.  This is
331     useful for callers who then want to validate certain values from other plug-ins.
338 …plug_in_dir_paths               A string which is a colon-delimited list of plug-ins specified by …
371     Create and return a directory path name that is suitable for saving plug-in data.
377 …plug_in_package_name            The plug-in package name.  This defaults to the name of the caller…
378 …                           plug-in package.  However, the caller can specify another value in order
379                                     to retrieve data saved by another plug-in package.
411     Create a directory suitable for saving plug-in processing data and return its path name.
422     gc.shell_cmd("mkdir -p " + plug_in_save_dir_path)
435         "rm -rf " + compose_plug_in_save_dir_path(plug_in_package_name)
441     Save a value in a plug-in save file.  The value may be retrieved later via a call to the
445     creating the plug-in save file.
454 … In this example, the value "5" would be saved to the "my_var1" file in the plug-in save directory.
456     Example 2:
460 … In this example, the value "5" would be saved to the "my_var1" file in the plug-in save directory.
474         var_name = gp.get_arg_name(0, 1, stack_frame_ix=2)
484     Return a value from a plug-in save file.
488     Mode 1 - The output of this function is assigned to a variable:
492     my_var1 = restore_plug_in_value(2)
496     Mode 2 - The output of this function is NOT assigned to a variable:
500     if restore_plug_in_value('my_var1', 2):
510 …default                         The default value to be returned if there is no plug-in save file …
515     lvalue = gp.get_arg_name(0, -1, stack_frame_ix=2)
524             "Programmer error - Too many arguments passed for this function."
558     There are cases where plug-ins are called by a multi-layered stack:
565 …master) and and then called again directly by obmc_boot_test.py (the child).  Some plug-in program…
590     Find the directory containing the tarball tools and pre-pend it to PATH.
616 … When a plug-in call point program returns this value, it indicates that master program should stop
627 …When a plug-in call point program returns this value, it indicates that FFDC data should be collec…