csit/suites/netconf/CRUD/CRUD.robot

   1 *** Settings ***
   2 Documentation       netconf-connector CRUD test suite.
   3 ...
   4 ...                 Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
   5 ...
   6 ...                 This program and the accompanying materials are made available under the
   7 ...                 terms of the Eclipse Public License v1.0 which accompanies this distribution,
   8 ...                 and is available at http://www.eclipse.org/legal/epl-v10.html
   9 ...
  10 ...
  11 ...                 Perform basic operations (Create, Read, Update and Delete or CRUD) on device
  12 ...                 data mounted onto a netconf connector and see if they work.
  13 ...
  14 ...                 FIXME: Replace the BuiltIn.Should_[Not_]Contain instances in the test cases
  15 ...                 that check the car list related data with calls to keywords of a Resource
  16 ...                 aimed at getting interesting pieces of data from the XML files and checking
  17 ...                 them against expected data sets. See MDSAL/northbound.robot suite for
  18 ...                 additional information.
  19
  20 Library             Collections
  21 Library             RequestsLibrary
  22 Library             OperatingSystem
  23 Library             String
  24 Library             SSHLibrary    timeout=10s
  25 Resource            ${CURDIR}/../../../libraries/CompareStream.robot
  26 Resource            ${CURDIR}/../../../libraries/FailFast.robot
  27 Resource            ${CURDIR}/../../../libraries/NetconfKeywords.robot
  28 Resource            ${CURDIR}/../../../libraries/SetupUtils.robot
  29 Resource            ${CURDIR}/../../../libraries/TemplatedRequests.robot
  30 Variables           ${CURDIR}/../../../variables/Variables.py
  31
  32 Suite Setup         Setup_Everything
  33 Suite Teardown      Teardown_Everything
  34 Test Setup          SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
  35
  36
  37 *** Variables ***
  38 ${directory_with_template_folders}      ${CURDIR}/../../../variables/netconf/CRUD
  39 ${device_name}                          netconf-test-device
  40 ${device_type}                          full-uri-device
  41 ${USE_NETCONF_CONNECTOR}                ${False}
  42
  43
  44 *** Test Cases ***
  45 Start_Testtool
  46     [Documentation]    Deploy and start test tool, then wait for all its devices to become online.
  47     [Tags]    odlmicro_ign
  48     NetconfKeywords.Install_And_Start_Testtool
  49     ...    device-count=1
  50     ...    schemas=${CURDIR}/../../../variables/netconf/CRUD/schemas
  51     ...    mdsal=true
  52
  53 Check_Device_Is_Not_Configured_At_Beginning
  54     [Documentation]    Sanity check making sure our device is not there. Fail if found.
  55     [Tags]    critical
  56     NetconfKeywords.Check_Device_Has_No_Netconf_Connector    ${device_name}
  57
  58 Configure_Device_On_Netconf
  59     [Documentation]    Make request to configure a testtool device on Netconf connector.
  60     [Tags]    critical
  61     NetconfKeywords.Configure_Device_In_Netconf    ${device_name}    device_type=${device_type}    http_timeout=2
  62
  63 Check_ODL_Has_Netconf_Connector_For_Device
  64     [Documentation]    Get the list of configured devices and search for our device there. Fail if not found.
  65     [Tags]    critical
  66     BuiltIn.Wait_Until_Keyword_Succeeds    5 sec    1 sec    Count_Netconf_Connectors
  67
  68 Wait_For_Device_To_Become_Connected
  69     [Documentation]    Wait until the device becomes available through Netconf.
  70     NetconfKeywords.Wait_Device_Connected    ${device_name}
  71
  72 Check_Device_Data_Is_Empty
  73     [Documentation]    Get the device data and make sure it is empty.
  74     Check_Config_Data    <data xmlns\="${ODL_NETCONF_NAMESPACE}"/>
  75
  76 Create_Device_Data_Label_Via_Xml
  77     [Documentation]    Send a sample test data label into the device and check that the request went OK.
  78     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
  79     TemplatedRequests.Post_As_Xml_Templated    ${directory_with_template_folders}${/}dataorig    ${template_as_string}
  80
  81 Check_Device_Data_Label_Is_Created
  82     [Documentation]    Get the device data label and make sure it contains the created content.
  83     Check_Config_Data
  84     ...    <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Content</l></cont></data>
  85
  86 Modify_Device_Data_Label_Via_Xml
  87     [Documentation]    Send a request to change the sample test data label and check that the request went OK.
  88     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
  89     TemplatedRequests.Put_As_Xml_Templated    ${directory_with_template_folders}${/}datamod1    ${template_as_string}
  90
  91 Check_Device_Data_Label_Is_Modified
  92     [Documentation]    Get the device data label and make sure it contains the modified content.
  93     Check_Config_Data
  94     ...    <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Modified Content</l></cont></data>
  95
  96 Deconfigure_Device_From_Netconf_Temporarily
  97     [Documentation]    Make request to deconfigure the testtool device on Netconf connector.
  98     ...    This is the first part of the "configure/deconfigure" cycle of the device
  99     ...    The purpose of cycling the device like this is to see that the configuration
 100     ...    data was really stored in the device.
 101     [Tags]    critical
 102     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 103     NetconfKeywords.Remove_Device_From_Netconf    ${device_name}
 104
 105 Wait_For_Device_To_Be_Gone
 106     [Documentation]    Wait for the device to completely disappear.
 107     NetconfKeywords.Wait_Device_Fully_Removed    ${device_name}
 108
 109 Configure_The_Device_Back
 110     [Documentation]    Configure the device again.
 111     ...    This is the second step of the device configuration.
 112     [Tags]    critical
 113     NetconfKeywords.Configure_Device_In_Netconf    ${device_name}    device_type=${device_type}
 114
 115 Wait_For_Device_To_Reconnect
 116     [Documentation]    Wait until the device becomes available through Netconf.
 117     NetconfKeywords.Wait_Device_Connected    ${device_name}
 118
 119 Check_Modified_Device_Data_Is_Still_There
 120     [Documentation]    Get the device data and make sure it contains the created content.
 121     BuiltIn.Wait_Until_Keyword_Succeeds
 122     ...    60s
 123     ...    1s
 124     ...    Check_Config_Data
 125     ...    <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Modified Content</l></cont></data>
 126
 127 Modify_Device_Data_Again
 128     [Documentation]    Send a request to change the sample test data and check that the request went OK.
 129     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
 130     TemplatedRequests.Put_As_Xml_Templated    ${DIRECTORY_WITH_TEMPLATE_FOLDERS}${/}datamod2    ${template_as_string}
 131
 132 Check_Device_Data_Is_Modified_Again
 133     [Documentation]    Get the device data and make sure it contains the created content.
 134     Check_Config_Data
 135     ...    <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Another Modified Content</l></cont></data>
 136
 137 Modify_Device_Data_Label_Via_Json
 138     [Documentation]    Send a JSON request to change the sample test data label and check that the request went OK.
 139     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
 140     TemplatedRequests.Put_As_Json_Templated
 141     ...    ${directory_with_template_folders}${/}datamodjson
 142     ...    ${template_as_string}
 143
 144 Check_Device_Data_Label_Is_Modified_Via_Json
 145     [Documentation]    Get the device data label as XML and make sure it matches the content posted as JSON in the previous case.
 146     Check_Config_Data
 147     ...    <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Content Modified via JSON</l></cont></data>
 148
 149 Create_Car_List
 150     [Documentation]    Send a request to create a list of cars in the sample test data label and check that the request went OK.
 151     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
 152     TemplatedRequests.Post_As_Xml_Templated    ${directory_with_template_folders}${/}cars    ${template_as_string}
 153
 154 Check_Car_List_Created
 155     [Documentation]    Get the device data label as XML and make sure it matches the content posted as JSON in the previous case.
 156     ${data}=    Get_Config_Data
 157     BuiltIn.Should_Contain    ${data}    <id>KEEP</id>
 158     BuiltIn.Should_Not_Contain    ${data}    <id>SMALL</id>
 159     BuiltIn.Should_Not_Contain    ${data}    <model>Isetta</model>
 160     BuiltIn.Should_Not_Contain    ${data}    <manufacturer>BMW</manufacturer>
 161     BuiltIn.Should_Not_Contain    ${data}    <year>1953</year>
 162     BuiltIn.Should_Not_Contain    ${data}    <category>microcar</category>
 163     BuiltIn.Should_Not_Contain    ${data}    <id>TOYOTA</id>
 164     BuiltIn.Should_Not_Contain    ${data}    <model>Camry</model>
 165     BuiltIn.Should_Not_Contain    ${data}    <manufacturer>Toyota</manufacturer>
 166     BuiltIn.Should_Not_Contain    ${data}    <year>1982</year>
 167     BuiltIn.Should_Not_Contain    ${data}    <category>sedan</category>
 168
 169 Add_Device_Data_Item_1_Via_XML_Post
 170     [Documentation]    Send a request to create a data item in the test list and check that the request went OK.
 171     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
 172     TemplatedRequests.Post_As_Xml_Templated    ${directory_with_template_folders}${/}item1    ${template_as_string}
 173
 174 Check_Item1_Is_Created
 175     [Documentation]    Get the device data as XML and make sure it matches the content posted as JSON in the previous case.
 176     ${data}=    Get_Config_Data
 177     BuiltIn.Should_Contain    ${data}    <id>SMALL</id>
 178     BuiltIn.Should_Contain    ${data}    <model>Isetta</model>
 179     BuiltIn.Should_Contain    ${data}    <manufacturer>BMW</manufacturer>
 180     BuiltIn.Should_Contain    ${data}    <year>1953</year>
 181     BuiltIn.Should_Contain    ${data}    <category>microcar</category>
 182     BuiltIn.Should_Not_Contain    ${data}    <id>TOYOTA</id>
 183     BuiltIn.Should_Not_Contain    ${data}    <model>Camry</model>
 184     BuiltIn.Should_Not_Contain    ${data}    <manufacturer>Toyota</manufacturer>
 185     BuiltIn.Should_Not_Contain    ${data}    <year>1982</year>
 186     BuiltIn.Should_Not_Contain    ${data}    <category>sedan</category>
 187
 188 Add_Device_Data_Item_2_Via_JSON_Post
 189     [Documentation]    Send a JSON request to change the sample test data and check that the request went OK.
 190     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
 191     TemplatedRequests.Post_As_Json_Templated    ${directory_with_template_folders}${/}item2    ${template_as_string}
 192
 193 Check_Item2_Is_Created
 194     [Documentation]    Get the device data as XML and make sure it matches the content posted as JSON in the previous case.
 195     ${data}=    Get_Config_Data
 196     BuiltIn.Should_Contain    ${data}    <id>SMALL</id>
 197     BuiltIn.Should_Contain    ${data}    <model>Isetta</model>
 198     BuiltIn.Should_Contain    ${data}    <manufacturer>BMW</manufacturer>
 199     BuiltIn.Should_Contain    ${data}    <year>1953</year>
 200     BuiltIn.Should_Contain    ${data}    <category>microcar</category>
 201     BuiltIn.Should_Contain    ${data}    <id>TOYOTA</id>
 202     BuiltIn.Should_Contain    ${data}    <model>Camry</model>
 203     BuiltIn.Should_Contain    ${data}    <manufacturer>Toyota</manufacturer>
 204     BuiltIn.Should_Contain    ${data}    <year>1982</year>
 205     BuiltIn.Should_Contain    ${data}    <category>sedan</category>
 206
 207 Delete_Device_Data
 208     [Documentation]    Send a request to delete the sample test data on the device and check that the request went OK.
 209     ${template_as_string}=    BuiltIn.Create_Dictionary    DEVICE_NAME=${device_name}
 210     TemplatedRequests.Delete_Templated    ${directory_with_template_folders}${/}datamod1    ${template_as_string}
 211     TemplatedRequests.Delete_Templated    ${directory_with_template_folders}${/}item1    ${template_as_string}
 212
 213 Check_Device_Data_Is_Deleted
 214     [Documentation]    Get the device data and make sure it is empty again.
 215     Check_Config_Data    <data xmlns\="${ODL_NETCONF_NAMESPACE}"/>
 216
 217 Deconfigure_Device_From_Netconf
 218     [Documentation]    Make request to deconfigure the testtool device on Netconf connector.
 219     [Tags]    critical
 220     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 221     NetconfKeywords.Remove_Device_From_Netconf    ${device_name}
 222
 223 Check_Device_Going_To_Be_Gone_After_Deconfiguring
 224     [Documentation]    Check that the device is really going to be gone. Fail
 225     ...    if found after one minute. This is an expected behavior as the
 226     ...    delete request is sent to the config subsystem which then triggers
 227     ...    asynchronous destruction of the netconf connector referring to the
 228     ...    device and the device's data. This test makes sure this
 229     ...    asynchronous operation does not take unreasonable amount of time
 230     ...    by making sure that both the netconf connector and the device's
 231     ...    data is gone before reporting success.
 232     [Tags]    critical
 233     NetconfKeywords.Wait_Device_Fully_Removed    ${device_name}
 234
 235
 236 *** Keywords ***
 237 Setup_Everything
 238     [Documentation]    Initialize SetupUtils. Setup everything needed for the test cases.
 239     # Setup resources used by the suite.
 240     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 241     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${REST_API}    auth=${AUTH}
 242     NetconfKeywords.Setup_Netconf_Keywords
 243     ${device_type}=    BuiltIn.Set_Variable_If
 244     ...    """${USE_NETCONF_CONNECTOR}""" == """True"""
 245     ...    default
 246     ...    ${device_type}
 247     BuiltIn.Set_Suite_Variable    ${device_type}
 248
 249 Teardown_Everything
 250     [Documentation]    Teardown the test infrastructure, perform cleanup and release all resources.
 251     RequestsLibrary.Delete_All_Sessions
 252     BuiltIn.Run_Keyword_And_Ignore_Error    NetconfKeywords.Stop_Testtool
 253
 254 Get_Config_Data
 255     [Documentation]    Get and return the config data from the device.
 256     ${url}=    Builtin.Set_Variable
 257     ...    ${REST_API}/network-topology:network-topology/topology=topology-netconf/node=${device_name}/yang-ext:mount?content=config
 258     ${data}=    TemplatedRequests.Get_As_Xml_From_Uri    ${url}
 259     RETURN    ${data}
 260
 261 Check_Config_Data
 262     [Arguments]    ${expected}    ${contains}=False
 263     ${data}=    Get_Config_Data
 264     IF    not ${contains}
 265         BuiltIn.Should_Be_Equal_As_Strings    ${data}    ${expected}
 266     END
 267     IF    ${contains}    BuiltIn.Should_Contain    ${data}    ${expected}
 268
 269 Count_Netconf_Connectors
 270     ${count}=    NetconfKeywords.Count_Netconf_Connectors_For_Device    ${device_name}
 271     Builtin.Should_Be_Equal_As_Strings    ${count}    1