Feature 11001: Robot framework linting for E2E tests
[osm/tests.git] / robot-systest / testsuite / heal_02-scale_vdu_healing.robot
index 86886ef..7b5c9ed 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   [HEAL-02] Healing of scaled charm VDUs
 
@@ -19,177 +21,177 @@ Library   Collections
 Library   Process
 Library   SSHLibrary
 
-Resource   %{ROBOT_DEVOPS_FOLDER}/lib/vnfd_lib.robot
-Resource   %{ROBOT_DEVOPS_FOLDER}/lib/vnf_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   %{ROBOT_DEVOPS_FOLDER}/lib/openstack_lib.robot
-
-Force Tags   heal_02   cluster_heal   daily
+Resource   ../lib/vnfd_lib.resource
+Resource   ../lib/vnf_lib.resource
+Resource   ../lib/nsd_lib.resource
+Resource   ../lib/ns_lib.resource
+Resource   ../lib/ns_operation_lib.resource
+Resource   ../lib/ssh_lib.resource
+Resource   ../lib/openstack_lib.resource
 
+Test Tags   heal_02   cluster_heal   daily
 
 Suite Teardown   Run Keyword And Ignore Error   Suite Cleanup
 
 
 *** Variables ***
 # NS and VNF descriptor package folder and ids
-${vnfd_volumes_pkg}   several_volumes_vnf
-${vnfd_volumes_name}   several_volumes-vnf
-${vdu_volumes_name}   several_volumes-VM
-${vnf_several_index}   several_volumes_vnf
-${vnfd_charm_pkg}   charm-packages/native_manual_scale_charm_vnf
-${vnfd_charm_name}   native_manual_scale_charm-vnf
-${vdu_charm_name}   mgmtVM
-${vnf_charm_index}   charm_vnf
-${vnf_charm_scaling_group}   manual-scaling_mgmtVM
-${vnf_charm_cloudinit_file}   /root/helloworld.txt
-${vnf_charm_day1_file}   /home/ubuntu/first-touch
-${nsd_pkg}   volumes_nativecharm_ns
-${nsd_name}   volumes_nativecharm-ns
+${VNFD_VOLUMES_PKG}   several_volumes_vnf
+${VNFD_VOLUMES_NAME}   several_volumes-vnf
+${VDU_VOLUMES_NAME}   several_volumes-VM
+${VNF_SEVERAL_INDEX}   several_volumes_vnf
+${VNFD_CHARM_PKG}   charm-packages/native_manual_scale_charm_vnf
+${VNFD_CHARM_NAME}   native_manual_scale_charm-vnf
+${VDU_CHARM_NAME}   mgmtVM
+${VNF_CHARM_INDEX}   charm_vnf
+${VNF_CHARM_SCALING_GROUP}   manual-scaling_mgmtVM
+${VNF_CHARM_CLOUDINIT_FILE}   /root/helloworld.txt
+${VNF_CHARM_DAY1_FILE}   /home/ubuntu/first-touch
+${NSD_PKG}   volumes_nativecharm_ns
+${NSD_NAME}   volumes_nativecharm-ns
 
 # NS instance name and configuration
-${flavor_name_prefix}   osm.heal02
-${ns_name}   heal_02
-${ns_timeout}   6min
-${scale_wait_time}   5min
+${FLAVOR_NAME_PREFIX}   osm.heal02
+${NS_NAME}   heal_02
+${NS_TIMEOUT}   6min
+${SCALE_WAIT_TIME}   5min
 
 # SSH keys and username to be used
-${publickey}   %{HOME}/.ssh/id_rsa.pub
-${privatekey}   %{HOME}/.ssh/id_rsa
-${username}   ubuntu
-${password}   ${EMPTY}
+${PUBLICKEY}   %{HOME}/.ssh/id_rsa.pub
+${PRIVATEKEY}   %{HOME}/.ssh/id_rsa
+${USERNAME}   ubuntu
+${PASSWORD}   ${EMPTY}
 
-${success_return_code}   0
+${SUCCESS_RETURN_CODE}   0
 
-@{vim_vdus}   @{EMPTY}
-@{vim_volumes}   @{EMPTY}
+@{VIM_VDUS}   @{EMPTY}
+@{VIM_VOLUMES}   @{EMPTY}
 
 
 *** Test Cases ***
 Create VNF Descriptors
