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     [Documentation]    Reduces the common work of running a command on a remote system to a single higher level
 177     ...    robot keyword, taking care to log in with a public key and. The command given is written
 178     ...    and the output returned. No test conditions are checked.
 179     ${current_ssh_connection}=    SSHLibrary.Get Connection
 180     BuiltIn.Log    Attempting to execute command "${cmd}" on remote system "${system}" by user "${user}" with keyfile pass "${keyfile_pass}" and prompt "${prompt}"
 181     BuiltIn.Log    ${password}
 182     ${conn_id}=    SSHLibrary.Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
 183     SSHKeywords.Flexible SSH Login    ${user}    ${password}
 184     ${stdout}    ${stderr}    SSHLibrary.Execute Command    ${cmd}    return_stderr=True
 185     SSHLibrary.Close Connection
 186     Log    ${stderr}
 187     [Teardown]    SSHKeywords.Restore_Current_SSH_Connection_From_Index    ${current_ssh_connection.index}
 188     [Return]    ${stdout}
 189
 190 Run Command On Remote System And Log
 191     [Arguments]    ${system}    ${cmd}    ${user}=${DEFAULT_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=${DEFAULT_TIMEOUT}
 192     [Documentation]    Reduces the common work of running a command on a remote system to a single higher level
 193     ...    robot keyword, taking care to log in with a public key and. The command given is written
 194     ...    and the output returned. No test conditions are checked.
 195     ${output} =    Run Command On Remote System    ${system}    ${cmd}    ${user}    ${password}    ${prompt}
 196     ...    ${prompt_timeout}
 197     Log    ${output}
 198     [Return]    ${output}
 199
 200 Run Command On Mininet
 201     [Arguments]    ${system}=${TOOLS_SYSTEM_IP}    ${cmd}=echo    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${TOOLS_SYSTEM_PROMPT}
 202     [Documentation]    Call Run Comand On Remote System, but with default values suitable for Mininet machine.
 203     BuiltIn.Run Keyword And Return    Run Command On Remote System    ${system}    ${cmd}    ${user}    ${password}    prompt=${prompt}
 204
 205 Run Command On Controller
 206     [Arguments]    ${system}=${ODL_SYSTEM_IP}    ${cmd}=echo    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 207     [Documentation]    Call Run Comand On Remote System, but with default values suitable for Controller machine.
 208     BuiltIn.Log    ${password}
 209     BuiltIn.Run Keyword And Return    Run Command On Remote System    ${system}    ${cmd}    ${user}    ${password}    prompt=${prompt}
 210
 211 Verify File Exists On Remote System
 212     [Arguments]    ${system}    ${file}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=5s
 213     [Documentation]    Will create connection with public key and will PASS if the given ${file} exists,
 214     ...    otherwise will FAIL
 215     ${conn_id}=    Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
 216     SSHKeywords.Flexible SSH Login    ${user}    ${password}
 217     SSHLibrary.File Should Exist    ${file}
 218     Close Connection
 219
 220 Check Karaf Log File Does Not Have Messages
 221     [Arguments]    ${ip}    ${message}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}    ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
 222     [Documentation]    Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The
 223     ...    karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip}
 224     ${output}=    Run Command On Controller    ${ip}    grep -c '${message}' ${log_file}    user=${user}    password=${password}    prompt=${prompt}
 225     Should Be Equal As Strings    ${output}    0
 226
 227 Verify Controller Is Not Dead
 228     [Arguments]    ${controller_ip}=${ODL_SYSTEM_IP}
 229     [Documentation]    Will execute any tests to verify the controller is not dead. Some checks are
 230     ...    Out Of Memory Execptions.
 231     Check Karaf Log File Does Not Have Messages    ${controller_ip}    java.lang.OutOfMemoryError
 232     # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments?
 233
 234 Verify Controller Has No Null Pointer Exceptions
 235     [Arguments]    ${controller_ip}=${ODL_SYSTEM_IP}
 236     [Documentation]    Will execute any tests to verify the controller is not having any null pointer eceptions.
 237     Check Karaf Log File Does Not Have Messages    ${controller_ip}    java.lang.NullPointerException
 238
 239 Get Epoch Time
 240     [Arguments]    ${time}
 241     [Documentation]    Get the Epoc time from MM/DD/YYYY HH:MM:SS
 242     ${epoch_time}=    Convert Date    ${time}    epoch    exclude_milles=True    date_format=%m/%d/%Y %H:%M:%S
 243     ${epoch_time}=    Convert To Integer    ${epoch_time}
 244     [Return]    ${epoch_time}
 245
 246 Remove Space on String
 247     [Arguments]    ${str}    ${count}=-1
 248     [Documentation]    Remove the empty space from given string.count is optional,if its given
 249     ...    that many occurence of space will be removed from left
 250     ${x}=    Convert To String    ${str}
 251     ${x}=    Replace String    ${str}    ${SPACE}    ${EMPTY}    count=${count}
 252     [Return]    ${x}
 253
 254 Split Value from String
 255     [Arguments]    ${str}    ${splitter}
 256     [Documentation]    Split the String based on given splitter and return as list
 257     @{x}=    Split String    ${str}    ${splitter}
 258     [Return]    @{x}
 259
 260 Concatenate the String
 261     [Arguments]    ${str1}    ${str2}
 262     [Documentation]    Catenate the two non-string objects and return as String
 263     ${str1}=    Convert to String    ${str1}
 264     ${str2}=    Convert to String    ${str2}
 265     ${output}=    Catenate    ${str1}    ${str2}
 266     [Return]    ${output}
 267
 268 Post Elements To URI
 269     [Arguments]    ${rest_uri}    ${data}    ${headers}=${headers}    ${session}=session
 270     [Documentation]    Perform a POST rest operation, using the URL and data provided
 271     ${resp} =    RequestsLibrary.Post Request    ${session}    ${rest_uri}    data=${data}    headers=${headers}
 272     Log    ${resp.content}
 273     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 274
 275 Remove All Elements At URI
 276     [Arguments]    ${uri}    ${session}=session
 277     ${resp}    RequestsLibrary.Delete Request    ${session}    ${uri}
 278     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 279
 280 Remove All Elements At URI And Verify
 281     [Arguments]    ${uri}    ${session}=session
 282     ${resp}    RequestsLibrary.Delete Request    ${session}    ${uri}
 283     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 284     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
 285     Should Be Equal As Strings    ${resp.status_code}    404
 286
 287 Remove All Elements If Exist
 288     [Arguments]    ${uri}    ${session}=session
 289     [Documentation]    Delete all elements from an URI if the configuration was not empty
 290     ${resp}    RequestsLibrary.Get Request    ${session}    ${uri}
 291     Run Keyword If    '${resp.status_code}'!='404'    Remove All Elements At URI    ${uri}    ${session}
 292
 293 Add Elements To URI From File
 294     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 295     ${body}    OperatingSystem.Get File    ${data_file}
 296     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 297     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 298
 299 Add Elements To URI From File And Verify
 300     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 301     ${body}    OperatingSystem.Get File    ${data_file}
 302     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 303     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 304     ${resp}    RequestsLibrary.Get Request    ${session}    ${dest_uri}
 305     Should Not Be Equal    ${resp.status_code}    404
 306
 307 Add Elements To URI And Verify
 308     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 309     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    ${data_file}    headers=${headers}
 310     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 311     ${resp}    RequestsLibrary.Get Request    ${session}    ${dest_uri}
 312     Should Not Be Equal    ${resp.status_code}    404
 313
 314 Add Elements To URI From File And Check Validation Error
 315     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 316     [Documentation]    Shorthand for PUTting data from file and expecting status code 400.
 317     BuiltIn.Comment    TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
 318     ${body}    OperatingSystem.Get File    ${data_file}
 319     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 320     Should Contain    ${DATA_VALIDATION_ERROR}    ${resp.status_code}
 321
 322 Add Elements To URI From File And Check Server Error
 323     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 324     [Documentation]    Shorthand for PUTting data from file and expecting status code 500.
 325     ...    Consider opening a Bug against ODL, as in most test cases, 400 is the http code to expect.
 326     BuiltIn.Comment    TODO: Does this have any benefits, considering TemplatedRequests can also do this in one line?
 327     ${body}    OperatingSystem.Get File    ${data_file}
 328     ${resp}    RequestsLibrary.Put Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 329     Should Contain    ${INTERNAL_SERVER_ERROR}    ${resp.status_code}
 330
 331 Post Elements To URI From File
 332     [Arguments]    ${dest_uri}    ${data_file}    ${headers}=${headers}    ${session}=session
 333     ${body}    OperatingSystem.Get File    ${data_file}
 334     ${resp}    RequestsLibrary.Post Request    ${session}    ${dest_uri}    data=${body}    headers=${headers}
 335     Should Contain    ${ALLOWED_STATUS_CODES}    ${resp.status_code}
 336
 337 Run Process With Logging And Status Check
 338     [Arguments]    @{proc_args}
 339     [Documentation]    Execute an OS command, log STDOUT and STDERR output and check exit code to be 0
 340     ${result}=    Run Process    @{proc_args}
 341     Log    ${result.stdout}
 342     Log    ${result.stderr}
 343     Should Be Equal As Integers    ${result.rc}    0
 344     [Return]    ${result}
 345
 346 Get Data From URI
 347     [Arguments]    ${session}    ${uri}    ${headers}=${NONE}
 348     [Documentation]    Issue a GET request and return the data obtained or on error log the error and fail.
 349     ...    Issues a GET request for ${uri} in ${session} using headers from
 350     ...    ${headers}. If the request returns a HTTP error, fails. Otherwise
 351     ...    returns the data obtained by the request.
 352     ${response}=    RequestsLibrary.Get Request    ${session}    ${uri}    ${headers}
 353     Builtin.Return_From_Keyword_If    ${response.status_code} == 200    ${response.text}
 354     Builtin.Log    ${response.text}
 355     Builtin.Fail    The request failed with code ${response.status_code}
 356
 357 No Content From URI
 358     [Arguments]    ${session}    ${uri}    ${headers}=${NONE}
 359     [Documentation]    Issue a GET request and return on error 404 (No content) or will fail and log the content.
 360     ...    Issues a GET request for ${uri} in ${session} using headers from
 361     ...    ${headers}. If the request returns a HTTP error, fails. Otherwise
 362     ...    returns the data obtained by the request.
 363     ${response}=    RequestsLibrary.Get Request    ${session}    ${uri}    ${headers}
 364     Builtin.Return_From_Keyword_If    ${response.status_code} == 404
 365     Builtin.Log    ${response.text}
 366     Builtin.Fail    The request failed with code ${response.status_code}
 367
 368 Get Index From List Of Dictionaries
 369     [Arguments]    ${dictionary_list}    ${key}    ${value}
 370     [Documentation]    Extract index for the dictionary in a list that contains a key-value pair. Returns -1 if key-value is not found.
 371     ${length}=    Get Length    ${dictionary_list}
 372     ${index}=    Set Variable    -1
 373     : FOR    ${i}    IN RANGE    ${length}
 374     \    ${dictionary}=    Get From List    ${dictionary_list}    ${i}
 375     \    Run Keyword If    """&{dictionary}[${key}]""" == """${value}"""    Set Test Variable    ${index}    ${i}
 376     [Return]    ${index}
 377
 378 Check Item Occurrence
 379     [Arguments]    ${string}    ${dictionary_item_occurrence}
 380     [Documentation]    Check string for occurrences of items expressed in a list of dictionaries {item=occurrences}. 0 occurences means item is not present.
 381     : FOR    ${item}    IN    @{dictionary_item_occurrence}
 382     \    Should Contain X Times    ${string}    ${item}    &{dictionary_item_occurrence}[${item}]
 383
 384 Post Log Check
 385     [Arguments]    ${uri}    ${body}    ${status_code}=200    ${session}=session
 386     [Documentation]    Post body to ${uri}, log response content, and check status
 387     ${resp}=    RequestsLibrary.Post Request    ${session}    ${uri}    ${body}
 388     Log    ${resp.content}
 389     Should Be Equal As Strings    ${resp.status_code}    ${status_code}
 390     [Return]    ${resp}
 391
 392 Get Log File Name
 393     [Arguments]    ${testtool}    ${testcase}=${EMPTY}
 394     [Documentation]    Get the name of the suite sanitized to be usable as a part of filename.
 395     ...    These names are used to constructs names of the log files produced
 396     ...    by the testing tools so two suites using a tool wont overwrite the
 397     ...    log files if they happen to run in one job.
 398     ${name}=    BuiltIn.Evaluate    """${SUITE_NAME}""".replace(" ","-").replace("/","-").replace(".","-")
 399     ${suffix}=    BuiltIn.Set_Variable_If    '${testcase}' != ''    --${testcase}    ${EMPTY}
 400     [Return]    ${testtool}--${name}${suffix}.log
 401
 402 Set_User_Configurable_Variable_Default
 403     [Arguments]    ${name}    ${value}
 404     [Documentation]    Set a default value for an user configurable variable.
 405     ...    This keyword is needed if your default value is calculated using
 406     ...    a complex expression which needs BuiltIn.Evaluate or even more
 407     ...    complex keywords. It sets the variable ${name} (the name of the
 408     ...    variable MUST be specified WITHOUT the ${} syntactic sugar due
 409     ...    to limitations of Robot Framework) to ${value} but only if the
 410     ...    variable ${name} was not set previously. This keyword is intended
 411     ...    for user configurable variables which are supposed to be set only
 412     ...    with pybot -v; calling this keyword on a variable that was already
 413     ...    set by another keyword will silently turn the call into a NOP and
 414     ...    thus is a bug in the suite or resource trying to call this
 415     ...    keyword.
 416     # TODO: Figure out how to make the ${value} evaluation "lazy" (meaning
 417     #    evaluating it only when the user did not set anything and thus the
 418     #    default is needed). This might be needed to avoid potentially costly
 419     #    keyword invocations when they are not needed. Currently no need for
 420     #    this was identified, thus leaving it here as a TODO. Based on
 421     #    comments the best approach would be to create another keyword that
 422     #    expects a ScalarClosure in the place of ${value} and calls the
 423     #    closure to get the value but only if the value is needed).
 424     #    The best idea how to implement this "laziness" would be to have the
 425     #    used to define another keyword that will be responsible for getting
 426     #    the default value and then passing the name of this getter keyword
 427     #    to this keyword. Then this keyword would call the getter (to obtain
 428     #    the expensive default value) only if it discovers that this value
 429     #    is really needed (because the variable is not set yet).
 430     # TODO: Is the above TODO really necessary? Right now we don't have any
 431     #    examples of "expensive default values" where to obtain the default
 432     #    value is so expensive on resources (e.g. need to SSH somewhere to
 433     #    check something) that we would want to skip the calculation if the
 434     #    variable for which it is needed has a value already provided by the
 435     #    user using "pybot -v" or something. One example would be
 436     #    JAVA_HOME if it would be designed as user-configurable variable
 437     #    (currently it is not; users can specify "use jdk7" or "use jdk8"
 438     #    but not "use the jdk over there"; and there actually is no JAVA_HOME
 439     #    present in the resource, rather the Java invocation command uses the
 440     #    Java invocation with a full path). The default value of JAVA_HOME
 441     #    has to be obtained by issuing commands on the SSH connection where
 442     #    the resulting Java invocation command will be used (to check
 443     #    multiple candidate paths until one that fits is found) and we could
 444     #    skip all this checking if a JAVA_HOME was supplied by the user using
 445     #    "pybot -v".
 446     ${value}=    BuiltIn.Get_Variable_Value    \${${name}}    ${value}
 447     BuiltIn.Set_Suite_Variable    \${${name}}    ${value}
 448
 449 Convert_To_Minutes
 450     [Arguments]    ${time}
 451     [Documentation]    Convert a Robot time string to an integer expressing the time in minutes, rounded up
 452     ...    This is a wrapper around DateTime.Convert_Time which does not
 453     ...    provide this functionality directly nor is even able to produce
 454     ...    an integer directly. It is needed for RestPerfClient which
 455     ...    cannot accept floats for its --timeout parameter and interprets
 456     ...    the value supplied in this parameter in minutes.
 457     ${seconds}=    DateTime.Convert_Time    ${time}    result_format=number
 458     ${minutes}=    BuiltIn.Evaluate    int(math.ceil(${seconds}/60.0))    modules=math
 459     [Return]    ${minutes}
 460
 461 Write Commands Until Expected Prompt
 462     [Arguments]    ${cmd}    ${prompt}    ${timeout}=30s
 463     [Documentation]    quick wrapper for Write and Read Until Prompt Keywords to make test cases more readable
 464     SSHLibrary.Set Client Configuration    timeout=${timeout}
 465     SSHLibrary.Read
 466     SSHLibrary.Write    ${cmd}
 467     ${output}=    SSHLibrary.Read Until    ${prompt}
 468     [Return]    ${output}
 469
 470 Install Package On Ubuntu System
 471     [Arguments]    ${package_name}    ${system}=${TOOLS_SYSTEM_IP}    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
 472     [Documentation]    Keyword to install packages for testing to Ubuntu Mininet VM
 473     Log    Keyword to install package to Mininet Ubuntu VM
 474     Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
 475     SSHKeywords.Flexible Mininet Login    user=${user}    password=${password}
 476     Write    sudo apt-get install -y ${package_name}
 477     Read Until    ${prompt}
 478
 479 Json Parse From String
 480     [Arguments]    ${plain_string_with_json}
 481     [Documentation]    Parse given plain string into json (dictionary)
 482     ${json_data}    Evaluate    json.loads('''${plain_string_with_json}''')    json
 483     [Return]    ${json_data}
 484
 485 Json Parse From File
 486     [Arguments]    ${json_file}
 487     [Documentation]    Parse given file content into json (dictionary)
 488     ${json_plain_string}    OperatingSystem.Get file    ${json_file}
 489     ${json_data}    Json Parse From String    ${json_plain_string}
 490     [Return]    ${json_data}