Add Documentation to Test Files

Change-Id: If5d69b411e9af08525dd359e18bed8f69097e117
Issue-ID: INT-1862
Signed-off-by: AndrewLamb <andrew.a.lamb@est.tech>

diff --git a/tests/so/etsi/etsi_package_onboarding_tests.robot b/tests/so/etsi/etsi_package_onboarding_tests.robot
index 96c9896..e4694e0 100644 (file)
--- a/tests/so/etsi/etsi_package_onboarding_tests.robot
+++ b/tests/so/etsi/etsi_package_onboarding_tests.robot
@@ -3,6 +3,11 @@ Library     Collections
 Library     RequestsLibrary
 Library     OperatingSystem
 Library     json
+Documentation    Test cases for onboarding and distributing a VNF package
+...              Note: onboarded VNF package is used in later VNF tests including:
+...                -etsi_vnf_lcm_tests.robot
+...                -etsi_vnf_package_management_tests.robot
+...                -etsi_vnf_notification_tests.robot
 
 *** Variables ***
 ${SLEEP_INTERVAL_SEC}=   5

diff --git a/tests/so/etsi/etsi_vnf_lcm_tests.robot b/tests/so/etsi/etsi_vnf_lcm_tests.robot
index fcfb515..e7b291c 100644 (file)
--- a/tests/so/etsi/etsi_vnf_lcm_tests.robot
+++ b/tests/so/etsi/etsi_vnf_lcm_tests.robot
@@ -3,6 +3,9 @@ Library     Collections
 Library     RequestsLibrary
 Library     OperatingSystem
 Library     json
+Documentation    Test cases for VNF lifecycle management operations
+...              Note, relies on:
+...                -package being onboarded in etsi_package_onboarding_tests
 
 *** Variables ***
 ${SLEEP_INTERVAL_SEC}=   5

diff --git a/tests/so/etsi/etsi_vnf_notification_tests.robot b/tests/so/etsi/etsi_vnf_notification_tests.robot
index 0d1eb41..0c3d5bc 100644 (file)
--- a/tests/so/etsi/etsi_vnf_notification_tests.robot
+++ b/tests/so/etsi/etsi_vnf_notification_tests.robot
@@ -3,6 +3,11 @@ Library     Collections
 Library     RequestsLibrary
 Library     OperatingSystem
 Library     json
+Documentation    Test cases for VNF package subscription notifications and subscription cleanup
+...              Test include checking that VNF package notification was received and deleting the subscription
+...              Note, relies on:
+...                -subscription being created in etsi_vnf_subscription_tests and
+...                -package being onboarded in etsi_package_onboarding_tests
 
 *** Variables ***
 ${SLEEP_INTERVAL_SEC}=   5

diff --git a/tests/so/etsi/etsi_vnf_package_management_tests.robot b/tests/so/etsi/etsi_vnf_package_management_tests.robot
index b7cd337..000148f 100644 (file)
--- a/tests/so/etsi/etsi_vnf_package_management_tests.robot
+++ b/tests/so/etsi/etsi_vnf_package_management_tests.robot
@@ -4,6 +4,9 @@ Library     RequestsLibrary
 Library     OperatingSystem
 Library     json
 Library     ArchiveLibrary
+Documentation    Test cases for VNF package management operations including get packages, package, content and artifacts
+...              Note, relies on:
+...                -package being onboarded in etsi_package_onboarding_tests
 
 *** Variables ***
 ${VNF_PACKAGE_ID}=    73522444-e8e9-49c1-be29-d355800aa349

diff --git a/tests/so/etsi/etsi_vnf_subscription_tests.robot b/tests/so/etsi/etsi_vnf_subscription_tests.robot
index 3bf2262..34913f0 100644 (file)
--- a/tests/so/etsi/etsi_vnf_subscription_tests.robot
+++ b/tests/so/etsi/etsi_vnf_subscription_tests.robot
@@ -3,6 +3,9 @@ Library     Collections
 Library     RequestsLibrary
 Library     OperatingSystem
 Library     json
+Documentation    Test cases that tests subscription functionality for VNF package onboarding/change notifications
+...              Tests include subscribing for notifications, and querying that the subscriptions have been created
+...              Note: creates ACCESS_TOKEN and SUBSCRIPTION_ID variables used in later etsi_vnf_notification_tests
 
 *** Variables ***
 ${SLEEP_INTERVAL_SEC}=   5