path: root/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="auto_fw_test_harness">
  <title>Automation Framework and Test Harness</title>

  <para>The Automation Framework and Test Harness installation directory is
  structured as follows:</para>

  <programlisting>.
|-- automation_framework
| |-- device
| | |-- addDevice.py
| | |-- getEventsForUcpe.py
| | |-- removeDevice.py
| | `-- waitDeviceUp.py
| |-- eneaUcpeMgr.py
| |-- network
| | |-- bindNetworkInterface.py
| | |-- delNetworkBridge.py
| | |-- getNetworkInterfaces.py
| | |-- newNetworkBridge.py
| | `-- unbindNetworkInterface.py
| |-- unittestSuite
| | |-- config
| | | |-- addDevice.json
| | | |-- bindNetworkInterface.json
| | | |-- controlVNFI.json
| | | |-- delNetworkBridge.json
| | | |-- destroyVNFI.json
| | | |-- instantiateVNFI.json
| | | |-- newNetworkBridge.json
| | | |-- offboardVNF.json
| | | |-- onboardVNF.json
| | | |-- onboardVNFRaw.json
| | | |-- removeDevice.json
| | | |-- unbindNetworkInterface.json
| | | `-- waitDeviceUp.json
| | |-- fortigateCleanup.json
| | |-- fortigateDeploy.json
| | |-- unittestLoader.py
| | `-- unittestSuite.py
| `-- vnf
| |-- controlVNFI.py
| |-- destroyVNFI.py
| |-- instantiateVNFI.py
| |-- offboardVNF.py
| |-- onboardVNF.py
| `-- onboardVNFRaw.py
|-- ansible.cfg
|-- hosts
|-- setup_env.sh
|-- lab_config
| |-- intelc3850-2
| | |-- intelc3850-2.json
| | |-- lan_br.json
| | |-- lan_nic.json
| | |-- wan_br.json
| | `-- wan_nic.json
| |-- inteld1521-1
| | |-- inteld1521-1.json
| | |-- lan_br.json
| | |-- lan_nic.json
| | |-- mgmt_nic.json
| | |-- sfc_br.json
| | |-- vnf_mgmt_br.json
| | |-- wan_br.json
| | `-- wan_nic.json
| `-- inteld1521-2
| |-- inteld1521-2.json
| |-- lan_br.json
| |-- lan_nic.json
| |-- mgmt_nic.json
| |-- sfc_br.json
| |-- vnf_mgmt_br.json
| |-- wan_br.json
| `-- wan_nic.json
|-- playbooks
| |-- addBridge.yml
| |-- addDevice.yml
| |-- bindNIC.yml
| |-- chainedVNFsService
| | |-- chainedVNFsService.yml
| | |-- cleanupChainedVNFsService.yml
| | `-- testChainedVNFsService.yml
| |-- controlVNFI.yml
| |-- deleteBridge.yml
| |-- destroyVNFI.yml
| |-- fortigateFWService
| | |-- cleanupFortigateFWInstance.yml
| | |-- cleanupTestFortigateFWInstance.yml
| | |-- instantiateFortigateFW.yml
| | `-- testFortigateFWInstance.yml
| |-- instantiateVNFI.yml
| |-- offboardVNF.yml
| |-- onboardVNFBundle.yml
| |-- onboardVNFImage.yml
| |-- removeDevice.yml
| |-- setupuCPEManager.yml
| |-- unbindNIC.yml
| `-- unittestSuiteTest
| |-- cleanupFortigateFWScenario.yml
| `-- deployFortigateFWScenario.yml
|-- uCPEM_config
| `-- ucpem01.json
|-- vnf_config
| |-- fortigateFWImage
| | |-- fortigateFWImage.json
| | |-- fortigateFWInstance1.json
| | `-- fortigateFWInstance2.json
| |-- fortigateImage
| | |-- fortigateFWInstance.json
| | `-- fortigateImage.json
| `-- junipervSRXImage
| |-- junipervSRXImage.json
| |-- junipervSRXInstanceAtomC1.json
| |-- junipervSRXInstanceAtomC2.json
| |-- junipervSRXInstanceXeonD1.json
| `-- junipervSRXInstanceXeonD2.json
`-- vnf_image</programlisting>

  <section id="auto_fw">
    <title>Automation Framework</title>

    <para>All Automation Framework sources are under the
    <literal>&lt;AF-TH-install-dir&gt;/automation_framework</literal>
    directory.</para>

    <para>The <literal>/device</literal> folder contains Python scripts for
    adding a uCPE device, receiving uCPE events' reports, removing a uCPE
    device, and waiting for a uCPE device to connect to the uCPE
    Manager.</para>

    <para>The <literal>/network</literal> folder contains Python scripts for
    binding or unbinding a network interface to/from a uCPE device (DPDK or
    SR-IOV), creating or deleting an OVS network bridge, or dumping network
    interface information about the available interfaces.</para>

    <para>The <literal>/unittestSuite</literal> folder contains Python
    unit-test class and loader scripts for generating specific test cases for
    the available Python scripts. The generated test cases are injected into
    the Python unit-test suite class to be run using the Python unit-test
    framework.</para>

    <para>The <literal>/unittestSuite/config</literal> folder contains
    configuration files in JSON format that describe the list of test cases
    for a particular Python script. Each defined test case is a dictionary
    that must contain the test case name and arguments to be passed to the
    Python script for running the test case.</para>

    <para>The <literal>/vnf</literal> folder contains Python scripts for
    onboarding and offboarding a VNF bundle or image, instantiating a VNF,
    controlling a VNF instance or destroying an existing one.</para>

    <para>The <filename>eneaUcpeMgr.py</filename> file acts as a library for
    the (Python) Automation Framework scripts. It contains common functions
    and unit-test configuration options.</para>

    <section id="python_testsuite">
      <title>Python Unit-Test Suite</title>

      <para>The Python unit-test class defined in the
      <filename>unittestSuite.py</filename> script provides a way to automate
      the execution of specific test cases for each supported Python script.
      This class requires a test suite configuration JSON file that contains a
      dictionary list of the Python scripts to be processed. Each dictionary
      must contain the path of the Python script to be loaded and the path to
      the file describing the test cases to be performed against the
      designated script.</para>

      <para>Steps for running the Python unit-test suite onto the uCPE Manager
      are provided below.</para>

      <section id="script_opts">
        <title>Script Options</title>

        <programlisting>$ python unittestSuite.py -h
Usage: unittestSuite.py [options]

