In book-enea-nfv-access-auto-fw-th-user-guide

New Sections 4.1.22-4.1.25
In book-enea-nfv-access-system-test-specification
New Sections 3.1.16-3.1.19.

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

2 files changed, 474 insertions, 2 deletions

diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index 888db4a..b7de1af 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
@@ -2007,12 +2007,14 @@ Options:
         <filename>installAndActivate</filename> Python module.</para>
 
         <para><emphasis role="bold">Sample unit-test JSON file
-        format:</emphasis><programlisting>[
+        format:</emphasis></para>
+
+        <programlisting>[
  {
  "name": "Install and activate NFVA image on uCPE device from uCPE Manager",
  "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16"
  }
-]</programlisting></para>
+]</programlisting>
       </section>
 
       <section id="pymod_install_activate">
@@ -2117,6 +2119,310 @@ Options:
 2020-02-28 12:51:56,025 - DEBUG: Logging out and exiting...</programlisting>
       </section>
     </section>
+
+    <section id="upload_custom_script">
+      <title>Uploading a Custom Script to the uCPE Manager</title>
+
+      <para>Steps and options on how to upload a custom script to the uCPE
+      Manager are described below.</para>
+
+      <section id="script_opts_upload_custom_script">
+        <title>Script Options</title>
+
+        <programlisting>$ python customScripts/upload.py -h
+2020-04-14 10:26:23,582 - INFO: Upload Custom Script
+Usage: upload.py [options]
+
+Add a Custom Script 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 CUSTOMSCRIPT, --file=CUSTOMSCRIPT
+                        Custom Script File
+  -e PHASE, --phase=PHASE
+                        Execution phase. Must be one of the following: once-
+                        before-startup | always-before-startup | once-after-
+                        startup | always-after-startup
+
+  Mandatory options:
+    -H/--host, -f/--file, -e/--phase</programlisting>
+      </section>
+
+      <section id="json_upload_custom_script">
+        <title>Configuring the JSON File</title>
+
+        <para>The JSON configuration file needed to upload a Custom Script to
+        the uCPE Manager must contain a list of dictionaries. Each dictionary
+        indicates the test case name and the test case arguments passed to the
+        <filename>customScripts/upload</filename> Python module.</para>
+
+        <para><emphasis role="bold">Sample unit-test JSON file
+        format:</emphasis></para>
+
+        <programlisting>[
+ {
+  "name": "Uploading a Custom Script to the uCPE Manager",
+  "args": "-f ../../lab_config/customScripts/test_success_after_always \
+  -e always-after-startup"
+ }
+]</programlisting>
+      </section>
+
+      <section id="pymod_upload_custom_script">
+        <title>Running the Python Module</title>
+
+        <para>The <filename>customScripts/upload</filename> Python module can
+        be executed individually by running the following command line:</para>
+
+        <programlisting>$ python automation_framework/customScripts/upload.py \
+-f lab_config/customScripts/test_success_after_always -e always-after-startup
+2020-04-14 14:08:02,824 - DEBUG: Started logging
+2020-04-14 14:08:02,915 - INFO: Upload Custom Script
+2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109'
+2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f
+2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \
+Content: #!/bin/bash
+echo test_success_after_always
+2020-04-14 14:08:03,138 - INFO: Done
+2020-04-14 14:08:03,169 - DEBUG: Logging out and exiting...</programlisting>
+      </section>
+    </section>
+
+    <section id="upload_custom_script_device">
+      <title>Uploading a Custom Script from the uCPE Manager to a
+      Device</title>
+
+      <para>Steps and options on how to upload a custom script from the uCPE
+      Manager to a Device are described below.</para>
+
+      <section id="script_opts_upload_custom_script_device">
+        <title>Script Options</title>
+
+        <programlisting>$ python customScripts/uploadOnDevice.py -h
+2020-04-14 10:27:05,614 - INFO: Upload Custom Script on Device
+Usage: uploadOnDevice.py [options]
+
+Add a Custom Script to 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
+  -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
+                        Custom Script Name that resides on Enea uCPE Manager
+  -e PHASE, --phase=PHASE
+                        Execution phase. Must be one of the following: once-
+                        before-startup | always-before-startup | once-after-
+                        startup | always-after-startup
+  -n DEVICENAME, --device-name=DEVICENAME
+                        Name of the device
+  -r, --reboot          Reboot the device after uploading
+
+  Mandatory options:
+    -H/--host, -c/--customScriptName, -e/--phase, -n/--device-name</programlisting>
+      </section>
+
+      <section id="json_upload_custom_script_device">
+        <title>Configuring the JSON File</title>
+
+        <para>The JSON configuration file needed to upload a Custom Script
+        from the uCPE Manager to a Device must contain a list of dictionaries.
+        Each dictionary indicates the test case name and the test case
+        arguments passed to the
+        <filename>customScripts/uploadOnDevice</filename> Python
+        module.</para>
+
+        <para><emphasis role="bold">Sample unit-test JSON file
+        format:</emphasis></para>
+
+        <programlisting>[
+{
+"name": "Uploading a Custom Script from uCPE Manager to device",
+"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6"
+}
+]</programlisting>
+      </section>
+
+      <section id="pymod_upload_custom_script_device">
+        <title>Running the Python Module</title>
+
+        <para>The <filename>customScripts/uploadOnDevice</filename> Python
+        module can be executed individually by running the following command
+        line:</para>
+
+        <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \
+test_success_after_always -e always-after-startup -n inteld1521-6
+2020-04-14 14:26:26,205 - DEBUG: Started logging
+2020-04-14 14:26:26,206 - INFO: Upload Custom Script on Device
+2020-04-14 14:26:26,251 - DEBUG: Login successful on host '172.24.3.109'
+2020-04-14 14:26:26,252 - DEBUG: Session token is: 28ebcb10-7e4b-11ea-835c-02423a1c239f
+2020-04-14 14:26:26,286 - DEBUG: Found device with name 'inteld1521-6'
+2020-04-14 14:26:26,287 - DEBUG: Upload test_success_after_always to inteld1521-6
+2020-04-14 14:26:26,314 - INFO: Done
+2020-04-14 14:26:26,341 - DEBUG: Logging out and exiting...</programlisting>
+      </section>
+    </section>
+
+    <section id="delete_custom_script">
+      <title>Removing a Custom Script from the uCPE Manager</title>
+
+      <para>Steps and options on how to remove a custom script from the uCPE
+      Manager are described below.</para>
+
+      <section id="script_opts_delete_custom_script">
+        <title>Script Options</title>
+
+        <programlisting>$ python customScripts/delete.py -h
+2020-04-14 14:36:52,010 - INFO: Delete Custom Script on uCPE Manager
+Usage: delete.py [options]
+
+Delete a Custom Script 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
+  -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
+                        Custom Script Name that resides on a Device
+  -e PHASE, --phase=PHASE
+                        Execution phase. Must be one of the following: once-
+                        before-startup | always-before-startup | once-after-
+                        startup | always-after-startup
+
+  Mandatory options:
+    -H/--host, -e/--phase</programlisting>
+      </section>
+
+      <section id="json_delete_custom_script">
+        <title>Configuring the JSON File</title>
+
+        <para>The JSON configuration file needed to remove a Custom Script
+        from the uCPE Manager<remark>did you mean device or uCPE
+        Manager?</remark> must contain a list of dictionaries. Each dictionary
+        indicates the test case name and the test case arguments passed to the
+        <filename>customScripts/delete</filename> Python module.</para>
+
+        <para><emphasis role="bold">Sample unit-test JSON file
+        format:</emphasis></para>
+
+        <programlisting>[
+{
+"name": "Removing a Custom Script from uCPE Manager",
+"args": "-c test_success_after_always -e always-after-startup"
+}
+]</programlisting>
+      </section>
+
+      <section id="pymod_delete_custom_script">
+        <title>Running the Python Module</title>
+
+        <para>The <filename>customScripts/delete</filename> Python module can
+        be executed individually by running the following command line:</para>
+
+        <programlisting>$ python automation_framework/customScripts/delete.py -c \
+test_success_after_always -e always-after-startup
+2020-04-14 14:39:22,042 - DEBUG: Started logging
+2020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager
+2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109'
+2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f
+2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always'
+2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \
+phase always-after-startup from uCPE Manager
+2020-04-14 14:39:22,118 - INFO: Done
+2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting>
+      </section>
+    </section>
+
+    <section id="delete_custom_script_device">
+      <title>Removing a Custom Script from a Device</title>
+
+      <para>Steps and options on how to remove a custom script from a device
+      are described below.</para>
+
+      <section id="script_opts_delete_custom_script_device">
+        <title>Script Options</title>
+
+        <programlisting>$ python customScripts/deleteOnDevice.py -h
+2020-04-14 10:27:23,536 - INFO: Delete Custom Script on Device
+Usage: deleteOnDevice.py [options]
+
+Delete a Custom Script 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
+  -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
+                        Custom Script Name that resides on a Device
+  -e PHASE, --phase=PHASE
+                        Execution phase. Must be one of the following: once-
+                        before-startup | always-before-startup | once-after-
+                        startup | always-after-startup
+  -n DEVICENAME, --device-name=DEVICENAME
+                        Name of the device
+
+  Mandatory options:
+    -H/--host, -n/--device-name</programlisting>
+      </section>
+
+      <section id="json_delete_custom_script_device">
+        <title>Configuring the JSON File</title>
+
+        <para>The JSON configuration file needed to remove a Custom Script
+        from a device must contain a list of dictionaries. Each dictionary
+        indicates the test case name and the test case arguments passed to the
+        <filename>customScripts/deleteOnDevice</filename> Python
+        module.</para>
+
+        <para><emphasis role="bold">Sample unit-test JSON file
+        format:</emphasis></para>
+
+        <programlisting>[
+{
+"name": "Removing a Custom Script from device",
+"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6"
+}
+]</programlisting>
+      </section>
+
+      <section id="pymod_delete_custom_script_delete">
+        <title>Running the Python Module</title>
+
+        <para>The <filename>customScripts/deleteOnDevice</filename> Python
+        module can be executed individually by running the following command
+        line:</para>
+
+        <programlisting>$ python automation_framework/customScripts/deleteOnDevice.py -c \
+test_success_after_always -e always-after-startup -n inteld1521-6
+2020-04-14 14:33:52,288 - DEBUG: Started logging
+2020-04-14 14:33:52,288 - INFO: Delete Custom Script on Device
+2020-04-14 14:33:52,327 - DEBUG: Login successful on host '172.24.3.109'
+2020-04-14 14:33:52,327 - DEBUG: Session token is: 32cde4f0-7e4c-11ea-835c-02423a1c239f
+2020-04-14 14:33:52,349 - DEBUG: Found device with name 'inteld1521-6'
+2020-04-14 14:33:52,349 - DEBUG: Delete test_success_after_always, \
+phase always-after-startup from inteld1521-6
+2020-04-14 14:33:52,373 - INFO: Done
+2020-04-14 14:33:52,391 - DEBUG: Logging out and exiting...</programlisting>
+      </section>
+    </section>
   </section>
 
   <section id="test_harness">
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 95d45ce..ab611a1 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
@@ -650,6 +650,172 @@ DEBUG: Set DPDK state to &lt;enable/disable&gt;</programlisting><emphasis
       role="bold">Note:</emphasis> DPDK use cannot be disabled if DPDK
       interfaces are configured. The task will fail in this case.</para>
     </section>
