Add deprecation notice, remove old code
[integration.git] / test / csit / libraries / Utils.robot
diff --git a/test/csit/libraries/Utils.robot b/test/csit/libraries/Utils.robot
deleted file mode 100644 (file)
index f330170..0000000
+++ /dev/null
@@ -1,298 +0,0 @@
-*** Settings ***
-Library           SSHLibrary
-Library           String
-Library           DateTime
-Library           ./UtilLibrary.py
-Resource          KarafKeywords.robot
-Variables           ../variables/Variables.py
-
-*** Variables ***
-# TODO: Introduce ${tree_size} and use instead of 1 in the next line.
-${start}          sudo mn --controller=remote,ip=${CONTROLLER} --topo tree,1 --switch ovsk,protocols=OpenFlow13
-${controller_index}    -1
-
-*** Keywords ***
-Start Suite
-    [Documentation]    Basic setup/cleanup work that can be done safely before any system
-    ...    is run.
-    [Arguments]    ${system}=${MININET}    ${user}=${MININET_USER}    ${password}=${MININET_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${timeout}=30s
-    Log    Start the test on the base edition
-    Clean Mininet System
-    ${mininet_conn_id}=    Open Connection    ${system}    prompt=${DEFAULT_LINUX_PROMPT}    timeout=${timeout}
-    Set Suite Variable    ${mininet_conn_id}
-    Flexible Mininet Login    user=${user}    password=${password}
-    Execute Command    sudo ovs-vsctl set-manager ptcp:6644
-    Write    ${start}
-    Read Until    mininet>
-
-Start Mininet
-    [Arguments]    ${system}=${MININET}    ${cmd}=${start}    ${custom}=${OVSDB_CONFIG_DIR}/ovsdb.py    ${user}=${MININET_USER}    ${password}=${MININET_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
-    [Documentation]    Basic setup to start mininet with custom topology
-    Log    Start the test on the base edition
-    Clean Mininet System
-    ${mininet_conn_id}=    Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
-    Set Suite Variable    ${mininet_conn_id}
-    Flexible Mininet Login    user=${user}    password=${password}
-    Put File    ${custom}
-    Write    ${cmd}
-    Read Until    mininet>
-    [Return]    ${mininet_conn_id}
-
-Connect To Controller Karaf
-    [Documentation]    Connect to the controller's karaf console.
-    ${connection}=    SSHLibrary.Open_Connection    ${CONTROLLER}    port=${KARAF_SHELL_PORT}    prompt=>
-    Set Suite Variable    ${controller_index}    ${connection}
-    SSHLibrary.Login    ${KARAF_USER}    ${KARAF_PASSWORD}
-
-Log Message To Controller Karaf
-    [Arguments]    ${message}
-    [Documentation]    Send a message into the controller's karaf log file.
-    # Background info: If there was no previous SSH connection, the "Get
-    # Connection" returns an information structure whose "index" field
-    # resolves to "None", and the "Switch Connection" below does not
-    # complain.
-    ${current}=    Get_Connection
-    ${connection}=    Set Variable    ${current.index}
-    BuiltIn.Run Keyword If    ${controller_index} <> -1    Switch Connection    ${controller_index}
-    BuiltIn.Run Keyword If    ${controller_index} == -1    Connect to Controller Karaf
-    SSHLibrary.Write    log:log "ROBOT MESSAGE: ${message}"
-    SSHLibrary.Read_Until_Prompt
-    Switch Connection    ${connection}
-
-Stop Mininet
-    [Arguments]    ${mininet_conn_id}    ${prompt}=${DEFAULT_LINUX_PROMPT}
-    [Documentation]    Basic setup to stop/clean mininet
-    Switch Connection    ${mininet_conn_id}
-    SSHLibrary.Write    exit
-    Read Until    ${prompt}
-    Close Connection
-
-Stop Suite
-    [Arguments]    ${prompt}=${DEFAULT_LINUX_PROMPT}
-    [Documentation]    Cleanup/Shutdown work that should be done at the completion of all
-    ...    tests
-    Log    Stop the test on the base edition
-    Switch Connection    ${mininet_conn_id}
-    Read
-    Write    exit
-    Read Until    ${prompt}
-    Close Connection
-
-Ensure All Nodes Are In Response
-    [Arguments]    ${URI}    ${node_list}
-    [Documentation]    A GET is made to the supplied ${URI} and every item in the ${node_list}
-    ...    is verified to exist in the repsonse. This keyword currently implies that it's node
-    ...    specific but any list of strings can be given in ${node_list}. Refactoring of this
-    ...    to make it more generic should be done. (see keyword "Check For Elements At URI")
-    : FOR    ${node}    IN    @{node_list}
-    \    ${resp}    RequestsLibrary.Get    session    ${URI}
-    \    Should Be Equal As Strings    ${resp.status_code}    200
-    \    Should Contain    ${resp.content}    ${node}
-
-Check Nodes Stats
-    [Arguments]    ${node}
-    [Documentation]    A GET on the /node/${node} API is made and specific flow stat
-    ...    strings are checked for existence.
-    ${resp}    RequestsLibrary.Get    session    ${OPERATIONAL_NODES_API}/node/${node}
-    Should Be Equal As Strings    ${resp.status_code}    200
-    Should Contain    ${resp.content}    flow-capable-node-connector-statistics
-    Should Contain    ${resp.content}    flow-table-statistics
-
-Check That Port Count Is Ok
-    [Arguments]    ${node}    ${count}
-    [Documentation]    A GET on the /port API is made and the specified port ${count} is
-    ...    verified. A more generic Keyword "Check For Specific Number Of Elements At URI"
-    ...    also does this work and further consolidation should be done.
-    ${resp}    RequestsLibrary.Get    session    ${REST_CONTEXT}/${CONTAINER}/port
-    Log    ${resp.content}
-    Should Be Equal As Strings    ${resp.status_code}    200
-    Should Contain X Times    ${resp.content}    ${node}    ${count}
-
-Check For Specific Number Of Elements At URI
-    [Arguments]    ${uri}    ${element}    ${expected_count}
-    [Documentation]    A GET is made to the specified ${URI} and the specific count of a
-    ...    given element is done (as supplied by ${element} and ${expected_count})
-    ${resp}    RequestsLibrary.Get    session    ${uri}
-    Log    ${resp.content}
-    Should Be Equal As Strings    ${resp.status_code}    200
-    Should Contain X Times    ${resp.content}    ${element}    ${expected_count}
-
-Check For Elements At URI
-    [Arguments]    ${uri}    ${elements}
-    [Documentation]    A GET is made at the supplied ${URI} and every item in the list of
-    ...    ${elements} is verified to exist in the response
-    ${resp}    RequestsLibrary.Get    session    ${uri}
-    Log    ${resp.content}
-    Should Be Equal As Strings    ${resp.status_code}    200
-    : FOR    ${i}    IN    @{elements}
-    \    Should Contain    ${resp.content}    ${i}
-
-Check For Elements Not At URI
-    [Arguments]    ${uri}    ${elements}
-    [Documentation]    A GET is made at the supplied ${URI} and every item in the list of
-    ...    ${elements} is verified to NOT exist in the response
-    ${resp}    RequestsLibrary.Get    session    ${uri}
-    Log    ${resp.content}
-    Should Be Equal As Strings    ${resp.status_code}    200
-    : FOR    ${i}    IN    @{elements}
-    \    Should Not Contain    ${resp.content}    ${i}
-
-Clean Mininet System
-    [Arguments]    ${system}=${MININET}
-    Run Command On Mininet    ${system}    sudo mn -c
-    Run Command On Mininet    ${system}    sudo ps -elf | egrep 'usr/local/bin/mn' | egrep python | awk '{print "sudo kill -9",$4}' | sh
-
-Clean Up Ovs
-    [Arguments]    ${system}=${MININET}
-    [Documentation]    Cleans up the OVS instance and remove any existing common known bridges.
-    ${output}=    Run Command On Mininet    ${system}    sudo ovs-vsctl list-br
-    Log    ${output}
-    : FOR    ${i}    IN    ${output}
-    \    Run Command On Mininet    ${system}    sudo ovs-vsctl --if-exists del-br ${i}
-    Run Command On Mininet    ${system}    sudo ovs-vsctl del-manager
-
-Extract Value From Content
-    [Arguments]    ${content}    ${index}    ${strip}=nostrip
-    [Documentation]    Will take the given response content and return the value at the given index as a string
-    ${value}=    Get Json Value    ${content}    ${index}
-    ${value}=    Convert To String    ${value}
-    ${value}=    Run Keyword If    '${strip}' == 'strip'    Strip Quotes    ${value}
-    [Return]    ${value}
-
-Get Process ID Based On Regex On Remote System
-    [Arguments]    ${system}    ${regex_string_to_match_on}    ${user}=${MININET_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
-    [Documentation]    Uses ps to find a process that matches the supplied regex. Returns the PID of that process
-    ...    The ${regex_string_to_match_on} should produce a unique process otherwise the PID returned may not be
-    ...    the expected PID
-    # doing the extra -v grep in this command to exclude the grep process itself from the output
-    ${cmd}=    Set Variable    ps -elf | grep -v grep | grep ${regex_string_to_match_on} | awk '{print $4}'
-    ${output}=    Run Command On Remote System    ${system}    ${cmd}    user=${user}    password=${password}    prompt=${prompt}    prompt_timeout=${prompt_timeout}
-    # ${output} contains the system prompt and all we want is the value of the number
-    ${pid}=    Fetch From Left    ${output}    \r
-    [Return]    ${pid}
-    # TODO: Get Process * keywords have perhaps non-standard default credentials.
-    # ...    Should there be * On Mininet and * On Controller specializations?
-
-Get Process Thread Count On Remote System
-    [Arguments]    ${system}    ${pid}    ${user}=${MININET_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
-    [Documentation]    Executes the ps command to retrieve the lightweight process (aka thread) count.
-    ${cmd}=    ps --no-headers -o nlwp ${pid}
-    ${output}=    Run Command On Remote System    ${system}    ${cmd}    user=${user}    password=${password}    prompt=${prompt}    prompt_timeout=${prompt_timeout}
-    # ${output} contains the system prompt and all we want is the value of the number
-    ${thread_count}=    Fetch From Left    ${output}    \r
-    [Return]    ${thread_count}
-
-Strip Quotes
-    [Arguments]    ${string_to_strip}
-    [Documentation]    Will strip ALL quotes from given string and return the new string
-    ${string_to_return}=    Replace String    ${string_to_strip}    "    \    count=-1
-    [Return]    ${string_to_return}
-
-Flexible SSH Login
-    [Arguments]    ${user}    ${password}=${EMPTY}    ${delay}=0.5s
-    [Documentation]    On active SSH session: if given non-empty password, do Login, else do Login With Public Key.
-    ${pwd_length} =    BuiltIn.Get Length    ${password}
-    # ${pwd_length} is guaranteed to be an integer, so we are safe to evaluate it as Python expression.
-    BuiltIn.Run Keyword And Return If    ${pwd_length} > 0    SSHLibrary.Login    ${user}    ${password}    delay=${delay}
-    BuiltIn.Run Keyword And Return    SSHLibrary.Login With Public Key    ${user}    ${USER_HOME}/.ssh/${SSH_KEY}    ${KEYFILE_PASS}   delay=${delay}
-
-Flexible Mininet Login
-    [Arguments]    ${user}=${MININET_USER}    ${password}=${MININET_PASSWORD}    ${delay}=0.5s
-    [Documentation]    Call Flexible SSH Login, but with default values suitable for Mininet machine.
-    BuiltIn.Run Keyword And Return    Flexible SSH Login    user=${user}    password=${password}    delay=${delay}
-
-Flexible Controller Login
-    [Arguments]    ${user}=${CONTROLLER_USER}    ${password}=${CONTROLLER_PASSWORD}    ${delay}=0.5s
-    [Documentation]    Call Flexible SSH Login, but with default values suitable for Controller machine.
-    BuiltIn.Run Keyword And Return    Flexible SSH Login    user=${user}    password=${password}    delay=${delay}
-
-Run Command On Remote System
-    [Arguments]    ${system}    ${cmd}    ${user}=${MININET_USER}    ${password}=${EMPTY}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
-    [Documentation]    Reduces the common work of running a command on a remote system to a single higher level
-    ...    robot keyword, taking care to log in with a public key and. The command given is written
-    ...    and the output returned. No test conditions are checked.
-    Log    Attempting to execute ${cmd} on ${system} by ${user} with ${keyfile_pass} and ${prompt}
-    ${conn_id}=    SSHLibrary.Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
-    Flexible SSH Login    ${user}    ${password}
-    SSHLibrary.Write    ${cmd}
-    ${output}=    SSHLibrary.Read Until    ${prompt}
-    SSHLibrary.Close Connection
-    Log    ${output}
-    [Return]    ${output}
-
-Run Command On Mininet
-    [Arguments]    ${system}=${MININET}    ${cmd}=echo    ${user}=${MININET_USER}    ${password}=${MININET_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
-    [Documentation]    Call Run Comand On Remote System, but with default values suitable for Mininet machine.
-    BuiltIn.Run Keyword And Return    Run Command On Remote System    ${system}    ${cmd}    user=${user}    password=${password}    prompt=${prompt}    prompt_timeout=${prompt_timeout}
-
-Run Command On Controller
-    [Arguments]    ${system}=${CONTROLLER}    ${cmd}=echo    ${user}=${CONTROLLER_USER}    ${password}=${CONTROLLER_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=30s
-    [Documentation]    Call Run Comand On Remote System, but with default values suitable for Controller machine.
-    BuiltIn.Run Keyword And Return    Run Command On Remote System    ${system}    ${cmd}    user=${user}    password=${password}    prompt=${prompt}    prompt_timeout=${prompt_timeout}
-
-Verify File Exists On Remote System
-    [Arguments]    ${system}    ${file}    ${user}=${MININET_USER}    ${password}=${MININET_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}    ${prompt_timeout}=5s
-    [Documentation]    Will create connection with public key and will PASS if the given ${file} exists,
-    ...    otherwise will FAIL
-    ${conn_id}=    Open Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
-    Flexible SSH Login    ${user}    ${password}
-    SSHLibrary.File Should Exist    ${file}
-    Close Connection
-
-Verify Controller Is Not Dead
-    [Arguments]    ${controller_ip}=${CONTROLLER}
-    [Documentation]    Will execute any tests to verify the controller is not dead. Some checks are
-    ...    Out Of Memory Execptions.
-    Check Karaf Log File Does Not Have Messages    ${controller_ip}    java.lang.OutOfMemoryError
-    # TODO: Should Verify Controller * keywords also accept user, password, prompt and karaf_log arguments?
-
-Verify Controller Has No Null Pointer Exceptions
-    [Arguments]    ${controller_ip}=${CONTROLLER}
-    [Documentation]    Will execute any tests to verify the controller is not having any null pointer eceptions.
-    Check Karaf Log File Does Not Have Messages    ${controller_ip}    java.lang.NullPointerException
-
-Get Epoch Time
-    [Arguments]    ${time}
-    [Documentation]    Get the Epoc time from MM/DD/YYYY HH:MM:SS
-    ${epoch_time}=    Convert Date    ${time}    epoch    exclude_milles=True    date_format=%m/%d/%Y %H:%M:%S
-    ${epoch_time}=    Convert To Integer    ${epoch_time}
-    [Return]    ${epoch_time}
-
-Remove Space on String
-    [Arguments]    ${str}    ${count}=-1
-    [Documentation]    Remove the empty space from given string.count is optional,if its given
-    ...    that many occurence of space will be removed from left
-    ${x}=    Convert To String    ${str}
-    ${x}=    Replace String    ${str}    ${SPACE}    ${EMPTY}    count=${count}
-    [Return]    ${x}
-
-Split Value from String
-    [Arguments]    ${str}    ${splitter}
-    [Documentation]    Split the String based on given splitter and return as list
-    @{x}=    Split String    ${str}    ${splitter}
-    [Return]    @{x}
-
-Concatenate the String
-    [Arguments]    ${str1}    ${str2}
-    [Documentation]    Catenate the two non-string objects and return as String
-    ${str1}=    Convert to String    ${str1}
-    ${str2}=    Convert to String    ${str2}
-    ${output}=    Catenate    ${str1}    ${str2}
-    [Return]    ${output}
-
-Remove All Elements At URI
-    [Arguments]    ${uri}
-    ${resp}    RequestsLibrary.Delete    session    ${uri}
-    Should Be Equal As Strings    ${resp.status_code}    200
-
-Add Elements To URI From File
-    [Arguments]    ${dest_uri}    ${data_file}
-    ${body}    OperatingSystem.Get File    ${data_file}
-    ${resp}    RequestsLibrary.Put    session    ${dest_uri}    data=${body}    headers=${headers}
-    Should Be Equal As Strings    ${resp.status_code}    200
-
-Post Elements To URI From File
-    [Arguments]    ${dest_uri}    ${data_file}
-    ${body}    OperatingSystem.Get File    ${data_file}
-    ${resp}    RequestsLibrary.Post    session    ${dest_uri}    data=${body}    headers=${headers}
-    Should Be Equal As Strings    ${resp.status_code}    200