Run selected unit-test suite against Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -n DEVICENAME, --deviceName=DEVICENAME
 Name of vCPE device (Virtual Infrastructure Manager)
 -s SUITEFILE, --suite=SUITEFILE
 Test suite configuration file in JSON format
 -d DESCRIPTION, --description=DESCRIPTION
 Test suite description

 Mandatory options:
 -H/--host, -n/--deviceName, -s/--suiteFile, -d/--description</programlisting>
      </section>

      <section id="config_ut_json">
        <title>Configuring Unit-Test JSON File<remark>Starting from this
        section onward NOTHING has been proofed</remark></title>

        <para>The unit-test suite JSON configuration file contains a list of
        dictionaries, each dictionary indicating the path of the Python module
        to load and the test cases configuration file to be executed against
        the loaded module.</para>

        <para>Sample unit-test configuration file describing the Fortigate
        deployment scenario, fortigateDeploy.json:</para>

        <para><programlisting>[
 {
 "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"
 }
]</programlisting>Sample unit-test configuration file describing the Fortigate
        cleanup scenario, fortigateCleanup.json:</para>

        <programlisting>[
 {
 "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"
 }
]</programlisting>

        <para>"config" key contains the path to the test cases configuration
        file.</para>

        <para>"module" key contains the path to the Python script to be
        executed.</para>
      </section>

      <section id="ut_config_opts">
        <title>Unit-Test Configuration Options</title>

        <para>The unit-test behavior can be tweaked in a number of ways
        through the following options set through the eneaUcpeMgr.py
        file:<programlisting># Defaults for the framework
username = "admin"
password = "admin"
host = None
deviceName = None
directory = "."
ftpUsername = "ftp"
ftpPassword = "ftp"
ftpPort = "2021"

# Stop the test run on the first error or failure
failfast = True

# Logging levels ordered by the highest severity:
# CRITICAL 50
# ERROR 40
# WARNING 30
# INFO 20
# DEBUG 10
# NOTSET 0
fileLoggingLevel = logging.DEBUG
consoleLoggingLevel = logging.INFO</programlisting>username - user to be used
        when authenticating to uCPE Manager; this can be overwritten by
        setting the Python unit-test suite command line option -u.</para>

        <para>password - password to be used when authenticating to uCPE
        Manager; this can be overwritten by setting the Python unit-test suite
        command line option -p.</para>

        <para>host - IP address of the uCPE Manager host; this can be
        overwritten by setting the Python unit-test suite command line option
        -H.</para>

        <para>devicename - name of the VCPE agent to perform the tests
        against; this can be overwritten by setting the Python unit-test suite
        command line option -n.</para>

        <para>ftpUsername - user to be used for the FTP connection when
        onboarding a VNF bundle/image; this can be overwritten by setting the
        Python script command line option -f.</para>

        <para>ftpPassword - password to be used for the FTP connection when
        onboarding a VNF bundle/image; this can be overwritten by setting the
        Python script command line option -w.</para>

        <para>ftpPort - port to be used for the FTP connection when onboarding
        a VNF bundle/image; this can be overwritten by setting the Python
        script command line option -P.</para>

        <para>failfast - describes the unit-test execution behavior on the
        first error or failure encountered.</para>

        <para>fileLoggingLevel - sets the file logging level.</para>

        <para>consoleLoggingLevel - sets the console logging level.</para>
      </section>

      <section id="ut_suite_log">
        <title>Python Unit-Test Suite Logging</title>

        <para>Logging messages are displayed in the console and also saved to
        the specified log file depending on the chosen logging level.</para>

        <para>Logging messages are ranked by their severity
        level:<programlisting>CRITICAL 50
ERROR 40
WARNING 30
INFO 20
DEBUG 10
NOTSET 0</programlisting>Logging messages which are less severe than the
        logging level set will be ignored.</para>

        <para>Setting console logging level to INFO is done through the
        consoleLoggingLevel option:<programlisting>consoleLoggingLevel = logging.INFO</programlisting>Setting
        file logging level to DEBUG is done through the fileLoggingLevel
        option:<programlisting>fileLoggingLevel = logging.DEBUG</programlisting></para>
      </section>

      <section id="run_ut_suite">
        <title>Running Python Unit-Test Suite</title>

        <para>Sample unit-test command line options for running the Fortigate
        deployment scenario:</para>

        <para><programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
fortigateDeploy.json -d "Fortigate deployment scenario"</programlisting>Setting
        console logging level to DEBUG:<programlisting>consoleLoggingLevel = logging.DEBUG</programlisting><emphasis
        role="bold">Expected Output:</emphasis><programlisting>2019-03-07 18:03:20,791 - DEBUG: Started logging

Running Fortigate deployment scenario...

