1 files changed, 249 insertions, 9 deletions

diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
index e3414f4..fb8ff8d 100644
--- a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
+++ b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
@@ -13,7 +13,7 @@
     TH.</para>
 
     <section id="onb_vnf_image">
-      <title>VNF - Onboard_VNF_Image<remark>all titles are formated with
+      <title>VNF - Onboard a VNF Image<remark>all titles are formated with
       underscores can this be changed or should it be left as
       is?</remark></title>
 
@@ -60,7 +60,7 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     </section>
 
     <section id="offb_vnf">
-      <title>VNF - Offboard_VNF</title>
+      <title>VNF - Offboard a VNF</title>
 
       <para><emphasis role="bold">Description:</emphasis> Removing a VNF
       Descriptor from the uCPE Manager. For details please refer to:</para>
@@ -92,7 +92,7 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     </section>
 
     <section id="add_device">
-      <title>Device - Add_Device</title>
+      <title>Device - Add a device</title>
 
       <para><emphasis role="bold">Description:</emphasis> Adding a uCPE device
       to the uCPE Manager. For details please refer to:</para>
@@ -124,8 +124,248 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
 &lt;Device-name&gt; device already exists!</programlisting></para>
     </section>
 
+    <section id="device_upload_image">
+      <title>Device - Upload a NFV Access image</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Upload a NFV Access image
+      file onto the uCPE Manager. For details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/uploadImage.yml</filename></para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/uploadImage.py</filename></para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Precondition:</emphasis> The image path must
+      already exist.</para>
+
+      <para><emphasis role="bold">Example:</emphasis> <programlisting>ansible-playbook playbooks/uploadImage.yml -e \
+image_path="/tmp/enea-nfv-access-xeon-d6.rootfs.ostree.tar.bz2" -e \
+upgrade_type="xeon_d"</programlisting></para>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>uploadImage.yml</filename> Ansible playbook with the
+      <filename>&lt;Image-path&gt;</filename> and
+      <filename>&lt;Upgrade-type&gt;</filename> as extra-vars:</para>
+
+      <para><programlisting>ansible-playbook playbooks/deleteUpgradeFile.yml -e \
+image_path="&lt;Image-path&gt;" -e upgrade_type="&lt;Upgrade-type&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:</para>
+
+      <para><programlisting>TASK [Upload NFVA image -- Run uploadImage.py module from automation_framework]
+localhost                  : ok=1    changed=1    unreachable=0    failed=0</programlisting><emphasis
+      role="bold">Note:</emphasis> The test will fail if the image file has
+      already been uploaded.</para>
+
+      <para><programlisting>TASK [Upload NFVA image -- Run uploadImage.py module from automation_framework]
+ok=0    changed=0    unreachable=0    failed=1
+
+# debug
+A file with the same name is already uploaded.</programlisting></para>
+    </section>
+
+    <section id="dev_del_upgrade">
+      <title>Device - Delete Upgraded File</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Deleting an uploaded
+      NFV Access image file from the uCPE Manager. For details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/deleteUpgradeFile.yml</filename></para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/deleteUpgradeFile.py</filename></para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Preconditions:</emphasis> The image file
+      must already be uploaded onto the uCPE Manager.</para>
+
+      <para><emphasis role="bold">Example:</emphasis></para>
+
+      <programlisting>ansible-playbook playbooks/deleteUpgradeFile.yml -e \
+image_name="enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2"</programlisting>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>deleteUpgradeFile.yml</filename> Ansible Playbook with the
+      <literal>&lt;Image-name&gt;</literal> as extra-vars:<programlisting>ansible-playbook playbooks/deleteUpgradeFile.yml -e \
+image_name="&lt;Image-name&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:<programlisting>TASK [Remove NFVA image -- Run deleteUpgradeFile.py module from automation_framework]
+localhost                  : ok=1    changed=1    unreachable=0    failed=0</programlisting>
+      <emphasis role="bold">Note:</emphasis> The test will fail if the image
+      file does not exist: <programlisting>TASK [Remove NFVA image -- Run deleteUpgradeFile.py module from automation_framework]
+ok=0    changed=0    unreachable=0    failed=1
+
+# debug
+No oid found for '&lt;image_name&gt;' image name</programlisting></para>
+    </section>
+
+    <section id="dev_clear_info">
+      <title>Device - Clear information about upgrades of uCPE devices</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Clear information
+      about upgrades of uCPE devices. For details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/clearCompletedUpgradesInfo.yml</filename></para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/clearCompletedUpgradesInfo.py</filename></para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Preconditions:</emphasis> No preconditions
+      needed.</para>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>clearCompletedUpgradesInfo.yml</filename> Ansible
+      Playbook:<programlisting>ansible-playbook playbooks/clearCompletedUpgradesInfo.yml</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:<programlisting>TASK [Clear completed info about upgrading -- Run \
+clearCompletedUpgradesInfo.py module from automation framework]]
+localhost                  : ok=1    changed=1    unreachable=0    failed=0</programlisting></para>
+    </section>
+
+    <section id="dev_inst_activ">
+      <title>Device - Install and Activate a NFV Access image</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Installing and
+      Activating a NFV Access image on a uCPE device from the uCPE Manager. For
+      details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/installAndActivate.yml</filename></para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/installAndActivate.py</filename></para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Preconditions:</emphasis> <itemizedlist>
+          <listitem>
+            <para>The device must be previously added to the uCPE Manager
+            instance.</para>
+          </listitem>
+
+          <listitem>
+            <para>The image file must already be uploaded onto the uCPE
+            Manager.</para>
+          </listitem>
+        </itemizedlist></para>
+
+      <para><emphasis role="bold">Example:</emphasis></para>
+
+      <programlisting>ansible-playbook playbooks/installAndActivate.yml -e \
+image_name="enea-nfv-access-xeon-d6.rootfs.ostree.tar.bz2" -e \
+upgrade_type=xeon_d -e device=inteld1521-16"</programlisting>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>installAndActivate.yml</filename> Ansible Playbook with the
+      <literal>&lt;Image-name&gt;</literal>,
+      <literal>&lt;Upgrade-type&gt;</literal>, and the
+      <literal>&lt;Device-name&gt;</literal> as extra-vars:<programlisting>ansible-playbook playbooks/installAndActivate.yml -e \
+image_name="&lt;Image_name&gt;" -e upgrade_type="&lt;Upgrade_type&gt;" -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>TASK \
+[Install And Activate -- Run installAndActivate.py module from automation_framework]
+localhost                  : ok=1    changed=1    unreachable=0    failed=0</programlisting>
+      <emphasis role="bold">Note:</emphasis> The test will fail if the image
+      has already been installed on the uCPE device:<programlisting>TASK \
+[Install And Activate -- Run installAndActivate.py module from automation_framework]
+ok=0    changed=0    unreachable=0    failed=1
+
+# debug
+Duplicate entry - Release already installed</programlisting></para>
+    </section>
+
+    <section id="dev_upload_inst_activ">
+      <title>Device - Upload, Install and Activate a NFV Access image on a uCPE
+      device</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Upload, install and
+      activate a NFV Access image on a uCPE device from the uCPE Manager. For details
+      please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/installNFVAImage.yml</filename></para>
+        </listitem>
+
+        <listitem>
+          <para>The playbook imports the previously described
+          playbooks:<itemizedlist spacing="compact">
+              <listitem>
+                <para><filename>playbook/addDevice.yml</filename></para>
+              </listitem>
+
+              <listitem>
+                <para><filename>playbook/uploadImage.yml</filename></para>
+              </listitem>
+
+              <listitem>
+                <para><filename>playbook/installAndActivate.yml</filename></para>
+              </listitem>
+
+              <listitem>
+                <para><filename>playbook/deleteUpgradeFile.yml</filename></para>
+              </listitem>
+
+              <listitem>
+                <para><filename>playbook/clearCompletedUpgradesInfo.yml</filename></para>
+              </listitem>
+
+              <listitem>
+                <para><filename>playbook/removeDevice.yml</filename></para>
+              </listitem>
+            </itemizedlist></para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Precondition:</emphasis> A device JSON
+      configuration file must be created:<programlisting>&lt;AF-TH-install-dir&gt;/lab_config/&lt;Device-name&gt;/&lt;Device-name&gt;.json</programlisting></para>
+
+      <para><emphasis role="bold">Example:</emphasis></para>
+
+      <programlisting>ansible-playbook playbooks/installNFVAImage.yml -e \
+device="inteld1521-16" -e \
+image_path=/tmp/enea-nfv-access-xeon-d5.rootfs.ostree.tar.bz2 -e \
+image_name=enea-nfv-access-xeon-d5.rootfs.ostree.tar.bz2 -e \
+upgrade_type=xeon_d</programlisting>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>installNFVAImage.yml</filename> Ansible Playbook with the
+      <literal>&lt;Image-path&gt;</literal>,
+      <literal>&lt;Image-name&gt;</literal>,
+      <literal>&lt;Upgrade-type&gt;</literal>, and the
+      <literal>&lt;Device-name&gt;</literal> as extra-vars:<programlisting>ansible-playbook playbooks/installNFVAImage.yml -e \
+device="&lt;Device-name&gt;" -e image_path="&lt;Image-path&gt;" -e \
+image_name="&lt;Image-name&gt;" -e upgrade_type="&lt;Upgrade-type&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:<programlisting>localhost                  : ok=1    changed=1    unreachable=0    failed=0</programlisting>
+      <emphasis role="bold">Note:</emphasis> The test will fail if the one
+      imported playbook fails:<programlisting>ok=0    changed=0    unreachable=0    failed=1</programlisting></para>
+    </section>
+
     <section id="remv_dev">
