Feature 11001: Robot framework linting for E2E tests
[osm/tests.git] / robot-systest / testsuite / basic_19-vnf_ip_profile.robot
index 6701096..6d5a557 100644 (file)
@@ -1,3 +1,4 @@
+*** Comments ***
 #   Licensed under the Apache License, Version 2.0 (the "License");
 #   you may not use this file except in compliance with the License.
 #   You may obtain a copy of the License at
@@ -10,6 +11,7 @@
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 
+
 *** Settings ***
 Documentation   [BASIC-19] NS with a single VNF and two VDU linked by a VLD with ip-profile.
 
@@ -18,99 +20,91 @@ Library   String
 Library   Collections
 Library   SSHLibrary
 
-Resource   %{ROBOT_DEVOPS_FOLDER}/lib/vnfd_lib.robot
-Resource   %{ROBOT_DEVOPS_FOLDER}/lib/nsd_lib.robot
-Resource   %{ROBOT_DEVOPS_FOLDER}/lib/ns_lib.robot
-Resource   %{ROBOT_DEVOPS_FOLDER}/lib/ssh_lib.robot
+Resource   ../lib/vnfd_lib.resource
+Resource   ../lib/nsd_lib.resource
+Resource   ../lib/ns_lib.resource
+Resource   ../lib/ssh_lib.resource
 
-Force Tags   basic_19   cluster_main   daily   regression
+Test Tags   basic_19   cluster_main   daily   regression
 
 Suite Teardown   Run Keyword And Ignore Error   Suite Cleanup
 
 
 *** Variables ***
 # NS and VNF descriptor package folder and ids
-${vnfd_pkg}   ipprofile_2vm_vnf
-${vnfd_name}   ipprofile_2vm-vnf
-${nsd_pkg}   ipprofile_2vm_ns
-${nsd_name}   ipprofile_2vm-ns
+${VNFD_PKG}   ipprofile_2vm_vnf
+${VNFD_NAME}   ipprofile_2vm-vnf
+${NSD_PKG}   ipprofile_2vm_ns
+${NSD_NAME}   ipprofile_2vm-ns
 
 # NS instance name and configuration
-${ns_name}   basic_19
-${ns_config}   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}} ] }
+${NS_NAME}   basic_19
+${NS_CONFIG}   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}} ] }
 
 # SSH keys and username to be used
-${publickey}   %{HOME}/.ssh/id_rsa.pub
-${username}   ubuntu
+${PUBLICKEY}   %{HOME}/.ssh/id_rsa.pub
+${USERNAME}   ubuntu
 
 # VNFs data
-${vnf_member_index_1}   vnf
-${internal_prefix}   ^192.168.200.*
+${VNF_MEMBER_INDEX_1}   vnf
+${INTERNAL_PREFIX}   ^192.168.200.*
 
-${success_return_code}   0
+${SUCCESS_RETURN_CODE}   0
 
 
 *** Test Cases ***
 Create VNF Descriptor
-
-    Create VNFD   '%{PACKAGES_FOLDER}/${vnfd_pkg}'
-
+    [Documentation]   Upload VNF package for the testsuite.
+    Create VNFD   '%{PACKAGES_FOLDER}/${VNFD_PKG}'
 
 Create NS Descriptor
-
-    Create NSD   '%{PACKAGES_FOLDER}/${nsd_pkg}'
-
+    [Documentation]   Upload NS package for the testsuite.
+    Create NSD   '%{PACKAGES_FOLDER}/${NSD_PKG}'
 
 Instantiate Network Service
-
-    ${id}=   Create Network Service   ${nsd_name}   %{VIM_TARGET}   ${ns_name}   ${ns_config}   ${publickey}
-    Set Suite Variable   ${ns_id}   ${id}
-
+    [Documentation]   Instantiate NS for the testsuite.
+    ${id}=   Create Network Service   ${NSD_NAME}   %{VIM_TARGET}   ${NS_NAME}   ${NS_CONFIG}   ${PUBLICKEY}
+    Set Suite Variable   ${NS_ID}   ${id}
 
 Get Vnf Info
-
-    Variable Should Exist   ${ns_id}   msg=Network service instance is not available
-    @{vnfr_list}=   Get Ns Vnfr Ids   ${ns_id}
+    [Documentation]   Get VNF information, specifically the VNF instance id and the mgmt IP address.
+    Variable Should Exist   ${NS_ID}   msg=Network service instance is not available
+    @{vnfr_list}=   Get Ns Vnfr Ids   ${NS_ID}
     Log List   ${vnfr_list}