+
+    <section id="cs_upload">
+      <title>Custom Scripts - Upload a Custom Script to the uCPE
+      Manager</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Upload a Custom
+      Script to the uCPE Manager. For details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/uploadCustomScript.yml</filename>.</para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/customScripts/upload.py</filename>.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Precondition:</emphasis></para>
+
+      <para><literal>lab_config/customScripts</literal> must contain a Custom
+      Script file.</para>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>uploadCustomScript.yml</filename> Ansible Playbook with the
+      <literal>&lt;scriptName&gt;</literal> and
+      <literal>&lt;phase&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/uploadCustomScript.yml -e "scriptName=&lt;scriptName&gt; \
+phase=
+&lt;always-after-startup/once-after-startup/always-before-startup/once-before-startup&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:</para>
+
+      <programlisting># Upload Custom Script task result
+DEBUG: "{{ scriptName }} was uploaded to uCPE Manager!"</programlisting>
+    </section>
+
+    <section id="cs_upload_device">
+      <title>Custom Scripts - Upload a Custom Script from the uCPE Manager to
+      a Device</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Upload a Custom
+      Script from the uCPE Manager to a Device. For details please refer
+      to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/uploadCustomScriptOnDevice.yml</filename>.</para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/customScripts/uploadOnDevice.py</filename>.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Preconditions:</emphasis></para>
+
+      <itemizedlist>
+        <listitem>
+          <para>A device must have been previously added and connected to the
+          uCPE Manager instance.</para>
+        </listitem>
+
+        <listitem>
+          <para>A Custom Script must have been previously added to the uCPE
+          Manager instance.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>uploadCustomScriptOnDevice.yml</filename> Ansible Playbook
+      with the <literal>&lt;scriptName&gt;</literal>,
+      <literal>&lt;phase&gt;</literal> and
+      <literal>&lt;deviceName&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/uploadCustomScriptOnDevice.yml -e "scriptName=&lt;scriptName&gt; \
+phase=
+&lt;always-after-startup/once-after-startup/always-before-startup/once-before-startup&gt; \
+device=&lt;deviceName&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:</para>
+
+      <programlisting># Upload Custom Script on Device task result
+DEBUG: "{{ scriptName }} was uploaded to {{ device }}!"</programlisting>
+    </section>
+
+    <section id="cs_remove">
+      <title>Custom Scripts - Remove a Custom Script from the uCPE
+      Manager</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Remove a Custom
+      Script from the uCPE Manager. For details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/removeCustomScript.yml</filename>.</para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/customScripts/delete.py</filename>.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Precondition:</emphasis></para>
+
+      <para>A Custom Script must have been previously added to the uCPE
+      Manager.</para>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>removeCustomScript.yml</filename> Ansible Playbook with the
+      <literal>&lt;scriptName&gt;</literal> and
+      <literal>&lt;phase&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/removeCustomScript.yml -e "scriptName=&lt;scriptName&gt; \
+phase=
+&lt;always-after-startup/once-after-startup/always-before-startup/once-before-startup&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:</para>
+
+      <programlisting># Remove Custom Script in phase from uCPE Manager task result
+DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from uCPE Manager!"</programlisting>
+    </section>
+
+    <section id="cs_remove_device">
+      <title>Custom Scripts - Remove a Custom Script from a Device</title>
+
+      <para><emphasis role="bold">Description:</emphasis> Remove a Custom
+      Script from a Device. For details please refer to:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/playbooks/removeCustomScriptOnDevice.yml</filename>.</para>
+        </listitem>
+
+        <listitem>
+          <para><filename>&lt;AF-TH-install-dir&gt;/automation_framework/customScripts/deleteOnDevice.py</filename>.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Preconditions:</emphasis></para>
+
+      <itemizedlist>
+        <listitem>
+          <para>A device must have been previously added and connected to the
+          uCPE Manager instance.</para>
+        </listitem>
+
+        <listitem>
+          <para>A Custom Script must have been previously added to the
+          Device.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para><emphasis role="bold">Action:</emphasis> Run the
+      <filename>removeCustomScriptOnDevice.yml</filename> Ansible Playbook
+      with the <literal>&lt;scriptName&gt;</literal>,
+      <literal>&lt;phase&gt;</literal> and and
+      <literal>&lt;deviceName&gt;</literal> as extra-vars: <programlisting>ansible-playbook playbooks/removeCustomScriptOnDevice.yml -e "scriptName=&lt;scriptName&gt; \
+phase=
+&lt;always-after-startup/once-after-startup/always-before-startup/once-before-startup&gt; \
+device=&lt;deviceName&gt;"</programlisting></para>
+
+      <para><emphasis role="bold">Result:</emphasis> Output of the test case
+      run using the Test Harness:</para>
+
+      <programlisting># Remove Custom Script in phase from Device task result
+DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"</programlisting>
+    </section>
   </section>
 
   <section id="vnf_deploy_lifecycle">