X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FUtils.robot;h=919da36a04d5850d5b6e44eac767741dbcc5ba0c;hb=566a5541cc299aa9e0f68c1abac6f8f06764a8fb;hp=383178a189228098ca61bc58c0ad6f598258ba2f;hpb=519dde2f454f7a8b1e4a71f43e97fdf0b9415b77;p=integration%2Ftest.git diff --git a/csit/libraries/Utils.robot b/csit/libraries/Utils.robot index 383178a189..919da36a04 100644 --- a/csit/libraries/Utils.robot +++ b/csit/libraries/Utils.robot @@ -1,25 +1,27 @@ *** Settings *** +Documentation General Utils library. This library has broad scope, it can be used by any robot system tests. Library SSHLibrary Library String Library DateTime Library Process +Library Collections +Library RequestsLibrary Library ./UtilLibrary.py Resource KarafKeywords.robot Variables ../variables/Variables.py *** Variables *** # TODO: Introduce ${tree_size} and use instead of 1 in the next line. -${start} sudo mn --controller=remote,ip=${CONTROLLER} --topo tree,1 --switch ovsk,protocols=OpenFlow13 -${controller_index} -1 +${start} sudo mn --controller=remote,ip=${ODL_SYSTEM_IP} --topo tree,1 --switch ovsk,protocols=OpenFlow13 *** Keywords *** Start Suite - [Arguments] ${system}=${MININET} ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${timeout}=30s + [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_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 Clean Mininet System - ${mininet_conn_id}= Open Connection ${system} prompt=${DEFAULT_LINUX_PROMPT} timeout=${timeout} + ${mininet_conn_id}= Open Connection ${system} prompt=${prompt} timeout=${timeout} Set Suite Variable ${mininet_conn_id} Flexible Mininet Login user=${user} password=${password} Execute Command sudo ovs-vsctl set-manager ptcp:6644 @@ -27,7 +29,7 @@ Start Suite Read Until mininet> Start Mininet - [Arguments] ${system}=${MININET} ${cmd}=${start} ${custom}= ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} + [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${cmd}=${start} ${custom}= ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ... ${prompt_timeout}=30s [Documentation] Basic setup to start mininet with custom topology Log Start the test on the base edition @@ -40,29 +42,6 @@ Start Mininet Read Until mininet> [Return] ${mininet_conn_id} -Connect To Controller Karaf - [Documentation] Connect to the controller's karaf console. - ${esc}= BuiltIn.Evaluate chr(int(27)) - ${prompt}= Builtin.Set Variable @${esc}[0m${esc}[34mroot${esc}[0m> - ${connection}= SSHLibrary.Open_Connection ${CONTROLLER} port=${KARAF_SHELL_PORT} prompt=${prompt} - Set Suite Variable ${controller_index} ${connection} - SSHLibrary.Login ${KARAF_USER} ${KARAF_PASSWORD} - -Log Message To Controller Karaf - [Arguments] ${message} - [Documentation] Send a message into the controller's karaf log file. - # Background info: If there was no previous SSH connection, the "Get - # Connection" returns an information structure whose "index" field - # resolves to "None", and the "Switch Connection" below does not - # complain. - ${current}= Get_Connection - ${connection}= Set Variable ${current.index} - BuiltIn.Run Keyword If ${controller_index} <> -1 Switch Connection ${controller_index} - BuiltIn.Run Keyword If ${controller_index} == -1 Connect to Controller Karaf - SSHLibrary.Write log:log "ROBOT MESSAGE: ${message}" - SSHLibrary.Read_Until_Prompt - Switch Connection ${connection} - Stop Mininet [Arguments] ${mininet_conn_id} ${prompt}=${DEFAULT_LINUX_PROMPT} [Documentation] Basic setup to stop/clean mininet @@ -82,6 +61,42 @@ Stop Suite Read Until ${prompt} Close Connection +Report_Failure_Due_To_Bug + [Arguments] ${number} + [Documentation] Report that a test failed due to a known Bugzilla bug whose + ... number is provided as an argument. + ... Not FAILED (incl. SKIPPED) test are not reported. + ... This keyword must be used in the [Teardown] setting of the affected test + ... 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 + 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} + BuiltIn.Set Test Message ${msg}${newline}${newline}${TEST_MESSAGE} + BuiltIn.Log ${msg} + +Report_Failure_And_Point_To_Linked_Bugs + [Documentation] Report that a test failed and point to linked Bugzilla bug(s). + ... Linked bugs must contain the ${reference} inside comments (workaround + ... becasue of currently missing suitable field for external references and + ... not correctly working the CONTENT MATCHES filter). + ... Not FAILED (incl. SKIPPED) test are not reported. + ... This keyword must be used in the [Teardown] setting of the affected test + ... 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 + 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" + BuiltIn.Set Test Message ${msg}${newline}${bugs}${newline}${newline}${TEST_MESSAGE} + BuiltIn.Log ${msg}${newline}${bugs} + Ensure All Nodes Are In Response [Arguments] ${URI} ${node_list} [Documentation] A GET is made to the supplied ${URI} and every item in the ${node_list} @@ -89,7 +104,7 @@ Ensure All Nodes Are In Response ... specific but any list of strings can be given in ${node_list}. Refactoring of this ... to make it more generic should be done. (see keyword "Check For Elements At URI") : FOR ${node} IN @{node_list} - \ ${resp} RequestsLibrary.Get session ${URI} + \ ${resp} RequestsLibrary.Get Request session ${URI} \ Should Be Equal As Strings ${resp.status_code} 200 \ Should Contain ${resp.content} ${node} @@ -97,7 +112,7 @@ Check Nodes Stats [Arguments] ${node} [Documentation] A GET on the /node/${node} API is made and specific flow stat ... strings are checked for existence. - ${resp} RequestsLibrary.Get session ${OPERATIONAL_NODES_API}/node/${node} + ${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 @@ -107,7 +122,7 @@ Check That Port Count Is Ok [Documentation] A GET on the /port API is made and the specified port ${count} is ... verified. A more generic Keyword "Check For Specific Number Of Elements At URI" ... also does this work and further consolidation should be done. - ${resp} RequestsLibrary.Get session ${REST_CONTEXT}/${CONTAINER}/port + ${resp} RequestsLibrary.Get Request session ${REST_CONTEXT}/${CONTAINER}/port Log ${resp.content} Should Be Equal As Strings ${resp.status_code} 200 Should Contain X Times ${resp.content} ${node} ${count} @@ -116,7 +131,7 @@ Check For Specific Number Of Elements At URI [Arguments] ${uri} ${element} ${expected_count} [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 session ${uri} + ${resp} RequestsLibrary.Get Request session ${uri} Log ${resp.content} Should Be Equal As Strings ${resp.status_code} 200 Should Contain X Times ${resp.content} ${element} ${expected_count} @@ -125,7 +140,7 @@ Check For Elements At URI [Arguments] ${uri} ${elements} [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 session ${uri} + ${resp} RequestsLibrary.Get Request session ${uri} Log ${resp.content} Should Be Equal As Strings ${resp.status_code} 200 : FOR ${i} IN @{elements} @@ -135,19 +150,19 @@ Check For Elements Not At URI [Arguments] ${uri} ${elements} [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 - ${resp} RequestsLibrary.Get session ${uri} + ${resp} RequestsLibrary.Get Request session ${uri} Log ${resp.content} Should Be Equal As Strings ${resp.status_code} 200 : FOR ${i} IN @{elements} \ Should Not Contain ${resp.content} ${i} Clean Mininet System - [Arguments] ${system}=${MININET} + [Arguments] ${system}=${TOOLS_SYSTEM_IP} Run Command On Mininet ${system} sudo mn -c Run Command On Mininet ${system} sudo ps -elf | egrep 'usr/local/bin/mn' | egrep python | awk '{print "sudo kill -9",$4}' | sh Clean Up Ovs - [Arguments] ${system}=${MININET} + [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} @@ -164,7 +179,7 @@ Extract Value From Content [Return] ${value} Get Process ID Based On Regex On Remote System - [Arguments] ${system} ${regex_string_to_match_on} ${user}=${MININET_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s + [Arguments] ${system} ${regex_string_to_match_on} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s [Documentation] Uses ps to find a process that matches the supplied regex. Returns the PID of that process ... The ${regex_string_to_match_on} should produce a unique process otherwise the PID returned may not be ... the expected PID @@ -179,7 +194,7 @@ Get Process ID Based On Regex On Remote System [Return] ${pid} Get Process Thread Count On Remote System - [Arguments] ${system} ${pid} ${user}=${MININET_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s + [Arguments] ${system} ${pid} ${user}=${TOOLS_SYSTEM_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s [Documentation] Executes the ps command to retrieve the lightweight process (aka thread) count. ${cmd}= Set Variable ps --no-headers -o nlwp ${pid} ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt} @@ -203,28 +218,27 @@ Flexible SSH Login BuiltIn.Run Keyword And Return SSHLibrary.Login With Public Key ${user} ${USER_HOME}/.ssh/${SSH_KEY} ${KEYFILE_PASS} delay=${delay} Flexible Mininet Login - [Arguments] ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${delay}=0.5s + [Arguments] ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${delay}=0.5s [Documentation] Call Flexible SSH Login, but with default values suitable for Mininet machine. BuiltIn.Run Keyword And Return Flexible SSH Login user=${user} password=${password} delay=${delay} Flexible Controller Login - [Arguments] ${user}=${CONTROLLER_USER} ${password}=${CONTROLLER_PASSWORD} ${delay}=0.5s + [Arguments] ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${delay}=0.5s [Documentation] Call Flexible SSH Login, but with default values suitable for Controller machine. BuiltIn.Run Keyword And Return Flexible SSH Login user=${user} password=${password} delay=${delay} Run Command On Remote System - [Arguments] ${system} ${cmd} ${user}=${MININET_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s + [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT} [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} ${conn_id}= SSHLibrary.Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout} Flexible SSH Login ${user} ${password} - SSHLibrary.Write ${cmd} - ${output}= SSHLibrary.Read Until ${prompt} + ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True SSHLibrary.Close Connection - Log ${output} - [Return] ${output} + Log ${stderr} + [Return] ${stdout} Write_Bare_Ctrl_C [Documentation] Construct ctrl+c character and SSH-write it (without endline) to the current SSH connection. @@ -232,20 +246,24 @@ Write_Bare_Ctrl_C ${ctrl_c}= BuiltIn.Evaluate chr(int(3)) SSHLibrary.Write_Bare ${ctrl_c} +Write Bare Ctrl D + [Documentation] Construct ctrl+d character and SSH-write it (without endline) to the current SSH connection. + ... Do not read anything yet. + ${ctrl_d}= BuiltIn.Evaluate chr(int(4)) + SSHLibrary.Write Bare ${ctrl_d} + Run Command On Mininet - [Arguments] ${system}=${MININET} ${cmd}=echo ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s + [Arguments] ${system}=${TOOLS_SYSTEM_IP} ${cmd}=echo ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${prompt}=${TOOLS_SYSTEM_PROMPT} [Documentation] Call Run Comand On Remote System, but with default values suitable for Mininet machine. - BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt} - ... prompt_timeout=${prompt_timeout} + BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt} Run Command On Controller - [Arguments] ${system}=${CONTROLLER} ${cmd}=echo ${user}=${CONTROLLER_USER} ${password}=${CONTROLLER_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s + [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.Run Keyword And Return Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt} - ... prompt_timeout=${prompt_timeout} + BuiltIn.Run Keyword And Return Run Command On Remote System ${system} ${cmd} ${user} ${password} prompt=${prompt} Verify File Exists On Remote System - [Arguments] ${system} ${file} ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=5s + [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, ... otherwise will FAIL ${conn_id}= Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout} @@ -254,14 +272,14 @@ Verify File Exists On Remote System Close Connection Verify Controller Is Not Dead - [Arguments] ${controller_ip}=${CONTROLLER} + [Arguments] ${controller_ip}=${ODL_SYSTEM_IP} [Documentation] Will execute any tests to verify the controller is not dead. Some checks are ... Out Of Memory Execptions. Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.OutOfMemoryError # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments? Verify Controller Has No Null Pointer Exceptions - [Arguments] ${controller_ip}=${CONTROLLER} + [Arguments] ${controller_ip}=${ODL_SYSTEM_IP} [Documentation] Will execute any tests to verify the controller is not having any null pointer eceptions. Check Karaf Log File Does Not Have Messages ${controller_ip} java.lang.NullPointerException @@ -294,21 +312,49 @@ Concatenate the String ${output}= Catenate ${str1} ${str2} [Return] ${output} +Post Elements To URI + [Arguments] ${rest_uri} ${data} ${headers}=${headers} + [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 + Remove All Elements At URI [Arguments] ${uri} - ${resp} RequestsLibrary.Delete session ${uri} + ${resp} RequestsLibrary.Delete Request session ${uri} Should Be Equal As Strings ${resp.status_code} 200 +Remove All Elements At URI And Verify + [Arguments] ${uri} + ${resp} RequestsLibrary.Delete Request session ${uri} + Should Be Equal As Strings ${resp.status_code} 200 + ${resp} RequestsLibrary.Get Request session ${uri} + Should Be Equal As Strings ${resp.status_code} 404 + Add Elements To URI From File - [Arguments] ${dest_uri} ${data_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 + +Add Elements To URI From File And Verify + [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${body} OperatingSystem.Get File ${data_file} - ${resp} RequestsLibrary.Put session ${dest_uri} data=${body} headers=${headers} + ${resp} RequestsLibrary.Put Request session ${dest_uri} data=${body} headers=${headers} + Should Be Equal As Strings ${resp.status_code} 200 + ${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 + ${resp} RequestsLibrary.Get Request session ${dest_uri} + Should Not Be Equal ${resp.status_code} 404 Post Elements To URI From File - [Arguments] ${dest_uri} ${data_file} + [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${body} OperatingSystem.Get File ${data_file} - ${resp} RequestsLibrary.Post session ${dest_uri} data=${body} headers=${headers} + ${resp} RequestsLibrary.Post Request session ${dest_uri} data=${body} headers=${headers} Should Be Equal As Strings ${resp.status_code} 200 Run Process With Logging And Status Check @@ -319,3 +365,49 @@ Run Process With Logging And Status Check Log ${result.stderr} Should Be Equal As Integers ${result.rc} 0 [Return] ${result} + +Get Data From URI + [Arguments] ${session} ${uri} ${headers}=${NONE} + [Documentation] Issue a GET request and return the data obtained or on error log the error and fail. + ... 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} + +No Content From URI + [Arguments] ${session} ${uri} ${headers}=${NONE} + [Documentation] Issue a GET request and return on error 404 (No content) or will fail and log the content. + ... 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} + +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} + [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}] + +Post Log Check + [Arguments] ${uri} ${body} ${status_code}=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} + [Return] ${resp}