test 001: Add VCPE Agent device (__main__.UnittestSuite) ...
2019-03-07 18:03:20,795 - INFO: Add uCPE device
2019-03-07 18:03:20,924 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:20,925 - DEBUG: Session token is: 876160c3-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:20,949 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host
2019-03-07 18:03:21,100 - INFO: Done
2019-03-07 18:03:21,133 - DEBUG: Logging out and exiting...
ok
test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ...
2019-03-07 18:03:21,133 - INFO: Wait uCPE device
2019-03-07 18:03:21,149 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:21,149 - DEBUG: Session token is: 8785b1a0-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:21,157 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:21,157 - DEBUG: Wait for device 'intelc3850-2' to connect
2019-03-07 18:03:29,356 - DEBUG: Status: Connected
2019-03-07 18:03:29,356 - INFO: Done
2019-03-07 18:03:29,365 - DEBUG: Logging out and exiting...
ok
test 003: Bind lan NIC to DPDK (__main__.UnittestSuite) ...
2019-03-07 18:03:29,366 - INFO: Bind NIC
2019-03-07 18:03:29,406 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:29,406 - DEBUG: Session token is: 8c719cb0-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:29,415 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:29,415 - DEBUG: Bind NIC '0000:01:00.1'
2019-03-07 18:03:30,030 - INFO: Done
2019-03-07 18:03:30,067 - DEBUG: Logging out and exiting...
ok
test 004: Bind wan NIC to DPDK (__main__.UnittestSuite) ...
2019-03-07 18:03:30,068 - INFO: Bind NIC
2019-03-07 18:03:30,086 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:30,087 - DEBUG: Session token is: 8cd95f32-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:30,095 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:30,096 - DEBUG: Bind NIC '0000:03:00.2'
2019-03-07 18:03:30,729 - INFO: Done
2019-03-07 18:03:30,767 - DEBUG: Logging out and exiting...
ok
test 005: Creating network bridge LAN (__main__.UnittestSuite) ...
2019-03-07 18:03:30,768 - INFO: New OVS network bridge
2019-03-07 18:03:30,801 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:30,801 - DEBUG: Session token is: 8d454061-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:30,811 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:30,812 - DEBUG: Create new OVS network bridge 'lan_br'
2019-03-07 18:03:37,358 - INFO: Done
2019-03-07 18:03:37,402 - DEBUG: Logging out and exiting...
ok
test 006: Creating network bridge WAN (__main__.UnittestSuite) ...
2019-03-07 18:03:37,402 - INFO: New OVS network bridge
2019-03-07 18:03:37,461 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:37,461 - DEBUG: Session token is: 913c4420-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:37,485 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:37,485 - DEBUG: Create new OVS network bridge 'wan_br'
2019-03-07 18:03:37,755 - INFO: Done
2019-03-07 18:03:37,792 - DEBUG: Logging out and exiting...
ok
test 007: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ...
2019-03-07 18:03:37,792 - INFO: Onboard wizard
2019-03-07 18:03:37,859 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:37,859 - DEBUG: Session token is: 91770330-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:37,860 - DEBUG: FTP file '../../vnf_bundles/fortios.qcow2' on host
'localhost', port '2021'
2019-03-07 18:03:38,027 - DEBUG: Onboard VNF raw: fortios.qcow2
2019-03-07 18:03:41,701 - INFO: Done
2019-03-07 18:03:41,748 - DEBUG: Logging out and exiting...
ok
test 008: Instantiate Fortigate VNF (__main__.UnittestSuite) ...
2019-03-07 18:03:41,778 - INFO: Instantiate VNF
2019-03-07 18:03:41,813 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:41,815 - DEBUG: Session token is: 93d69e10-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:41,834 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:41,878 - DEBUG: Found VNF descriptor with name 'fortigateImage'
2019-03-07 18:03:41,888 - DEBUG: Encrypt string content:
cloudInit("vnf_config/fortigateImage/fortigateFW.conf")
2019-03-07 18:03:41,889 - DEBUG: Encrypt string content:
License("vnf_config/fortigateImage/fortigateLicense.lic")
2019-03-07 18:03:41,889 - DEBUG: Instantiate fortigateImage VNF on 'intelc3850-2'
2019-03-07 18:03:49,887 - INFO: Done
2019-03-07 18:03:49,921 - DEBUG: Logging out and exiting...
ok
test 009: Pause Fortigate VNF instance (__main__.UnittestSuite) ...
2019-03-07 18:03:49,923 - INFO: Control VNF
2019-03-07 18:03:49,982 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:49,983 - DEBUG: Session token is: 98b17220-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:49,991 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:50,031 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 18:03:50,031 - DEBUG: Control VNF instance 'intelc3850-2', command:
pause
2019-03-07 18:03:50,914 - INFO: Done
2019-03-07 18:03:50,933 - DEBUG: Logging out and exiting...
ok
test 010: Resume Fortigate VNF instance (__main__.UnittestSuite) ...
2019-03-07 18:03:50,933 - INFO: Control VNF
2019-03-07 18:03:50,992 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:50,992 - DEBUG: Session token is: 994c0473-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:51,005 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:51,023 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 18:03:51,024 - DEBUG: Control VNF instance 'intelc3850-2', command:
resume
2019-03-07 18:03:51,963 - INFO: Done
2019-03-07 18:03:51,991 - DEBUG: Logging out and exiting...
ok
test 011: Stop Fortigate VNF instance (__main__.UnittestSuite) ...
2019-03-07 18:03:51,992 - INFO: Control VNF
2019-03-07 18:03:52,031 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:52,031 - DEBUG: Session token is: 99ed9ba3-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:52,046 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:52,073 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 18:03:52,073 - DEBUG: Control VNF instance 'intelc3850-2', command: stop
2019-03-07 18:03:53,011 - INFO: Done
2019-03-07 18:03:53,047 - DEBUG: Logging out and exiting...
ok
test 012: Start Fortigate VNF instance (__main__.UnittestSuite) ...
2019-03-07 18:03:53,048 - INFO: Control VNF
2019-03-07 18:03:53,080 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:53,080 - DEBUG: Session token is: 9a8d8523-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:53,109 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:53,140 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 18:03:53,141 - DEBUG: Control VNF instance 'intelc3850-2', command:
start
2019-03-07 18:03:54,087 - INFO: Done
2019-03-07 18:03:54,123 - DEBUG: Logging out and exiting...
ok

----------------------------------------------------------------------
Ran 12 tests in 33.328s

OK</programlisting></para>

        <para>Sample unit-test command line options for running the Fortigate
        cleanup scenario:<programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting></para>

        <para>Setting console logging level to INFO: <programlisting>consoleLoggingLevel = logging.INFO</programlisting></para>

        <para><emphasis role="bold">Expected
        Output:</emphasis><programlisting>Running Fortigate cleanup scenario...
test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ...
2019-03-07 18:04:55,997 - INFO: Destroy VNF
2019-03-07 18:04:56,668 - INFO: Done
ok
test 002: Deleting network bridge LAN (__main__.UnittestSuite) ...
2019-03-07 18:04:56,739 - INFO: Delete OVS network bridge
2019-03-07 18:04:57,908 - INFO: Done
ok
test 003: Deleting network bridge WAN (__main__.UnittestSuite) ...
2019-03-07 18:04:57,931 - INFO: Delete OVS network bridge
2019-03-07 18:04:59,464 - INFO: Done
ok
test 004: Unbind lan NIC from DPDK uCPE device (__main__.UnittestSuite) ...
2019-03-07 18:04:59,477 - INFO: Unbind NIC
2019-03-07 18:05:00,639 - INFO: Done
ok
test 005: Unbind wan NIC from DPDK uCPE device (__main__.UnittestSuite) ...
2019-03-07 18:05:00,658 - INFO: Unbind NIC
2019-03-07 18:05:01,533 - INFO: Done
ok
test 006: Offboarding Fortigate VNF (__main__.UnittestSuite) ...
2019-03-07 18:05:01,566 - INFO: Offboard VNF
2019-03-07 18:05:01,814 - INFO: Done
ok
test 007: Remove VCPE Agent device (__main__.UnittestSuite) ...
2019-03-07 18:05:01,853 - INFO: Remove uCPE device
2019-03-07 18:05:02,184 - INFO: Done
ok

----------------------------------------------------------------------
Ran 7 tests in 6.198s

OK</programlisting></para>
      </section>
    </section>

    <section id="add_ucpe_device">
      <title>Adding a uCPE Device</title>

      <para>Adds a uCPE device to the uCPE manager.</para>

      <section id="opts_add_device">
        <title>Script Options</title>

        <programlisting>$ python addDevice.py -h
Usage: addDevice.py [options]

Add a uCPE in Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f DEVICEFILE, --file=DEVICEFILE
 File containing uCPE Information in JSON format

 Mandatory options:
 -H/--host, -f/--file</programlisting>
      </section>

      <section id="config_json_adddev">
        <title>Configuring the JSON File</title>

        <para>The add device suite JSON configuration file should contain a
        list of dictionaries, each dictionary indicating the test case name
        and the test case arguments passed to the addDevice Python
        module.</para>

        <para><emphasis role="bold">Sample configuration file in JSON
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Add VCPE Agent device ",
 "args": "-f ../../lab_config/intelc3850-2/intelc3850-2.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample intelc3850-2.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": " intelc3850-2",
 "description": "",
 "address": "192.168.1.100",
 "port": "22",
 "username": "root",
 "password": "root",
 "certificate": null,
 "passphrase": null,
 "maintMode": "false"
}</programlisting>
      </section>

      <section id="run_py_mod">
        <title>Running the Python Module</title>

        <para>The addDevice Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python addDevice.py -u admin -p admin -H localhost -f config/device.json
