path: root/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="sample_testcases">
  <title>Sample Test Cases</title>

  <para>The test cases specified in this chapter are implemented as a Sample
  Test Suite included in the TH.</para>

  <section id="vnf_dev_net_smoke">
    <title>VNF, Device and Network Smoke Test Cases</title>

    <para>The following is an automated test suite that acts as basic smoke
    tests for Enea NFV Access, and as a sanity-check test suite for the AF and
    TH.</para>

    <section id="onb_vnf_image">
      <title>VNF - Onboard_VNF_Image<remark>all titles are formated with
      underscores can this be changed or should it be left as
      is?</remark></title>

      <para><emphasis role="bold">Description: </emphasis>Onboarding a VNF
      Image into the uCPE Manager. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/onboardVNFImage.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/vnf/onboardVNFRaw.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis></para>

      <itemizedlist>
        <listitem>
          <para>Add the VNF Image in the <literal>vnf_image</literal> folder
          in the QCOW2 format: <programlisting>&lt;AF-TH-install-dir&gt;/vnf_image/&lt;VNF-Image-name&gt;.qcow2</programlisting></para>
        </listitem>

        <listitem>
          <para>A VNF Image JSON configuration file is created:
          <programlisting>&lt;AF-TH-install-dir&gt;/vnf_config/&lt;VNF-Descriptor-name&gt;/&lt;VNF-Descriptor-name&gt;.json</programlisting><emphasis
          role="bold">Example:</emphasis><programlisting>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateImage/fortigateImage.json</programlisting></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>onboardVNFImage.yml</filename> Ansible Playbook with the
      <literal>&lt;VNF-Image-name&gt;</literal> and the
      <literal>&lt;VNF-Descriptor-name&gt;</literal> as extra-vars:
      <programlisting>ansible-playbook playbooks/onboardVNFImage.yml -e "vnfb=&lt;VNF-Image-name&gt; \
vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness:<programlisting># Onboard VNF Image task result
&lt;VNF-Descriptor-name&gt; successfully onboarded!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the VNF Image is
      already onboarded. The output will instead contain: <programlisting># debug &lt;VNF-Descriptor-name&gt; already onboarded!</programlisting></para>
    </section>

    <section id="onb_vnf_bundle">
      <title>VNF - Onboard_VNF_Bundle<remark>since we're removing mention of
      bundles is this section still relevant?</remark></title>

      <para><emphasis role="bold">Description:</emphasis> Onboarding a VNF
      Bundle into the uCPE Manager. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/onboardVNFBundle.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/vnf/onboardVNF.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Precondition:</emphasis> Add the VNF Bundle
      in the <literal>vnf_image</literal> folder in the zip format:
      <programlisting><filename>&lt;AF-TH-install-dir&gt;/vnf_image/&lt;VNF-Bundle-name&gt;.zip</filename></programlisting></para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>onboardVNFBundle.yml</filename> Ansible Playbook with the
      <literal>&lt;VNF-Bundle-name&gt;</literal> as extra-vars:
      <programlisting>ansible-playbook playbooks/onboardVNFBundle.yml -e "vnfb=&lt;VNF-Bundle-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Onboard VNF Bundle task result
&lt;VNF-Bundle-name&gt; successfully onboarded!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the VNF Bundle is
      already onboarded. The output will instead contain: <programlisting># debug &lt;VNF-Bundle-name&gt; already onboarded!</programlisting></para>
    </section>

    <section id="offb_vnf">
      <title>VNF - Offboard_VNF</title>

      <para><emphasis role="bold">Description:</emphasis> Removing a VNF
      Descriptor from the uCPE Manager. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/offboardVNF.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/vnf/offboardVNF.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Precondition:</emphasis> The VNF has been
      previously onboarded in the uCPE Manager instance.</para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>offboardVNF.yml</filename> Ansible Playbook with the
      <literal>&lt;VNF-Descriptor-name&gt;</literal> as extra-vars:
      <programlisting>ansible-playbook playbooks/offboardVNF.yml -e "vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Remove Descriptor task result
