Updated the documentation for the new playbook WaitDeviceUP.yml.

Change-Id: Ic3a7341f7f7c66fadb5c6a284941e62d07ce9bd3
Signed-off-by: mrpa <miruna.paun@enea.com>

3 files changed, 128 insertions, 50 deletions

diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml b/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml
index 1be36cb..98ac9ff 100644
--- a/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml
+++ b/doc/book-enea-nfv-access-system-test-specification/doc/configuration.xml
@@ -6,28 +6,43 @@
     <title>Test Objects</title>
 
     <para>The test objects for the Test Harness are the Enea NFV Access and
-    Enea uCPE Manager installations performed as indicated in chapter 3 of the
-    Enea NFV Access Automation Framework and Test Harness User
-    Guide.<remark>olink needed.</remark></para>
+    Enea uCPE Manager installations performed as indicated in the <olink
+    targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
+    targetptr="components">Components chapter of <xi:include
+    href="../../s_docbuild/olinkdb/pardoc-names.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>.</para>
   </section>
 
   <section id="test_env">
     <title>Test Environment</title>
 
-    <para>To set up the required Test Harness environment please refer to the
-    "Environment" chapter from the Enea NFV Access Automation Framework and
-    Test Harness User Guide.<remark>olink needed.</remark></para>
+    <para>To set up the required Test Harness environment please refer to
+    section <olink targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
+    targetptr="envrion">Envrionment in the <xi:include
+    href="../../s_docbuild/olinkdb/pardoc-names.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>
+    .</para>
   </section>
 
   <section id="precon_exe_steps">
     <title>Preconditions and Execution</title>
 
-    <para>Please refer to the "Prerequisites" and "Installation and Initial
-    Setup" chapters from Enea NFV Access Automation Framework and Test Harness
-    User Guide <remark>olinks needed.</remark> for more details.</para>
+    <para>Please refer to section <olink
+    targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
+    targetptr="prerequisites">Prerequisites in the <xi:include
+    href="../../s_docbuild/olinkdb/pardoc-names.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>
+    and section <olink targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
+    targetptr="initial_setup">Installation and Initial Setup in the<xi:include
+    href="../../s_docbuild/olinkdb/pardoc-names.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>
+    for more details.</para>
 
     <para>For detailed execution steps of the sample test cases included with
-    the Test Harness please see chapter 3 in this document. <remark>xref to
-    the next chapter needed.</remark></para>
+    the Test Harness please see the following chapter.</para>
   </section>
 </chapter>
\ No newline at end of file
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml
index d23a073..7afbfb6 100644
--- a/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml
+++ b/doc/book-enea-nfv-access-system-test-specification/doc/overview.xml
@@ -13,7 +13,7 @@
       <title>Definitions</title>
 
       <tgroup cols="2">
-        <colspec align="center" />
+        <colspec align="left" />
 
         <thead>
           <row>
@@ -38,7 +38,7 @@
       <title>Acronyms</title>
 
       <tgroup cols="2">
-        <colspec align="center" />
+        <colspec align="left" />
 
         <thead>
           <row>
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
index fb8ff8d..95d45ce 100644
--- a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
+++ b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml
@@ -13,9 +13,7 @@
     TH.</para>
 
     <section id="onb_vnf_image">
-      <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>
+      <title>VNF - Onboard a VNF Image</title>
 
       <para><emphasis role="bold">Description: </emphasis>Onboarding a VNF
       Image into the uCPE Manager. For details please refer to:</para>
@@ -127,8 +125,8 @@ vnfd=&lt;VNF-Descriptor-name&gt;"</programlisting></para>
     <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>
+      <para><emphasis role="bold">Description:</emphasis> Upload a NFV Access
+      image file onto the uCPE Manager. For details please refer to:</para>
 
       <itemizedlist>
         <listitem>
@@ -174,7 +172,8 @@ A file with the same name is already uploaded.</programlisting></para>
       <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>
+      NFV Access image file from the uCPE Manager. For details please refer
+      to:</para>
 
       <itemizedlist>
         <listitem>
@@ -243,8 +242,8 @@ localhost                  : ok=1    changed=1    unreachable=0    failed=0</pro
       <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>
+      Activating a NFV Access image on a uCPE device from the uCPE Manager.
+      For details please refer to:</para>
 
       <itemizedlist>
         <listitem>
@@ -296,12 +295,12 @@ 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>
+      <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>
+      activate a NFV Access image on a uCPE device from the uCPE Manager. For
+      details please refer to:</para>
 
       <itemizedlist>
         <listitem>
@@ -364,6 +363,48 @@ image_name="&lt;Image-name&gt;" -e upgrade_type="&lt;Upgrade-type&gt;"</programl
       imported playbook fails:<programlisting>ok=0    changed=0    unreachable=0    failed=1</programlisting></para>
     </section>
 
+    <section id="wait_dev">
+      <title>Device - Wait a Device</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Wait for a uCPE
+      device to connect to the uCPE Manager. For details please refer
+      to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/waitDeviceUp.yml</filename></para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/device/waitDeviceUp.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>waitDeviceUp.yml</filename> Ansible Playbook with the
+      <literal>&lt;Device-name&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/waitDeviceUp.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># Wait Device task result
+&lt;Device-name&gt; device is connected!</programlisting> <emphasis
+      role="bold">Note:</emphasis> The test will fail if the device does not
+      exist or it is not connected.</para>
+    </section>
+
     <section id="remv_dev">
       <title>Device - Remove a Device</title>
 
