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