2019-03-07 17:33:10,755 - DEBUG: Started logging
2019-03-07 17:33:10,756 - INFO: Add uCPE device
2019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host
2019-03-07 17:33:11,483 - INFO: Done
2019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting>
      </section>
    </section>

    <section id="remove_ucpe_device">
      <title>Removing a uCPE Device</title>

      <para>Removes a uCPE device from uCPE manager.</para>

      <section id="rem_script_opts">
        <title>Script Options</title>

        <programlisting>$ python removeDevice.py -h
Usage: removeDevice.py [options]

Remove a uCPE from Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f DEVICEFILE, --file=DEVICEFILE
 File containing uCPE Information in JSON format

 Mandatory options:
 -H/--host, -f/--file</programlisting>
      </section>

      <section id="config_json_rem">
        <title>Configuring the JSON File</title>

        <para>The remove device suite JSON configuration file should contain a
        list of dictionaries, each dictionary indicating the test case name
        and the test case arguments passed to the removeDevice Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Remove VCPE Agent device ",
 "args": "-f ../../lab_config/intelc3850-2/intelc3850-2.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample intelc3850-2.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "intelc3850-2"
}</programlisting>
      </section>

      <section id="Run_py_mod_rem">
        <title>Running the Python Module</title>

        <para>The removeDevice Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python removeDevice.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/intelc3850-2.json
2019-03-07 17:33:56,834 - DEBUG: Started logging
2019-03-07 17:33:56,835 - INFO: Remove uCPE device
2019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager
host
2019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:57,159 - INFO: Done
2019-03-07 17:33:57,171 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="wait_ucpe_device">
      <title>Waiting a uCPE Device</title>

      <para>Wait for uCPE to connect to the Enea uCPE Manager after
      installation.</para>

      <section id="wait_script_opts">
        <title>Script Options</title>

        <programlisting>$ python waitDeviceUp.py -h
Usage: waitDeviceUp.py [options]

Wait for uCPE to connect to the Enea uCPE Manager after installation.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f DEVICEFILE, --file=DEVICEFILE
 File containing uCPE Information in JSON format
 -t TIMEOUT, --timeout=TIMEOUT
 Time in seconds for maximum wait period, default =
 instant

 Mandatory options:
 -H/--host, -f/--file</programlisting>
      </section>

      <section id="config_json_wait">
        <title>Configuring the JSON File</title>

        <para>The wait device suite JSON configuration file should contain a
        list of dictionaries, each dictionary indicating the test case name
        and the test case arguments passed to the waitDeviceUp Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Wait VCPE Agent device be up",
 "args": "-f ../../lab_config/intelc3850-2/intelc3850-2.json -t 60"
 }
]</programlisting>

        <para><emphasis role="bold">Sample intelc3850-2.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "intelc3850-2"
}</programlisting>
      </section>

      <section id="runpy_mod_wait">
        <title>Running the Python Module</title>

        <para>The waitDeviceUp Python module can be executed individually by
        running the following command line:<programlisting>$ python waitDeviceUp.py -u admin -p admin -H localhost -t 60 -f
../../lab_config/intelc3850-2/intelc3850-2.json
2019-03-07 18:03:21,132 - DEBUG: Started logging
2019-03-07 18:03:21,133 - INFO: Wait uCPE device
2019-03-07 18:03:21,149 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:21,149 - DEBUG: Session token is: 8785b1a0-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:21,157 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:21,157 - DEBUG: Wait for device 'intelc3850-2' to connect
2019-03-07 18:03:29,356 - DEBUG: Status: Connected
2019-03-07 18:03:29,356 - INFO: Done
2019-03-07 18:03:29,365 - DEBUG: Logging out and exiting...</programlisting></para>
      </section>
    </section>

        <section id="print_ucpe_log">
          <title>Printing the uCPE Device log</title>

          <para>Print the events log for a specific uCPE device installed in Enea uCPE Manager.</para>

          <section id="print_script_opts">
            <title>Script Options</title>

            <programlisting>
$ python getEventsForUcpe.py -h
Usage: getEventsForUcpe.py [options]

Print the events log for a specific uCPE installed in Enea uCPE Manager.

Options:
--version                          show program's version number and exit
-h, --help                         show this help message and exit
-u USERNAME, --username=USERNAME   Enea uCPE Manager login username
-p PASSWORD, --password=PASSWORD   Enea uCPE Manager login password
-H HOST, --host=HOST               Enea uCPE Manager host name or IP address
-f DEVICEFILE, --file=DEVICEFILE   File containing uCPE Information in JSON format
-s SEVERITY, --severity=SEVERITY   Event severity level (Critical|Major|Minor)

Mandatory options:
-H/--host, -f/--file
            </programlisting>
            </section>
          
            <section id="config_json_log">
              <title>Configuring the JSON File</title>
              
              <para><emphasis role="bold">Sample <filename>intelc3850-2.json</filename> 
                configuration file:</emphasis></para>
              
              <programlisting>{
"name": "intelc3850-2",
"description": "",
"address": "172.24.12.114",
"port": "22",
"username": "root",
"password": "root",
"certificate": null,
"passphrase": null,
"maintMode": "false"
              }</programlisting>
            </section>
          
            <section id="runpy_mod_log">
              <title>Running the Python Module</title>
              
              <para>The <literal>getEventsForUcpe</literal> Python module can be executed 
                individually by running the following command:</para>
                <programlisting>
$ python getEventsForUcpe.py -H localhost -f \
../../lab_config/intelc3850-2/intelc3850-2.json

2019-07-04 13:48:31,289 - DEBUG: Started logging
2019-07-04 13:48:31,290 - INFO: Dump uCPE events
2019-07-04 13:48:31,336 - DEBUG: Login successful on host '172.24.3.108'
2019-07-04 13:48:31,336 - DEBUG: Session token is: a53c68d3-9e51-11e9-a715-5254007632e2
2019-07-04 13:48:31,356 - DEBUG: Found device with name 'intelc3850-2'
2019-07-04 13:48:31,357 - DEBUG:
Events on device: intelc3850-2 and severity: 1000
2019-07-04 13:48:31,450 - DEBUG:  Dumping 1 events
2019-07-04 13:48:31,450 - DEBUG: Device Disconnected | Alarm | Device | None | \
    2019-07-04 09:57:40.042
2019-07-04 13:48:31,469 - DEBUG:  Dumping 0 events
2019-07-04 13:48:31,469 - INFO: Done
2019-07-04 13:48:31,488 - DEBUG: Logging out and exiting...
              </programlisting>
            </section>

        </section>

    <section id="bind_ucpe_device">
      <title>Binding a network interface</title>

      <para>Binds a physical network interface to a DPDK or SR-IOV.
      </para>

      <section id="script_opts_bind">
        <title>Script Options</title>

        <programlisting>$ python bindNetworkInterface.py -h
Usage: bindNetworkInterface.py [options]

