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