&lt;VNF-Descriptor-name&gt; was removed!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the VNF
      Descriptor does not exist. The output will instead contain:
      <programlisting># debug No Descriptor with name &lt;VNF-Descriptor-name&gt;!</programlisting></para>
    </section>

    <section id="add_device">
      <title>Device - Add_Device</title>

      <para><emphasis role="bold">Description:</emphasis> Adding a uCPE device
      to the uCPE Manager. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/addDevice.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/addDevice.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Precondition:</emphasis> A device JSON
      configuration file must be created: <programlisting><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</filename></programlisting></para>

      <para><emphasis role="bold">Example:</emphasis> <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/intelc3850-2/intelc3850-2.json</programlisting></para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>addDevice.yml</filename> Ansible playbook with the
      <filename>&lt;Device-name&gt;</filename> as extra-vars: <programlisting>ansible-playbook playbooks/addDevice.yml -e "device=&lt;Device-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Add Device task result
&lt;Device-name&gt; device was added!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the device
      already exists. The output will instead contain: <programlisting># debug
&lt;Device-name&gt; device already exists!</programlisting></para>
    </section>

    <section id="remv_dev">
      <title>Device - Remove_Device</title>

      <para><emphasis role="bold">Description:</emphasis> Removing a uCPE
      device from the uCPE Manager. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/removeDevice.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/removeDevice.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis></para>

      <itemizedlist>
        <listitem>
          <para>The device has to be previously added to the uCPE Manager
          instance.</para>
        </listitem>

        <listitem>
          <para>The device JSON configuration file must exist:
          <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</programlisting></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>removeDevice.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/removeDevice.yml -e "device=&lt;Device-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness:<programlisting># Remove Device task result
&lt;Device-name&gt; device was removed!</programlisting> <emphasis
      role="bold">Note:</emphasis> The test will not fail if the device does
      not exist. The output will contain: <programlisting># debug
&lt;Device-name&gt; device was not found!</programlisting></para>
    </section>

    <section id="bind_nic">
      <title>Network - Bind_NIC</title>

      <para><emphasis role="bold">Description:</emphasis> Binding a physical
      network interface (NIC) to a device. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/bindNIC.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/network/bindNetworkInterface.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis></para>

      <itemizedlist>
        <listitem>
          <para>A device must have been previously added to the uCPE Manager
          instance.</para>
        </listitem>

        <listitem>
          <para>A NIC JSON configuration file must exist: <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;NIC&gt;.json</programlisting></para>

          <para><emphasis role="bold">Example:</emphasis> <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/intelc3850-2/wan_nic.json
&lt;AF-TH-install-dir&gt;/lab_config/intelc3850-2/lan_nic.json</programlisting></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>bindNIC.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal> and
      <literal>&lt;NIC&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/bindNIC.yml -e "device=&lt;Device-name&gt; nic=&lt;NIC&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness:<programlisting># Bind NIC task result
&lt;NIC&gt; binded successfully!</programlisting> <emphasis
      role="bold">Note:</emphasis> The test will not fail if the NIC is
      already bound, it will be unbound and bound again with the provided
      configuration.</para>
    </section>

    <section id="unbind_nic">
      <title>Network - Unbind_NIC</title>

      <para><emphasis role="bold">Description:</emphasis> Unbinding a physical
      network interface (NIC) from a device. For details please refer
      to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/unbindNIC.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/network/unbindNetworkInterface.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis></para>

      <itemizedlist>
        <listitem>
          <para>A NIC is bound to a device in a uCPE Manager instance.</para>
        </listitem>

        <listitem>
          <para>A NIC JSON configuration file exists: <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;NIC&gt;.json</programlisting></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>unbindNIC.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal> and
      <literal>&lt;NIC&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/unbindNIC.yml -e "device=&lt;Device-name&gt; nic=&lt;NIC&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Unbind NIC task result
&lt;NIC&gt; unbinded!</programlisting> <emphasis role="bold">Note:</emphasis>
      The test will not fail if the NIC is not bound. The output will instead
      contain:<programlisting># debug
&lt;NIC&gt; is not binded!</programlisting></para>
    </section>

    <section id="create_bri">
      <title>Network - Create_Bridge</title>

      <para><emphasis role="bold">Description:</emphasis> Creating an OVS
      network bridge on a uCPE device. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/addBridge.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/network/newNetworkBridge.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis><itemizedlist>
          <listitem>
            <para>A NIC is bound to a device in a uCPE Manager
            instance.</para>
          </listitem>

          <listitem>
            <para>A Bridge JSON configuration file exists:<programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Bridge-name&gt;.json</programlisting></para>

            <para><emphasis role="bold">Example:</emphasis><programlisting>&lt;AF-TH-install-dir&gt;/lab_config/intelc3850-2/wan_br.json