-    Set Suite Variable   ${vnf_id}   ${vnfr_list}[0]
-    ${ip}   Get Vnf Management Ip Address   ${ns_id}   ${vnf_member_index_1}
-    Set Suite Variable   ${vnf_ipmgmt}   ${ip}
-    Log   ${vnf_ipmgmt}
-
+    Set Suite Variable   ${VNF_ID}   ${vnfr_list}[0]
+    ${ip}=   Get Vnf Management Ip Address   ${NS_ID}   ${VNF_MEMBER_INDEX_1}
+    Set Suite Variable   ${VNF_IPMGMT}   ${ip}
+    Log   ${VNF_IPMGMT}
 
 Check Vnf IPs
-
-    Variable Should Exist   ${vnf_id}   msg=VNF is not available
-    ${rc}   ${stdout}=   Run and Return RC and Output   osm vnf-show ${vnf_id} --literal | yq '.vdur[0].interfaces[] | select(."vnf-vld-id" == "internal")' | yq -r '."ip-address"'
-    Should Be Equal As Integers   ${rc}   ${success_return_code}   msg=${stdout}   values=False
-    Should Match Regexp   ${stdout}   ${internal_prefix}   msg=${stdout} doesn't match subnet's regexp ${internal_prefix}
-    ${rc}   ${stdout}=   Run and Return RC and Output   osm vnf-show ${vnf_id} --literal | yq '.vdur[1].interfaces[] | select(."vnf-vld-id" == "internal")' | yq -r '."ip-address"'
-    Should Be Equal As Integers   ${rc}   ${success_return_code}   msg=${stdout}   values=False
-    Should Match Regexp   ${stdout}   ${internal_prefix}   msg=${stdout} doesn't match subnet's regexp ${internal_prefix}
-
+    [Documentation]   Check whether IP addresses are syntactically valid.
+    Variable Should Exist   ${VNF_ID}   msg=VNF is not available
+    ${rc}   ${stdout}=   Run And Return RC And Output   osm vnf-show ${VNF_ID} --literal | yq '.vdur[0].interfaces[] | select(."vnf-vld-id" == "internal")' | yq -r '."ip-address"'
+    Should Be Equal As Integers   ${rc}   ${SUCCESS_RETURN_CODE}   msg=${stdout}   values=False
+    Should Match Regexp   ${stdout}   ${INTERNAL_PREFIX}   msg=${stdout} doesn't match subnet's regexp ${INTERNAL_PREFIX}
+    ${rc}   ${stdout}=   Run And Return RC And Output   osm vnf-show ${VNF_ID} --literal | yq '.vdur[1].interfaces[] | select(."vnf-vld-id" == "internal")' | yq -r '."ip-address"'
+    Should Be Equal As Integers   ${rc}   ${SUCCESS_RETURN_CODE}   msg=${stdout}   values=False
+    Should Match Regexp   ${stdout}   ${INTERNAL_PREFIX}   msg=${stdout} doesn't match subnet's regexp ${INTERNAL_PREFIX}
 
 Delete NS Instance
+    [Documentation]   Delete NS instance.
     [Tags]   cleanup
-
-    Delete NS   ${ns_name}
-
+    Delete NS   ${NS_NAME}
 
 Delete NS Descriptor
+    [Documentation]   Delete NS package from OSM.
     [Tags]   cleanup
-
-    Delete NSD   ${nsd_name}
-
+    Delete NSD   ${NSD_NAME}
 
 Delete VNF Descriptor
+    [Documentation]   Delete VNF package from OSM.
     [Tags]   cleanup
-
-    Delete VNFD   ${vnfd_name}
+    Delete VNFD   ${VNFD_NAME}
 
 
 *** Keywords ***
 Suite Cleanup
     [Documentation]   Test Suite Cleanup: Deleting descriptors and NS instance
-
-    Run Keyword If Any Tests Failed   Delete NS   ${ns_name}
-    Run Keyword If Any Tests Failed   Delete NSD   ${nsd_name}
-    Run Keyword If Any Tests Failed   Delete VNFD   ${vnfd_name}
+    Run Keyword If Any Tests Failed   Delete NS   ${NS_NAME}
+    Run Keyword If Any Tests Failed   Delete NSD   ${NSD_NAME}
+    Run Keyword If Any Tests Failed   Delete VNFD   ${VNFD_NAME}