From 7f3a380ad0ca61ffd90d9ace3773984759f5571a Mon Sep 17 00:00:00 2001 From: mrpa Date: Fri, 20 Mar 2020 11:41:28 +0100 Subject: Updated the documentation for the new playbook WaitDeviceUP.yml. Change-Id: Ic3a7341f7f7c66fadb5c6a284941e62d07ce9bd3 Signed-off-by: mrpa --- .../doc/configuration.xml | 37 ++++-- .../doc/overview.xml | 4 +- .../doc/sample_test_cases.xml | 137 +++++++++++++++------ 3 files changed, 128 insertions(+), 50 deletions(-) diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml b/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml index 1be36cb..98ac9ff 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml @@ -6,28 +6,43 @@ Test Objects The test objects for the Test Harness are the Enea NFV Access and - Enea uCPE Manager installations performed as indicated in chapter 3 of the - Enea NFV Access Automation Framework and Test Harness User - Guide.olink needed. + Enea uCPE Manager installations performed as indicated in the Components chapter of .
Test Environment - To set up the required Test Harness environment please refer to the - "Environment" chapter from the Enea NFV Access Automation Framework and - Test Harness User Guide.olink needed. + To set up the required Test Harness environment please refer to + section Envrionment in the + .
Preconditions and Execution - Please refer to the "Prerequisites" and "Installation and Initial - Setup" chapters from Enea NFV Access Automation Framework and Test Harness - User Guide olinks needed. for more details. + Please refer to section Prerequisites in the + and section Installation and Initial Setup in the + for more details. For detailed execution steps of the sample test cases included with - the Test Harness please see chapter 3 in this document. xref to - the next chapter needed. + the Test Harness please see the following chapter.
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml index d23a073..7afbfb6 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml @@ -13,7 +13,7 @@ Definitions - + @@ -38,7 +38,7 @@ Acronyms - + diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml index fb8ff8d..95d45ce 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml @@ -13,9 +13,7 @@ TH.
- VNF - Onboard a VNF Image<remark>all titles are formated with - underscores can this be changed or should it be left as - is?</remark> + VNF - Onboard a VNF Image Description: Onboarding a VNF Image into the uCPE Manager. For details please refer to: @@ -127,8 +125,8 @@ vnfd=<VNF-Descriptor-name>"
Device - Upload a NFV Access image - Description: Upload a NFV Access image - file onto the uCPE Manager. For details please refer to: + Description: Upload a NFV Access + image file onto the uCPE Manager. For details please refer to: @@ -174,7 +172,8 @@ A file with the same name is already uploaded. Device - Delete Upgraded File Description: Deleting an uploaded - NFV Access image file from the uCPE Manager. For details please refer to: + NFV Access image file from the uCPE Manager. For details please refer + to: @@ -243,8 +242,8 @@ localhost : ok=1 changed=1 unreachable=0 failed=0Device - Install and Activate a NFV Access image Description: Installing and - Activating a NFV Access image on a uCPE device from the uCPE Manager. For - details please refer to: + Activating a NFV Access image on a uCPE device from the uCPE Manager. + For details please refer to: @@ -296,12 +295,12 @@ Duplicate entry - Release already installed
- Device - Upload, Install and Activate a NFV Access image on a uCPE - device + Device - Upload, Install and Activate a NFV Access image on a + uCPE device Description: Upload, install and - activate a NFV Access image on a uCPE device from the uCPE Manager. For details - please refer to: + activate a NFV Access image on a uCPE device from the uCPE Manager. For + details please refer to: @@ -364,6 +363,48 @@ image_name="<Image-name>" -e upgrade_type="<Upgrade-type>"ok=0 changed=0 unreachable=0 failed=1
+
+ Device - Wait a Device + + Description: Wait for a uCPE + device to connect to the uCPE Manager. For details please refer + to: + + + + <AF-TH-install-dir>/playbooks/waitDeviceUp.yml + + + + <AF-TH-install-dir>/automation_framework/device/waitDeviceUp.py + + + + Preconditions: + + + + The device has to be previously added to the uCPE Manager + instance. + + + + The device JSON configuration file must exist: + <AF-TH-install-dir>/lab_config/<Device-name>/<Device-name>.json + + + + Action: Run the + waitDeviceUp.yml Ansible Playbook with the + <Device-name> as extra-vars: ansible-playbook playbooks/waitDeviceUp.yml -e "device=<Device-name>" + + Result: Output of the test case + run using the Test Harness:# Wait Device task result +<Device-name> device is connected! Note: The test will fail if the device does not + exist or it is not connected. +
+
Device - Remove a Device @@ -426,8 +467,8 @@ image_name="<Image-name>" -e upgrade_type="<Upgrade-type>" - A device must have been previously added to the uCPE Manager - instance. + A device must have been previously added and connected to the + uCPE Manager instance. @@ -592,8 +633,8 @@ bridge=<Bridge-name>" Precondition: - A device must have been previously added to the uCPE Manager - instance. + A device must have been previously added and connected to the uCPE + Manager instance. Action: Run the configDPDK.yml Ansible Playbook with the @@ -619,7 +660,7 @@ DEBUG: Set DPDK state to <enable/disable>
- Instantiate_VNFI + Instantiating a VNFI Description: Creating a VNF instance on a uCPE device. For details please refer to: @@ -636,8 +677,9 @@ DEBUG: Set DPDK state to <enable/disable>Preconditions: - A VNF Image is onboarded and a device is added to the uCPE - Manager. Depending on the VNF, other steps may be required. + A VNF Image is onboarded and a device is added and connected + to the uCPE Manager. Depending on the VNF, other steps may be + required. @@ -663,7 +705,7 @@ vnfd=<VNF-Descriptor-name> vnfi=<VNFI-name>"
- Control_VNFI + Controlling a VNFI Description: Changing the status of a VNF instance (Pause, Resume, Stop, Start). For details please refer @@ -701,7 +743,7 @@ Invalid VNF Instance control command specified - <Command>
- Destroy_VNFI + Destroying a VNFI Description: Destroying a VNF instance from a uCPE device. For details please refer to: @@ -722,7 +764,8 @@ Invalid VNF Instance control command specified - <Command>Action: Run the destroyVNFI.yml Ansible Playbook with the <Device-name> and the - <VNFI-name> as extra-vars: ansible-playbook playbooks/destroyVNFI.yml -e "device=<Device-name> vnfi=<VNFI-name>"<VNFI-name> as extra-vars: ansible-playbook playbooks/destroyVNFI.yml -e "device=<Device-name> \ +vnfi=<VNFI-name>"Result: Output of the test case run using the Test Harness:# Destroy VNFI task result <VNFI-name> was destroyed! - Onboard the FortiGate VNF Image. + Add a uCPE device. - Add a uCPE device. + Wait for the uCPE device to be connected in the Enea uCPE + Manager. + + + + Onboard the FortiGate VNF Image. @@ -884,9 +932,13 @@ ansible_user=root ansible_pass=root directory and rename it to fortigateLicense.lic. - Please refer to the "FortiGate VNF as a Firewall" chapter - from the Enea NFV Access Example Use-cases - manual.olink + For more information please refer to section FortiGate VNF as a Firewall in + the + Manual. @@ -982,15 +1034,23 @@ FortigateFWInstance tested successfully! - The "FortiGate VNF as a Firewall" chapter from the Enea - NFV Access Example Use-cases manual.olink - needed + Section FortiGate VNF as a + Firewall in the + Manual. - The "Python Unit-Test Suite" chapter from the Enea NFV - Access Automation Framework and Test Harness User - Guide. + Section Python Unit-Test Suite in + . @@ -1154,10 +1214,13 @@ ansible_pass=root from Enea and copy it into the junipervSRXImage directory. - Please refer to the "VNF Chaining Example Use-case" chapter - from the Enea NFV Access Example Use-cases manual for additional - information about preconditions.olink to this - chapter + Please refer to the Chapter concerning the VNF Chaining Example Use-case in the + + manual for additional information about preconditions. -- cgit v1.2.3-54-g00ecf