-    Create VNFD   '%{PACKAGES_FOLDER}/${vnfd_charm_pkg}'
-    Create VNFD   '%{PACKAGES_FOLDER}/${vnfd_volumes_pkg}'
-
+    [Documentation]   Upload VNF packages for the testsuite.
+    Create VNFD   '%{PACKAGES_FOLDER}/${VNFD_CHARM_PKG}'
+    Create VNFD   '%{PACKAGES_FOLDER}/${VNFD_VOLUMES_PKG}'
 
 Create NS Descriptor
-    Create NSD   '%{PACKAGES_FOLDER}/${nsd_pkg}'
-
+    [Documentation]   Upload NS package for the testsuite.
+    Create NSD   '%{PACKAGES_FOLDER}/${NSD_PKG}'
 
 Create Test Flavor
+    [Documentation]   Create a flavor that will be used at NS instantiation time and save it as FLAVOR_ID.
     ${rand}=   Generate Random String   6   [NUMBERS]
-    ${flavor_name}=   Catenate   SEPARATOR=_   ${flavor_name_prefix}   ${rand}
+    ${flavor_name}=   Catenate   SEPARATOR=_   ${FLAVOR_NAME_PREFIX}   ${rand}
     ${id}=   Create Flavor   ${flavor_name}   1   1024   10
-    Set Suite Variable   ${flavor_id}   ${id}
-
+    Set Suite Variable   ${FLAVOR_ID}   ${id}
 
 Network Service Instance Test
-    ${ns_config}=   Set Variable   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}}],vnf: [ {member-vnf-index: charm_vnf, vdu: [{ id: mgmtVM, vim-flavor-id: ${flavor_id}}]}] }
-    ${id}=   Create Network Service   ${nsd_name}   %{VIM_TARGET}   ${ns_name}   ${ns_config}   ${publickey}   ${ns_timeout}
-    Set Suite Variable   ${ns_id}   ${id}
-
+    [Documentation]   Instantiate NS for the testsuite using the previously created flavor.
+    ${ns_config}=   Set Variable   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}}],vnf: [ {member-vnf-index: charm_vnf, vdu: [{ id: mgmtVM, vim-flavor-id: ${FLAVOR_ID}}]}] }
+    ${id}=   Create Network Service   ${NSD_NAME}   %{VIM_TARGET}   ${NS_NAME}   ${ns_config}   ${PUBLICKEY}   ${NS_TIMEOUT}
+    Set Suite Variable   ${NS_ID}   ${id}
 
 Get NS Id
+    [Documentation]   Get NS identifier.
     [Tags]   cleanup
-    ${variables}   Get Variables
+    ${variables}=   Get Variables
     IF   not "\${ns_id}" in "${variables}"
-        ${id}=   Get Ns Id   ${ns_name}
-        Set Suite Variable   ${ns_id}   ${id}
+        ${id}=   Get Ns Id   ${NS_NAME}
+        Set Suite Variable   ${NS_ID}   ${id}
     END
 
-
 Scale Out Charm VNF
-    ${vnf_id}=   Get Vnf Id   ${ns_id}   ${vnf_charm_index}
-    Set Suite Variable   ${vnf_charm_id}   ${vnf_id}
-    @{vdur_list}=   Get Vnf Vdur Names   ${vnf_charm_id}
+    [Documentation]   Perform a manual scale-out operation of the charm VNF.
+    ${vnf_id}=   Get Vnf Id   ${NS_ID}   ${VNF_CHARM_INDEX}
+    Set Suite Variable   ${VNF_CHARM_ID}   ${vnf_id}
+    @{vdur_list}=   Get Vnf Vdur Names   ${VNF_CHARM_ID}
     ${vdurs}=   Get Length   ${vdur_list}
-    Set Suite Variable   ${initial_vdur_count}   ${vdurs}
-    Execute Manual VNF Scale   ${ns_name}   ${vnf_charm_index}   ${vnf_charm_scaling_group}   SCALE_OUT   ${scale_wait_time}
-    @{vdur_list}=   Get Vnf Vdur Names   ${vnf_charm_id}
+    Set Suite Variable   ${INITIAL_VDUR_COUNT}   ${vdurs}
+    Execute Manual VNF Scale   ${NS_NAME}   ${VNF_CHARM_INDEX}   ${VNF_CHARM_SCALING_GROUP}   SCALE_OUT   ${SCALE_WAIT_TIME}
+    @{vdur_list}=   Get Vnf Vdur Names   ${VNF_CHARM_ID}
     ${vdurs}=   Get Length   ${vdur_list}
