Library Process
Library Collections
Library RequestsLibrary
-Library ./UtilLibrary.py
-Resource KarafKeywords.robot
-Variables ../variables/Variables.py
+Library ${CURDIR}/UtilLibrary.py
+Resource ${CURDIR}/SSHKeywords.robot
+Resource ${CURDIR}/TemplatedRequests.robot
+Variables ${CURDIR}/../variables/Variables.py
*** Variables ***
# TODO: Introduce ${tree_size} and use instead of 1 in the next line.
... or as the first line of the test if FastFail module is not being
... used. It reports the URL of the bug on console and also puts it
... into the Robot log file.
- ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', '''${TEST_MESSAGE}''')) > 0 modules=re
+ ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
${newline}= BuiltIn.Evaluate chr(10)
${msg}= BuiltIn.Set_Variable This test fails due to https://bugs.opendaylight.org/show_bug.cgi?id=${number}
... or as the first line of the test if FastFail module is not being
... used. It reports the URL of the bug on console and also puts it
... into the Robot log file.
- ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', '''${TEST_MESSAGE}''')) > 0 modules=re
+ ${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
${newline}= BuiltIn.Evaluate chr(10)
${reference}= String.Replace_String_Using_Regexp ${SUITE_NAME}_${TEST_NAME} [ /\.-] _
${reference}= String.Convert_To_Lowercase ${reference}
${msg}= BuiltIn.Set_Variable ... click for list of related bugs or create a new one if needed (with the${newline}"${reference}"${newline}reference somewhere inside)
- ${bugs}= BuiltIn.Set_Variable "https://bugs.opendaylight.org/buglist.cgi?f1=longdesc&o1=substring&v1=${reference}&order=bug_status"
+ ${bugs}= BuiltIn.Set_Variable "https://bugs.opendaylight.org/buglist.cgi?f1=cf_external_ref&o1=substring&v1=${reference}&order=bug_status"
BuiltIn.Set Test Message ${msg}${newline}${bugs}${newline}${newline}${TEST_MESSAGE}
BuiltIn.Log ${msg}${newline}${bugs}
[Documentation] Reduces the common work of running a command on a remote system to a single higher level
... robot keyword, taking care to log in with a public key and. The command given is written
... and the output returned. No test conditions are checked.
- Log Attempting to execute ${cmd} on ${system} by ${user} with ${keyfile_pass} and ${prompt}
+ ${current_ssh_connection}= SSHLibrary.Get Connection
+ BuiltIn.Log Attempting to execute command "${cmd}" on remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}"
+ BuiltIn.Log ${password}
${conn_id}= SSHLibrary.Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
Flexible SSH Login ${user} ${password}
${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True
SSHLibrary.Close Connection
Log ${stderr}
+ [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index}
[Return] ${stdout}
Write_Bare_Ctrl_C
Run Command On Controller
[Arguments] ${system}=${ODL_SYSTEM_IP} ${cmd}=echo ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
[Documentation] Call Run Comand On Remote System, but with default values suitable for Controller machine.
+ BuiltIn.Log ${password}
BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
Verify File Exists On Remote System
[Return] ${output}
Post Elements To URI
- [Arguments] ${rest_uri} ${data} ${headers}=${headers}
+ [Arguments] ${rest_uri} ${data} ${headers}=${headers} ${session}=session
[Documentation] Perform a POST rest operation, using the URL and data provided
- ${resp} = RequestsLibrary.Post Request session ${rest_uri} data=${data} headers=${headers}
- Should Be Equal As Strings ${resp.status_code} 200
+ ${resp} = RequestsLibrary.Post Request ${session} ${rest_uri} data=${data} headers=${headers}
+ Log ${resp.content}
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
Remove All Elements At URI
[Arguments] ${uri}
${resp} RequestsLibrary.Delete Request session ${uri}
- Should Be Equal As Strings ${resp.status_code} 200
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
Remove All Elements At URI And Verify
[Arguments] ${uri}
${resp} RequestsLibrary.Delete Request session ${uri}
- Should Be Equal As Strings ${resp.status_code} 200
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
${resp} RequestsLibrary.Get Request session ${uri}
Should Be Equal As Strings ${resp.status_code} 404
+Remove All Elements If Exist
+ [Arguments] ${uri}
+ [Documentation] Delete all elements from an URI if the configuration was not empty
+ ${resp} RequestsLibrary.Get Request session ${uri}
+ Run Keyword If '${resp.status_code}'!='404' Remove All Elements At URI ${uri}
+
Add Elements To URI From File
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers}
${body} OperatingSystem.Get File ${data_file}
${resp} RequestsLibrary.Put Request session ${dest_uri} data=${body} headers=${headers}
- Should Be Equal As Strings ${resp.status_code} 200
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
Add Elements To URI From File And Verify
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers}
${body} OperatingSystem.Get File ${data_file}
${resp} RequestsLibrary.Put Request session ${dest_uri} data=${body} headers=${headers}
- Should Be Equal As Strings ${resp.status_code} 200
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
${resp} RequestsLibrary.Get Request session ${dest_uri}
Should Not Be Equal ${resp.status_code} 404
Add Elements To URI And Verify
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers}
${resp} RequestsLibrary.Put Request session ${dest_uri} ${data_file} headers=${headers}
- Should Be Equal As Strings ${resp.status_code} 200
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
${resp} RequestsLibrary.Get Request session ${dest_uri}
Should Not Be Equal ${resp.status_code} 404
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers}
${body} OperatingSystem.Get File ${data_file}
${resp} RequestsLibrary.Post Request session ${dest_uri} data=${body} headers=${headers}
- Should Be Equal As Strings ${resp.status_code} 200
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
Run Process With Logging And Status Check
[Arguments] @{proc_args}
${index}= Set Variable -1
: FOR ${i} IN RANGE ${length}
\ ${dictionary}= Get From List ${dictionary_list} ${i}
- \ Run Keyword If '&{dictionary}[${key}]' == '${value}' Set Test Variable ${index} ${i}
+ \ Run Keyword If """&{dictionary}[${key}]""" == """${value}""" Set Test Variable ${index} ${i}
[Return] ${index}
Check Item Occurrence
Log ${resp.content}
Should Be Equal As Strings ${resp.status_code} ${status_code}
[Return] ${resp}
+
+Get Log File Name
+ [Arguments] ${testtool} ${testcase}=${EMPTY}
+ [Documentation] Get the name of the suite sanitized to be usable as a part of filename.
+ ... These names are used to constructs names of the log files produced
+ ... by the testing tools so two suites using a tool wont overwrite the
+ ... log files if they happen to run in one job.
+ ${name}= BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-")
+ ${suffix}= BuiltIn.Set_Variable_If '${testcase}' != '' --${testcase} ${EMPTY}
+ [Return] ${testtool}--${name}${suffix}.log
+
+Set_User_Configurable_Variable_Default
+ [Arguments] ${name} ${value}
+ [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.
+ # 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
+ [Arguments] ${time}
+ [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.
+ ${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
+ [Arguments] ${cmd} ${prompt} ${timeout}=30s
+ [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
+ SSHLibrary.Set Client Configuration timeout=${timeout}
+ SSHLibrary.Write ${cmd}
+ ${output}= SSHLibrary.Read Until ${prompt}
+ [Return] ${output}
+
+Install Package On Ubuntu System
+ [Arguments] ${package_name} ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s
+ [Documentation] Keyword to install packages for testing to Ubuntu Mininet VM
+ Log Keyword to install package to Mininet Ubuntu VM
+ Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout}
+ Flexible Mininet Login user=${user} password=${password}
+ Write sudo apt-get install -y ${package_name}
+ Read Until ${prompt}
Code Review / integration / test.git / blobdiff