@@ -426,8 +467,8 @@ image_name="&lt;Image-name&gt;" -e upgrade_type="&lt;Upgrade-type&gt;"</programl
 
       <itemizedlist>
         <listitem>
-          <para>A device must have been previously added to the uCPE Manager
-          instance.</para>
+          <para>A device must have been previously added and connected to the
+          uCPE Manager instance.</para>
         </listitem>
 
         <listitem>
@@ -592,8 +633,8 @@ bridge=&lt;Bridge-name&gt;"</programlisting></para>
 
       <para><emphasis role="bold">Precondition: </emphasis></para>
 
-      <para>A device must have been previously added to the uCPE Manager
-      instance.</para>
+      <para>A device must have been previously added and connected to the uCPE
+      Manager instance.</para>
 
       <para><emphasis role="bold">Action:</emphasis> Run the
       <filename>configDPDK.yml</filename> Ansible Playbook with the
@@ -619,7 +660,7 @@ DEBUG: Set DPDK state to &lt;enable/disable&gt;</programlisting><emphasis
     Access.</para>
 
     <section id="inst_vnfi">
-      <title>Instantiate_VNFI</title>
+      <title>Instantiating a VNFI</title>
 
       <para><emphasis role="bold">Description:</emphasis> Creating a VNF
       instance on a uCPE device. For details please refer to:</para>
@@ -636,8 +677,9 @@ DEBUG: Set DPDK state to &lt;enable/disable&gt;</programlisting><emphasis
 
       <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>
+            <para>A VNF Image is onboarded and a device is added and connected
+            to the uCPE Manager. Depending on the VNF, other steps may be
+            required.</para>
           </listitem>
 
           <listitem>
@@ -663,7 +705,7 @@ vnfd=&lt;VNF-Descriptor-name&gt; vnfi=&lt;VNFI-name&gt;"</programlisting></para>
     </section>
 
     <section id="control_vnfi">
-      <title>Control_VNFI</title>
+      <title>Controlling a VNFI</title>
 
       <para><emphasis role="bold">Description:</emphasis> Changing the status
       of a VNF instance (Pause, Resume, Stop, Start). For details please refer
@@ -701,7 +743,7 @@ Invalid VNF Instance control command specified - &lt;Command&gt;</programlisting
     </section>
 
     <section id="destroy_vnfi">
-      <title>Destroy_VNFI</title>
+      <title>Destroying a VNFI</title>
 
       <para><emphasis role="bold">Description:</emphasis> Destroying a VNF
       instance from a uCPE device. For details please refer to:</para>
@@ -722,7 +764,8 @@ Invalid VNF Instance control command specified - &lt;Command&gt;</programlisting
       <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
+      <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
@@ -751,11 +794,16 @@ Invalid VNF Instance control command specified - &lt;Command&gt;</programlisting
 
       <orderedlist>
         <listitem>
-          <para>Onboard the FortiGate VNF Image.</para>
+          <para>Add a uCPE device.</para>
         </listitem>
 
         <listitem>
-          <para>Add a uCPE device.</para>
+          <para>Wait for the uCPE device to be connected in the Enea uCPE
+          Manager.</para>
+        </listitem>
+
+        <listitem>
+          <para>Onboard the FortiGate VNF Image.</para>
         </listitem>
 
         <listitem>
@@ -884,9 +932,13 @@ ansible_user=root ansible_pass=root</programlisting></para>
             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>
+            <para>For more information please refer to section <olink
+            targetdoc="book_enea_nfv_access_example_usecases"
+            targetptr="fortigate_firewall_uc_1">FortiGate VNF as a Firewall in
+            the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
+            xmlns:xi="http://www.w3.org/2001/XInclude"
+            xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
+            Manual.</para>
           </listitem>
         </itemizedlist>
 
@@ -982,15 +1034,23 @@ FortigateFWInstance tested successfully!</programlisting></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>
+                <para>Section <olink
+                targetdoc="book_enea_nfv_access_example_usecases"
+                targetptr="fortigate_firewall_uc_1">FortiGate VNF as a
+                Firewall in the <xi:include
+                href="../../s_docbuild/olinkdb/pardoc-names.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude"
+                xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
+                Manual.</para>
               </listitem>
 
               <listitem>
-                <para>The "Python Unit-Test Suite" chapter from the Enea NFV
-                Access Automation Framework and Test Harness User
-                Guide.</para>
+                <para>Section <olink
+                targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
+                targetptr="python_testsuite">Python Unit-Test Suite in
+                <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude"
+                xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /></olink>.</para>
               </listitem>
             </itemizedlist>
           </listitem>
@@ -1154,10 +1214,13 @@ ansible_pass=root</programlisting></para>
           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>
+          <para>Please refer to the Chapter concerning the <olink
+          targetdoc="book_enea_nfv_access_example_usecases"
+          targetptr="vnf_chaining">VNF Chaining Example Use-case in the
+          <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xpointer="element(book_enea_nfv_access_example_usecases/1)" /></olink>
+          manual for additional information about preconditions.</para>
         </listitem>
       </itemizedlist>