*** Settings ***
Documentation General Utils library. This library has broad scope, it can be used by any robot system tests.
Library SSHLibrary
-Library HttpLibrary.HTTP
Library String
Library DateTime
Library Process
Library ${CURDIR}/UtilLibrary.py
Resource ${CURDIR}/SSHKeywords.robot
Resource ${CURDIR}/TemplatedRequests.robot
-Variables ${CURDIR}/../variables/Variables.py
+Resource ${CURDIR}/../variables/Variables.robot
*** Variables ***
# TODO: Introduce ${tree_size} and use instead of 1 in the next line.
*** Keywords ***
Start Mininet
- [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${timeout}=30s
+ [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${TOOLS_SYSTEM_PROMPT} ${timeout}=30s
[Documentation] Basic setup/cleanup work that can be done safely before any system
... is run.
Log Start the test on the base edition
Read Until mininet>
Stop Mininet
- [Arguments] ${prompt}=${DEFAULT_LINUX_PROMPT}
+ [Arguments] ${prompt}=${TOOLS_SYSTEM_PROMPT}
[Documentation] Cleanup/Shutdown work that should be done at the completion of all
... tests
Log Stop the test on the base edition
Read Until ${prompt}
Close Connection
-Report_Failure_Due_To_Bug
+Report Failure Due To Bug
[Arguments] ${number} ${include_bug_in_tags}=True
[Documentation] Report that a test failed due to a known Bugzilla bug whose
... number is provided as an argument.
... into the Robot log file.
${test_skipped}= BuiltIn.Evaluate len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0 modules=re
BuiltIn.Return From Keyword If ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
- ${bug_url}= BuiltIn.Set_Variable https://bugs.opendaylight.org/show_bug.cgi?id=${number}
+ Comment Jira tickets are {PROJECT}-{NUMBER} while Bugzilla tickets are {NUMBER}
+ ${match} BuiltIn.Run Keyword And Return Status Should Contain ${number} -
+ ${bug_url}= BuiltIn.Set Variable If ${match} https://jira.opendaylight.org/browse/${number} https://bugs.opendaylight.org/show_bug.cgi?id=${number}
${msg}= BuiltIn.Set_Variable This test fails due to ${bug_url}
${newline}= BuiltIn.Evaluate chr(10)
BuiltIn.Set Test Message ${msg}${newline}${newline}${TEST_MESSAGE}
BuiltIn.Log ${msg}
- BuiltIn.Run_Keyword_If "${include_bug_in_tags}"=="True" Set Tags ${bug_url}
+ BuiltIn.Run Keyword If "${include_bug_in_tags}"=="True" Set Tags ${bug_url}
Report_Failure_And_Point_To_Linked_Bugs
[Documentation] Report that a test failed and point to linked Bugzilla bug(s).
... strings are checked for existence.
${resp} RequestsLibrary.Get Request ${session} ${OPERATIONAL_NODES_API}/node/${node}
Should Be Equal As Strings ${resp.status_code} 200
- Should Contain ${resp.content} flow-capable-node-connector-statistics
- Should Contain ${resp.content} flow-table-statistics
+ Should Contain ${resp.text} flow-capable-node-connector-statistics
+ Should Contain ${resp.text} flow-table-statistics
Check For Specific Number Of Elements At URI
[Arguments] ${uri} ${element} ${expected_count} ${session}=session
[Documentation] A GET is made to the specified ${URI} and the specific count of a
... given element is done (as supplied by ${element} and ${expected_count})
${resp} RequestsLibrary.Get Request ${session} ${uri}
- Log ${resp.content}
+ Log ${resp.text}
Should Be Equal As Strings ${resp.status_code} 200
- Should Contain X Times ${resp.content} ${element} ${expected_count}
+ Should Contain X Times ${resp.text} ${element} ${expected_count}
+
+Log Content
+ [Arguments] ${resp_content}
+ ${resp_json} = BuiltIn.Run Keyword If '''${resp_content}''' != '${EMPTY}' RequestsLibrary.To Json ${resp_content} pretty_print=True
+ ... ELSE BuiltIn.Set Variable ${EMPTY}
+ BuiltIn.Log ${resp_json}
+ [Return] ${resp_json}
Check For Elements At URI
- [Arguments] ${uri} ${elements} ${session}=session
+ [Arguments] ${uri} ${elements} ${session}=session ${pretty_print_json}=False
[Documentation] A GET is made at the supplied ${URI} and every item in the list of
... ${elements} is verified to exist in the response
${resp} RequestsLibrary.Get Request ${session} ${uri}
- Log ${resp.content}
+ BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.text}
+ ... ELSE BuiltIn.Log ${resp.text}
Should Be Equal As Strings ${resp.status_code} 200
- : FOR ${i} IN @{elements}
- \ Should Contain ${resp.content} ${i}
+ FOR ${i} IN @{elements}
+ Should Contain ${resp.text} ${i}
+ END
Check For Elements Not At URI
- [Arguments] ${uri} ${elements} ${session}=session
- [Documentation] A GET is made at the supplied ${URI} and every item in the list of
- ... ${elements} is verified to NOT exist in the response
+ [Arguments] ${uri} ${elements} ${session}=session ${pretty_print_json}=False ${check_for_null}=False
+ [Documentation] A GET is made at the supplied ${uri} and every item in the list of
+ ... ${elements} is verified to NOT exist in the response. If ${check_for_null} is True
+ ... return of 404 is treated as empty list. From Neon onwards, an empty list is always
+ ... returned as null, giving 404 on rest call.
${resp} RequestsLibrary.Get Request ${session} ${uri}
- Log ${resp.content}
+ BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.text}
+ ... ELSE BuiltIn.Log ${resp.text}
+ BuiltIn.Run Keyword If "${check_for_null}" == "True" Builtin.Return From Keyword If ${resp.status_code} == 404 or ${resp.status_code} == 409
Should Be Equal As Strings ${resp.status_code} 200
- : FOR ${i} IN @{elements}
- \ Should Not Contain ${resp.content} ${i}
+ FOR ${i} IN @{elements}
+ Should Not Contain ${resp.text} ${i}
+ END
Clean Mininet System
[Arguments] ${system}=${TOOLS_SYSTEM_IP}
[Documentation] Cleans up the OVS instance and remove any existing common known bridges.
${output}= Run Command On Mininet ${system} sudo ovs-vsctl list-br
Log ${output}
- : FOR ${i} IN ${output}
- \ Run Command On Mininet ${system} sudo ovs-vsctl --if-exists del-br ${i}
+ FOR ${i} IN ${output}
+ Run Command On Mininet ${system} sudo ovs-vsctl --if-exists del-br ${i}
+ END
Run Command On Mininet ${system} sudo ovs-vsctl del-manager
Extract Value From Content
- [Arguments] ${content} ${index} ${strip}=nostrip
+ [Arguments] ${content} ${index}
[Documentation] Will take the given response content and return the value at the given index as a string
- ${value}= Get Json Value ${content} ${index}
- ${value}= Convert To String ${value}
- ${value}= Run Keyword If '${strip}' == 'strip' Strip Quotes ${value}
+ ${JSON} = Evaluate json.loads('''${content}''') json
+ ${value} = Set Variable ${JSON${index}}
[Return] ${value}
Get Process ID Based On Regex On Remote System
[Documentation] Call Run Comand On Remote System, but with default values suitable for Controller machine.
BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt}
+Run Command On Existing Connection
+ [Arguments] ${conn_id}=${EMPTY} ${cmd}=echo ${return_stdout}=True ${return_stderr}=False
+ [Documentation] Switch to and run command on an already existing SSH connection and switch back
+ Run Keyword If "${return_stdout}"!="True" and "${return_stderr}"!="True" Fail At least one of {return_stdout} or {return_stderr} args should be set to True
+ ${current_ssh_connection}= SSHLibrary.Get Connection
+ BuiltIn.Log Attempting to execute command "${cmd}" on existing connection "${conn_id}
+ SSHLibrary.Switch Connection ${conn_id}
+ ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True
+ Log ${stderr}
+ Run Keyword If "${return_stdout}"!="True" Return From Keyword ${stderr}
+ Run Keyword If "${return_stderr}"!="True" Return From Keyword ${stdout}
+ [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index}
+ [Return] ${stdout} ${stderr}
+
Verify File Exists On Remote System
[Arguments] ${system} ${file} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=5s
[Documentation] Will create connection with public key and will PASS if the given ${file} exists,
[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}
- Log ${resp.content}
+ Log ${resp.text}
Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
Remove All Elements At URI
${resp} RequestsLibrary.Delete Request ${session} ${uri}
Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
${resp} RequestsLibrary.Get Request ${session} ${uri}
- Should Be Equal As Strings ${resp.status_code} 404
+ Should Contain ${DELETED_STATUS_CODES} ${resp.status_code}
Remove All Elements If Exist
[Arguments] ${uri} ${session}=session
[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} ${session}
+ Run Keyword If '${resp.status_code}'!='404' and '${resp.status_code}'!='409' Remove All Elements At URI ${uri} ${session}
Add Elements To URI From File
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
+ [Documentation] Put data from a file to a URI
${body} OperatingSystem.Get File ${data_file}
${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
Add Elements To URI From File And Verify
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
+ [Documentation] Put data from a file to a URI and verify the HTTP response
${body} OperatingSystem.Get File ${data_file}
- ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} data=${body} headers=${headers}
- 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 ${dest_uri} ${body} ${headers} ${session}
Add Elements To URI And Verify
- [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
- ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} ${data_file} headers=${headers}
+ [Arguments] ${dest_uri} ${data} ${headers}=${headers} ${session}=session
+ [Documentation] Put data to a URI and verify the HTTP response
+ ${resp} RequestsLibrary.Put Request ${session} ${dest_uri} ${data} headers=${headers}
Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
${resp} RequestsLibrary.Get Request ${session} ${dest_uri}
- Should Not Be Equal ${resp.status_code} 404
+ Should Not Contain ${DELETED_STATUS_CODES} ${resp.status_code}
Add Elements To URI From File And Check Validation Error
[Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${session}=session
... Issues a GET request for ${uri} in ${session} using headers from
... ${headers}. If the request returns a HTTP error, fails. Otherwise
... returns the data obtained by the request.
- ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
- Builtin.Return_From_Keyword_If ${response.status_code} == 200 ${response.text}
- Builtin.Log ${response.text}
- Builtin.Fail The request failed with code ${response.status_code}
+ ${resp}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
+ Builtin.Return_From_Keyword_If ${resp.status_code} == 200 ${resp.text}
+ Builtin.Log ${resp.text}
+ Builtin.Fail The request failed with code ${resp.status_code}
+
+Get URI And Verify
+ [Arguments] ${uri} ${session}=session ${headers}=${NONE}
+ [Documentation] Issue a GET request and verify a successfull HTTP return.
+ ... Issues a GET request for ${uri} in ${session} using headers from ${headers}.
+ ${resp} = RequestsLibrary.Get Request ${session} ${uri} ${headers}
+ Builtin.Log ${resp.status_code}
+ Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code}
No Content From URI
[Arguments] ${session} ${uri} ${headers}=${NONE}
... Issues a GET request for ${uri} in ${session} using headers from
... ${headers}. If the request returns a HTTP error, fails. Otherwise
... returns the data obtained by the request.
- ${response}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
- Builtin.Return_From_Keyword_If ${response.status_code} == 404
- Builtin.Log ${response.text}
- Builtin.Fail The request failed with code ${response.status_code}
+ ${resp}= RequestsLibrary.Get Request ${session} ${uri} ${headers}
+ Builtin.Return_From_Keyword_If ${resp.status_code} == 404 or ${resp.status_code} == 409
+ Builtin.Log ${resp.text}
+ Builtin.Fail The request failed with code ${resp.status_code}
Get Index From List Of Dictionaries
[Arguments] ${dictionary_list} ${key} ${value}
[Documentation] Extract index for the dictionary in a list that contains a key-value pair. Returns -1 if key-value is not found.
${length}= Get Length ${dictionary_list}
${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}
+ FOR ${i} IN RANGE ${length}
+ ${dictionary}= Get From List ${dictionary_list} ${i}
+ Run Keyword If """${dictionary}[${key}]""" == """${value}""" Set Test Variable ${index} ${i}
+ END
[Return] ${index}
Check Item Occurrence
[Arguments] ${string} ${dictionary_item_occurrence}
[Documentation] Check string for occurrences of items expressed in a list of dictionaries {item=occurrences}. 0 occurences means item is not present.
- : FOR ${item} IN @{dictionary_item_occurrence}
- \ Should Contain X Times ${string} ${item} &{dictionary_item_occurrence}[${item}]
+ FOR ${item} IN @{dictionary_item_occurrence}
+ Should Contain X Times ${string} ${item} ${dictionary_item_occurrence}[${item}]
+ END
Post Log Check
- [Arguments] ${uri} ${body} ${status_code}=200 ${session}=session
+ [Arguments] ${uri} ${body} ${session}=session ${status_codes}=200
[Documentation] Post body to ${uri}, log response content, and check status
${resp}= RequestsLibrary.Post Request ${session} ${uri} ${body}
- Log ${resp.content}
- Should Be Equal As Strings ${resp.status_code} ${status_code}
+ Log ${resp.text}
+ TemplatedRequests.Check Status Code ${resp} ${status_codes}
[Return] ${resp}
Get Log File Name
... 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
+ ${date} = DateTime.Get Current Date
+ ${timestamp} = DateTime.Convert Date ${date} epoch
+ [Return] ${testtool}--${name}${suffix}.${timestamp}.log
Set_User_Configurable_Variable_Default
[Arguments] ${name} ${value}
[Return] ${minutes}
Write Commands Until Expected Prompt
- [Arguments] ${cmd} ${prompt} ${timeout}=30s
+ [Arguments] ${cmd} ${prompt} ${timeout}=${DEFAULT_TIMEOUT}
[Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
+ 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
+ [Arguments] ${cmd} ${regexp} ${timeout}=${DEFAULT_TIMEOUT}
+ [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
+ 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
[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
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
+ [Arguments] ${ip_address}=${ODL_SYSTEM_IP}
+ [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.
+ ${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
+ [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_connection.index}
+ [Return] ${output}
+
+Check Diagstatus
+ [Arguments] ${ip_address}=${ODL_SYSTEM_IP} ${check_status}=True ${expected_status}=${200}
+ [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.
+ RequestsLibrary.Create Session diagstatus_session http://${ip_address}:${RESTCONFPORT}
+ ${resp} RequestsLibrary.Get Request diagstatus_session /diagstatus
+ Run Keyword If "${check_status}" == "True" BuiltIn.Should Be Equal As Strings ${resp.status_code} ${expected_status}
+ [Return] ${resp}
+
+Download File On Openstack Node
+ [Arguments] ${conn_id} ${save_file_name} ${url}
+ [Documentation] Download a file from web to the node. the input will be a session ID with established SSH connection.
+ SSHLibrary.Switch Connection ${conn_id}
+ Utils.Write Commands Until Expected Prompt wget -O /tmp/${save_file_name} ${url} ${DEFAULT_LINUX_PROMPT_STRICT}
Code Review / integration / test.git / blobdiff