Feature 11001: Robot framework linting for E2E tests
[osm/tests.git] / robot-systest / testsuite / basic_26-secure_helm_execution_environment.robot
index 10b3f24..1a6f94f 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
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 
+
 *** Settings ***
 Documentation   [BASIC-26] Secure connection to helm execution environments.
 
 Library   OperatingSystem
 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_26   cluster_ee_config   regression
+Test Tags   basic_26   cluster_ee_config   regression
 
 Suite Teardown   Run Keyword And Ignore Error   Suite Cleanup
 
 
 *** Variables ***
 # NS and VNF descriptor package folder and ids
-${vnfd_pkg}   simple_ee_vnf
-${vnfd_name}   simple_ee-vnf
-${nsd_pkg}   simple_ee_ns
-${nsd_name}   simple_ee-ns
+${VNFD_PKG}   simple_ee_vnf
+${VNFD_NAME}   simple_ee-vnf
+${NSD_PKG}   simple_ee_ns
+${NSD_NAME}   simple_ee-ns
 
 # NS instance name and configuration
-${ns_name}   basic_26_secure_helm_ee_test
-${ns_config}   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}} ] }
-${ns_timeout}   5min
+${NS_NAME}   basic_26_secure_helm_ee_test
+${NS_CONFIG}   {vld: [ {name: mgmtnet, vim-network-name: %{VIM_MGMT_NET}} ] }
+${NS_TIMEOUT}   5min
 
 # SSH keys and username to be used to connect to the VNF
-${username}   ubuntu
-${password}   ${EMPTY}
-${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
 
 # SSH keys and username to be used to connect to OSM VM
-${osm_host}   %{OSM_HOSTNAME}
-${osm_username}   ubuntu
-${osm_password}   ${EMPTY}
-${osm_privatekey}   %{OSM_RSA_FILE}
+${OSM_HOST}   %{OSM_HOSTNAME}
+${OSM_USERNAME}   ubuntu
+${OSM_PASSWORD}   ${EMPTY}
+${OSM_PRIVATEKEY}   %{OSM_RSA_FILE}
 
 # Variables related to day1 and day2
-${action_name}   touch
-${new_action_name}   mkdir
-${vnf_member_index}   simple
-${day_1_file_name}   /home/ubuntu/first-touch
+${ACTION_NAME}   touch
+${NEW_ACTION_NAME}   mkdir
+${VNF_MEMBER_INDEX}   simple
+${DAY_1_FILE_NAME}   /home/ubuntu/first-touch
 
 
 *** Test Cases ***
 Create VNF Descriptor
-
-    ${id}=   Create VNFD   '%{PACKAGES_FOLDER}/${vnfd_pkg}'
-    Set Suite Variable   ${vnfd_id}   ${id}
-
+    [Documentation]   Upload VNF package for the testsuite.
+    ${id}=   Create VNFD   '%{PACKAGES_FOLDER}/${VNFD_PKG}'
+    Set Suite Variable   ${VNFD_ID}   ${id}
 
 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}   ${ns_timeout}
-    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}   ${NS_TIMEOUT}
+    Set Suite Variable   ${NS_ID}   ${id}
 
 Get Management 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 SSH Access
-
-    Variable Should Exist   ${vnf_ip_addr}   msg=IP address of the management VNF '${vnf_member_index}' is not available
+    [Documentation]   Check that the VNF is accessible via SSH in its mgmt IP address.
+    Variable Should Exist   ${VNF_IP_ADDR}   msg=IP address of the management VNF '${VNF_MEMBER_INDEX}' is not available
     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}
 
 Check Remote File Created Via Day 1 Operation
     [Documentation]   Check whether the file created in the previous test via Day 1 operations exist or not.
-
-    Check If remote File Exists   ${vnf_ip_addr}   ${username}   ${password}   ${privatekey}   ${day_1_file_name}
-
+    Check If Remote File Exists   ${VNF_IP_ADDR}   ${USERNAME}   ${PASSWORD}   ${PRIVATEKEY}   ${DAY_1_FILE_NAME}
 
 Get data from EE pod
-
-    Open Connection   ${osm_host}
-    Login With Public Key   ${osm_username}   keyfile=${osm_privatekey}
-    ${pod}=   Execute Remote Command Check Rc Return Output   ${osm_host}   ${osm_username}   ${osm_password}   ${osm_privatekey}   kubectl get pod -n ${ns_id} --no-headers -o custom-columns=":metadata.name"
-    ${svc}=   Execute Remote Command Check Rc Return Output   ${osm_host}   ${osm_username}   ${osm_password}   ${osm_privatekey}   kubectl get svc -n ${ns_id} -l app.kubernetes.io/name=eechart -o jsonpath='{.items[0].spec.clusterIP}'
-    Set Suite Variable   ${pod_name}   ${pod}
-    Set Suite Variable   ${svc_ip}   ${svc}
-
+    [Documentation]   Retrieve pod name and service IP address of the helm-based EE running in OSM cluster and store as suite variables to be used later on.
+    Open Connection   ${OSM_HOST}
+    Login With Public Key   ${OSM_USERNAME}   keyfile=${OSM_PRIVATEKEY}
+    ${pod}=   Execute Remote Command Check Rc Return Output   ${OSM_HOST}   ${OSM_USERNAME}   ${OSM_PASSWORD}   ${OSM_PRIVATEKEY}   kubectl get pod -n ${NS_ID} --no-headers -o custom-columns=":metadata.name"
+    ${svc}=   Execute Remote Command Check Rc Return Output   ${OSM_HOST}   ${OSM_USERNAME}   ${OSM_PASSWORD}   ${OSM_PRIVATEKEY}   kubectl get svc -n ${NS_ID} -l app.kubernetes.io/name=eechart -o jsonpath='{.items[0].spec.clusterIP}'
+    Set Suite Variable   ${POD_NAME}   ${pod}
+    Set Suite Variable   ${SVC_IP}   ${svc}
 
 Fail when trying to access gRPC server without TLS
-
-    ${command} =   Catenate   python3 osm_ee/frontend_client.py ${svc_ip} 50050 sleep
-    ${result}=   Execute Remote Command Check Rc Return Output   ${osm_host}   ${osm_username}   ${osm_password}   ${osm_privatekey}   kubectl exec -it -n ${ns_id} ${pod_name} -- ${command}
+    [Documentation]   Assert failure when accessing the EE without TLS.
+    ${command}=   Catenate   python3 osm_ee/frontend_client.py ${SVC_IP} 50050 sleep
+    ${result}=   Execute Remote Command Check Rc Return Output   ${OSM_HOST}   ${OSM_USERNAME}   ${OSM_PASSWORD}   ${OSM_PRIVATEKEY}   kubectl exec -it -n ${NS_ID} ${POD_NAME} -- ${command}
     Should Contain   ${result}   Connection lost
 
-
 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}