&lt;AF-TH-install-dir&gt;/lab_config/intelc3850-2/lan_br.json</programlisting></para>
          </listitem>
        </itemizedlist></para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>addBridge.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal> and the
      <literal>&lt;Bridge-name&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/addBridge.yml -e "device=&lt;Device-name&gt; bridge=&lt;Bridge-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Add Bridge task result
&lt;Bridge-name&gt; network bridge was added!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if there already
      exists a bridge with the same name. It will be deleted and the bridge
      will be created again with the provided configuration.</para>
    </section>

    <section id="remov_bri">
      <title>Network - Remove_Bridge</title>

      <para><emphasis role="bold">Description:</emphasis> Removing an OVS
      network bridge from a uCPE device. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/deleteBridge.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/network/delNetworkBridge.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis><itemizedlist>
          <listitem>
            <para>A Bridge exists in a uCPE Manager instance.</para>
          </listitem>

          <listitem>
            <para>A Bridge JSON configuration file exists: <programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Bridge-name&gt;.json</programlisting></para>
          </listitem>
        </itemizedlist><emphasis role="bold">Action:</emphasis> Run the
      <filename>deleteBridge.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal> and the
      <literal>&lt;Bridge-name&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/deleteBridge.yml -e "device=&lt;Device-name&gt; \
bridge=&lt;Bridge-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Delete Bridge task result
&lt;Bridge-name&gt; network bridge was deleted!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the bridge does
      not exist: <programlisting># debug
&lt;Bridge-name&gt; bridge not found!</programlisting></para>
    </section>
  </section>

  <section id="vnf_deploy_lifecycle">
    <title>VNF Deployment and Lifecycle</title>

    <para>The following details the automated suite that handles the testing
    of the instantiation, lifecycle and destruction of a VNF for Enea NFV
    Access.</para>

    <section id="inst_vnfi">
      <title>Instantiate_VNFI</title>

      <para><emphasis role="bold">Description:</emphasis> Creating a VNF
      instance on a uCPE device. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/instantiateVNFI.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/vnf/instantiateVNFI.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis> <itemizedlist>
          <listitem>
            <para>A VNF Image is onboarded and a device is added to the uCPE
            Manager. Depending on the VNF, other steps may be required.</para>
          </listitem>

          <listitem>
            <para>A VNFI JSON configuration file exists: <programlisting>&lt;AF-TH-install-dir&gt;/vnf_config/&lt;VNF-Descriptor-name&gt;/&lt;VNFI-name&gt;.json</programlisting></para>

            <para><emphasis role="bold">Example:</emphasis> <programlisting>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateImage/fortigateFWInstance.json</programlisting></para>
          </listitem>
        </itemizedlist></para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>instantiateVNFI.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal>,
      <literal>&lt;VNF-Descriptor-name&gt;</literal> and the
      <literal>&lt;VNFI-name&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/instantiateVNFI.yml -e "device=&lt;Device-name&gt; \
vnfd=&lt;VNF-Descriptor-name&gt; vnfi=&lt;VNFI-name&gt;"</programlisting></para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Instantiate VNF task result
&lt;VNFI-name&gt; was instantiated!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the VNF instance
      already exists. The output will instead contain: <programlisting># debug
&lt;VNFI-name&gt; already exists!</programlisting></para>
    </section>

    <section id="control_vnfi">
      <title>Control_VNFI</title>

      <para><emphasis role="bold">Description:</emphasis> Changing the status
      of a VNF instance (Pause, Resume, Stop, Start). For details please refer
      to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/controlVNFI.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/vnf/controlVNFI.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Precondition:</emphasis> A VNF is
      instantiated on a uCPE device.</para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>controlVNFI.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal>,
      <literal>&lt;VNFI-name&gt;</literal> and the
      <literal>&lt;Command&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/controlVNFI.yml -e "device=&lt;Device-name&gt; \
vnfi=&lt;VNFI-name&gt; status=&lt;Command&gt;"</programlisting>Where Command =
      { pause | resume | stop | start }</para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># Change VNFI Status task result
