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