-      <title>Device - Remove_Device</title>
+      <title>Device - Remove a Device</title>
 
       <para><emphasis role="bold">Description:</emphasis> Removing a uCPE
       device from the uCPE Manager. For details please refer to:</para>
@@ -167,7 +407,7 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     </section>
 
     <section id="bind_nic">
-      <title>Network - Bind_NIC</title>
+      <title>Network - Bind a NIC</title>
 
       <para><emphasis role="bold">Description:</emphasis> Binding a physical
       network interface (NIC) to a device. For details please refer to:</para>
@@ -212,7 +452,7 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     </section>
 
     <section id="unbind_nic">
-      <title>Network - Unbind_NIC</title>
+      <title>Network - Unbind a NIC</title>
 
       <para><emphasis role="bold">Description:</emphasis> Unbinding a physical
       network interface (NIC) from a device. For details please refer
@@ -254,7 +494,7 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     </section>
 
     <section id="create_bri">
-      <title>Network - Create_Bridge</title>
+      <title>Network - Create a Bridge</title>
 
       <para><emphasis role="bold">Description:</emphasis> Creating an OVS
       network bridge on a uCPE device. For details please refer to:</para>
@@ -297,7 +537,7 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     </section>
 
     <section id="remov_bri">
-      <title>Network - Remove_Bridge</title>
+      <title>Network - Remove a Bridge</title>
 
       <para><emphasis role="bold">Description:</emphasis> Removing an OVS
       network bridge from a uCPE device. For details please refer to:</para>
@@ -335,7 +575,7 @@ bridge=&lt;Bridge-name&gt;"</programlisting></para>
     </section>
 
     <section id="config_dpdk">
-      <title>Network - Configure_DPDK</title>
+      <title>Network - Configure a DPDK</title>
 
       <para><emphasis role="bold">Description:</emphasis> Enabling or
       Disabling the DPDK support in OVS. For details please refer to:</para>