Binds a physical network interface to a DPDK or SR-IOV.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f NICFILE, --file=NICFILE
File containing network interface Information in JSON
format
 -n DEVICENAME, --device-name=DEVICENAME
 Name of the device

 Mandatory options:
 -H/--host, -f/--file, -n/--device-name</programlisting>
      </section>

      <section id="bind_config">
        <title>Configuring the JSON File</title>

        <para>The bind network interface suite JSON configuration file should
        contain a list of dictionaries, each dictionary indicating the test
        case name and the test case arguments passed to the
        bindNetworkInterface Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Bind lan NIC to DPDK",
 "args": "-f ../../lab_config/intelc3850-2/lan_nic.json"
 },
 {
 "name": "Bind wan NIC to DPDK ",
 "args": "-f ../../lab_config/intelc3850-2/wan_nic.json"
 }
]</programlisting><emphasis role="bold">Sample lan_nic.json configuration
        file:</emphasis><programlisting>{
 "name": "0000:01:00.1",
 "type": "dpdk",
 "subType": "igb_uio"
}</programlisting><emphasis role="bold">Sample wan_nic.json configuration
        file:</emphasis><programlisting>{
 "name": "0000:03:00.2",
 "type": "dpdk",
 "subType": "igb_uio"
}</programlisting></para>
      </section>

      <section id="runpy_bind">
        <title>Running the Python Module</title>

        <para>The <literal>bindNetworkInterface</literal> Python module can be executed
        individually by running the following command line:</para>

        <programlisting>$ python bindNetworkInterface.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_nic.json -n intelc3850-2
2019-03-07 18:03:29,365 - DEBUG: Started logging
2019-03-07 18:03:29,366 - INFO: Bind NIC
2019-03-07 18:03:29,406 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:29,406 - DEBUG: Session token is: 8c719cb0-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:29,415 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:29,415 - DEBUG: Bind NIC '0000:01:00.1'
2019-03-07 18:03:30,030 - INFO: Done
2019-03-07 18:03:30,067 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="unbind_ucpe_device">
      <title>Unbinding a Network Interface</title>

      <para>Unbinds a physical network interface from DPDK or SR-IOV.</para>

      <section id="script_opts_unbind">
        <title>Script Options</title>

        <programlisting>$ python unbindNetworkInterface.py -h
Usage: unbindNetworkInterface.py [options]

Unbinds a physical interface to the DPDK or SR-IOV.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f NICFILE, --file=NICFILE
 File containing network interface Information in JSON
 format
 -n DEVICENAME, --device-name=DEVICENAME
 Name of the device

 Mandatory options:
 -H/--host, -f/--file, -n/--device-name</programlisting>
      </section>

      <section id="json_unbind">
        <title>Configuring the JSON File</title>

        <para>The unbind network interface suite JSON configuration file
        should contain a list of dictionaries, each dictionary indicating the
        test case name and the test case arguments passed to the
        unbindNetworkInterface Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Unbind lan NIC",
 "args": "-f ../../lab_config/intelc3850-2/lan_nic.json"
 },
 {
  name": "Unbind wan NIe",
Unbinds a physical interface to the DPDK or SR-IOV
 "args": "-f ../../lab_config/intelc3850-2/wan_nic.json"
 }
]</programlisting></para>

        <para><emphasis role="bold">Sample lan_nic.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "0000:01:00.1",
 "type": "dpdk"
}</programlisting>

        <para><emphasis role="bold">Sample wan_nic.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "0000:03:00.2",
 "type": "dpdk",
}
</programlisting>
      </section>

      <section id="pymod_unbind">
        <title>Running the Python Module</title>

        <para>The unbindNetworkInterface Python module can be executed
        individually by running the following command line:</para>

        <programlisting>$ python unbindNetworkInterface.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_nic.json -n intelc3850-2
2019-03-07 17:33:54,377 - DEBUG: Started logging
2019-03-07 17:33:54,378 - INFO: Unbind NIC
2019-03-07 17:33:54,431 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:54,432 - DEBUG: Session token is: 6a77a1d1-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:54,467 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:54,468 - DEBUG: Unbind NIC '0000:01:00.1'
2019-03-07 17:33:55,616 - INFO: Done
2019-03-07 17:33:55,659 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="get_network_interface">
      <title>Getting a Network Interface</title>
      
      <para>List the network interfaces for a device.</para>

    <section id="script_opts_interface">
      <title>Script Options</title>
      <programlisting>
$ python getNetworkInterfaces.py -h
2019-07-04 16:35:50,496 - DEBUG: Started logging
2019-07-04 16:35:50,496 - INFO: Dump NICs
Usage: getNetworkInterfaces.py [options]

Options:
  --version                               show program's version number and exit
  -h, --help                              show this help message and exit
  -u USERNAME, --username=USERNAME        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD        Enea uCPE Manager login password
  -H HOST, --host=HOST                    Enea uCPE Manager host name or IP address
  -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network interfaces from

  Mandatory options:
    -H/--host, -n/--device-name
      </programlisting>
  </section>

    <section id="runpy_net_interface">
      <title>Running the Python Module</title>
      <para>The <literal>getNetworkInterfaces</literal> Python module can be executed individually 
        by running the following command:</para>
      <programlisting>
$ python getNetworkInterfaces.py -H localhost -n intelc3850-2
2019-07-04 16:03:47,580 - DEBUG: Started logging
2019-07-04 16:03:47,580 - INFO: Dump NICs
2019-07-04 16:03:47,609 - DEBUG: Login successful on host 'localhost'
2019-07-04 16:03:47,610 - DEBUG: Session token is: 8ae9b103-9e64-11e9-a715-5254007632e2
2019-07-04 16:03:47,626 - DEBUG: Found device with name 'intelc3850-2'
2019-07-04 16:03:47,627 - DEBUG:
----------------- External Network Interfaces for intelc3850-2-----------------
2019-07-04 16:03:47,945 - DEBUG: 0000:01:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
        MacAddress: ac:1f:6b:2d:ee:58sriov(63)
2019-07-04 16:03:47,945 - DEBUG:
2019-07-04 16:03:47,969 - DEBUG:
----------------- Configured External Network Interfaces for intelc3850-2-------------
2019-07-04 16:03:47,969 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
        41d31385-fafd-48fe-b702-ce72fea85478
2019-07-04 16:03:47,969 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
        b0a4b919-95cd-48c2-83ad-28ec233546b2
2019-07-04 16:03:47,969 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
        380ac405-9e51-11e9-a715-5254007632e2
2019-07-04 16:03:47,970 - DEBUG: 0000:03:00.1 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
        MacAddress: 0c:c4:7a:fb:85:ddsriov(7)
2019-07-04 16:03:47,970 - DEBUG:
2019-07-04 16:03:47,991 - DEBUG:
----------------- Configured External Network Interfaces for intelc3850-2-------------
2019-07-04 16:03:47,991 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
        41d31385-fafd-48fe-b702-ce72fea85478
2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
        b0a4b919-95cd-48c2-83ad-28ec233546b2
2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
        380ac405-9e51-11e9-a715-5254007632e2
