X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FUtils.robot;h=d700bd7ee9a0974d22c355584b3b496ab6e9527a;hb=9634f7daf93e0554390fee8e8e158b2d3ad2fdd7;hp=f4c1bdf9ed69cf67fd051525a7c9974791abf4b4;hpb=afa2ef553baf75b44aced4efec653787bfd4a61e;p=integration%2Ftest.git diff --git a/csit/libraries/Utils.robot b/csit/libraries/Utils.robot index f4c1bdf9ed..d700bd7ee9 100644 --- a/csit/libraries/Utils.robot +++ b/csit/libraries/Utils.robot @@ -1,21 +1,23 @@ *** 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 Collections Library RequestsLibrary -Library ./UtilLibrary.py -Resource KarafKeywords.robot -Variables ../variables/Variables.py +Library ${CURDIR}/UtilLibrary.py +Resource ${CURDIR}/SSHKeywords.robot +Resource ${CURDIR}/TemplatedRequests.robot +Variables ${CURDIR}/../variables/Variables.py *** Variables *** # TODO: Introduce ${tree_size} and use instead of 1 in the next line. ${start} sudo mn --controller=remote,ip=${ODL_SYSTEM_IP} --topo tree,1 --switch ovsk,protocols=OpenFlow13 *** Keywords *** -Start Suite +Start Mininet [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. @@ -28,29 +30,7 @@ Start Suite Write ${start} Read Until mininet> -Start Mininet - [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 - Clean Mininet System - ${mininet_conn_id}= Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout} - Set Suite Variable ${mininet_conn_id} - Flexible Mininet Login user=${user} password=${password} - Put File ${custom} - Write ${cmd} - Read Until mininet> - [Return] ${mininet_conn_id} - Stop Mininet - [Arguments] ${mininet_conn_id} ${prompt}=${DEFAULT_LINUX_PROMPT} - [Documentation] Basic setup to stop/clean mininet - Switch Connection ${mininet_conn_id} - SSHLibrary.Write exit - Read Until ${prompt} - Close Connection - -Stop Suite [Arguments] ${prompt}=${DEFAULT_LINUX_PROMPT} [Documentation] Cleanup/Shutdown work that should be done at the completion of all ... tests @@ -97,17 +77,6 @@ Report_Failure_And_Point_To_Linked_Bugs 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} - ... is verified to exist in the repsonse. This keyword currently implies that it's node - ... 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 Request session ${URI} - \ Should Be Equal As Strings ${resp.status_code} 200 - \ Should Contain ${resp.content} ${node} - Check Nodes Stats [Arguments] ${node} [Documentation] A GET on the /node/${node} API is made and specific flow stat @@ -117,16 +86,6 @@ Check Nodes Stats Should Contain ${resp.content} flow-capable-node-connector-statistics Should Contain ${resp.content} flow-table-statistics -Check That Port Count Is Ok - [Arguments] ${node} ${count} - [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 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} - 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 @@ -232,13 +191,16 @@ Run Command On Remote System [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} + ${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} Flexible SSH Login ${user} ${password} - ${stdout} ${stderr} SSHLibrary.Execute Command ${cmd} return_stderr=True + ${stdout} ${stderr} ${rc} SSHLibrary.Execute Command ${cmd} return_stderr=True return_rc=True SSHLibrary.Close Connection Log ${stderr} - [Return] ${stdout} + [Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_ssh_connection.index} + [Return] ${stdout} ${rc} Write_Bare_Ctrl_C [Documentation] Construct ctrl+c character and SSH-write it (without endline) to the current SSH connection. @@ -260,6 +222,7 @@ 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} Verify File Exists On Remote System @@ -271,6 +234,13 @@ Verify File Exists On Remote System SSHLibrary.File Should Exist ${file} Close Connection +Check Karaf Log File Does Not Have Messages + [Arguments] ${ip} ${message} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT} ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log + [Documentation] Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The + ... karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip} + ${output}= Run Command On Controller ${ip} grep -c '${message}' ${log_file} user=${user} password=${password} prompt=${prompt} + Should Be Equal As Strings ${output} 0 + Verify Controller Is Not Dead [Arguments] ${controller_ip}=${ODL_SYSTEM_IP} [Documentation] Will execute any tests to verify the controller is not dead. Some checks are @@ -313,41 +283,48 @@ Concatenate the String [Return] ${output} Post Elements To URI - [Arguments] ${rest_uri} ${data} ${headers}=${headers} + [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} - Should Be Equal As Strings ${resp.status_code} 200 + ${resp} = RequestsLibrary.Post Request ${session} ${rest_uri} data=${data} headers=${headers} + Log ${resp.content} + Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code} Remove All Elements At URI [Arguments] ${uri} ${resp} RequestsLibrary.Delete Request session ${uri} - Should Be Equal As Strings ${resp.status_code} 200 + Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code} Remove All Elements At URI And Verify [Arguments] ${uri} ${resp} RequestsLibrary.Delete Request session ${uri} - Should Be Equal As Strings ${resp.status_code} 200 + Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code} ${resp} RequestsLibrary.Get Request session ${uri} Should Be Equal As Strings ${resp.status_code} 404 +Remove All Elements If Exist + [Arguments] ${uri} + [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} + Add Elements To URI From 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 + Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code} Add Elements To URI From File And Verify [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 + 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 [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 + Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code} ${resp} RequestsLibrary.Get Request session ${dest_uri} Should Not Be Equal ${resp.status_code} 404 @@ -355,7 +332,7 @@ Post Elements To URI From File [Arguments] ${dest_uri} ${data_file} ${headers}=${headers} ${body} OperatingSystem.Get File ${data_file} ${resp} RequestsLibrary.Post Request session ${dest_uri} data=${body} headers=${headers} - Should Be Equal As Strings ${resp.status_code} 200 + Should Contain ${ALLOWED_STATUS_CODES} ${resp.status_code} Run Process With Logging And Status Check [Arguments] @{proc_args} @@ -395,7 +372,7 @@ Get Index From List Of Dictionaries ${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} + \ Run Keyword If """&{dictionary}[${key}]""" == """${value}""" Set Test Variable ${index} ${i} [Return] ${index} Check Item Occurrence @@ -413,25 +390,29 @@ Post Log Check [Return] ${resp} Get Log File Name - [Arguments] ${testtool} + [Arguments] ${testtool} ${testcase}=${EMPTY} [Documentation] Get the name of the suite sanitized to be usable as a part of filename. ... These names are used to constructs names of the log files produced ... by the testing tools so two suites using a tool wont overwrite the ... log files if they happen to run in one job. ${name}= BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-") - [Return] ${testtool}--${name}.log + ${suffix}= BuiltIn.Set_Variable_If '${testcase}' != '' --${testcase} ${EMPTY} + [Return] ${testtool}--${name}${suffix}.log Set_User_Configurable_Variable_Default [Arguments] ${name} ${value} [Documentation] Set a default value for an user configurable variable. ... This keyword is needed if your default value is calculated using ... a complex expression which needs BuiltIn.Evaluate or even more - ... complex keywords. It sets the variable ${name} to ${value} but - ... only if the variable ${name} was not set previously. This keyword - ... is intended for user configurable variables which are supposed to - ... be set only with pybot -v; calling this keyword on a variable - ... that was already set by another keyword is a bug in the suite or - ... resource trying to call this keyword. + ... complex keywords. It sets the variable ${name} (the name of the + ... variable MUST be specified WITHOUT the ${} syntactic sugar due + ... to limitations of Robot Framework) to ${value} but only if the + ... variable ${name} was not set previously. This keyword is intended + ... for user configurable variables which are supposed to be set only + ... with pybot -v; calling this keyword on a variable that was already + ... set by another keyword will silently turn the call into a NOP and + ... thus is a bug in the suite or resource trying to call this + ... keyword. # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning # evaluating it only when the user did not set anything and thus the # default is needed). This might be needed to avoid potentially costly @@ -440,5 +421,56 @@ Set_User_Configurable_Variable_Default # comments the best approach would be to create another keyword that # expects a ScalarClosure in the place of ${value} and calls the # closure to get the value but only if the value is needed). + # The best idea how to implement this "laziness" would be to have the + # used to define another keyword that will be responsible for getting + # the default value and then passing the name of this getter keyword + # to this keyword. Then this keyword would call the getter (to obtain + # the expensive default value) only if it discovers that this value + # is really needed (because the variable is not set yet). + # TODO: Is the above TODO really necessary? Right now we don't have any + # examples of "expensive default values" where to obtain the default + # value is so expensive on resources (e.g. need to SSH somewhere to + # check something) that we would want to skip the calculation if the + # variable for which it is needed has a value already provided by the + # user using "pybot -v" or something. One example would be + # JAVA_HOME if it would be designed as user-configurable variable + # (currently it is not; users can specify "use jdk7" or "use jdk8" + # but not "use the jdk over there"; and there actually is no JAVA_HOME + # present in the resource, rather the Java invocation command uses the + # Java invocation with a full path). The default value of JAVA_HOME + # has to be obtained by issuing commands on the SSH connection where + # the resulting Java invocation command will be used (to check + # multiple candidate paths until one that fits is found) and we could + # skip all this checking if a JAVA_HOME was supplied by the user using + # "pybot -v". ${value}= BuiltIn.Get_Variable_Value \${${name}} ${value} BuiltIn.Set_Suite_Variable \${${name}} ${value} + +Convert_To_Minutes + [Arguments] ${time} + [Documentation] Convert a Robot time string to an integer expressing the time in minutes, rounded up + ... This is a wrapper around DateTime.Convert_Time which does not + ... provide this functionality directly nor is even able to produce + ... an integer directly. It is needed for RestPerfClient which + ... cannot accept floats for its --timeout parameter and interprets + ... the value supplied in this parameter in minutes. + ${seconds}= DateTime.Convert_Time ${time} result_format=number + ${minutes}= BuiltIn.Evaluate int(math.ceil(${seconds}/60.0)) modules=math + [Return] ${minutes} + +Write Commands Until Expected Prompt + [Arguments] ${cmd} ${prompt} ${timeout}=30s + [Documentation] quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable + SSHLibrary.Set Client Configuration timeout=${timeout} + SSHLibrary.Write ${cmd} + ${output}= SSHLibrary.Read Until ${prompt} + [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 + Log Keyword to install package to Mininet Ubuntu VM + Open Connection ${system} prompt=${prompt} timeout=${prompt_timeout} + Flexible Mininet Login user=${user} password=${password} + Write sudo apt-get install -y ${package_name} + Read Until ${prompt}