-    Run Keyword If   ${vdurs} != ${initial_vdur_count} + 1   Fail   msg=There is no new VDU records in the VNF after Scale Out
-
+    IF   ${vdurs} != ${INITIAL_VDUR_COUNT} + 1   Fail   msg=There is no new VDU records in the VNF after Scale Out
 
 Get VIM Objects
-    Variable Should Exist   ${ns_id}   msg=NS is not available
-    @{vnf_id_list}=   Get Ns Vnf List   ${ns_id}
+    [Documentation]   Retrieve all VMs and volumes from the NS and stores them in VIM_VDUS and VIM_VOLUMES lists.
+    Variable Should Exist   ${NS_ID}   msg=NS is not available
+    @{vnf_id_list}=   Get Ns Vnf List   ${NS_ID}
     Log   ${vnf_id_list}
     FOR   ${vnf_id}   IN   @{vnf_id_list}
         Log   ${vnf_id}
         ${id}=   Get VNF VIM ID   ${vnf_id}
         @{vdu_ids}=   Split String   ${id}
-        Append To List   ${vim_vdus}   @{vdu_ids}
+        Append To List   ${VIM_VDUS}   @{vdu_ids}
     END
-    FOR   ${vdu_id}   IN   @{vim_vdus}
+    FOR   ${vdu_id}   IN   @{VIM_VDUS}
         ${volumes_attached}=   Get Server Property   ${vdu_id}   volumes_attached
         ${match}=   Get Regexp Matches   ${volumes_attached}   '([0-9a-f\-]+)'   1
         IF   ${match} != @{EMPTY}
-            IF   not "${match}[0]" in "@{vim_volumes}"
-                Append To List   ${vim_volumes}   ${match}[0]
+            IF   not "${match}[0]" in "@{VIM_VOLUMES}"
+                Append To List   ${VIM_VOLUMES}   ${match}[0]
             END
         END
     END
-    Log Many   @{vim_vdus}
-    Log Many   @{vim_volumes}
-
+    Log Many   @{VIM_VDUS}
+    Log Many   @{VIM_VOLUMES}
 
 Get Charm VNF Info
-    Variable Should Exist   ${ns_id}   msg=NS is not available
-    ${variables}   Get Variables
+    [Documentation]   Get VDU ID and IP addresses of the charm VNF and stores them in VDU_CHARM_IDS and CHARM_IP_LIST.
+    Variable Should Exist   ${NS_ID}   msg=NS is not available
+    ${variables}=   Get Variables
     IF   not "\${vnf_charm_id}" in "${variables}"
-        ${vnf_id}=   Get Vnf Id   ${ns_id}   ${vnf_charm_index}
-        Set Suite Variable   ${vnf_charm_id}   ${vnf_id}
+        ${vnf_id}=   Get Vnf Id   ${NS_ID}   ${VNF_CHARM_INDEX}
+        Set Suite Variable   ${VNF_CHARM_ID}   ${vnf_id}
     END
-    ${id}=   Get VNF VIM ID   ${vnf_charm_id}
-    @{vdu_charm_ids}=   Split String   ${id}
-    Set Suite Variable   @{vdu_charm_ids}   @{vdu_charm_ids}
-    Log   ${vdu_charm_ids}[1]
-    @{charm_ip_list}=   Get Vnf Vdur IPs   ${vnf_charm_id}
-    Set Suite Variable   @{charm_ip_list}   @{charm_ip_list}
-
+    ${id}=   Get VNF VIM ID   ${VNF_CHARM_ID}
+    @{VDU_CHARM_IDS}=   Split String   ${id}
+    Set Suite Variable   @{VDU_CHARM_IDS}   @{VDU_CHARM_IDS}
+    Log   ${VDU_CHARM_IDS}[1]
+    @{CHARM_IP_LIST}=   Get Vnf Vdur IPs   ${VNF_CHARM_ID}
+    Set Suite Variable   @{CHARM_IP_LIST}   @{CHARM_IP_LIST}
 
 Halt Charm VDU
