diff options
| author | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-10-08 08:18:36 +0200 |
|---|---|---|
| committer | Martin Borg <martin.borg@enea.com> | 2019-10-11 15:26:12 +0200 |
| commit | 4f5655136c79442f0c5d0c430b03e26c4bcda300 (patch) | |
| tree | 07dd4ba5512bb06b47d8ab6f8eb5dc951b1353b5 | |
| parent | c809d907776503d4bdae0056a78ebb4d8840d559 (diff) | |
| download | nfv-access-documentation-4f5655136c79442f0c5d0c430b03e26c4bcda300.tar.gz | |
AF and TH: minor update
- Remove test directory from ch 4
- Remove 4.2.1 Extending functionality
- Fix path to deactivate, the correct way to run is:
~/automation_and_systemtest$ deactivate
Change-Id: I614c7769ba6044bd8fd2d67e72d0658102f71b23
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
| -rw-r--r-- | doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | 139 | ||||
| -rw-r--r-- | doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml | 8 |
2 files changed, 5 insertions, 142 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 ffdda0d..da661db 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 | |||
| @@ -2,121 +2,6 @@ | |||
| 2 | <chapter id="auto_fw_test_harness"> | 2 | <chapter id="auto_fw_test_harness"> |
| 3 | <title>Automation Framework and Test Harness</title> | 3 | <title>Automation Framework and Test Harness</title> |
| 4 | 4 | ||
| 5 | <para>The Automation Framework and Test Harness installation directory is | ||
| 6 | structured as follows:</para> | ||
| 7 | |||
| 8 | <programlisting>. | ||
| 9 | |-- automation_framework | ||
| 10 | | |-- device | ||
| 11 | | | |-- addDevice.py | ||
| 12 | | | |-- getEventsForUcpe.py | ||
| 13 | | | |-- removeDevice.py | ||
| 14 | | | `-- waitDeviceUp.py | ||
| 15 | | |-- eneaUcpeMgr.py | ||
| 16 | | |-- network | ||
| 17 | | | |-- bindNetworkInterface.py | ||
| 18 | | | |-- delNetworkBridge.py | ||
| 19 | | | |-- getNetworkInterfaces.py | ||
| 20 | | | |-- newNetworkBridge.py | ||
| 21 | | | `-- unbindNetworkInterface.py | ||
| 22 | | |-- unittestSuite | ||
| 23 | | | |-- config | ||
| 24 | | | | |-- addDevice.json | ||
| 25 | | | | |-- bindNetworkInterface.json | ||
| 26 | | | | |-- controlVNFI.json | ||
| 27 | | | | |-- delNetworkBridge.json | ||
| 28 | | | | |-- destroyVNFI.json | ||
| 29 | | | | |-- instantiateVNFI.json | ||
| 30 | | | | |-- newNetworkBridge.json | ||
| 31 | | | | |-- offboardVNF.json | ||
| 32 | | | | |-- onboardVNF.json | ||
| 33 | | | | |-- onboardVNFRaw.json | ||
| 34 | | | | |-- removeDevice.json | ||
| 35 | | | | |-- unbindNetworkInterface.json | ||
| 36 | | | | `-- waitDeviceUp.json | ||
| 37 | | | |-- fortigateCleanup.json | ||
| 38 | | | |-- fortigateDeploy.json | ||
| 39 | | | |-- unittestLoader.py | ||
| 40 | | | `-- unittestSuite.py | ||
| 41 | | `-- vnf | ||
| 42 | | |-- controlVNFI.py | ||
| 43 | | |-- destroyVNFI.py | ||
| 44 | | |-- instantiateVNFI.py | ||
| 45 | | |-- offboardVNF.py | ||
| 46 | | |-- onboardVNF.py | ||
| 47 | | `-- onboardVNFRaw.py | ||
| 48 | |-- ansible.cfg | ||
| 49 | |-- hosts | ||
| 50 | |-- setup_env.sh | ||
| 51 | |-- lab_config | ||
| 52 | | |-- intelc3850-2 | ||
| 53 | | | |-- intelc3850-2.json | ||
| 54 | | | |-- lan_br.json | ||
| 55 | | | |-- lan_nic.json | ||
| 56 | | | |-- wan_br.json | ||
| 57 | | | `-- wan_nic.json | ||
| 58 | | |-- inteld1521-1 | ||
| 59 | | | |-- inteld1521-1.json | ||
| 60 | | | |-- lan_br.json | ||
| 61 | | | |-- lan_nic.json | ||
| 62 | | | |-- mgmt_nic.json | ||
| 63 | | | |-- sfc_br.json | ||
| 64 | | | |-- vnf_mgmt_br.json | ||
| 65 | | | |-- wan_br.json | ||
| 66 | | | `-- wan_nic.json | ||
| 67 | | `-- inteld1521-2 | ||
| 68 | | |-- inteld1521-2.json | ||
| 69 | | |-- lan_br.json | ||
| 70 | | |-- lan_nic.json | ||
| 71 | | |-- mgmt_nic.json | ||
| 72 | | |-- sfc_br.json | ||
| 73 | | |-- vnf_mgmt_br.json | ||
| 74 | | |-- wan_br.json | ||
| 75 | | `-- wan_nic.json | ||
| 76 | |-- playbooks | ||
| 77 | | |-- addBridge.yml | ||
| 78 | | |-- addDevice.yml | ||
| 79 | | |-- bindNIC.yml | ||
| 80 | | |-- chainedVNFsService | ||
| 81 | | | |-- chainedVNFsService.yml | ||
| 82 | | | |-- cleanupChainedVNFsService.yml | ||
| 83 | | | `-- testChainedVNFsService.yml | ||
| 84 | | |-- controlVNFI.yml | ||
| 85 | | |-- deleteBridge.yml | ||
| 86 | | |-- destroyVNFI.yml | ||
| 87 | | |-- fortigateFWService | ||
| 88 | | | |-- cleanupFortigateFWInstance.yml | ||
| 89 | | | |-- cleanupTestFortigateFWInstance.yml | ||
| 90 | | | |-- instantiateFortigateFW.yml | ||
| 91 | | | `-- testFortigateFWInstance.yml | ||
| 92 | | |-- instantiateVNFI.yml | ||
| 93 | | |-- offboardVNF.yml | ||
| 94 | | |-- onboardVNFBundle.yml | ||
| 95 | | |-- onboardVNFImage.yml | ||
| 96 | | |-- removeDevice.yml | ||
| 97 | | |-- setupuCPEManager.yml | ||
| 98 | | |-- unbindNIC.yml | ||
| 99 | | `-- unittestSuiteTest | ||
| 100 | | |-- cleanupFortigateFWScenario.yml | ||
| 101 | | `-- deployFortigateFWScenario.yml | ||
| 102 | |-- uCPEM_config | ||
| 103 | | `-- ucpem01.json | ||
| 104 | |-- vnf_config | ||
| 105 | | |-- fortigateFWImage | ||
| 106 | | | |-- fortigateFWImage.json | ||
| 107 | | | |-- fortigateFWInstance1.json | ||
| 108 | | | `-- fortigateFWInstance2.json | ||
| 109 | | |-- fortigateImage | ||
| 110 | | | |-- fortigateFWInstance.json | ||
| 111 | | | `-- fortigateImage.json | ||
| 112 | | `-- junipervSRXImage | ||
| 113 | | |-- junipervSRXImage.json | ||
| 114 | | |-- junipervSRXInstanceAtomC1.json | ||
| 115 | | |-- junipervSRXInstanceAtomC2.json | ||
| 116 | | |-- junipervSRXInstanceXeonD1.json | ||
| 117 | | `-- junipervSRXInstanceXeonD2.json | ||
| 118 | `-- vnf_image</programlisting> | ||
| 119 | |||
| 120 | <section id="auto_fw"> | 5 | <section id="auto_fw"> |
| 121 | <title>Automation Framework</title> | 6 | <title>Automation Framework</title> |
| 122 | 7 | ||
| @@ -1907,27 +1792,5 @@ fortigateFWInstance | |||
| 1907 | Ansible and the Python logs are stored in the | 1792 | Ansible and the Python logs are stored in the |
| 1908 | <filename>ansible.log</filename> and <filename>debug.log</filename> files, | 1793 | <filename>ansible.log</filename> and <filename>debug.log</filename> files, |
| 1909 | respectively.</para> | 1794 | respectively.</para> |
| 1910 | |||
| 1911 | <section id="test_suites"> | ||
| 1912 | <title>Extending functionality - Test Suites</title> | ||
| 1913 | |||
| 1914 | <para>Extending the functionality of the Test Harness, typically | ||
| 1915 | requires the functionality of the Automation Framework to also be | ||
| 1916 | extended to cover additional uCPE Manager REST Northbound APIs. The | ||
| 1917 | extension of the Automation Framework will result in new Python modules | ||
| 1918 | that have to be created.</para> | ||
| 1919 | |||
| 1920 | <para>Additional Python modules, that are not related to the | ||
| 1921 | functionality of the Automation Framework, could be easily integrated | ||
| 1922 | into the Test Harness to aid in the creation of more complex test cases. | ||
| 1923 | Using the TH, test cases can be implemented that run directly on the | ||
| 1924 | boards with Enea NFV Access, over SSH.</para> | ||
| 1925 | |||
| 1926 | <para>For a better understanding of the Test Harness functionality and | ||
| 1927 | how to extend the test suites, please refer to the chapter "Sample Test | ||
| 1928 | Cases" from the Enea NFV Access System Test Specification document | ||
| 1929 | <remark>olink to the chapter needed here.</remark>and the TH code | ||
| 1930 | source.</para> | ||
| 1931 | </section> | ||
| 1932 | </section> | 1795 | </section> |
| 1933 | </chapter> \ No newline at end of file | 1796 | </chapter> |
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml index e4aaa6b..2f430c3 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml | |||
| @@ -159,7 +159,7 @@ | |||
| 159 | 159 | ||
| 160 | <orderedlist> | 160 | <orderedlist> |
| 161 | <listitem> | 161 | <listitem> |
| 162 | <para>Unzip the <filename>nfvaccess22_af-th.zip</filename> archive | 162 | <para>Unzip the <filename>nfvaccess<version>_af-th.zip</filename> archive |
| 163 | file, provided by Enea, on a supported host machine.</para> | 163 | file, provided by Enea, on a supported host machine.</para> |
| 164 | 164 | ||
| 165 | <para>The directory in which the archive has been unpacked will be | 165 | <para>The directory in which the archive has been unpacked will be |
| @@ -210,8 +210,8 @@ | |||
| 210 | </note> | 210 | </note> |
| 211 | 211 | ||
| 212 | <para>After the initial setup, each session ends by closing the Python | 212 | <para>After the initial setup, each session ends by closing the Python |
| 213 | virtual environment: <literal>source | 213 | virtual environment through running <literal>deactivate</literal> |
| 214 | <AF-THinstall-dir>/testHarness/bin/deactivate</literal>.</para> | 214 | from the <literal><AF-THinstall-dir></literal> directory.</para> |
| 215 | 215 | ||
| 216 | <para>Subsequent use of the installation requires activating the Python | 216 | <para>Subsequent use of the installation requires activating the Python |
| 217 | virtual enviroment before using the Automation Framework and Test Harness: | 217 | virtual enviroment before using the Automation Framework and Test Harness: |
| @@ -223,4 +223,4 @@ | |||
| 223 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding | 223 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding |
| 224 | JSON config for the new uCPE Manager instance.</para> | 224 | JSON config for the new uCPE Manager instance.</para> |
| 225 | </section> | 225 | </section> |
| 226 | </chapter> \ No newline at end of file | 226 | </chapter> |