2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
        MacAddress: 0c:c4:7a:fb:85:dcsriov(7)
2019-07-04 16:03:47,992 - DEBUG:
2019-07-04 16:03:48,012 - DEBUG:
----------------- Configured External Network Interfaces for intelc3850-2-------------
2019-07-04 16:03:48,012 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
        41d31385-fafd-48fe-b702-ce72fea85478
2019-07-04 16:03:48,012 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
        b0a4b919-95cd-48c2-83ad-28ec233546b2
2019-07-04 16:03:48,012 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
        380ac405-9e51-11e9-a715-5254007632e2
2019-07-04 16:03:48,013 - DEBUG:
2019-07-04 16:03:48,013 - INFO: Done
2019-07-04 16:03:48,029 - DEBUG: Logging out and exiting...</programlisting>

    </section>

</section>

    <section id="create_ovs_net_bridge">
      <title>Create an OVS Network Bridge</title>

      <para>Create an OVS Bridge on a device.</para>

      <section id="script_opts_creovs">
        <title>Script Options</title>

        <programlisting>$ python newNetworkBridge.py -h
Usage: newNetworkBridge.py [options]

Create an OVS Bridge on a device.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f OVSFILE, --file=OVSFILE
 File containing OVS bridge Information in JSON format
 -n DEVICENAME, --device-name=DEVICENAME
 Name of the device

 Mandatory options:
 -H/--host, -f/--file, -n/--device-name</programlisting>
      </section>

      <section id="json_creovs">
        <title>Configuring the JSON File</title>

        <para>The new network bridge suite JSON configuration file should
        contain a list of dictionaries, each dictionary indicating the test
        case name and the test case arguments passed to the newNetworkBridge
        Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Creating network bridge LAN ",
 "args": "-f ../../lab_config/intelc3850-2/lan_br.json"
 },
 {
 "name": "Creating network bridge WAN ",
 "args": "-f ../../lab_config/intelc3850-2/wan_br.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample lan_br.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "lan_br",
 "interfaces": ["0000:01:00.1"]
}</programlisting>

        <para><emphasis role="bold">Sample wan_br.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "wan_br",
 "interfaces": ["0000:03:00.2"]
}</programlisting>
      </section>

      <section id="pymod_creovs">
        <title>Running the Python Module</title>

        <para>The newNetworkBridge Python module can be executed individually
        by running the following command line:</para>

        <programlisting>$ python newNetworkBridge.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_br.json -n intelc3850-2
2019-03-07 18:03:30,767 - DEBUG: Started logging
2019-03-07 18:03:30,768 - INFO: New OVS network bridge
2019-03-07 18:03:30,801 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:30,801 - DEBUG: Session token is: 8d454061-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:30,811 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:30,812 - DEBUG: Create new OVS network bridge 'lan_br'
2019-03-07 18:03:37,358 - INFO: Done
2019-03-07 18:03:37,402 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="delete_ovs_net_bridge">
      <title>Delete an OVS Network Bridge</title>

      <para>Delete an OVS Bridge from a device.</para>

      <section id="script_opts_delovs">
        <title>Script Options</title>

        <programlisting>$ python delNetworkBridge.py -h
Usage: delNetworkBridge.py [options]

Delete an OVS Bridge from a device.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f OVSFILE, --file=OVSFILE
 File containing OVS bridge Information in JSON format
 -n DEVICENAME, --device-name=DEVICENAME
 Name of the device

 Mandatory options:
 -H/--host, -f/--file, -n/--device-name</programlisting>
      </section>

      <section id="json_delovs">
        <title>Configuring the JSON File</title>

        <para>The delete network bridge suite JSON configuration file should
        contain a list of dictionaries, each dictionary indicating the test
        case name and the test case arguments passed to the delNetworkBridge
        Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Deleting network bridge LAN ",
 "args": "-f ../../lab_config/intelc3850-2/lan_br.json"
 },
 {
 "name": "Deleting network bridge WAN ",
 "args": "-f ../../lab_config/intelc3850-2/wan_br.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample lan_br.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name" : "lan_br"
}</programlisting>

        <para><emphasis role="bold">Sample wan_br.json configuration
        file:</emphasis></para>

        <programlisting>{
 "name" : "wan_br"
}</programlisting>
      </section>

      <section id="pymod_delovs">
        <title>Running the Python Module</title>

        <para>The delNetworkBridge Python module can be executed individually
        by running the following command line:</para>

        <programlisting>$ python delNetworkBridge.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_br.json -n intelc3850-2
2019-03-07 17:33:51,712 - DEBUG: Started logging
2019-03-07 17:33:51,713 - INFO: Delete OVS network bridge
2019-03-07 17:33:51,751 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:51,752 - DEBUG: Session token is: 68e08711-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:51,768 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:51,768 - DEBUG: Delete OVS network bridge 'lan_br'
2019-03-07 17:33:52,839 - INFO: Done
2019-03-07 17:33:52,872 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="onboard_vnf_bundle">
      <title>Onboard a VNF Bundle</title>

      <para>Onboard a VNF to Enea uCPE Manager.</para>

      <section id="script_opts_onbvnf">
        <title>Script Options</title>

        <programlisting>$ python onboardVNF.py -h
Usage: onboardVNF.py [options]

Onboard a VNF to Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
 Username for FTP
 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
 FTP password
 -P FTPPORT, --ftpPort=FTPPORT
 FTP port
 -b VNFBUNDLE, --bundle=VNFBUNDLE
 File name of VNF bundle in ZIP format

 Mandatory options:
 -H/--host, -b/--bundle</programlisting>
      </section>

      <section id="json_onbvnf">
        <title>Configuring the JSON File</title>

        <para>The onboard VNF suite JSON configuration file should contain a
        list of dictionaries, each dictionary indicating the test case name
        and the test case arguments passed to the onboardVNF Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Onboarding Fortigate VNF ",
 "args": "-b ../../vnf_images/Fortigate.zip"
 }
]</programlisting></para>
      </section>

      <section id="pymod_onbvnf">
        <title>Running the Python Module</title>

        <para>The onboardVNF Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python onboardVNF.py -u admin -p admin -f ftp -w ftp -H localhost -b
../../vnf_images/Fortigate.zip
2019-02-25 16:00:53,890 - DEBUG: Started logging
2019-02-25 16:00:53,890 - INFO: Onboard VNF
2019-02-25 16:00:53,985 - DEBUG: Login successful on host 'localhost'
2019-02-25 16:00:53,985 - DEBUG: Session token is: c421cd03-3905-11e9-a81f525400d08e1d
2019-02-25 16:00:53,994 - DEBUG: FTP file '../../vnf_images/Fortigate.zip' on host
'localhost', port '2021'
2019-02-25 16:00:54,229 - DEBUG: Onboard VNF: Fortigate
2019-02-25 16:00:56,836 - INFO: Done
2019-02-25 16:00:56,861 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="onboard_vnf_image">
      <title>Onboard a VNF Image</title>

      <para>Onboard a VNF image in Enea uCPE Manager based upon its raw
      constituents.</para>

      <section id="script_opts_image">
        <title>Script Options</title>

        <programlisting>$ python onboardVNFRaw.py -h