-    Variable Should Exist   @{vdu_charm_ids}   msg=VDU is not available
-    Halt Server   ${vdu_charm_ids}[1]
+    [Documentation]   Halt one of the VM of the charm VNF.
+    Variable Should Exist   @{VDU_CHARM_IDS}   msg=VDU is not available
+    Halt Server   ${VDU_CHARM_IDS}[1]
     Sleep   15
 
-
 Heal Charm VDU
-    Variable Should Exist   ${vnf_charm_id}   msg=VNF is not available
-    Heal Network Service   ${ns_id}   --vnf ${vnf_charm_id} --cause "Heal VM of charm_vnf" --vdu ${vdu_charm_name} --count-index 1 --run-day1
-
+    [Documentation]   Heal manually via OSM commands all stopped VMs . They should be started again.
+    Variable Should Exist   ${VNF_CHARM_ID}   msg=VNF is not available
+    Heal Network Service   ${NS_ID}   --vnf ${VNF_CHARM_ID} --cause "Heal VM of charm_vnf" --vdu ${VDU_CHARM_NAME} --count-index 1 --run-day1
 
 Check VNF After Healing
-    Variable Should Exist   ${vnf_charm_id}   msg=VNF is not available
-
-    @{ip_list}=   Get Vnf Vdur IPs   ${vnf_charm_id}
-    Should Be Equal   ${ip_list}   ${charm_ip_list}   IP addresses have changed after healing
-
-    ${id}=   Get VNF VIM ID   ${vnf_charm_id}
+    [Documentation]   Check that the IDs of the VM and volumes have not changed after healing.
+    Variable Should Exist   ${VNF_CHARM_ID}   msg=VNF is not available
+    @{ip_list}=   Get Vnf Vdur IPs   ${VNF_CHARM_ID}
+    Should Be Equal   ${ip_list}   ${CHARM_IP_LIST}   IP addresses have changed after healing
+    ${id}=   Get VNF VIM ID   ${VNF_CHARM_ID}
     @{ids}=   Split String   ${id}
-    Should Be Equal   ${vdu_charm_ids}[0]   ${ids}[0]   VDU[0] id has changed after healing
-    Should Not Be Equal   ${vdu_charm_ids}[1]   ${ids}[1]   VDU[1] id has not changed after healing
-    Should Be Equal   ${vdu_charm_ids}[2]   ${ids}[2]   VDU[2] id has changed after healing
-
-    ${ip}=   Get Vdu Attribute   ${vnf_charm_id}   ip-address   1
-    ${stdout}=   Execute Remote Command Check Rc Return Output   ${ip}   ${username}   ${password}   ${privatekey}   sudo ls ${vnf_charm_cloudinit_file}
+    Should Be Equal   ${VDU_CHARM_IDS}[0]   ${ids}[0]   VDU[0] id has changed after healing
+    Should Not Be Equal   ${VDU_CHARM_IDS}[1]   ${ids}[1]   VDU[1] id has not changed after healing
+    Should Be Equal   ${VDU_CHARM_IDS}[2]   ${ids}[2]   VDU[2] id has changed after healing
+    ${ip}=   Get Vdu Attribute   ${VNF_CHARM_ID}   ip-address   1
+    ${stdout}=   Execute Remote Command Check Rc Return Output   ${ip}   ${USERNAME}   ${PASSWORD}   ${PRIVATEKEY}   sudo ls ${VNF_CHARM_CLOUDINIT_FILE}
     Log   ${stdout}
-    Check If remote File Exists   ${ip}   ${username}   ${password}   ${privatekey}   ${vnf_charm_day1_file}
-    ${vim_info}=   Get Vdu Attribute   ${vnf_charm_id}   vim_info   1
-    Should Contain   ${vim_info}   id: ${flavor_id}   msg=Flavor ID is incorrect
-
+    Check If Remote File Exists   ${ip}   ${USERNAME}   ${PASSWORD}   ${PRIVATEKEY}   ${VNF_CHARM_DAY1_FILE}
+    ${vim_info}=   Get Vdu Attribute   ${VNF_CHARM_ID}   vim_info   1
+    Should Contain   ${vim_info}   id: ${FLAVOR_ID}   msg=Flavor ID is incorrect
 
 Update VIM Objects
-    Variable Should Exist   ${ns_id}   msg=NS is not available
+    [Documentation]   Retrieve all VMs and volumes from the NS and stores them in VIM_VDUS and VIM_VOLUMES lists.
+    ...               This is done again to guarantee that all objects are cleaned in the VIM in case the heal operation
+    ...               added new objects.
+    Variable Should Exist   ${NS_ID}   msg=NS is not available
     @{vdu_updated}=   Create List
