X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FUtils.robot;h=7a4b62c0a3fbe6f9cbbe95d3dbb584e2b619e390;hb=d52be90c6c92151afb0ddeb49401f195b347011f;hp=497dcb16d7de843edaa25a912971ee9d43cf200a;hpb=967f534f762ce38f7cf2f1bb1139a8d9ab4205c0;p=integration%2Ftest.git diff --git a/csit/libraries/Utils.robot b/csit/libraries/Utils.robot index 497dcb16d7..7a4b62c0a3 100644 --- a/csit/libraries/Utils.robot +++ b/csit/libraries/Utils.robot @@ -1,7 +1,6 @@ *** 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 @@ -19,7 +18,7 @@ ${start} sudo mn --controller=remote,ip=${ODL_SYSTEM_IP} --topo tree,1 *** 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 @@ -32,7 +31,7 @@ Start Mininet 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 @@ -42,7 +41,7 @@ Stop Mininet 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. @@ -53,12 +52,14 @@ Report_Failure_Due_To_Bug ... 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). @@ -86,8 +87,8 @@ Check Nodes Stats ... 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 @@ -96,7 +97,7 @@ Check For Specific Number Of Elements At 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} + Should Contain X Times ${resp.text} ${element} ${expected_count} Log Content [Arguments] ${resp_content} @@ -113,19 +114,24 @@ Check For Elements At URI BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.content} ... ELSE BuiltIn.Log ${resp.content} 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 ${pretty_print_json}=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 + [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} BuiltIn.Run Keyword If "${pretty_print_json}" == "True" Log Content ${resp.content} ... ELSE BuiltIn.Log ${resp.content} + 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} @@ -137,8 +143,9 @@ Clean Up Ovs [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 @@ -310,34 +317,34 @@ Remove All Elements At URI And Verify ${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 @@ -377,10 +384,18 @@ Get Data From URI ... 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} @@ -388,33 +403,35 @@ No Content From URI ... 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} + TemplatedRequests.Check Status Code ${resp} ${status_codes} [Return] ${resp} Get Log File Name @@ -489,14 +506,25 @@ Convert_To_Minutes [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 @@ -553,3 +581,9 @@ Check Diagstatus ${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}