&lt;VNFI-name&gt; status was set to &lt;Command&gt;</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the VNF instance
      does not exist or if the specified command is not valid. Depending on
      the case, the output will contain: <programlisting># debug
&lt;VNFI-name&gt; was not found!</programlisting>or<programlisting># debug
Invalid VNF Instance control command specified - &lt;Command&gt;</programlisting></para>
    </section>

    <section id="destroy_vnfi">
      <title>Destroy_VNFI</title>

      <para><emphasis role="bold">Description:</emphasis> Destroying a VNF
      instance from a uCPE device. For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/destroyVNFI.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/vnf/destroyVNFI.py</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Precondition:</emphasis> A VNF is
      instantiated on a uCPE device.</para>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>destroyVNFI.yml</filename> Ansible Playbook with the
      <literal>&lt;Device-name&gt;</literal> and the
      <filename>&lt;VNFI-name&gt;</filename> as extra-vars: <programlisting>ansible-playbook playbooks/destroyVNFI.yml -e "device=&lt;Device-name&gt; vnfi=&lt;VNFI-name&gt;"</programlisting><emphasis
      role="bold">Result:</emphasis> Output of the test case run using the
      Test Harness:<programlisting># Destroy VNFI task result
&lt;VNFI-name&gt; was destroyed!</programlisting><emphasis
      role="bold">Note:</emphasis> The test will not fail if the VNF instance
      does not exist. The output will instead contain: <programlisting># debug
&lt;VNFI-name&gt; was not found!</programlisting></para>
    </section>
  </section>

  <section id="serv_creat_lifecycle">
    <title>Service Creation and Lifecycle</title>

    <para>This test suite contains more complex test cases designed to verify
    service creation and service lifecycle management. These test cases also
    serve as examples of how different services can be deployed using the
    Automation Framework (AF) and the Test Harness (TH).</para>

    <section id="fortigate_firewall">
      <title>Fortigate VNF as a Firewall</title>

      <para>This test case was implemented in two different ways to exemplify
      both methods supported by the AF and TH to deploy such services.</para>

      <para>Prerequisites needed in order to deploy the FortiGate VNF as a
      Firewall:</para>

      <orderedlist>
        <listitem>
          <para>Onboard the FortiGate VNF Image.</para>
        </listitem>

        <listitem>
          <para>Add a uCPE device.</para>
        </listitem>

        <listitem>
          <para>Bind 2 physical interfaces: <literal>wan_nic</literal> (this
          physical interface has to be connected to the Lab Network) and
          <literal>lan_nic</literal>.</para>
        </listitem>

        <listitem>
          <para>Create 2 bridges: <literal>wan_br</literal> (using the
          <literal>wan_nic</literal> interface) and <literal>lan_br</literal>
          (using the <literal>lan_nic</literal> interface).</para>
        </listitem>

        <listitem>
          <para>Instantiate the FortiGate VNF using the basic Firewall
          configuration and the FortiGate License.</para>
        </listitem>
      </orderedlist>

      <para>For more information please refer to the "FortiGate VNF as a
      Firewall" chapter from the "Enea NFV Access Example Use-cases" manual.
      <remark>olink needed here</remark><note>
          <para>The license and configuration files for the FortiGate VNF are
          not included in the TH and should be obtained from Enea.</para>
        </note></para>

      <section id="fortigate_fw_instance">
        <title>FortigateFWInstance Test</title>

        <para><emphasis role="bold">Description:</emphasis> Instantiate the
        FortiGate VNF as a Firewall and test it using an isolated network
        namespace.</para>

        <para>This example was implemented with the "Test Harness" method,
        based on Ansible Playbooks. For details please refer to:</para>

        <itemizedlist>
          <listitem>
            <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/fortigateFWService/instantiateFortigateFW.yml</filename></para>
          </listitem>

          <listitem>
            <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/fortigateFWService/testFortigateFWInstance.yml</filename></para>
          </listitem>

          <listitem>
            <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/fortigateFWService/cleanupTestFortigateFWInstance.yml</filename></para>
          </listitem>

          <listitem>
            <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/fortigateFWService/cleanupFortigateFWInstance.yml</filename></para>
          </listitem>
        </itemizedlist>

        <para><emphasis role="bold">Preconditions:</emphasis></para>

        <itemizedlist>
          <listitem>
            <para>Add the Fortigate VNF Image
            (<filename>fortios.qcow2</filename>) to the
            <literal>vnf_image</literal> folder.</para>
          </listitem>

          <listitem>
            <para>The device JSON configuration file is created:
            <filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</filename>.</para>
          </listitem>

          <listitem>
            <para>Add device settings in the <literal>hosts</literal> Ansible
            inventory file under <literal>[fortigateFW]</literal> and remove
            the <filename>intelc3850-2</filename> example.</para>

            <para><emphasis role="bold">Example:</emphasis> <programlisting>intelc3850-2 ansible_host=172.24.12.114 ansible_port=22 \
