csit/suites/netconf/CRUD/CRUD-RPC.robot

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