csit/libraries/Utils.robot

   1 *** Settings ***
   2 Documentation     General Utils library. This library has broad scope, it can be used by any robot system tests.
   3 Library           SSHLibrary
   4 Library           HttpLibrary.HTTP
   5 Library           String
   6 Library           DateTime
   7 Library           Process
   8 Library           Collections
   9 Library           RequestsLibrary
  10 Library           OperatingSystem
  11 Library           ${CURDIR}/UtilLibrary.py
  12 Resource          ${CURDIR}/SSHKeywords.robot
  13 Resource          ${CURDIR}/TemplatedRequests.robot
  14 Variables         ${CURDIR}/../variables/Variables.py
  15
  16 *** Variables ***
  17 # TODO: Introduce ${tree_size} and use instead of 1 in the next line.
  18 ${start}          sudo mn --controller=remote,ip=${ODL_SYSTEM_IP} --topo tree,1 --switch ovsk,protocols=OpenFlow13
  19
  20 *** Keywords ***
  21 Start Mininet
  22     [Arguments]    ${system}=${TOOLS_SYSTEM_IP}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${timeout}=30s
  23     [Documentation]    Basic setup/cleanup work that can be done safely before any system
  24     ...    is run.
  25     Log    Start the test on the base edition
  26     Clean Mininet System
  27     ${mininet_conn_id}=    Open Connection    ${system}    prompt=${prompt}    timeout=${timeout}
  28     Set Suite Variable    ${mininet_conn_id}
  29     SSHKeywords.Flexible Mininet Login    user=${user}    password=${password}
  30     Execute Command    sudo ovs-vsctl set-manager ptcp:6644
  31     Write    ${start}
  32     Read Until    mininet>
  33
  34 Stop Mininet
  35     [Arguments]    ${prompt}=${DEFAULT_LINUX_PROMPT}
  36     [Documentation]    Cleanup/Shutdown work that should be done at the completion of all
  37     ...    tests
  38     Log    Stop the test on the base edition
  39     Switch Connection    ${mininet_conn_id}
  40     Read
  41     Write    exit
  42     Read Until    ${prompt}
  43     Close Connection
  44
  45 Report_Failure_Due_To_Bug
  46     [Arguments]    ${number}    ${include_bug_in_tags}=True
  47     [Documentation]    Report that a test failed due to a known Bugzilla bug whose
  48     ...    number is provided as an argument.
  49     ...    Not FAILED (incl. SKIPPED) test are not reported.
  50     ...    This keyword must be used in the [Teardown] setting of the affected test
  51     ...    or as the first line of the test if FastFail module is not being
  52     ...    used. It reports the URL of the bug on console and also puts it
  53     ...    into the Robot log file.
  54     ${test_skipped}=    BuiltIn.Evaluate    len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0    modules=re
  55     BuiltIn.Return From Keyword If    ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
  56     ${bug_url}=    BuiltIn.Set_Variable    https://bugs.opendaylight.org/show_bug.cgi?id=${number}
  57     ${msg}=    BuiltIn.Set_Variable    This test fails due to ${bug_url}
  58     ${newline}=    BuiltIn.Evaluate    chr(10)
  59     BuiltIn.Set Test Message    ${msg}${newline}${newline}${TEST_MESSAGE}
  60     BuiltIn.Log    ${msg}
  61     BuiltIn.Run_Keyword_If    "${include_bug_in_tags}"=="True"    Set Tags    ${bug_url}
  62
  63 Report_Failure_And_Point_To_Linked_Bugs
  64     [Documentation]    Report that a test failed and point to linked Bugzilla bug(s).
  65     ...    Linked bugs must contain the ${reference} inside comments (workaround
  66     ...    becasue of currently missing suitable field for external references and
  67     ...    not correctly working the CONTENT MATCHES filter).
  68     ...    Not FAILED (incl. SKIPPED) test are not reported.
  69     ...    This keyword must be used in the [Teardown] setting of the affected test
  70     ...    or as the first line of the test if FastFail module is not being
  71     ...    used. It reports the URL of the bug on console and also puts it
  72     ...    into the Robot log file.
  73     ${test_skipped}=    BuiltIn.Evaluate    len(re.findall('SKIPPED', """${TEST_MESSAGE}""")) > 0    modules=re
  74     BuiltIn.Return From Keyword If    ('${TEST_STATUS}' != 'FAIL') or ${test_skipped}
  75     ${newline}=    BuiltIn.Evaluate    chr(10)
  76     ${reference}=    String.Replace_String_Using_Regexp    ${SUITE_NAME}_${TEST_NAME}    [ /\.-]    _
  77     ${reference}=    String.Convert_To_Lowercase    ${reference}
  78     ${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)
  79     ${bugs}=    BuiltIn.Set_Variable    "https://bugs.opendaylight.org/buglist.cgi?f1=cf_external_ref&o1=substring&v1=${reference}&order=bug_status"
  80     BuiltIn.Set Test Message    ${msg}${newline}${bugs}${newline}${newline}${TEST_MESSAGE}
  81     BuiltIn.Log    ${msg}${newline}${bugs}
  82
  83 Check Nodes Stats
  84     [Arguments]    ${node}    ${session}=session
  85     [Documentation]    A GET on the /node/${node} API is made and specific flow stat
  86     ...    strings are checked for existence.
  87     ${resp}    RequestsLibrary.Get Request    ${session}    ${OPERATIONAL_NODES_API}/node/${node}
  88     Should Be Equal As Strings    ${resp.status_code}    200
  89     Should Contain    ${resp.content}    flow-capable-node-connector-statistics
  90     Should Contain    ${resp.content}    flow-table-statistics
  91
  92 Check For Specific Number Of Elements At URI
  93     [Arguments]    ${uri}    ${element}    ${expected_count}    ${session}=session
  94     [Documentation]    A GET is made to the specified ${URI} and the specific count of a
  95     ...    given element is done (as supplied by ${element} and ${expected_count})
  96     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
  97     Log    ${resp.content}
  98     Should Be Equal As Strings    ${resp.status_code}    200
  99     Should Contain X Times    ${resp.content}    ${element}    ${expected_count}
 100
 101 Check For Elements At URI
 102     [Arguments]    ${uri}    ${elements}    ${session}=session
 103     [Documentation]    A GET is made at the supplied ${URI} and every item in the list of
 104     ...    ${elements} is verified to exist in the response
 105     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
 106     Log    ${resp.content}
 107     Should Be Equal As Strings    ${resp.status_code}    200
 108     : FOR    ${i}    IN    @{elements}
 109     \    Should Contain    ${resp.content}    ${i}
 110
 111 Check For Elements Not At URI
 112     [Arguments]    ${uri}    ${elements}    ${session}=session
 113     [Documentation]    A GET is made at the supplied ${URI} and every item in the list of
 114     ...    ${elements} is verified to NOT exist in the response
 115     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
 116     Log    ${resp.content}
 117     Should Be Equal As Strings    ${resp.status_code}    200
 118     : FOR    ${i}    IN    @{elements}
 119     \    Should Not Contain    ${resp.content}    ${i}
 120
 121 Clean Mininet System
 122     [Arguments]    ${system}=${TOOLS_SYSTEM_IP}
 123     Run Command On Mininet    ${system}    sudo mn -c
 124     Run Command On Mininet    ${system}    sudo ps -elf | egrep 'usr/local/bin/mn' | egrep python | awk '{print "sudo kill -9",$4}' | sh
 125
 126 Clean Up Ovs
 127     [Arguments]    ${system}=${TOOLS_SYSTEM_IP}
 128     [Documentation]    Cleans up the OVS instance and remove any existing common known bridges.
 129     ${output}=    Run Command On Mininet    ${system}    sudo ovs-vsctl list-br
 130     Log    ${output}
 131     : FOR    ${i}    IN    ${output}
 132     \    Run Command On Mininet    ${system}    sudo ovs-vsctl --if-exists del-br ${i}
 133     Run Command On Mininet    ${system}    sudo ovs-vsctl del-manager
 134
 135 Extract Value From Content
 136     [Arguments]    ${content}    ${index}    ${strip}=nostrip
 137     [Documentation]    Will take the given response content and return the value at the given index as a string
 138     ${value}=    Get Json Value    ${content}    ${index}
 139     ${value}=    Convert To String    ${value}
 140     ${value}=    Run Keyword If    '${strip}' == 'strip'    Strip Quotes    ${value}
 141     [Return]    ${value}
 142
 143 Get Process ID Based On Regex On Remote System
 144     [Arguments]    ${system}    ${regex_string_to_match_on}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
 145     [Documentation]    Uses ps to find a process that matches the supplied regex. Returns the PID of that process
 146     ...    The ${regex_string_to_match_on} should produce a unique process otherwise the PID returned may not be
 147     ...    the expected PID
 148     # doing the extra -v grep in this command to exclude the grep process itself from the output
 149     ${cmd}=    Set Variable    ps -elf | grep -v grep | grep ${regex_string_to_match_on} | awk '{print $4}'
 150     ${output}=    Run Command On Remote System    ${system}    ${cmd}    user=${user}    password=${password}    prompt=${prompt}
 151     ...    prompt_timeout=${prompt_timeout}
 152     # ${output} contains the system prompt and all we want is the value of the number
 153     ${pid}=    Fetch From Left    ${output}    \r
 154     # TODO: Get Process * keywords have perhaps non-standard default credentials.
 155     # ...    Should there be * On Mininet and * On Controller specializations?
 156     [Return]    ${pid}
 157
 158 Get Process Thread Count On Remote System
 159     [Arguments]    ${system}    ${pid}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
 160     [Documentation]    Executes the ps command to retrieve the lightweight process (aka thread) count.
 161     ${cmd}=    Set Variable    ps --no-headers -o nlwp ${pid}
 162     ${output}=    Run Command On Remote System    ${system}    ${cmd}    user=${user}    password=${password}    prompt=${prompt}
 163     ...    prompt_timeout=${prompt_timeout}
 164     # ${output} contains the system prompt and all we want is the value of the number
 165     ${thread_count}=    Fetch From Left    ${output}    \r
 166     [Return]    ${thread_count}
 167
 168 Strip Quotes
 169     [Arguments]    ${string_to_strip}
 170     [Documentation]    Will strip ALL quotes from given string and return the new string
 171     ${string_to_return}=    Replace String    ${string_to_strip}    "    \    count=-1
 172     [Return]    ${string_to_return}
 173
 174 Run Command On Remote System
 175     [Arguments]    ${system}    ${cmd}    ${user}=${DEFAULT_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=${DEFAULT_TIMEOUT}
 176     ...    ${return_stdout}=True    ${return_stderr}=False
 177     [Documentation]    Reduces the common work of running a command on a remote system to a single higher level
 178     ...    robot keyword, taking care to log in with a public key and. The command given is written and the return value
 179     ...    depends on the passed argument values of return_stdout (default: True) and return_stderr (default: False).
 180     ...    At least one should be True, or the keyword will exit and FAIL. If both are True, the resulting return value
 181     ...    will be a two element list containing both. Otherwise the resulting return value is a string.
 182     ...    No test conditions are checked.
 183     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
 184     ${current_ssh_connection}=    SSHLibrary.Get Connection
 185     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}"
 186     ${conn_id}=    SSHLibrary.Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
 187     SSHKeywords.Flexible SSH Login    ${user}    ${password}
 188     ${stdout}    ${stderr}    SSHLibrary.Execute Command    ${cmd}    return_stderr=True
 189     SSHLibrary.Close Connection
 190     Log    ${stderr}
 191     Run Keyword If    "${return_stdout}"!="True"    Return From Keyword    ${stderr}
 192     Run Keyword If    "${return_stderr}"!="True"    Return From Keyword    ${stdout}
 193     [Teardown]    SSHKeywords.Restore_Current_SSH_Connection_From_Index    ${current_ssh_connection.index}
 194     [Return]    ${stdout}    ${stderr}
 195
 196 Run Command On Remote System And Log
 197     [Arguments]    ${system}    ${cmd}    ${user}=${DEFAULT_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=${DEFAULT_TIMEOUT}
 198     [Documentation]    Reduces the common work of running a command on a remote system to a single higher level
 199     ...    robot keyword, taking care to log in with a public key and. The command given is written
 200     ...    and the output returned. No test conditions are checked.
 201     ${output} =    Run Command On Remote System    ${system}    ${cmd}    ${user}    ${password}    ${prompt}
 202     ...    ${prompt_timeout}
 203     Log    ${output}
 204     [Return]    ${output}
 205
 206 Run Command On Mininet
 207     [Arguments]    ${system}=${TOOLS_SYSTEM_IP}    ${cmd}=echo    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${TOOLS_SYSTEM_PROMPT}
 208     [Documentation]    Call Run Comand On Remote System, but with default values suitable for Mininet machine.
 209     BuiltIn.Run Keyword And Return    Run Command On Remote System    ${system}    ${cmd}    ${user}    ${password}    prompt=${prompt}
 210
 211 Run Command On Controller
 212     [Arguments]    ${system}=${ODL_SYSTEM_IP}    ${cmd}=echo    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 213     [Documentation]    Call Run Comand On Remote System, but with default values suitable for Controller machine.
 214     BuiltIn.Run Keyword And Return    Run Command On Remote System    ${system}    ${cmd}    ${user}    ${password}    prompt=${prompt}
 215
 216 Verify File Exists On Remote System
 217     [Arguments]    ${system}    ${file}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=5s
 218     [Documentation]    Will create connection with public key and will PASS if the given ${file} exists,
 219     ...    otherwise will FAIL
 220     ${conn_id}=    Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
 221     SSHKeywords.Flexible SSH Login    ${user}    ${password}
 222     SSHLibrary.File Should Exist    ${file}
 223     Close Connection
 224
 225 Check Karaf Log File Does Not Have Messages
 226     [Arguments]    ${ip}    ${message}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}    ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
 227     [Documentation]    Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The
 228     ...    karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip}
 229     ${output}=    Run Command On Controller    ${ip}    grep -c '${message}' ${log_file}    user=${user}    password=${password}    prompt=${prompt}
 230     Should Be Equal As Strings    ${output}    0
 231
 232 Verify Controller Is Not Dead
 233     [Arguments]    ${controller_ip}=${ODL_SYSTEM_IP}
 234     [Documentation]    Will execute any tests to verify the controller is not dead. Some checks are
 235     ...    Out Of Memory Execptions.
 236     Check Karaf Log File Does Not Have Messages    ${controller_ip}    java.lang.OutOfMemoryError
 237     # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments?
 238
 239 Verify Controller Has No Null Pointer Exceptions
 240     [Arguments]    ${controller_ip}=${ODL_SYSTEM_IP}
 241     [Documentation]    Will execute any tests to verify the controller is not having any null pointer eceptions.
 242     Check Karaf Log File Does Not Have Messages    ${controller_ip}    java.lang.NullPointerException
 243
 244 Get Epoch Time
 245     [Arguments]    ${time}
 246     [Documentation]    Get the Epoc time from MM/DD/YYYY HH:MM:SS
 247     ${epoch_time}=    Convert Date    ${time}    epoch    exclude_milles=True    date_format=%m/%d/%Y %H:%M:%S
 248     ${epoch_time}=    Convert To Integer    ${epoch_time}
 249     [Return]    ${epoch_time}
 250
 251 Remove Space on String
 252     [Arguments]    ${str}    ${count}=-1
 253     [Documentation]    Remove the empty space from given string.count is optional,if its given
 254     ...    that many occurence of space will be removed from left
 255     ${x}=    Convert To String    ${str}
 256     ${x}=    Replace String    ${str}    ${SPACE}    ${EMPTY}    count=${count}
 257     [Return]    ${x}
 258
 259 Split Value from String
 260     [Arguments]    ${str}    ${splitter}
 261     [Documentation]    Split the String based on given splitter and return as list
 262     @{x}=    Split String    ${str}    ${splitter}
 263     [Return]    @{x}
 264
 265 Concatenate the String
 266     [Arguments]    ${str1}    ${str2}
 267     [Documentation]    Catenate the two non-string objects and return as String
 268     ${str1}=    Convert to String    ${str1}
 269     ${str2}=    Convert to String    ${str2}
 270     ${output}=    Catenate    ${str1}    ${str2}
 271     [Return]    ${output}
 272
 273 Post Elements To URI
 274     [Arguments]    ${rest_uri}    ${data}    ${headers}=${headers}    ${session}=session
 275     [Documentation]    Perform a POST rest operation, using the URL and data provided
 276     ${resp} =    RequestsLibrary.Post Request    ${session}    ${rest_uri}    data=${data}    headers=${headers}
 277     Log    ${resp.content}
 278     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 279
 280 Remove All Elements At URI
 281     [Arguments]    ${uri}    ${session}=session
 282     ${resp}    RequestsLibrary.Delete Request    ${session}    ${uri}
 283     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 284
 285 Remove All Elements At URI And Verify
 286     [Arguments]    ${uri}    ${session}=session
 287     ${resp}    RequestsLibrary.Delete Request    ${session}    ${uri}
 288     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 289     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
 290     Should Be Equal As Strings    ${resp.status_code}    404
 291
 292 Remove All Elements If Exist
 293     [Arguments]    ${uri}    ${session}=session
 294     [Documentation]    Delete all elements from an URI if the configuration was not empty
 295     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
 296     Run Keyword If    '${resp.status_code}'!='404'    Remove All Elements At URI    ${uri}    ${session}
 297
 298 Add Elements To URI From File
 299     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 300     ${body}    OperatingSystem.Get File    ${data_file}
 301     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 302     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 303
 304 Add Elements To URI From File And Verify
 305     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 306     ${body}    OperatingSystem.Get File    ${data_file}
 307     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 308     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 309     ${resp}    RequestsLibrary.Get Request    ${session}    ${dest_uri}
 310     Should Not Be Equal    ${resp.status_code}    404
 311
 312 Add Elements To URI And Verify
 313     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 314     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    ${data_file}    headers=${headers}
 315     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 316     ${resp}    RequestsLibrary.Get Request    ${session}    ${dest_uri}
 317     Should Not Be Equal    ${resp.status_code}    404
 318
 319 Add Elements To URI From File And Check Validation Error
 320     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 321     [Documentation]    Shorthand for PUTting data from file and expecting status code 400.
 322     BuiltIn.Comment    TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
 323     ${body}    OperatingSystem.Get File    ${data_file}
 324     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 325     Should Contain    ${DATA_VALIDATION_ERROR}    ${resp.status_code}
 326
 327 Add Elements To URI From File And Check Server Error
 328     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 329     [Documentation]    Shorthand for PUTting data from file and expecting status code 500.
 330     ...    Consider opening a Bug against ODL, as in most test cases, 400 is the http code to expect.
 331     BuiltIn.Comment    TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
 332     ${body}    OperatingSystem.Get File    ${data_file}
 333     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 334     Should Contain    ${INTERNAL_SERVER_ERROR}    ${resp.status_code}
 335
 336 Post Elements To URI From File
 337     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 338     ${body}    OperatingSystem.Get File    ${data_file}
 339     ${resp}    RequestsLibrary.Post Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 340     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 341
 342 Run Process With Logging And Status Check
 343     [Arguments]    @{proc_args}
 344     [Documentation]    Execute an OS command, log STDOUT and STDERR output and check exit code to be 0
 345     ${result}=    Run Process    @{proc_args}
 346     Log    ${result.stdout}
 347     Log    ${result.stderr}
 348     Should Be Equal As Integers    ${result.rc}    0
 349     [Return]    ${result}
 350
 351 Get Data From URI
 352     [Arguments]    ${session}    ${uri}    ${headers}=${NONE}
 353     [Documentation]    Issue a GET request and return the data obtained or on error log the error and fail.
 354     ...    Issues a GET request for ${uri} in ${session} using headers from
 355     ...    ${headers}. If the request returns a HTTP error, fails. Otherwise
 356     ...    returns the data obtained by the request.
 357     ${response}=    RequestsLibrary.Get Request    ${session}    ${uri}    ${headers}
 358     Builtin.Return_From_Keyword_If    ${response.status_code} == 200    ${response.text}
 359     Builtin.Log    ${response.text}
 360     Builtin.Fail    The request failed with code ${response.status_code}
 361
 362 No Content From URI
 363     [Arguments]    ${session}    ${uri}    ${headers}=${NONE}
 364     [Documentation]    Issue a GET request and return on error 404 (No content) or will fail and log the content.
 365     ...    Issues a GET request for ${uri} in ${session} using headers from
 366     ...    ${headers}. If the request returns a HTTP error, fails. Otherwise
 367     ...    returns the data obtained by the request.
 368     ${response}=    RequestsLibrary.Get Request    ${session}    ${uri}    ${headers}
 369     Builtin.Return_From_Keyword_If    ${response.status_code} == 404
 370     Builtin.Log    ${response.text}
 371     Builtin.Fail    The request failed with code ${response.status_code}
 372
 373 Get Index From List Of Dictionaries
 374     [Arguments]    ${dictionary_list}    ${key}    ${value}
 375     [Documentation]    Extract index for the dictionary in a list that contains a key-value pair. Returns -1 if key-value is not found.
 376     ${length}=    Get Length    ${dictionary_list}
 377     ${index}=    Set Variable    -1
 378     : FOR    ${i}    IN RANGE    ${length}
 379     \    ${dictionary}=    Get From List    ${dictionary_list}    ${i}
 380     \    Run Keyword If    """&{dictionary}[${key}]""" == """${value}"""    Set Test Variable    ${index}    ${i}
 381     [Return]    ${index}
 382
 383 Check Item Occurrence
 384     [Arguments]    ${string}    ${dictionary_item_occurrence}
 385     [Documentation]    Check string for occurrences of items expressed in a list of dictionaries {item=occurrences}. 0 occurences means item is not present.
 386     : FOR    ${item}    IN    @{dictionary_item_occurrence}
 387     \    Should Contain X Times    ${string}    ${item}    &{dictionary_item_occurrence}[${item}]
 388
 389 Post Log Check
 390     [Arguments]    ${uri}    ${body}    ${status_code}=200    ${session}=session
 391     [Documentation]    Post body to ${uri}, log response content, and check status
 392     ${resp}=    RequestsLibrary.Post Request    ${session}    ${uri}    ${body}
 393     Log    ${resp.content}
 394     Should Be Equal As Strings    ${resp.status_code}    ${status_code}
 395     [Return]    ${resp}
 396
 397 Get Log File Name
 398     [Arguments]    ${testtool}    ${testcase}=${EMPTY}
 399     [Documentation]    Get the name of the suite sanitized to be usable as a part of filename.
 400     ...    These names are used to constructs names of the log files produced
 401     ...    by the testing tools so two suites using a tool wont overwrite the
 402     ...    log files if they happen to run in one job.
 403     ${name}=    BuiltIn.Evaluate    """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-")
 404     ${suffix}=    BuiltIn.Set_Variable_If    '${testcase}' != ''    --${testcase}    ${EMPTY}
 405     [Return]    ${testtool}--${name}${suffix}.log
 406
 407 Set_User_Configurable_Variable_Default
 408     [Arguments]    ${name}    ${value}
 409     [Documentation]    Set a default value for an user configurable variable.
 410     ...    This keyword is needed if your default value is calculated using
 411     ...    a complex expression which needs BuiltIn.Evaluate or even more
 412     ...    complex keywords. It sets the variable ${name} (the name of the
 413     ...    variable MUST be specified WITHOUT the ${} syntactic sugar due
 414     ...    to limitations of Robot Framework) to ${value} but only if the
 415     ...    variable ${name} was not set previously. This keyword is intended
 416     ...    for user configurable variables which are supposed to be set only
 417     ...    with pybot -v; calling this keyword on a variable that was already
 418     ...    set by another keyword will silently turn the call into a NOP and
 419     ...    thus is a bug in the suite or resource trying to call this
 420     ...    keyword.
 421     # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning
 422     #    evaluating it only when the user did not set anything and thus the
 423     #    default is needed). This might be needed to avoid potentially costly
 424     #    keyword invocations when they are not needed. Currently no need for
 425     #    this was identified, thus leaving it here as a TODO. Based on
 426     #    comments the best approach would be to create another keyword that
 427     #    expects a ScalarClosure in the place of ${value} and calls the
 428     #    closure to get the value but only if the value is needed).
 429     #    The best idea how to implement this "laziness" would be to have the
 430     #    used to define another keyword that will be responsible for getting
 431     #    the default value and then passing the name of this getter keyword
 432     #    to this keyword. Then this keyword would call the getter (to obtain
 433     #    the expensive default value) only if it discovers that this value
 434     #    is really needed (because the variable is not set yet).
 435     # TODO: Is the above TODO really necessary? Right now we don't have any
 436     #    examples of "expensive default values" where to obtain the default
 437     #    value is so expensive on resources (e.g. need to SSH somewhere to
 438     #    check something) that we would want to skip the calculation if the
 439     #    variable for which it is needed has a value already provided by the
 440     #    user using "pybot -v" or something. One example would be
 441     #    JAVA_HOME if it would be designed as user-configurable variable
 442     #    (currently it is not; users can specify "use jdk7" or "use jdk8"
 443     #    but not "use the jdk over there"; and there actually is no JAVA_HOME
 444     #    present in the resource, rather the Java invocation command uses the
 445     #    Java invocation with a full path). The default value of JAVA_HOME
 446     #    has to be obtained by issuing commands on the SSH connection where
 447     #    the resulting Java invocation command will be used (to check
 448     #    multiple candidate paths until one that fits is found) and we could
 449     #    skip all this checking if a JAVA_HOME was supplied by the user using
 450     #    "pybot -v".
 451     ${value}=    BuiltIn.Get_Variable_Value    \${${name}}    ${value}
 452     BuiltIn.Set_Suite_Variable    \${${name}}    ${value}
 453
 454 Convert_To_Minutes
 455     [Arguments]    ${time}
 456     [Documentation]    Convert a Robot time string to an integer expressing the time in minutes, rounded up
 457     ...    This is a wrapper around DateTime.Convert_Time which does not
 458     ...    provide this functionality directly nor is even able to produce
 459     ...    an integer directly. It is needed for RestPerfClient which
 460     ...    cannot accept floats for its --timeout parameter and interprets
 461     ...    the value supplied in this parameter in minutes.
 462     ${seconds}=    DateTime.Convert_Time    ${time}    result_format=number
 463     ${minutes}=    BuiltIn.Evaluate    int(math.ceil(${seconds}/60.0))    modules=math
 464     [Return]    ${minutes}
 465
 466 Write Commands Until Expected Prompt
 467     [Arguments]    ${cmd}    ${prompt}    ${timeout}=30s
 468     [Documentation]    quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
 469     SSHLibrary.Set Client Configuration    timeout=${timeout}
 470     SSHLibrary.Read
 471     SSHLibrary.Write    ${cmd}
 472     ${output}=    SSHLibrary.Read Until    ${prompt}
 473     [Return]    ${output}
 474
 475 Install Package On Ubuntu System
 476     [Arguments]    ${package_name}    ${system}=${TOOLS_SYSTEM_IP}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
 477     [Documentation]    Keyword to install packages for testing to Ubuntu Mininet VM
 478     Log    Keyword to install package to Mininet Ubuntu VM
 479     Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
 480     SSHKeywords.Flexible Mininet Login    user=${user}    password=${password}
 481     Write    sudo apt-get install -y ${package_name}
 482     Read Until    ${prompt}
 483
 484 Json Parse From String
 485     [Arguments]    ${plain_string_with_json}
 486     [Documentation]    Parse given plain string into json (dictionary)
 487     ${json_data}    Evaluate    json.loads('''${plain_string_with_json}''')    json
 488     [Return]    ${json_data}
 489
 490 Json Parse From File
 491     [Arguments]    ${json_file}
 492     [Documentation]    Parse given file content into json (dictionary)
 493     ${json_plain_string}    OperatingSystem.Get file    ${json_file}
 494     ${json_data}    Json Parse From String    ${json_plain_string}
 495     [Return]    ${json_data}
 496
 497 Modify Iptables On Remote System
 498     [Arguments]    ${remote_system_ip}    ${iptables_rule}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 499     [Documentation]    Wrapper keyword to run iptables with any given ${iptables_rule} string on the remote system given
 500     ...    by ${remote_system_ip}. The iptables listing will be output before and after the command is run
 501     ${list_iptables_command} =    BuiltIn.Set Variable    sudo /sbin/iptables -L -n
 502     ${output} =    Utils.Run Command On Remote System    ${remote_system_ip}    ${list_iptables_command}    ${user}    ${password}    prompt=${prompt}
 503     BuiltIn.Log    ${output}
 504     Utils.Run Command On Remote System    ${remote_system_ip}    sudo /sbin/iptables ${iptables_rule}    ${user}    ${password}    prompt=${prompt}
 505     ${output} =    Utils.Run Command On Remote System    ${remote_system_ip}    ${list_iptables_command}    ${user}    ${password}    prompt=${prompt}
 506     BuiltIn.Log    ${output}