csit/libraries/KarafKeywords.robot

   1 *** Settings ***
   2 Documentation     Karaf library. General utility keywords for interacting with the karaf environment, such as the
   3 ...               karaf console, karaf.log, karaf features, and karaf config files.
   4 ...
   5 ...               This library is useful to deal with controller Karaf console for ssh sessions in cluster.
   6 ...               Running Setup_Karaf_Keywords is necessary. If SetupUtils initialization is called, this gets initialized as well.
   7 ...               If this gets initialized, ClusterManagement gets initialized as well.
   8 Library           SSHLibrary
   9 Library           OperatingSystem
  10 Resource          ${CURDIR}/ClusterManagement.robot
  11 Resource          ${CURDIR}/SSHKeywords.robot
  12 Variables         ${CURDIR}/../variables/Variables.py
  13
  14 *** Variables ***
  15 ${WORKSPACE}      /tmp
  16 ${connection_index_dict}    &{EMPTY}
  17
  18 *** Keywords ***
  19 Setup_Karaf_Keywords
  20     [Arguments]    ${http_timeout}=${DEFAULT_TIMEOUT_HTTP}
  21     [Documentation]    Initialize ClusterManagement. Open ssh karaf connections to each ODL.
  22     ClusterManagement.ClusterManagement_Setup    http_timeout=${http_timeout}
  23     BuiltIn.Comment    First connections to Karaf console may fail, so WUKS is used. TODO: Track as a Bug.
  24     : FOR    ${index}    IN    @{ClusterManagement__member_index_list}
  25     \    BuiltIn.Run_Keyword_And_Ignore_Error    BuiltIn.Wait_Until_Keyword_Succeeds    3s    1s    Open_Controller_Karaf_Console_On_Background    member_index=${index}
  26
  27 Verify_Feature_Is_Installed
  28     [Arguments]    ${feature_name}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}
  29     [Documentation]    Will Succeed if the given ${feature_name} is found in the output of "feature:list -i"
  30     ${output} =    Issue_Command_On_Karaf_Console    feature:list -i | grep ${feature_name}    ${controller}    ${karaf_port}
  31     BuiltIn.Should_Contain    ${output}    ${feature_name}
  32     [Return]    ${output}
  33
  34 Issue_Command_On_Karaf_Console
  35     [Arguments]    ${cmd}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}    ${timeout}=10    ${loglevel}=INFO
  36     [Documentation]    Will execute the given ${cmd} by ssh'ing to the karaf console running on ${controller}
  37     ...    Note that this keyword will open&close new SSH connection, without switching back to previously current session.
  38     SSHLibrary.Open_Connection    ${controller}    port=${karaf_port}    prompt=${KARAF_PROMPT_LOGIN}    timeout=${timeout}
  39     SSHLibrary.Login    ${KARAF_USER}    ${KARAF_PASSWORD}    loglevel=${loglevel}
  40     SSHLibrary.Write    ${cmd}
  41     ${output}    SSHLibrary.Read_Until_Regexp    ${KARAF_PROMPT}
  42     SSHLibrary.Close_Connection
  43     BuiltIn.Log    ${output}
  44     [Return]    ${output}
  45
  46 Safe_Issue_Command_On_Karaf_Console
  47     [Arguments]    ${cmd}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}    ${timeout}=10    ${loglevel}=INFO
  48     [Documentation]    Run Issue_Command_On_Karaf_Console but restore previous connection afterwards.
  49     BuiltIn.Run_Keyword_And_Return    SSHKeywords.Run_Keyword_Preserve_Connection    Issue_Command_On_Karaf_Console    ${cmd}    ${controller}    ${karaf_port}    ${timeout}
  50     ...    ${loglevel}
  51
  52 Check For Elements On Karaf Command Output Message
  53     [Arguments]    ${cmd}    ${elements}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}    ${timeout}=5
  54     [Documentation]    Will execute the command using Issue Command On Karaf Console then check for the given elements
  55     ...    in the command output message
  56     ${output}    Issue_Command_On_Karaf_Console    ${cmd}    ${controller}    ${karaf_port}    ${timeout}
  57     : FOR    ${i}    IN    @{elements}
  58     \    BuiltIn.Should_Contain    ${output}    ${i}
  59
  60 Verify_Bundle_Is_Installed
  61     [Arguments]    ${bundle_name}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}
  62     [Documentation]    Will succeed if the given ${bundle name} is present in the output of "bundle:list -s "
  63     ${output} =    Issue_Command_On_Karaf_Console    bundle:list -s | grep ${bundle_name}    ${controller}    ${karaf_port}
  64     BuiltIn.Should_Contain    ${output}    ${bundle_name}
  65     [Return]    ${output}
  66
  67 Verify_Bundle_Is_Not_Installed
  68     [Arguments]    ${bundle_name}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}
  69     [Documentation]    Will succeed if the given ${bundle_name} is NOT found in the output of "bundle:list -s"
  70     ${output} =    Issue_Command_On_Karaf_Console    bundle:list -i | grep ${bundle_name}    ${controller}    ${karaf_port}
  71     BuiltIn.Should_Not_Contain    ${output}    ${bundle_name}
  72     [Return]    ${output}
  73
  74 Check_Karaf_Log_Has_Messages
  75     [Arguments]    ${filter_string}    @{message_list}
  76     [Documentation]    Will succeed if the @{messages} are found in \ the output of "log:display"
  77     ${output} =    Issue_Command_On_Karaf_Console    log:display | grep ${filter_string}
  78     : FOR    ${message}    IN    @{message_list}
  79     \    BuiltIn.Should_Contain    ${output}    ${message}
  80     [Return]    ${output}
  81
  82 Check_Karaf_Log_Message_Count
  83     [Arguments]    ${message}    ${count}    ${use_console}=False
  84     [Documentation]    Verifies that the ${message} exists specified number of times in
  85     ...    karaf console log or Karaf Log Folder based on the arg ${use_console}.
  86     Run Keyword If    ${use_console} == False    Check_Karaf_Log_File    ${message}    ${count}
  87     ...    ELSE    Check_Karaf_Log_From_Console    ${message}    ${count}
  88
  89 Check_Karaf_Log_From_Console
  90     [Arguments]    ${message}    ${count}
  91     [Documentation]    Verifies that the ${message} exists in the Karaf Console log:display and checks
  92     ...    that it appears ${count} number of times
  93     ${output} =    Issue_Command_On_Karaf_Console    log:display | grep ${message} | wc -l
  94     ${line} =    Get Line    ${output}    0
  95     ${stripped} =    Strip String    ${line}
  96     Should Be Equal As Strings    ${stripped}    ${count}
  97
  98 Check_Karaf_Log_File
  99     [Arguments]    ${message}    ${count}
 100     [Documentation]    Verifies that the ${message} exists in the Karaf Log Folder and checks
 101     ...    that it appears ${count} number of times
 102     ${output}    Run Command On Controller    ${ODL_SYSTEM_IP}    grep -o ${message} ${WORKSPACE}/${BUNDLEFOLDER}/data/log/* | wc -l
 103     Should Be Equal As Strings    ${output}    ${count}
 104
 105 Install_A_Feature
 106     [Arguments]    ${feature_name}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}    ${timeout}=180
 107     [Documentation]    Will Install the given ${feature_name}
 108     BuiltIn.Log    ${timeout}
 109     ${output} =    Issue_Command_On_Karaf_Console    feature:install ${feature_name}    ${controller}    ${karaf_port}    ${timeout}
 110     BuiltIn.Log    ${output}
 111     [Return]    ${output}
 112
 113 Install_A_Feature_Using_Active_Connection
 114     [Arguments]    ${feature_name}
 115     [Documentation]    Will Install the given ${feature_name} using active connection
 116     ${cmd} =    BuiltIn.Set_Variable    feature:install ${feature_name}
 117     SSHLibrary.Write    ${cmd}
 118     ${output}    SSHLibrary.Read_Until_Regexp    ${KARAF_PROMPT}
 119     BuiltIn.Log    ${output}
 120     [Return]    ${output}
 121
 122 Uninstall_A_Feature
 123     [Arguments]    ${feature_name}    ${controller}=${ODL_SYSTEM_IP}    ${karaf_port}=${KARAF_SHELL_PORT}    ${timeout}=180
 124     [Documentation]    Will UnInstall the given ${feature_name}
 125     ${output} =    Issue_Command_On_Karaf_Console    feature:uninstall ${feature_name}    ${controller}    ${karaf_port}    ${timeout}
 126     BuiltIn.Log    ${output}
 127     [Return]    ${output}
 128
 129 Open_Controller_Karaf_Console_On_Background
 130     [Arguments]    ${member_index}=${1}    ${timeout}=10    ${loglevel}=INFO
 131     [Documentation]    If there is a stored ssh connection index of connection to the controller's karaf console for ${member_index},
 132     ...    close the previous connection. In any case create a new connection
 133     ...    to karaf console for ${member_index}, set correct prompt set and login to karaf console.
 134     ...    Store connection index for ${member_index} and restore the previous active connection.
 135     ${current_ssh_connection_object}=    SSHLibrary.Get_Connection
 136     BuiltIn.Log    ${connection_index_dict}
 137     BuiltIn.Log    ${member_index}
 138     ${status}    ${old_connection_index} =    BuiltIn.Run_Keyword_And_Ignore_Error    Get From Dictionary    ${connection_index_dict}    ${member_index}
 139     BuiltIn.Run_Keyword_If    '${status}'=='PASS'    BuiltIn.Run_Keywords    SSHLibrary.Switch_Connection    ${old_connection_index}
 140     ...    AND    SSHLibrary.Close_Connection
 141     ${odl_ip} =    ClusterManagement.Resolve_IP_Address_For_Member    ${member_index}
 142     SSHLibrary.Open_Connection    ${odl_ip}    port=${KARAF_SHELL_PORT}    prompt=${KARAF_PROMPT_LOGIN}    timeout=${timeout}
 143     ${karaf_connection_object} =    SSHLibrary.Get_Connection
 144     Collections.Set_To_Dictionary    ${connection_index_dict}    ${member_index}    ${karaf_connection_object.index}
 145     SSHLibrary.Login    ${KARAF_USER}    ${KARAF_PASSWORD}    loglevel=${loglevel}
 146     [Teardown]    SSHKeywords.Restore_Current_Ssh_Connection_From_Index    ${current_ssh_connection_object.index}
 147
 148 Open_Controller_Karaf_Console_With_Timeout
 149     [Arguments]    ${member_index}=${1}    ${timeout}=3s
 150     [Documentation]    Open new connection to karaf console for member index with specified timeout.
 151     BuiltIn.Log    ${member_index}
 152     ${odl_ip} =    ClusterManagement.Resolve_IP_Address_For_Member    ${member_index}
 153     SSHLibrary.Open_Connection    ${odl_ip}    port=${KARAF_SHELL_PORT}    prompt=${KARAF_PROMPT_LOGIN}    timeout=${timeout}
 154     SSHLibrary.Login    ${KARAF_USER}    ${KARAF_PASSWORD}
 155
 156 Configure_Timeout_For_Karaf_Console
 157     [Arguments]    ${timeout}    ${member_index_list}=${EMPTY}
 158     [Documentation]    Configure a different timeout for each Karaf console.
 159     ${index_list} =    ClusterManagement.List_Indices_Or_All    given_list=${member_index_list}
 160     ${current_connection_object} =    SSHLibrary.Get_Connection
 161     : FOR    ${member_index}    IN    @{index_list}    # usually: 1, 2, 3
 162     \    ${karaf_connection_index} =    Collections.Get_From_Dictionary    ${connection_index_dict}    ${member_index}
 163     \    SSHLibrary.Switch_Connection    ${karaf_connection_index}
 164     \    SSHLibrary.Set_Client_Configuration    timeout=${timeout}
 165     [Teardown]    SSHKeywords.Restore_Current_Ssh_Connection_From_Index    ${current_connection_object.index}
 166
 167 Execute_Controller_Karaf_Command_On_Background
 168     [Arguments]    ${command}    ${member_index}=${1}
 169     [Documentation]    Send command to karaf without affecting current SSH connection. Read, log and return response.
 170     ${karaf_connection_index} =    Collections.Get_From_Dictionary    ${connection_index_dict}    ${member_index}
 171     ${current_connection_index} =    SSHLibrary.Switch_Connection    ${karaf_connection_index}
 172     ${status_write}    ${message_write} =    BuiltIn.Run_Keyword_And_Ignore_Error    SSHLibrary.Write    ${command}
 173     ${status_wait}    ${message_wait} =    BuiltIn.Run_Keyword_And_Ignore_Error    SSHLibrary.Read_Until_Regexp    ${KARAF_PROMPT}
 174     BuiltIn.Run Keyword If    '${status_write}' != 'PASS'    BuiltIn.Fail    Failed to send the command: ${command}
 175     BuiltIn.Log    ${message_wait}
 176     BuiltIn.Run_Keyword_If    '${status_wait}' != 'PASS'    BuiltIn.Fail    Failed to see prompt after sending the command: ${command}
 177     [Teardown]    SSHKeywords.Restore_Current_Ssh_Connection_From_Index    ${current_connection_index}
 178     [Return]    ${message_wait}
 179
 180 Execute_Controller_Karaf_Command_With_Retry_On_Background
 181     [Arguments]    ${command}    ${member_index}=${1}
 182     [Documentation]    Attemp to send command to karaf for ${member_index}, if fail then open connection and try again.
 183     ${status}    ${message} =    BuiltIn.Run_Keyword_And_Ignore_Error    Execute_Controller_Karaf_Command_On_Background    ${command}    ${member_index}
 184     BuiltIn.Return_From_Keyword_If    '${status}' == 'PASS'    ${message}
 185     # TODO: Verify this does not leak connections indices.
 186     Open_Controller_Karaf_Console_On_Background    ${member_index}
 187     ${message} =    Execute_Controller_Karaf_Command_On_Background    ${command}    ${member_index}
 188     [Return]    ${message}
 189
 190 Log_Message_To_Controller_Karaf
 191     [Arguments]    ${message}    ${member_index_list}=${EMPTY}    ${tolerate_failure}=True
 192     [Documentation]    Make sure this resource is initialized. Send a message into the controller's karaf log file on every node listed (or all).
 193     ...    By default, failure while processing a node is silently ignored, unless ${tolerate_failure} is False.
 194     ${index_list} =    ClusterManagement.List_Indices_Or_All    given_list=${member_index_list}
 195     : FOR    ${index}    IN    @{index_list}    # usually: 1, 2, 3.
 196     \    ${status}    ${output} =    BuiltIn.Run_Keyword_And_Ignore_Error    Execute_Controller_Karaf_Command_With_Retry_On_Background    log:log "ROBOT MESSAGE: ${message}"    member_index=${index}
 197     \    BuiltIn.Run_Keyword_Unless    ${tolerate_failure} or "${status}" == "PASS"    BuiltIn.Fail    ${output}
 198
 199 Log_Test_Suite_Start_To_Controller_Karaf
 200     [Arguments]    ${member_index_list}=${EMPTY}
 201     [Documentation]    Log suite name to karaf log, useful in suite setup.
 202     Log_Message_To_Controller_Karaf    Starting suite ${SUITE_SOURCE}    ${member_index_list}
 203
 204 Log_Testcase_Start_To_Controller_Karaf
 205     [Arguments]    ${member_index_list}=${EMPTY}
 206     [Documentation]    Log test case name to karaf log, useful in test case setup.
 207     Log_Message_To_Controller_Karaf    Starting test ${SUITE_NAME}.${TEST_NAME}    ${member_index_list}
 208
 209 Set_Bgpcep_Log_Levels
 210     [Arguments]    ${bgpcep_level}=${DEFAULT_BGPCEP_LOG_LEVEL}    ${protocol_level}=${DEFAULT_PROTOCOL_LOG_LEVEL}    ${member_index_list}=${EMPTY}
 211     [Documentation]    Assuming OCKCOB was used, set logging level on bgpcep and protocol loggers without affecting current SSH session.
 212     # FIXME: Move to appropriate Resource
 213     ${index_list} =    ClusterManagement.List_Indices_Or_All    given_list=${member_index_list}
 214     : FOR    ${index}    IN    @{index_list}    # usually: 1, 2, 3.
 215     \    Execute_Controller_Karaf_Command_On_Background    log:set ${bgpcep_level} org.opendaylight.bgpcep    member_index=${index}
 216     \    Execute_Controller_Karaf_Command_On_Background    log:set ${protocol_level} org.opendaylight.protocol    member_index=${index}
 217
 218 Get Karaf Log Type From Test Start
 219     [Arguments]    ${ip}    ${test_name}    ${type}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 220     ...    ${log_file}=${KARAF_LOG}
 221     [Documentation]    Scrapes all log messages that match regexp ${type} which fall after a point given by a log message that
 222     ...    contains ${test_name}. This is useful if your test cases are marking karaf.log with a message indicating when
 223     ...    that test case has started; such that you can easily pull out any extra log messsages to parse/log/etc in the
 224     ...    test logic itself. For example, you can grab all ERRORS that occur during your test case.
 225     ${cmd}    Set Variable    sed '1,/ROBOT MESSAGE: Starting test ${test_name}/d' ${log_file} | grep '${type}'
 226     ${output}    Run Command On Controller    ${ip}    ${cmd}    ${user}    ${password}    ${prompt}
 227     [Return]    ${output}
 228
 229 Get Karaf Log Types From Test Start
 230     [Arguments]    ${ip}    ${test_name}    ${types}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 231     ...    ${log_file}=${KARAF_LOG}
 232     [Documentation]    A wrapper keyword for "Get Karaf Log Type From Test Start" so that we can parse for multiple types
 233     ...    of log messages. For example, we can grab all messages of type WARN and ERROR
 234     : FOR    ${type}    IN    @{types}
 235     \    Get Karaf Log Type From Test Start    ${ip}    ${test_name}    ${type}    ${user}    ${password}
 236     \    ...    ${prompt}    ${log_file}
 237
 238 Get Karaf Log Events From Test Start
 239     [Arguments]    ${test_name}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
 240     [Documentation]    Wrapper for the wrapper "Get Karaf Log Types From Test Start" so that we can easily loop over
 241     ...    any number of controllers to analyze karaf.log for ERROR, WARN and Exception log messages
 242     ${log_types} =    Create List    ERROR    WARN    Exception
 243     : FOR    ${i}    IN RANGE    1    ${NUM_ODL_SYSTEM} + 1
 244     \    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_${i}_IP}    ${test_name}    ${log_types}
 245
 246 Fail If Exceptions Found During Test
 247     [Arguments]    ${test_name}    ${exceptions_white_list}=${EMPTY}
 248     [Documentation]    Create a failure if an Exception is found in the karaf.log. Will work for single controller jobs
 249     ...    as well as 3node cluster jobs
 250     : FOR    ${i}    IN RANGE    1    ${NUM_ODL_SYSTEM} + 1
 251     \    Verify Exception Logging In Controller    ${ODL_SYSTEM_${i}_IP}    ${test_name}    ${exceptions_white_list}
 252
 253 Verify Exception Logging In Controller
 254     [Arguments]    ${controller_ip}    ${test_name}    ${exceptions_white_list}
 255     [Documentation]    Local keyword to make it easier to loop through N controllers to pull Exceptions from the
 256     ...    karaf.log file and validate with "Check Against White List"
 257     ${exceptions}=    Get Karaf Log Type From Test Start    ${controller_ip}    ${test_name}    Exception
 258     @{log_lines}=    Split String    ${exceptions}    ${\n}
 259     ${num_log_entries}    Get Length    ${log_lines}
 260     Return From Keyword If    ${num_log_entries} == ${0}    No Exceptions found.
 261     : FOR    ${log_message}    IN    @{log_lines}
 262     \    Check Against White List    ${log_message}    ${exceptions_white_list}
 263
 264 Check Against White List
 265     [Arguments]    ${exception_line}    ${exceptions_white_list}
 266     [Documentation]    As soon as the ${exceptions_line} is found in one of the elements of ${exceptions_white_list}
 267     ...    this keyword will exit and give a Pass to the caller. If there is no match, this keyword will end up
 268     ...    marking a failure. In the case that no exceptions are found, the caller could end up passing a single
 269     ...    empty line as that is what is returned when a grep on karaf.log has no match, so we can safely return
 270     ...    in that case as well.
 271     Return From Keyword If    "${exception_line}" == ""
 272     : FOR    ${exception}    IN    @{exceptions_white_list}
 273     \    Return From Keyword If    "${exception}" in "${exception_line}"    Exceptions found, but whitelisted: ${\n}${exception_line}${\n}
 274     Fail    Exceptions Found: ${\n}${exception_line}${\n}
 275
 276 Wait_For_Karaf_Log
 277     [Arguments]    ${message}    ${timeout}=60    ${member_index}=${1}
 278     [Documentation]    Read karaf logs until message appear
 279     # TODO: refactor this keyword to use the new workflow to account for multiple controllers.    Initial work was done
 280     # in this patch https://git.opendaylight.org/gerrit/#/c/45596/
 281     # however, the consumers of this keyword were breaking after that change.    Initial theory is that a previous
 282     # keyword used before this "Wait For Karaf Log" keyword was closing the karaf console connection, so the
 283     # "Flexible SSH Login" keyword from the patch above (45596) was failing.
 284     BuiltIn.Log    Waiting for '${message}' in karaf log
 285     SSHLibrary.Open_Connection    ${ODL_SYSTEM_IP}    port=${KARAF_SHELL_PORT}    prompt=${KARAF_PROMPT_LOGIN}    timeout=${timeout}
 286     SSHLibrary.Login    ${KARAF_USER}    ${KARAF_PASSWORD}    loglevel=${loglevel}
 287     SSHLibrary.Write    log:tail
 288     SSHLibrary.Read_Until    ${message}
 289     SSHLibrary.Close_Connection
 290
 291 Restart_Bundle
 292     [Arguments]    ${bundle_id}
 293     [Documentation]    Restarts bundle passed as argument. Note this operation is only for testing and not production environments
 294     # TODO: prepare this for cluster environment and multiple controllers
 295     Execute_Controller_Karaf_Command_With_Retry_On_Background    bundle:restart -f $(bundle:id '${bundle_id}')
 296
 297 Restart_Karaf
 298     [Documentation]    Restarts Karaf and polls log to detect when Karaf is up and running again
 299     # TODO: prepare this for cluster environment and multiple controllers
 300     Execute_Controller_Karaf_Command_With_Retry_On_Background    log:clear
 301     Execute_Controller_Karaf_Command_With_Retry_On_Background    shutdown -r -f
 302     BuiltIn.Run_Keyword_And_Return_Status    BuiltIn.Wait_Until_Keyword_Succeeds    240s    60s    Wait_For_Karaf_Log    Karaf started in
 303
 304 Restart_Jetty
 305     [Documentation]    Restarts jetty bundle (to reload certificates or key/truststore information)
 306     Execute_Controller_Karaf_Command_With_Retry_On_Background    log:clear
 307     Restart_Bundle    OPS4J Pax Web - Jetty
 308     Wait_For_Karaf_Log    Instantiated the Application class org.opendaylight.restconf.RestconfApplication
 309     Wait_For_Karaf_Log    Instantiated the Application class org.opendaylight.netconf.sal.rest.impl.RestconfApplication
 310     Wait_For_Karaf_Log    Instantiated the Application class org.opendaylight.aaa.idm.IdmLightApplication