Feature 11001: Robot framework linting for E2E tests

[osm/tests.git] / robot-systest / testsuite / hackfest_basic.robot

diff --git a/robot-systest/testsuite/hackfest_basic.robot b/robot-systest/testsuite/hackfest_basic.robot
index 1c9d7c9..09d8aa5 100644 (file)
--- a/robot-systest/testsuite/hackfest_basic.robot
+++ b/robot-systest/testsuite/hackfest_basic.robot
@@ -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   [HACKFEST-BASIC] Basic NS with a single-VDU VNF
 
@@ -19,94 +21,87 @@ Library   Collections
 Library   Process
 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/connectivity_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/connectivity_lib.resource
+Resource   ../lib/ssh_lib.resource
 
-Force Tags   hackfest_basic   cluster_main   daily   regression   sanity   azure
+Test Tags   hackfest_basic   cluster_main   daily   regression   sanity   azure
 
 Suite Teardown   Run Keyword And Ignore Error   Suite Cleanup
 
 
 *** Variables ***
 # NS and VNF descriptor package folder and ids
-${vnfd_pkg}   hackfest_basic_vnf
-${vnfd_name}   hackfest_basic-vnf
-${nsd_pkg}   hackfest_basic_ns
-${nsd_name}   hackfest_basic-ns
+${VNFD_PKG}   hackfest_basic_vnf
+${VNFD_NAME}   hackfest_basic-vnf
+${NSD_PKG}   hackfest_basic_ns
+${NSD_NAME}   hackfest_basic-ns
 
 # NS instance name and configuration
-${ns_name}   hfbasic
-${ns_config}   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}} ] }
+${NS_NAME}   hfbasic
+${NS_CONFIG}   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}} ] }
 
 # 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}
 
-${ns_id}   ${EMPTY}
-${vnf_member_index}   vnf
-${vnf_ip_addr}   ${EMPTY}
+${NS_ID}   ${EMPTY}
+${VNF_MEMBER_INDEX}   vnf
+${VNF_IP_ADDR}   ${EMPTY}
 
 
 *** Test Cases ***
 Create Hackfest Basic VNF Descriptor
-
-    Create VNFD   '%{PACKAGES_FOLDER}/${vnfd_pkg}'
-
+    [Documentation]   Upload VNF package for the testsuite.
+    Create VNFD   '%{PACKAGES_FOLDER}/${VNFD_PKG}'
 
 Create Hackfest Basic NS Descriptor
-
-    Create NSD   '%{PACKAGES_FOLDER}/${nsd_pkg}'
+    [Documentation]   Upload NS package for the testsuite.
+    Create NSD   '%{PACKAGES_FOLDER}/${NSD_PKG}'
 
 Network Service Instance Test
-
-    ${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 Ip Address
-
-    ${ip_addr}   Get Vnf Management Ip Address   ${ns_id}   ${vnf_member_index}
+    [Documentation]   Get the mgmt IP address of the VNF of the NS.
+    ${ip_addr}=   Get Vnf Management Ip Address   ${NS_ID}   ${VNF_MEMBER_INDEX}
     Log   ${ip_addr}
-    Set Suite Variable   ${vnf_ip_addr}   ${ip_addr}
+    Set Suite Variable   ${VNF_IP_ADDR}   ${ip_addr}
 
 Test Ping
-    Test Connectivity   ${vnf_ip_addr}
+    [Documentation]   Test that the mgmt IP address of the VNF is reachable with ping.
+    Test Connectivity   ${VNF_IP_ADDR}
 
 Test SSH Access
+    [Documentation]   Check that the VNF is accessible via SSH in its mgmt IP address.
     Sleep   30s   Waiting ssh daemon to be up
-    Test SSH Connection   ${vnf_ip_addr}   ${username}   ${password}   ${privatekey}
+    Test SSH Connection   ${VNF_IP_ADDR}   ${USERNAME}   ${PASSWORD}   ${PRIVATEKEY}
 
 Delete NS Instance Test
+    [Documentation]   Delete NS instance.
     [Tags]   cleanup
-
-    Delete NS   ${ns_name}
-
+    Delete NS   ${NS_NAME}
 
 Delete NS Descriptor Test
+    [Documentation]   Delete NS package from OSM.
     [Tags]   cleanup
-
-    Delete NSD   ${nsd_name}
-
+    Delete NSD   ${NSD_NAME}
 
 Delete VNF Descriptor Test
+    [Documentation]   Delete VNF package from OSM.
     [Tags]   cleanup
-
-    Delete VNFD   ${vnfd_name}
+    Delete VNFD   ${VNFD_NAME}
 
 
 *** 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_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}