Usage: onboardVNFRaw.py [options]

Onboard a VNF in Enea uCPE Manager based upon its raw constituents.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
 Username for FTP
 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
 FTP password
 -P FTPPORT, --ftpPort=FTPPORT
 FTP port
 -i IMAGEPATH, --imagePath=IMAGEPATH
 VNF image path
 -b IMAGEINFO, --imageInfo=IMAGEINFO
 File name of VNF image information in JSON format

 Mandatory options:
 -H/--host, -b/--imageInfo, -i/--imagePath</programlisting>
      </section>

      <section id="json_image">
        <title>Configuring the JSON File</title>

        <para>The onboard VNF image suite JSON configuration file should
        contain a list of dictionaries, each dictionary indicating the test
        case name and the test case arguments passed to the onboardVNFRaw
        Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Onboarding Fortigate VNF (wizard API)",
 "args": "-b ../../vnf_config/fortigateImage/fortigateImage.json -i
../../vnf_images/fortios.qcow2"
 }
]</programlisting>

        <para><emphasis role="bold">Sample fortigateImage.json configuration
        file:</emphasis><programlisting>{
 "name" : "fortigateImage",
 "version" : "1.0",
 "description" : "Fortigate VNF Image",
 "provider" : "Fortinet, Inc",
 "numVcpus" : 1,
 "imageFormat" : "QCOW2",
 "memoryInMb" : 1024,
 "storageInGb" : 20,
 "image" : "fortios.qcow2",
 "interfaces" : [
 {
 "name" : "external",
 "type" : "PhysicalPort",
 "description" : "External interface"
 },
 {
 "name" : "in",
 "type" : "PhysicalPort",
 "description" : "Incoming interface"
 },
 {
 "name" : "out",
 "type" : "PhysicalPort",
 "description" : "Outgoing interface"
 }
 ],
 "cloudInitDataSource" : "ConfigDrive",
 "cloudInitDriveType" : "cdrom",
 "cloudInitContentParams" : [
 {
 "path" : "License",
 "description" : "Operational license"
 }
 ]
}</programlisting></para>
      </section>

      <section id="pymod_image">
        <title>Running the Python Module</title>

        <para>The onboardVNFRaw Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python onboardVNFRaw.py -u admin -p admin -f ftp -w ftp -H localhost -b b
../../vnf_config/fortigateImage/fortigateImage.json -i
../../vnf_images/fortios.qcow2
2019-03-07 18:03:37,791 - DEBUG: Started logging
2019-03-07 18:03:37,792 - INFO: Onboard wizard
2019-03-07 18:03:37,859 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:37,859 - DEBUG: Session token is: 91770330-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:37,860 - DEBUG: FTP file '../../vnf_images/fortios.qcow2' on host
'localhost', port '2021'
2019-03-07 18:03:38,027 - DEBUG: Onboard VNF raw: fortios.qcow2
2019-03-07 18:03:41,701 - INFO: Done
2019-03-07 18:03:41,748 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="offboard_vnf">
      <title>Offboard a VNF</title>

      <para>Offboard a VNF from Enea uCPE Manager.</para>

      <section id="script_opts_offimage">
        <title>Script Options</title>

        <programlisting>$ python offboardVNF.py -h
Usage: offboardVNF.py [options]

Offboard a VNF from Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -n VNFDNAME, --vnfdName=VNFDNAME
 Name of VNF descriptor to offboard

 Mandatory options:
 -H/--host, -n/--vnfdName</programlisting>
      </section>

      <section id="json_offimage">
        <title>Configuring the JSON File</title>

        <para>The offboard VNF suite JSON configuration file should contain a
        list of dictionaries, each dictionary indicating the test case name
        and the test case arguments passed to the offboardVNF Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Offboarding Fortigate VNF ",
 "args": "-n fortigateImage"
 }
]</programlisting>
      </section>

      <section id="pymod_offimage">
        <title>Running the Python Module</title>

        <para>The offboardVNF Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python offboardVNF.py -u admin -p admin -H localhost -n fortigateImage
2019-03-07 17:33:56,523 - DEBUG: Started logging
2019-03-07 17:33:56,524 - INFO: Offboard VNF
2019-03-07 17:33:56,557 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:56,557 - DEBUG: Session token is: 6bbe2b90-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:56,682 - DEBUG: Found VNF descriptor with name 'fortigateImage'
2019-03-07 17:33:56,683 - DEBUG: Offboard VNF: fortigateImage
2019-03-07 17:33:56,811 - INFO: Done
2019-03-07 17:33:56,834 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="instantiate_vnf">
      <title>Instantiate a VNF</title>

      <para>Instantiate a VNF via Enea uCPE Manager.</para>

      <section id="script_opts_inst">
        <title>Script Options</title>

        <programlisting>$ python instantiateVNFI.py -h
Usage: instantiateVNFI.py [options]

Instantiate a VNF via Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -t VNFTYPE, --vnfType=VNFTYPE
 VNF Type (Name of VNF descriptor)
 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
 Name of the device
 -f PROPSFILE, --file=PROPSFILE
 File containing VNF instance properties in JSON format

 Mandatory options:
 -H/--host, -t/--vnfType, -n/--device-name, -f/--file</programlisting>
      </section>

      <section id="json_inst">
        <title>Configuring the JSON File</title>

        <para>The instantiate VNF suite JSON configuration file should contain
        a list of dictionaries, each dictionary indicating the test case name
        and the test case arguments passed to the instantiateVNFI Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Instantiate Fortigate VNF ",
 "args": "-t fortigateImage -f
../../vnf_config/fortigateImage/fortigateFWInstance.json"
 }
]</programlisting>

        <para>The VNF instance JSON configuration file is specific to each
        VNF.</para>
      </section>

      <section id="pymod_inst">
        <title>Running the Python Module</title>

        <para>The instantiateVNFI Python module can be executed individually
        by running the following command line:</para>

        <programlisting>$ python instantiateVNFI.py -u admin -p admin -H localhost -n intelc3850-2 -t
fortigateImage -f ../../vnf_config/fortigateImage/fortigateFWInstance.json
2019-03-07 18:03:41,777 - DEBUG: Started logging
2019-03-07 18:03:41,778 - INFO: Instantiate VNF
2019-03-07 18:03:41,813 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:41,815 - DEBUG: Session token is: 93d69e10-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:41,834 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:41,878 - DEBUG: Found VNF descriptor with name 'fortigateImage'
2019-03-07 18:03:41,888 - DEBUG: Encrypt string content:
cloudInit("vnf_config/fortigateImage/fortigateFW.conf")
2019-03-07 18:03:41,889 - DEBUG: Encrypt string content:
License("vnf_config/fortigateImage/fortigateLicense.lic")
2019-03-07 18:03:41,889 - DEBUG: Instantiate fortigateImage VNF on 'intelc3850-2'
2019-03-07 18:03:49,887 - INFO: Done
2019-03-07 18:03:49,921 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="control_vnf_inst">
      <title>Control a VNF Instance</title>

      <para>Controls a VNF instance from Enea uCPE Manager.</para>

      <section id="script_opts_control">
        <title>Script Options</title>

        <programlisting>$ python controlVNFI.py -h
