X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FUtils.robot;h=3ab78a5484c58170484a41ce6eed686c1677beda;hb=35c6edaabd48b171bc374ae689b7196e91ed7c1a;hp=52adab847e3f5b8caebf8933602d70a196f5d5bd;hpb=bbb7606657c36a5352617cd46a7c70a8071d241c;p=integration%2Ftest.git diff --git a/csit/libraries/Utils.robot b/csit/libraries/Utils.robot index 52adab847e..3ab78a5484 100644 --- a/csit/libraries/Utils.robot +++ b/csit/libraries/Utils.robot @@ -11,7 +11,7 @@ Library OperatingSystem 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. @@ -42,7 +42,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 +53,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). @@ -98,22 +100,31 @@ Check For Specific Number Of Elements At URI Should Be Equal As Strings ${resp.status_code} 200 Should Contain X Times ${resp.content} ${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.content} + ... ELSE BuiltIn.Log ${resp.content} Should Be Equal As Strings ${resp.status_code} 200 : FOR ${i} IN @{elements} \ Should Contain ${resp.content} ${i} Check For Elements Not 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 NOT exist in the response ${resp} RequestsLibrary.Get Request ${session} ${uri} - Log ${resp.content} + 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 Not Contain ${resp.content} ${i} @@ -173,33 +184,25 @@ Strip Quotes Run Command On Remote System [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT} + ... ${return_stdout}=True ${return_stderr}=False [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. + ... robot keyword, taking care to log in with a public key and. The command given is written and the return value + ... depends on the passed argument values of return_stdout (default: True) and return_stderr (default: False). + ... At least one should be True, or the keyword will exit and FAIL. If both are True, the resulting return value + ... will be a two element list containing both. Otherwise the resulting return value is a string. + ... No test conditions are checked. + 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 remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}" - BuiltIn.Log ${password} + BuiltIn.Log Attempting to execute command "${cmd}" on remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}" and password "${password}" ${conn_id}= SSHLibrary.Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout} SSHKeywords.Flexible SSH Login ${user} ${password} ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True SSHLibrary.Close Connection 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} - -Run Command On Remote System And Return Error - [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT} - [Documentation] Same as Run Command On Remote System but in this case it returns the stderr. - ${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} - SSHKeywords.Flexible SSH Login ${user} ${password} - ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True - SSHLibrary.Close Connection - Log ${stdout} - [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index} - [Return] ${stderr} + [Return] ${stdout} ${stderr} Run Command On Remote System And Log [Arguments] ${system} ${cmd} ${user}=${DEFAULT_USER} ${password}=${EMPTY} ${prompt}=${DEFAULT_LINUX_PROMPT} ${prompt_timeout}=${DEFAULT_TIMEOUT} @@ -219,9 +222,22 @@ Run Command On Mininet 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} +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, @@ -306,21 +322,21 @@ Remove All Elements If Exist 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 @@ -368,6 +384,14 @@ Get Data From URI Builtin.Log ${response.text} Builtin.Fail The request failed with code ${response.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}. + ${response} = RequestsLibrary.Get Request ${session} ${uri} ${headers} + Builtin.Log ${response.status_code} + Should Contain ${ALLOWED_STATUS_CODES} ${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. @@ -411,7 +435,9 @@ 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} @@ -473,7 +499,7 @@ 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 SSHLibrary.Set Client Configuration timeout=${timeout} SSHLibrary.Read @@ -513,3 +539,33 @@ Modify Iptables On Remote System 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}