X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FUtils.robot;h=951bcc319fb5e5b98ee8dcb132c9aa8941d31168;hb=05b0346dda5ec2dd1d9e2b0c015687fdf47f6e22;hp=dd7efed84279cfa3a5626a2f0d751bbb67b16dcb;hpb=611a34523b1d9bc8e307c1f7c7ec87f47831a58a;p=integration%2Ftest.git diff --git a/csit/libraries/Utils.robot b/csit/libraries/Utils.robot index dd7efed842..951bcc319f 100644 --- a/csit/libraries/Utils.robot +++ b/csit/libraries/Utils.robot @@ -1,22 +1,22 @@ *** 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 ./UtilLibrary.py Resource KarafKeywords.robot -Variables ../variables/Variables.py +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 *** Keywords *** Start Suite + [Arguments] ${system}=${MININET} ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${timeout}=30s [Documentation] Basic setup/cleanup work that can be done safely before any system ... is run. - [Arguments] ${system}=${MININET} ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${timeout}=30s Log Start the test on the base edition Clean Mininet System ${mininet_conn_id}= Open Connection ${system} prompt=${DEFAULT_LINUX_PROMPT} timeout=${timeout} @@ -27,7 +27,8 @@ Start Suite Read Until mininet> Start Mininet - [Arguments] ${system}=${MININET} ${cmd}=${start} ${custom}= ${user}=${MININET_USER} ${password}=${MININET_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=30s + [Arguments] ${system}=${MININET} ${cmd}=${start} ${custom}= ${user}=${MININET_USER} ${password}=${MININET_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 Clean Mininet System @@ -39,29 +40,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 @@ -81,6 +59,19 @@ 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. + ... This 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. + ${msg}= BuiltIn.Set_Variable This test fails due to https://bugs.opendaylight.org/show_bug.cgi?id=${number} + ${newline}= BuiltIn.Evaluate chr(10) + Run Keyword If "${TEST STATUS}"=="FAIL" BuiltIn.Set Test Message ${msg}${newline}${newline}${TEST_MESSAGE} + Run Keyword If "${TEST STATUS}"=="FAIL" BuiltIn.Log ${msg} + 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} @@ -88,7 +79,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} @@ -96,7 +87,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 @@ -106,7 +97,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} @@ -115,7 +106,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} @@ -124,7 +115,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} @@ -134,14 +125,14 @@ 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 @@ -169,18 +160,20 @@ Get Process ID Based On Regex On Remote System ... the expected PID # doing the extra -v grep in this command to exclude the grep process itself from the output ${cmd}= Set Variable ps -elf | grep -v grep | grep ${regex_string_to_match_on} | awk '{print $4}' - ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt} prompt_timeout=${prompt_timeout} + ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt} + ... prompt_timeout=${prompt_timeout} # ${output} contains the system prompt and all we want is the value of the number ${pid}= Fetch From Left ${output} \r - [Return] ${pid} # TODO: Get Process * keywords have perhaps non-standard default credentials. # ... Should there be * On Mininet and * On Controller specializations? + [Return] ${pid} Get Process Thread Count On Remote System [Arguments] ${system} ${pid} ${user}=${MININET_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} prompt_timeout=${prompt_timeout} + ${output}= Run Command On Remote System ${system} ${cmd} user=${user} password=${password} prompt=${prompt} + ... prompt_timeout=${prompt_timeout} # ${output} contains the system prompt and all we want is the value of the number ${thread_count}= Fetch From Left ${output} \r [Return] ${thread_count} @@ -197,31 +190,30 @@ Flexible SSH Login ${pwd_length} = BuiltIn.Get Length ${password} # ${pwd_length} is guaranteed to be an integer, so we are safe to evaluate it as Python expression. BuiltIn.Run Keyword And Return If ${pwd_length} > 0 SSHLibrary.Login ${user} ${password} delay=${delay} - BuiltIn.Run Keyword And Return SSHLibrary.Login With Public Key ${user} ${USER_HOME}/.ssh/${SSH_KEY} ${KEYFILE_PASS} delay=${delay} + 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. @@ -229,15 +221,21 @@ 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 @@ -289,21 +287,34 @@ 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 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 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 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 @@ -314,3 +325,41 @@ 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}]