ansible_user=root ansible_pass=root</programlisting></para>
          </listitem>

          <listitem>
            <para>NIC JSON configuration files are created:</para>

            <itemizedlist>
              <listitem>
                <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/wan_nic.json</filename></para>
              </listitem>

              <listitem>
                <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/lan_nic.json</filename></para>
              </listitem>
            </itemizedlist>
          </listitem>

          <listitem>
            <para>Bridge JSON configuration files are created:</para>

            <itemizedlist>
              <listitem>
                <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/wan_br.json</filename></para>
              </listitem>

              <listitem>
                <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/lan_br.json</filename></para>
              </listitem>
            </itemizedlist>
          </listitem>

          <listitem>
            <para>Download the FortiGate VNF Firewall basic configuration file
            from Enea, copy it into the
            <filename>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateImage</filename>
            directory and rename it to
            <filename>fortigateFW.conf</filename>.</para>
          </listitem>

          <listitem>
            <para>Retrieve the FortiGate VNF license file from Fortinet or
            Enea, copy it into the
            <literal>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateImage</literal>
            directory and rename it to
            <filename>fortigateLicense.lic</filename>.</para>

            <para>Please refer to the "FortiGate VNF as a Firewall" chapter
            from the Enea NFV Access Example Use-cases
            manual.<remark>olink</remark></para>
          </listitem>
        </itemizedlist>

        <para><emphasis role="bold">Action:</emphasis> Run the
        <filename>instantiateFortigateFW.yml</filename> Ansible Playbook with
        the <literal>&lt;Device-name&gt;</literal> as
        extra-vars:<programlisting>ansible-playbook playbooks/fortigateFWService/instantiateFortigateFW.yml \
-e "device=&lt;Device-name&gt;"</programlisting></para>

        <para><emphasis role="bold">Result:</emphasis> Output of the test case
        run using the Test Harness: <programlisting># Test FortigateFWInstance task result
FortigateFWInstance tested successfully!</programlisting></para>

        <para><emphasis role="bold">Cleanup:</emphasis> Run the
        <filename>cleanupFortigateFWInstance.yml</filename> Ansible Playbook
        with the <literal>&lt;Device-name&gt;</literal> as extra-vars:
        <programlisting>ansible-playbook playbooks/fortigateFWService/cleanupFortigateFWInstance.yml \
