+ ${suffix}= BuiltIn.Set_Variable_If '${testcase}' != '' --${testcase} ${EMPTY}
+ ${date}= DateTime.Get Current Date
+ ${timestamp}= DateTime.Convert Date ${date} epoch
+ RETURN ${testtool}--${name}${suffix}.${timestamp}.log
+
+Set_User_Configurable_Variable_Default
+ [Documentation] Set a default value for an user configurable variable.
+ ... This keyword is needed if your default value is calculated using
+ ... a complex expression which needs BuiltIn.Evaluate or even more
+ ... complex keywords. It sets the variable ${name} (the name of the
+ ... variable MUST be specified WITHOUT the ${} syntactic sugar due
+ ... to limitations of Robot Framework) to ${value} but only if the
+ ... variable ${name} was not set previously. This keyword is intended
+ ... for user configurable variables which are supposed to be set only
+ ... with pybot -v; calling this keyword on a variable that was already
+ ... set by another keyword will silently turn the call into a NOP and
+ ... thus is a bug in the suite or resource trying to call this
+ ... keyword.
+ [Arguments] ${name} ${value}
+ # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning
+ # evaluating it only when the user did not set anything and thus the
+ # default is needed). This might be needed to avoid potentially costly
+ # keyword invocations when they are not needed. Currently no need for
+ # this was identified, thus leaving it here as a TODO. Based on
+ # comments the best approach would be to create another keyword that
+ # expects a ScalarClosure in the place of ${value} and calls the
+ # closure to get the value but only if the value is needed).
+ # The best idea how to implement this "laziness" would be to have the
+ # used to define another keyword that will be responsible for getting
+ # the default value and then passing the name of this getter keyword
+ # to this keyword. Then this keyword would call the getter (to obtain
+ # the expensive default value) only if it discovers that this value
+ # is really needed (because the variable is not set yet).
+ # TODO: Is the above TODO really necessary? Right now we don't have any
+ # examples of "expensive default values" where to obtain the default
+ # value is so expensive on resources (e.g. need to SSH somewhere to
+ # check something) that we would want to skip the calculation if the
+ # variable for which it is needed has a value already provided by the
+ # user using "pybot -v" or something. One example would be
+ # JAVA_HOME if it would be designed as user-configurable variable
+ # (currently it is not; users can specify "use jdk7" or "use jdk8"
+ # but not "use the jdk over there"; and there actually is no JAVA_HOME
+ # present in the resource, rather the Java invocation command uses the
+ # Java invocation with a full path). The default value of JAVA_HOME
+ # has to be obtained by issuing commands on the SSH connection where
+ # the resulting Java invocation command will be used (to check
+ # multiple candidate paths until one that fits is found) and we could
+ # skip all this checking if a JAVA_HOME was supplied by the user using
+ # "pybot -v".
+ ${value}= BuiltIn.Get_Variable_Value \${${name}} ${value}
+ BuiltIn.Set_Suite_Variable \${${name}} ${value}
+
+Convert_To_Minutes
+ [Documentation] Convert a Robot time string to an integer expressing the time in minutes, rounded up
+ ... This is a wrapper around DateTime.Convert_Time which does not
+ ... provide this functionality directly nor is even able to produce
+ ... an integer directly. It is needed for RestPerfClient which
+ ... cannot accept floats for its --timeout parameter and interprets
+ ... the value supplied in this parameter in minutes.
+ [Arguments] ${time}
+ ${seconds}= DateTime.Convert_Time ${time} result_format=number
+ ${minutes}= BuiltIn.Evaluate int(math.ceil(${seconds}/60.0)) modules=math
+ RETURN ${minutes}
+
+Write Commands Until Expected Prompt
+ [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
+ [Arguments] ${cmd} ${prompt} ${timeout}=${DEFAULT_TIMEOUT}
+ BuiltIn.Log cmd: ${cmd}
+ SSHLibrary.Set Client Configuration timeout=${timeout}
+ SSHLibrary.Read
+ SSHLibrary.Write ${cmd}
+ ${output}= SSHLibrary.Read Until ${prompt}
+ RETURN ${output}
+
+Write Commands Until Expected Regexp
+ [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
+ [Arguments] ${cmd} ${regexp} ${timeout}=${DEFAULT_TIMEOUT}
+ BuiltIn.Log cmd: ${cmd}
+ SSHLibrary.Set Client Configuration timeout=${timeout}
+ SSHLibrary.Read
+ SSHLibrary.Write ${cmd}
+ ${output}= SSHLibrary.Read Until Regexp ${regexp}
+ RETURN ${output}
+
+Install Package On Ubuntu System
+ [Documentation] Keyword to install packages for testing to Ubuntu Mininet VM
+ [Arguments] ${package_name} ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
+ Log Keyword to install package to Mininet Ubuntu VM
+ Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
+ SSHKeywords.Flexible Mininet Login user=${user} password=${password}
+ Write sudo apt-get install -y ${package_name}
+ Read Until ${prompt}
+
+Json Parse From String
+ [Documentation] Parse given plain string into json (dictionary)
+ [Arguments] ${plain_string_with_json}
+ ${json_data}= Evaluate json.loads('''${plain_string_with_json}''') json
+ RETURN ${json_data}
+
+Json Parse From File
+ [Documentation] Parse given file content into json (dictionary)
+ [Arguments] ${json_file}
+ ${json_plain_string}= OperatingSystem.Get file ${json_file}
+ ${json_data}= Json Parse From String ${json_plain_string}
+ RETURN ${json_data}
+
+Modify Iptables On Remote System
+ [Documentation] Wrapper keyword to run iptables with any given ${iptables_rule} string on the remote system given
+ ... by ${remote_system_ip}. The iptables listing will be output before and after the command is run
+ [Arguments] ${remote_system_ip} ${iptables_rule} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
+ ${list_iptables_command}= BuiltIn.Set Variable sudo /sbin/iptables -L -n
+ ${output}= Utils.Run Command On Remote System
+ ... ${remote_system_ip}
+ ... ${list_iptables_command}
+ ... ${user}
+ ... ${password}
+ ... prompt=${prompt}
+ BuiltIn.Log ${output}
+ Utils.Run Command On Remote System
+ ... ${remote_system_ip}
+ ... sudo /sbin/iptables ${iptables_rule}
+ ... ${user}
+ ... ${password}
+ ... prompt=${prompt}
+ ${output}= Utils.Run Command On Remote System
+ ... ${remote_system_ip}
+ ... ${list_iptables_command}
+ ... ${user}
+ ... ${password}
+ ... prompt=${prompt}
+ BuiltIn.Log ${output}
+
+Get_Sysstat_Statistics
+ [Documentation] Store current connection index, open new connection to ip_address. Run command to get sysstat results from script,
+ ... which is running on all children nodes. Returns cpu, network, memory usage statistics from the node for each 10 minutes
+ ... that node was running. Used for debug purposes. Returns whole output of sysstat.
+ [Arguments] ${ip_address}=${ODL_SYSTEM_IP}
+ ${current_connection}= SSHLibrary.Get_Connection
+ SSHKeywords.Open_Connection_To_ODL_System ${ip_address}
+ SSHLibrary.Write sar -A -f /var/log/sa/sa*
+ ${output}= SSHLibrary.Read_Until_Prompt
+ BuiltIn.Log ${output}
+ SSHLibrary.Close_Connection
+ RETURN ${output}
+ [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_connection.index}
+
+Check Diagstatus
+ [Documentation] GET http://${ip_address}:${RESTCONFPORT}/diagstatus and return the response. ${check_status}
+ ... and ${expected_status_code} can be used to ignore the status code, or validate any status code value.
+ ... By default, this keyword will pass if the status code returned is 200, and fail otherwise.
+ [Arguments] ${ip_address}=${ODL_SYSTEM_IP} ${check_status}=True ${expected_status}=${200}
+ RequestsLibrary.Create Session diagstatus_session http://${ip_address}:${RESTCONFPORT}
+ ${resp}= RequestsLibrary.Get On Session diagstatus_session url=/diagstatus
+ IF "${check_status}" == "True"
+ BuiltIn.Should Be Equal As Strings ${resp.status_code} ${expected_status}
+ END
+ RETURN ${resp}