Usage: controlVNFI.py [options]

Controls a VNF instance from Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
 Name of VNF instance
 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
 Name of the device
 -c COMMAND, --command=COMMAND
 Control command (stop, start, pause or resume)

 Mandatory options:
 -H/--host, -i/--vnfInstanceName, -n/--device-name, -c/--command</programlisting>
      </section>

      <section id="json_control">
        <title>Configuring the JSON File</title>

        <para>The control VNF instance suite JSON configuration file should
        contain a list of dictionaries, each dictionary indicating the test
        case name and the test case arguments passed to the controlVNFI Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Pause Fortigate VNF instance",
 "args": "-i fortigateFWInstance -c pause"
 },
 {
 "name": "Resume Fortigate VNF instance",
 "args": "-i fortigateFWInstance -c resume"
 },
 {
 "name": "Stop Fortigate VNF instance ",
 "args": "-i fortigateFWInstance -c stop"
 },
 {
 "name": "Start Fortigate VNF instance",
 "args": "-i fortigateFWInstance -c start"
 }
]</programlisting>
      </section>

      <section id="pymod_control">
        <title>Running the Python Module</title>

        <para>The controlVNFI Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python controlVNFI.py -u admin -p admin -H localhost -n intelc3850-2 -i
fortigateFWInstance -c stop
2019-03-07 18:03:51,991 - DEBUG: Started logging
2019-03-07 18:03:51,992 - INFO: Control VNF
2019-03-07 18:03:52,031 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:52,031 - DEBUG: Session token is: 99ed9ba3-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:52,046 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:52,073 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 18:03:52,073 - DEBUG: Control VNF instance 'intelc3850-2', command: stop
2019-03-07 18:03:53,011 - INFO: Done
2019-03-07 18:03:53,047 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="destroy_vnf_inst">
      <title>Destroy a VNF Instance</title>

      <para>Destroys a VNF instance from Enea uCPE Manager.</para>

      <section id="script_opts_destroy">
        <title>Script Options</title>

        <programlisting>$ python destroyVNFI.py -h
Usage: destroyVNFI.py [options]

Destroys a VNF instance from Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
 Name of VNF instance
 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
 Name of the device

 Mandatory options:
 -H/--host, -i/--vnfInstanceName, -n/--device-name</programlisting>
      </section>

      <section id="json_destroy">
        <title>Configuring the JSON File</title>

        <para>The destroy VNF instance suite JSON configuration file should
        contain a list of dictionaries, each dictionary indicating the test
        case name and the test case arguments passed to the destroyVNFI Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Destroying Fortigate VNF ",
 "args": "-i fortigateFWInstance"
 }
]</programlisting></para>
      </section>

      <section id="pymod_destory">
        <title>Running the Python Module</title>

        <para>The destroyVNFI Python module can be executed individually by
        running the following command line:</para>

        <programlisting>$ python destroyVNFI.py -u admin -p admin -H localhost -n intelc3850-2 -i
fortigateFWInstance
2019-03-07 17:33:51,025 - DEBUG: Started logging
2019-03-07 17:33:51,026 - INFO: Destroy VNF
2019-03-07 17:33:51,119 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:51,119 - DEBUG: Session token is: 68803ea5-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:51,128 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:51,148 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 17:33:51,149 - DEBUG: Destroy VNF: fortigateFWInstance
2019-03-07 17:33:51,655 - INFO: Done
2019-03-07 17:33:51,712 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>
  </section>

  <section id="test_harness">
    <title>Test Harness</title>

    <para>All Test Harness sources are under &lt;AF-TH-install-dir&gt;
    directory, except under the automation_framework sub-directory. See
    chapter 4 for a complete tree listing.</para>

    <para>The Ansible based Test Harness represents an example of how to
    structure all the files needed for creating automated test cases using the
    AF and provides a way to implement them. The ansible.cfg file contains an
    example of the Ansible default configuration. It offers the possibility to
    display the Ansible console output in different ways, by setting the
    stdout_callback to selective or debug. Default is set to selective to
    print only certain tasks. It is recommended to switch on debug when a test
    fails. By setting any_errors_fatal to True, task failures will be
    considered fatal errors (the play execution will stop). The hosts file is
    the Ansible inventory file.</para>

    <para>All the Playbooks that are executing AF python modules are run on
    localhost. New entries have to be created for direct communication over
    SSH with the boards, like [fortigateFW] example. The setup_env.sh script
    sets up the "testHarness" test environment by creating testHarness-venv
    python virtualenv, installing requests needed by Automation Framework
    python modules and installing Ansible. The playbooks directory contains
    all the implemented Ansible Playbooks. For details please refer to chapter
    "Sample Test Cases" from the Enea NFV Access System Test Specification
    document.</para>

    <para>The uCPEM_config directory stores JSON configuration files needed
    for the setup of the uCPE Manager used by TH. One configuration file is
    needed per uCPE Manager installation to be used in the TH. The vnf_image
    directory stores the VNF Images needed by the Ansible Playbooks (i.e. the
    sample test cases).</para>

    <para>The lab_config directory stores the JSON configuration files related
    to a device (devices, NICs and bridges). Each subfolder should be named
    exactly like the device name and should contain all the related
    configuration files needed for the test cases to be run on it.</para>

    <para>The vnf_config directory stores the configuration files related to a
    VNF Descriptor. Typically these include a VNF Image JSON, VNF Instance
    JSON, VNF license and any other files required by the type of the VNF.
    Each subfolder should be named exactly like the name of the VNF Descriptor
    and should contain all the related configuration files needed for test
    cases to be run using this VNF.</para>

    <para>The log directory is created when the setup_env.sh is run. When test
    cases are ran, the Ansible and the Python logs are stored in ansible.log
    and debug.log files, respectively.</para>

    <section id="test_suites">
      <title>Extending functionality - Test Suites</title>

      <para>To extend the functionality of the Test Harness it is typically
      needed that the functionlity of the Automation Framework be also
      extended to cover additional uCPE Manager REST Northbound APIs. The
      extension of the Automation Framework will result in new Python modules
      that have to be created.</para>

      <para>Additional Python modules, that are not related to the
      functionality of the Automation Framework, could be easily integrated
      into Test Harness to aid in the creation of more complex test cases.
      Using the TH one can implement test cases that are run directly on the
      boards with Enea NFV Access, over SSH.</para>

      <para>For a better understanding of the Test Harness functionality and
      how to extend the test suites, please refer to the chapter "Sample Test
      Cases" from the Enea NFV Access System Test Specification document and
      the TH code source.</para>
    </section>
  </section>
</chapter>