-e "device=&lt;Device-name&gt;"</programlisting></para>
      </section>

      <section id="deploy_fortigate_fw">
        <title>DeployFortigateFW Scenario</title>

        <para><emphasis role="bold">Description:</emphasis> Deploy the
        Fortigate VNF as a Firewall. This example was implemented with the
        "Automation Framework" method, based on the
        <filename>unittestSuite.py</filename> Python module.</para>

        <para>For details please refer to:</para>

        <itemizedlist>
          <listitem>
            <para><literal>&lt;AF-TH-install-dir&gt;/playbooks/unittestSuiteTest/deployFortigateFWScenario.yml</literal></para>
          </listitem>

          <listitem>
            <para><literal>&lt;AF-TH-install-dir&gt;/playbooks/unittestSuiteTest/cleanupFortigateFWScenario.yml</literal></para>
          </listitem>

          <listitem>
            <para><literal>&lt;AF-TH-install-dir&gt;/automation_framework/unittestSuite</literal>
            directory.</para>
          </listitem>
        </itemizedlist>

        <para><emphasis role="bold">Preconditions:</emphasis></para>

        <itemizedlist>
          <listitem>
            <para>Add the FortiGate VNF Image
            (<filename>fortios.qcow2</filename>) to the
            <literal>vnf_image</literal> folder.</para>
          </listitem>

          <listitem>
            <para>The device JSON configuration file is created: </para>

            <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</filename>.</para>
          </listitem>

          <listitem>
            <para>The NIC JSON configuration files are created:</para>

            <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/wan_nic.json</filename></para>

            <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/lan_nic.json</filename></para>
          </listitem>

          <listitem>
            <para>The Bridge JSON configuration files are created:</para>

            <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/wan_br.json</filename></para>

            <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/lan_br.json</filename></para>
          </listitem>

          <listitem>
            <para>Download the FortiGate VNF Firewall basic configuration from
            Enea, copy it into the
            <literal>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateImage</literal>
            directory and rename it to
            <filename>fortigateFW.conf</filename>.</para>
          </listitem>

          <listitem>
            <para>Retrieve the FortiGate VNF license file from Fortinet or
            Enea, copy it into the
            <literal>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateImage</literal>
            directory and rename it to
            <filename>fortigateLicense.lic</filename>.</para>

            <para>For more details, please refer to:</para>

            <itemizedlist>
              <listitem>
                <para>The "FortiGate VNF as a Firewall" chapter from the Enea
                NFV Access Example Use-cases manual.<remark>olink
                needed</remark></para>
              </listitem>

              <listitem>
                <para>The "Python Unit-Test Suite" chapter from the Enea NFV
                Access Automation Framework and Test Harness User
                Guide.</para>
              </listitem>
            </itemizedlist>
          </listitem>
        </itemizedlist>

        <para><emphasis role="bold">Action:</emphasis> Run the
        <filename>deployFortigateFWScenario.yml</filename> Ansible Playbook
        with the <literal>&lt;Device-name&gt;</literal> as extra-vars:
        <programlisting>ansible-playbook playbooks/unittestSuiteTest/deployFortigateFWScenario.yml \
-e "device=&lt;Device-name&gt;"</programlisting></para>

        <para><emphasis role="bold">Result:</emphasis> Output of the test case
        run using the Test Harness: <programlisting># unittestSuite Deploy Test task result
FortigateFW Scenario deployed successfully!</programlisting></para>

        <para><emphasis role="bold">Cleanup:</emphasis> Run the
        <filename>cleanupFortigateFWScenario.yml</filename> Ansible Playbook
        with the <literal>&lt;Device-name&gt;</literal> as extra-vars:
        <programlisting>ansible-playbook playbooks/unittestSuiteTest/cleanupFortigateFWScenario.yml \
-e "device=&lt;Device-name&gt;"</programlisting></para>
      </section>
    </section>

    <section id="chained_vnf">
      <title>chainedVNFsService</title>

      <para><emphasis role="bold">Description:</emphasis> This sample test
      case corresponds to the "VNF Chaining Example Use-case" from the Enea
      NFV Access Example Use-cases manual.</para>

      <para>For details please refer to:</para>

      <itemizedlist>
        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/chainedVNFsService/chainedVNFsService.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/chainedVNFsService/testChainedVNFsService.yml</filename></para>
        </listitem>

        <listitem>
          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/chainedVNFsService/cleanupChainedVNFsService.yml</filename></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Preconditions:</emphasis></para>

      <itemizedlist>
        <listitem>
          <para>Add the Fortigate VNF Image
          (<filename>fortios.qcow2</filename>) to the
          <literal>vnf_image</literal> folder.</para>
        </listitem>

        <listitem>
          <para>Add the Juniper vSRX VNF Image
          (<filename>juniper.qcow2</filename>) to the
          <literal>vnf_image</literal> folder.</para>
        </listitem>

        <listitem>
          <para>The device JSON configuration file(s) is created, e.g.:</para>

          <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</filename>.</para>
        </listitem>

        <listitem>
          <para>Add device settings in the <literal>hosts</literal> Ansible
          inventory file under <literal>[chainedVNFs]</literal>. Keep both
          devices, the "site1" and "site2" entries, and update the values for
          <literal>ansible_host</literal>, <literal>ansible_port</literal>,
          <literal>ansible_user</literal> and <literal>ansible_pass</literal>,
          as applicable.</para>

          <para><emphasis role="bold">Example:</emphasis></para>

          <para><programlisting>site1 ansible_host=172.24.14.157 ansible_port=22 ansible_user=root \
