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