-    @{vnf_id_list}=   Get Ns Vnf List   ${ns_id}
+    @{vnf_id_list}=   Get Ns Vnf List   ${NS_ID}
     FOR   ${vnf_id}   IN   @{vnf_id_list}
         ${id}=   Get VNF VIM ID   ${vnf_id}
         @{vdu_ids}=   Split String   ${id}
         Append To List   ${vdu_updated}   @{vdu_ids}
         FOR   ${id}   IN   @{vdu_ids}
-            IF   not "${id}" in "@{vim_vdus}"
-                Append To List   ${vim_vdus}   ${id}
+            IF   not "${id}" in "@{VIM_VDUS}"
+                Append To List   ${VIM_VDUS}   ${id}
             END
         END
     END
@@ -197,45 +199,59 @@ Update VIM Objects
         ${volumes_attached}=   Get Server Property   ${vdu_id}   volumes_attached
         ${match}=   Get Regexp Matches   ${volumes_attached}   '([0-9a-f\-]+)'   1
         IF   ${match} != @{EMPTY}
-            IF   not "${match}[0]" in "@{vim_volumes}"
-                Append To List   ${vim_volumes}   ${match}[0]
+            IF   not "${match}[0]" in "@{VIM_VOLUMES}"
+                Append To List   ${VIM_VOLUMES}   ${match}[0]
             END
         END
     END
-    Log Many   @{vim_vdus}
-    Log Many   @{vim_volumes}
-
+    Log Many   @{VIM_VDUS}
+    Log Many   @{VIM_VOLUMES}
 
 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 Descriptors
+    [Documentation]   Delete VNF packages from OSM.
     [Tags]   cleanup
-    Delete VNFD   ${vnfd_volumes_name}
-    Delete VNFD   ${vnfd_charm_name}
-
+    Delete VNFD   ${VNFD_VOLUMES_NAME}
+    Delete VNFD   ${VNFD_CHARM_NAME}
 
-Delete Objects in VIM
+Delete Remaining Objects In VIM
+    [Documentation]   Delete any remaining objects (volumes, VMs, etc.) in the VIM.
     [Tags]   cleanup
-    Delete Flavor   ${flavor_id}
+    Delete Objects In VIM
+
+
+*** Keywords ***
+Suite Cleanup
+    [Documentation]   Test Suit Cleanup: Deleting Descriptor, instance and vim
+    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_VOLUMES_NAME}
+    Run Keyword If Any Tests Failed   Delete VNFD   ${VNFD_CHARM_NAME}
+    Run Keyword If Any Tests Failed   Delete Objects In VIM
+
+Delete Objects In VIM
+    [Documentation]   Clean up remaining VMs and volumes directly from the VIM.
+    Delete Flavor   ${FLAVOR_ID}
     ${error}=   Set Variable   0
-    FOR   ${vol_id}   IN   @{vim_volumes}
+    FOR   ${vol_id}   IN   @{VIM_VOLUMES}
         Log   Checking if volume ${vol_id} is still in VIM
         ${exists}=   Check If Volume Exists   ${vol_id}
-        IF   ${exists}!=0
+        IF   ${exists}
             ${error}=   Set Variable   1
             Log   Deleting volume ${vol_id}
             Run Keyword And Ignore Error   Delete Volume   ${vol_id}
         END
     END
-    FOR   ${vdu_id}   IN   @{vim_vdus}
+    FOR   ${vdu_id}   IN   @{VIM_VDUS}
         Log   Checking if server ${vdu_id} is still in VIM
         ${status}=   Run Keyword And Ignore Error   Get Server Property   ${vdu_id}   id
         Log   ${status}[0]
@@ -248,14 +264,3 @@ Delete Objects in VIM
     IF   ${error}==1
         Fail   Some objects created by test were not deleted in VIM
     END
-
-
-*** Keywords ***
-Suite Cleanup
-    [Documentation]   Test Suit Cleanup: Deleting Descriptor, instance and vim
-
-    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_volumes_name}
-    Run Keyword If Any Tests Failed   Delete VNFD   ${vnfd_charm_name}
-    Run Keyword If Any Tests Failed   Delete Objects in VIM