ansible_pass=root</programlisting></para>

          <para><programlisting>site2 ansible_host=172.24.14.50 ansible_port=22 ansible_user=root \
ansible_pass=root</programlisting></para>
        </listitem>

        <listitem>
          <para>NIC JSON configuration files are created for each of the
          devices, where <literal>mgmt_nic</literal> is connected to the DHCP
          from the Lab Network and <literal>wan_nic</literal> is connected
          back to back to the other device:</para>

          <itemizedlist>
            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/mgmt_nic.json</filename></para>
            </listitem>

            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/wan_nic.json</filename></para>
            </listitem>

            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/lan_nic.json</filename></para>
            </listitem>
          </itemizedlist>
        </listitem>

        <listitem>
          <para>Bridge JSON configuration files are created for each of the
          devices:</para>

          <itemizedlist>
            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/vnf_mgmt_br.json</filename></para>
            </listitem>

            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/sfc_br.json</filename></para>
            </listitem>

            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/wan_br.json</filename></para>
            </listitem>

            <listitem>
              <para><filename>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/lan_br.json</filename></para>
            </listitem>
          </itemizedlist>

          <para>Note that sample configuration files needed for devices' NICs
          and bridges can be found in:
          <literal>&lt;AF-TH-install-dir&gt;/lab_config/inteld1521-1</literal>
          and
          <literal>&lt;AF-TH-install-dir&gt;/lab_config/inteld1521-2</literal>.</para>
        </listitem>

        <listitem>
          <para>Retrieve the FortiGate VNF Firewall basic configuration files
          from Enea (<filename>FortiFW-Site1.conf</filename> and
          <filename>FortiFW-Site2.conf</filename>), and copy them into the
          <literal>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateFWImage</literal>
          directory.</para>
        </listitem>

        <listitem>
          <para>Retrieve the FortiGate VNF license file from Fortinet or Enea,
          copy it into the
          <literal>&lt;AF-TH-install-dir&gt;/vnf_config/fortigateFWImage</literal>
          directory and rename it to
          <filename>fortigateLicense.lic</filename>.</para>
        </listitem>

        <listitem>
          <para>Retrieve the Juniper vSRX basic configuration files from Enea
          (<filename>vSRX-Site1.iso</filename> and
          <filename>vSRX-Site2.iso</filename>), and copy them into the
          <literal>&lt;AF-TH-install-dir&gt;/vnf_config/junipervSRXImage</literal>
          directory.</para>
        </listitem>

        <listitem>
          <para>Retrieve the <filename>vSRX-domain-update-script</filename>
          from Enea and copy it into the <literal>junipervSRXImage</literal>
          directory.</para>

          <para>Please refer to the "VNF Chaining Example Use-case" chapter
          from the Enea NFV Access Example Use-cases manual for additional
          information about preconditions.<remark>olink to this
          chapter</remark></para>
        </listitem>
      </itemizedlist>

      <para><emphasis role="bold">Action:</emphasis> Run the
      <filename>chainedVNFsService.yml</filename> Ansible Playbook as
      follows:<programlisting>ansible-playbook playbooks/chainedVNFsService/chainedVNFsService.yml \
-e "site1=inteld1521-1 site2=inteld1521-2 arch=XeonD"</programlisting></para>

      <para>Note that "arch" may either be { XeonD | AtomC } depending on the
      target set chosen.</para>

      <para><emphasis role="bold">Result:</emphasis> Output of the test case
      run using the Test Harness: <programlisting># testChainedVNFsService task result
******************************************************************************
 * site1 - changed=False ----------------------------------------------
----
&lt;site1_lan-ip&gt; ---&gt; &lt;site2_lan-ip&gt;
LAN-to-LAN connectivity (through VPN tunnel)tested successfully!</programlisting></para>

      <para><emphasis role="bold">Cleanup:</emphasis> Run the
      <filename>cleanupChainedVNFsService.yml</filename> Ansible Playbook as
      follows: <programlisting>ansible-playbook playbooks/chainedVNFsService/cleanupChainedVNFsService.yml \
-e "site1=inteld1521-1 site2=inteld1521-2 arch=XeonD"</programlisting></para>
    </section>
  </section>
</chapter>