Changes to run_keyword:
- Allow multiple lib/resource paths separated by ":" for lib_file_path.
- Allow multiple keywords separated by " ; " for keyword_string.
- Add smarts to allow assignments (e.g. ${state}= Get State).
Change-Id: Idf38edb18b6b0bec0e6cd53ebc0b420439931306
Signed-off-by: Michael Walsh <micwalsh@us.ibm.com>
diff --git a/extended/run_keyword.robot b/extended/run_keyword.robot
old mode 100755
new mode 100644
index 52924d1..cf45d29
--- a/extended/run_keyword.robot
+++ b/extended/run_keyword.robot
@@ -1,6 +1,31 @@
*** Settings ***
Documentation Run the caller's keyword string.
+# Description of parameters:
+# keyword_string The keyword string to be run by this program. If this
+# keyword string contains " ; " anywhere, it will be taken to
+# be multiple keyword strings (see example below). Each
+# keywrod may also include a variable assignment. Example:
+# ${my_var}= My Keyword
+# lib_file_path The path to a library or resource needed to run the keywords.
+# This may contain a colon-delimited list of library/resource
+# paths.
+# test_mode This means that this program should go through all the
+# motions but not actually do anything substantial.
+# debug If this parameter is set to "1", this program will print
+# additional debug information.
+# quiet If this parameter is set to "1", this program will print
+# only essential information, i.e. it will not echo parameters,
+# echo commands, print the total run time, etc.
+
+# Example calls:
+# cd $HOME/git/openbmc-test-automation
+# export PYTHONPATH=${HOME}/git/openbmc-test-automation/lib/
+
+# robot --outputdir=/tmp -v OPENBMC_HOST:barp01 -v 'keyword_string:Log To Console Hi.' extended/run_keyword.robot
+
+# robot --outputdir=/tmp -v OPENBMC_HOST:barp01 -v 'keyword_string:${state}= Get State quiet=${1} ; Rpvar state' -v lib_file_path:state.py extended/run_keyword.robot
+
# NOTE: Robot searches PYTHONPATH for libraries.
Library run_keyword.py