From 5beeb75c0b80fd5454beefffefca7bd68bf38cfa Mon Sep 17 00:00:00 2001 From: mrpa Date: Sat, 11 Apr 2020 04:05:57 +0200 Subject: Correcting typo and programlistings in the AFTH User Guide. Change-Id: I39ec2401452cf0edff4d1591b26a978ca5cf82b3 Signed-off-by: mrpa --- .../doc/automation_framework_test_harness.xml | 150 +++++++++++---------- .../doc/getting_started.xml | 4 +- 2 files changed, 83 insertions(+), 71 deletions(-) diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index 9f9930a..f32e5b7 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml @@ -95,63 +95,59 @@ Options: Fortigate deployment scenario fortigateDeploy.json: - [ - { - "config": "config/addDevice.json", - "module": "../device/addDevice.py" - }, - { - "config": "config/waitDeviceUp.json", - "module": "../device/waitDeviceUp.py" - }, - { - "config": "config/bindNetworkInterface.json", - "module": "../network/bindNetworkInterface.py" - }, - { - "config": "config/newNetworkBridge.json", - "module": "../network/newNetworkBridge.py" - }, - { - "config": "config/onboardVNFRaw.json", - "module": "../vnf/onboardVNFRaw.py" - }, - { - "config": "config/instantiateVNFI.json", - "module": "../vnf/instantiateVNFI.py" - }, - { - "config": "config/controlVNFI.json", - "module": "../vnf/controlVNFI.py" - } -] + +[ + { + "config": "config/waitDeviceUp.json", + "module": "../device/waitDeviceUp.py" + }, + { + "config": "config/bindNetworkInterface.json", + "module": "../network/bindNetworkInterface.py" + }, + { + "config": "config/newNetworkBridge.json", + "module": "../network/newNetworkBridge.py" + }, + { + "config": "config/onboardVNFRaw.json", + "module": "../vnf/onboardVNFRaw.py" + }, + { + "config": "config/instantiateVNFI.json", + "module": "../vnf/instantiateVNFI.py" + }, + { + "config": "config/controlVNFI.json", + "module": "../vnf/controlVNFI.py" + } +] + Below is a sample unit-test configuration file, describing the Fortigate cleanup scenario fortigateCleanup.json: - [ - { - "config": "config/destroyVNFI.json", - "module": "../vnf/destroyVNFI.py" - }, - { - "config": "config/delNetworkBridge.json", - "module": "../network/delNetworkBridge.py" - }, - { - "config": "config/unbindNetworkInterface.json", - "module": "../network/unbindNetworkInterface.py" - }, - { - "config": "config/offboardVNF.json", - "module": "../vnf/offboardVNF.py" - }, - { - "config": "config/removeDevice.json", - "module": "../device/removeDevice.py" - } -] + +[ + { + "config": "config/destroyVNFI.json", + "module": "../vnf/destroyVNFI.py" + }, + { + "config": "config/delNetworkBridge.json", + "module": "../network/delNetworkBridge.py" + }, + { + "config": "config/unbindNetworkInterface.json", + "module": "../network/unbindNetworkInterface.py" + }, + { + "config": "config/offboardVNF.json", + "module": "../vnf/offboardVNF.py" + } +] + The config key contains the path to the test case's configuration file. @@ -165,12 +161,15 @@ Options: Unit-test behavior can be tweaked through setting any of the following options. This is done through the - eneaUcpeMgr.py file:# Defaults for the framework + eneaUcpeMgr.py file: + + +# Defaults for the framework username = "admin" password = "admin" host = None deviceName = None -directory = "." +directory = "." ftpUsername = "ftp" ftpPassword = "ftp" ftpPort = "2021" @@ -179,16 +178,17 @@ ftpPort = "2021" failfast = True # Logging levels ordered by the highest severity: -# CRITICAL 50 -# ERROR 40 -# WARNING 30 -# INFO 20 -# DEBUG 10 -# NOTSET 0 +# CRITICAL 50 +# ERROR 40 +# WARNING 30 +# INFO 20 +# DEBUG 10 +# NOTSET 0 fileLoggingLevel = logging.DEBUG -consoleLoggingLevel = logging.INFO +consoleLoggingLevel = logging.INFO + - +
eneaUcpeMgr.py Options @@ -287,7 +287,7 @@ consoleLoggingLevel = logging.INFO -
+
@@ -323,10 +323,18 @@ NOTSET 0 running the Fortigate deployment scenario: - $ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s -fortigateDeploy.json -d "Fortigate deployment scenario"Setting - the console logging level to DEBUG:consoleLoggingLevel = logging.DEBUGExpected Output:2019-03-07 18:03:20,791 - DEBUG: Started logging + +$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s +fortigateDeploy.json -d "Fortigate deployment scenario" + + +Setting the console logging level to DEBUG: + +consoleLoggingLevel = logging.DEBUG +Expected Output: + + +2019-03-07 18:03:20,791 - DEBUG: Started logging Running Fortigate deployment scenario... @@ -459,8 +467,12 @@ OK Below you'll find sample unit-test command line options for running the Fortigate cleanup - scenario:$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s -fortigateCleanup.json -d "Fortigate cleanup scenario" + scenario: + + +$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s +fortigateCleanup.json -d "Fortigate cleanup scenario" + Setting the console logging level to INFO: consoleLoggingLevel = logging.INFO diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml index a63dfda..b1ec97a 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml @@ -216,8 +216,8 @@ Subsequent use of the installation requires activating the Python virtual enviroment before using the Automation Framework and Test Harness: source - <AF-THinstall-dir>/testHarness/bin/activate. - + <AF-TH-install-dir>/testHarness-venv/bin/activate. + Furthermore, if a user wants to use a new uCPE Manager instance for a new session, the user also has to re-run the setupuCPEManager.yml playbook with the corresponding -- cgit v1.2.3-54-g00ecf