*** Settings ***
Documentation       Test suite for Stats Manager flows collection

Library             OperatingSystem
Library             Collections
Library             XML
Library             ../../../libraries/XmlComparator.py
Library             RequestsLibrary
Library             ../../../libraries/Common.py
Variables           ../../../variables/Variables.py
Resource            ../../../variables/openflowplugin/Variables.robot

Suite Setup         Initialization Phase
Suite Teardown      Teardown Phase


*** Variables ***
${XmlsDir}          ${CURDIR}/../../../variables/xmls
${switch_idx}       1
${switch_name}      s${switch_idx}
@{xml_files}        f1.xml    f2.xml    f3.xml    f5.xml    f7.xml    f8.xml    f9.xml
...                 f10.xml    f11.xml    f14.xml    f17.xml    f19.xml    f24.xml


*** Test Cases ***
Test Add Flows
    [Documentation]    Add all flows and waits for SM to collect data
    FOR    ${flowfile}    IN    @{xml_files}
        Log    ${flowfile}
        Init Flow Variables    ${flowfile}
        Run Keyword And Continue On Failure    Add Flow
    END

Test Is Flow 1 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f1.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 2 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f2.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 3 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f3.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 5 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f5.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 7 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f7.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 8 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f8.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 9 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f9.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 10 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f10.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 11 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f11.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 14 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f14.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 17 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f17.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 19 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f19.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Is Flow 24 Added
    [Documentation]    Checks if flow is configured and operational
    Init Flow Variables    f24.xml
    Check Config Flow    ${True}
    Check Operational Table    ${True}

Test Delete Flows
    [Documentation]    Delete all flows and waits for SM to collect data
    FOR    ${flowfile}    IN    @{xml_files}
        Log    ${flowfile}
        Init Flow Variables    ${flowfile}
        Run Keyword And Continue On Failure    Delete Flow
    END

Test Is Flow 1 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f1.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 2 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f2.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 3 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f3.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 5 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f5.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 7 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f7.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 8 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f8.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 9 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f9.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 10 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f10.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 11 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f11.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 14 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f14.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 17 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f17.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 19 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f19.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}

Test Is Flow 24 Deleted
    [Documentation]    Checks if flow is not configured and operational
    Init Flow Variables    f24.xml
    Check Config Flow    ${False}
    Check Operational Table    ${False}


*** Keywords ***
Init Flow Variables
    [Arguments]    ${file}
    ${data}=    Get File    ${XmlsDir}/${file}
    ${xmlroot}=    Parse Xml    ${XmlsDir}/${file}
    ${table_id}=    Get Element Text    ${xmlroot}    table_id
    ${flow_id}=    Get Element Text    ${xmlroot}    id
    ${flow_priority}=    Get Element Text    ${xmlroot}    priority
    Set Suite Variable    ${table_id}
    Set Suite Variable    ${flow_id}
    Set Suite Variable    ${flow_priority}
    Set Suite Variable    ${data}
    Set Suite Variable    ${xmlroot}

Check Config Flow
    [Arguments]    ${expected}
    Wait Until Keyword Succeeds    40s    2s    Check Config Flow Presence    ${expected}

Check Config Flow Presence
    [Arguments]    ${expected}
    ${presence_flow}    ${msg}=    Flow Presence Config Flow
    ${msgf}=    Get Presence Failure Message    config    ${expected}    ${presence_flow}    ${msg}
    Should Be Equal    ${expected}    ${presence_flow}    msg=${msgf}

Flow Presence Config Flow
    ${headers}=    Create Dictionary    Accept=application/xml
    ${resp}=    RequestsLibrary.Get Request
    ...    session
    ...    ${RFC8040_NODES_API}/node=openflow%3A${switch_idx}/flow-node-inventory:table=${table_id}/flow=${flow_id}
    ...    headers=${headers}
    Log    ${resp}
    Log    ${resp.content}
    IF    ${resp.status_code}!=200    RETURN    ${False}    ${EMPTY}
    ${pres}    ${msg}=    Is Flow Configured    ${data}    ${resp.content}
    IF    '''${msg}'''!='${EMPTY}'    Log    ${msg}
    RETURN    ${pres}    ${msg}

Check Operational Table
    [Arguments]    ${expected}
    Wait Until Keyword Succeeds    120s    2s    Check Operational Table Presence    ${expected}

Check Operational Table Presence
    [Arguments]    ${expected}
    ${presence_table}    ${msg}=    Flow Presence Operational Table
    ${msgf}=    Get Presence Failure Message    config    ${expected}    ${presence_table}    ${msg}
    Should Be Equal    ${expected}    ${presence_table}    msg=${msgf}

Flow Presence Operational Table
    ${headers}=    Create Dictionary    Accept=application/xml
    ${resp}=    RequestsLibrary.Get Request
    ...    session
    ...    ${RFC8040_NODES_API}/node=openflow%3A${switch_idx}/flow-node-inventory:table=${table_id}?${RFC8040_OPERATIONAL_CONTENT}
    ...    headers=${headers}
    Log    ${resp}
    Log    ${resp.content}
    IF    ${resp.status_code}!=200    RETURN    ${False}    ${EMPTY}
    ${pres}    ${msg}=    Is Flow Operational2    ${data}    ${resp.content}
    IF    '''${msg}'''!='${EMPTY}'    Log    ${msg}
    RETURN    ${pres}    ${msg}

Add Flow
    Log    ${data}
    ${resp}=    RequestsLibrary.Put Request
    ...    session
    ...    ${RFC8040_NODES_API}/node=openflow%3A${switch_idx}/flow-node-inventory:table=${table_id}/flow=${flow_id}
    ...    headers=${HEADERS_XML}
    ...    data=${data}
    ${msg}=    Set Variable
    ...    Adding flow for ${RFC8040_NODES_API}/node=openflow%3A${switch_idx}/flow-node-inventory:table=${table_id}/flow=${flow_id} failed, http response ${resp.status_code} received.
    Should Be Equal As Strings    ${resp.status_code}    200    msg=${msg}

Delete Flow
    ${resp}=    RequestsLibrary.Delete Request
    ...    session
    ...    ${RFC8040_NODES_API}/node=openflow%3A${switch_idx}/flow-node-inventory:table=${table_id}/flow=${flow_id}
    ${msg}=    Set Variable
    ...    Delete flow for ${RFC8040_NODES_API}/node=openflow%3A${switch_idx}/flow-node-inventory:table=${table_id}/flow=${flow_id} failed, http response ${resp.status_code} received.
    Should Be Equal As Strings    ${resp.status_code}    200    msg=${msg}

Delete All Flows
    [Documentation]    Deletes all flows
    FOR    ${flowfile}    IN    @{xml_files}
        Log    ${flowfile}
        Init Flow Variables    ${flowfile}
        Delete Flow
    END

Initialization Phase
    [Documentation]    Initiate tcp connection with controller
    Create Session    session    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}    headers=${HEADERS_XML}

Teardown Phase
    [Documentation]    Closes tcp connection with controller and removes flows
    Delete All Sessions

Get Presence Failure Message
    [Arguments]    ${ds}    ${expected}    ${presence}    ${diffmsg}
    IF    '''${diffmsg}'''!='${EMPTY}'
        RETURN    Flow found in ${ds} data store but: ${diffmsg}
    END
    ${msgf}=    Set Variable If
    ...    ${expected}==${True}
    ...    The flow is expected in operational data store, but
    ...    The flow is not expected in operational data store, but
    ${msgp}=    Set Variable If    ${presence}==${True}    it is present.    it is not present.
    RETURN    ${msgf} ${msgp}