summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2020-04-11 04:05:57 +0200
committerMartin Borg <martin.borg@enea.com>2020-04-14 10:56:17 +0200
commit5beeb75c0b80fd5454beefffefca7bd68bf38cfa (patch)
treeaca4fe4585e4b713c423a87db9285cc87e55206b
parent5d6764292ad589992be1e44f61d162507c6bc929 (diff)
downloadel_releases-nfv-access-5beeb75c0b80fd5454beefffefca7bd68bf38cfa.tar.gz
Correcting typo and programlistings in the AFTH User Guide.
Change-Id: I39ec2401452cf0edff4d1591b26a978ca5cf82b3 Signed-off-by: mrpa <miruna.paun@enea.com>
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml150
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml4
2 files changed, 83 insertions, 71 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 9f9930a..f32e5b7 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
@@ -95,63 +95,59 @@ Options:
95 Fortigate <emphasis role="bold">deployment</emphasis> scenario 95 Fortigate <emphasis role="bold">deployment</emphasis> scenario
96 <filename>fortigateDeploy.json</filename>:</para> 96 <filename>fortigateDeploy.json</filename>:</para>
97 97
98 <para><programlisting>[ 98 <para><programlisting>
99 { 99[
100 "config": "config/addDevice.json", 100 {
101 "module": "../device/addDevice.py" 101 "config": "config/waitDeviceUp.json",
102 }, 102 "module": "../device/waitDeviceUp.py"
103 { 103 },
104 "config": "config/waitDeviceUp.json", 104 {
105 "module": "../device/waitDeviceUp.py" 105 "config": "config/bindNetworkInterface.json",
106 }, 106 "module": "../network/bindNetworkInterface.py"
107 { 107 },
108 "config": "config/bindNetworkInterface.json", 108 {
109 "module": "../network/bindNetworkInterface.py" 109 "config": "config/newNetworkBridge.json",
110 }, 110 "module": "../network/newNetworkBridge.py"
111 { 111 },
112 "config": "config/newNetworkBridge.json", 112 {
113 "module": "../network/newNetworkBridge.py" 113 "config": "config/onboardVNFRaw.json",
114 }, 114 "module": "../vnf/onboardVNFRaw.py"
115 { 115 },
116 "config": "config/onboardVNFRaw.json", 116 {
117 "module": "../vnf/onboardVNFRaw.py" 117 "config": "config/instantiateVNFI.json",
118 }, 118 "module": "../vnf/instantiateVNFI.py"
119 { 119 },
120 "config": "config/instantiateVNFI.json", 120 {
121 "module": "../vnf/instantiateVNFI.py" 121 "config": "config/controlVNFI.json",
122 }, 122 "module": "../vnf/controlVNFI.py"
123 { 123 }
124 "config": "config/controlVNFI.json", 124]
125 "module": "../vnf/controlVNFI.py" 125</programlisting></para>
126 }
127]</programlisting></para>
128 126
129 <para>Below is a sample unit-test configuration file, describing the 127 <para>Below is a sample unit-test configuration file, describing the
130 Fortigate <emphasis role="bold">cleanup</emphasis> scenario 128 Fortigate <emphasis role="bold">cleanup</emphasis> scenario
131 <filename>fortigateCleanup.json</filename>:</para> 129 <filename>fortigateCleanup.json</filename>:</para>
132 130
133 <programlisting>[ 131 <programlisting>
134 { 132[
135 "config": "config/destroyVNFI.json", 133 {
136 "module": "../vnf/destroyVNFI.py" 134 "config": "config/destroyVNFI.json",
137 }, 135 "module": "../vnf/destroyVNFI.py"
138 { 136 },
139 "config": "config/delNetworkBridge.json", 137 {
140 "module": "../network/delNetworkBridge.py" 138 "config": "config/delNetworkBridge.json",
141 }, 139 "module": "../network/delNetworkBridge.py"
142 { 140 },
143 "config": "config/unbindNetworkInterface.json", 141 {
144 "module": "../network/unbindNetworkInterface.py" 142 "config": "config/unbindNetworkInterface.json",
145 }, 143 "module": "../network/unbindNetworkInterface.py"
146 { 144 },
147 "config": "config/offboardVNF.json", 145 {
148 "module": "../vnf/offboardVNF.py" 146 "config": "config/offboardVNF.json",
149 }, 147 "module": "../vnf/offboardVNF.py"
150 { 148 }
151 "config": "config/removeDevice.json", 149]
152 "module": "../device/removeDevice.py" 150</programlisting>
153 }
154]</programlisting>
155 151
156 <para>The <literal>config</literal> key contains the path to the test 152 <para>The <literal>config</literal> key contains the path to the test
157 case's configuration file.</para> 153 case's configuration file.</para>
@@ -165,12 +161,15 @@ Options:
165 161
166 <para>Unit-test behavior can be tweaked through setting any of the 162 <para>Unit-test behavior can be tweaked through setting any of the
167 following options. This is done through the 163 following options. This is done through the
168 <filename>eneaUcpeMgr.py</filename> file:<programlisting># Defaults for the framework 164 <filename>eneaUcpeMgr.py</filename> file:</para>
165
166 <programlisting>
167# Defaults for the framework
169username = "admin" 168username = "admin"
170password = "admin" 169password = "admin"
171host = None 170host = None
172deviceName = None 171deviceName = None
173directory = "." 172directory = "."
174ftpUsername = "ftp" 173ftpUsername = "ftp"
175ftpPassword = "ftp" 174ftpPassword = "ftp"
176ftpPort = "2021" 175ftpPort = "2021"
@@ -179,16 +178,17 @@ ftpPort = "2021"
179failfast = True 178failfast = True
180 179
181# Logging levels ordered by the highest severity: 180# Logging levels ordered by the highest severity:
182# CRITICAL 50 181# CRITICAL 50
183# ERROR 40 182# ERROR 40
184# WARNING 30 183# WARNING 30
185# INFO 20 184# INFO 20
186# DEBUG 10 185# DEBUG 10
187# NOTSET 0 186# NOTSET 0
188fileLoggingLevel = logging.DEBUG 187fileLoggingLevel = logging.DEBUG
189consoleLoggingLevel = logging.INFO</programlisting></para> 188consoleLoggingLevel = logging.INFO
189</programlisting>
190 190
191 <para><table> 191 <table>
192 <title>eneaUcpeMgr.py Options</title> 192 <title>eneaUcpeMgr.py Options</title>
193 193
194 <tgroup cols="2"> 194 <tgroup cols="2">
@@ -287,7 +287,7 @@ consoleLoggingLevel = logging.INFO</programlisting></para>
287 </row> 287 </row>
288 </tbody> 288 </tbody>
289 </tgroup> 289 </tgroup>
290 </table></para> 290 </table>
291 </section> 291 </section>
292 292
293 <section id="ut_suite_log"> 293 <section id="ut_suite_log">
@@ -323,10 +323,18 @@ NOTSET 0</programlisting></para>
323 running the Fortigate <emphasis role="bold">deployment</emphasis> 323 running the Fortigate <emphasis role="bold">deployment</emphasis>
324 scenario:</para> 324 scenario:</para>
325 325
326 <para><programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s 326<programlisting>
327fortigateDeploy.json -d "Fortigate deployment scenario"</programlisting>Setting 327$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
328 the console logging level to DEBUG:<programlisting>consoleLoggingLevel = logging.DEBUG</programlisting><emphasis 328fortigateDeploy.json -d "Fortigate deployment scenario"
329 role="bold">Expected Output:</emphasis><programlisting>2019-03-07 18:03:20,791 - DEBUG: Started logging 329</programlisting>
330
331<para>Setting the console logging level to DEBUG:</para>
332
333<para><programlisting>consoleLoggingLevel = logging.DEBUG</programlisting>
334<emphasis role="bold">Expected Output:</emphasis>
335
336<programlisting>
3372019-03-07 18:03:20,791 - DEBUG: Started logging
330 338
331Running Fortigate deployment scenario... 339Running Fortigate deployment scenario...
332 340
@@ -459,8 +467,12 @@ OK</programlisting></para>
459 467
460 <para>Below you'll find sample unit-test command line options for 468 <para>Below you'll find sample unit-test command line options for
461 running the Fortigate <emphasis role="bold">cleanup</emphasis> 469 running the Fortigate <emphasis role="bold">cleanup</emphasis>
462 scenario:<programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s 470 scenario:</para>
463fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting></para> 471
472<programlisting>
473$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
474fortigateCleanup.json -d "Fortigate cleanup scenario"
475</programlisting>
464 476
465 <para>Setting the console logging level to INFO: <programlisting>consoleLoggingLevel = logging.INFO</programlisting></para> 477 <para>Setting the console logging level to INFO: <programlisting>consoleLoggingLevel = logging.INFO</programlisting></para>
466 478
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 a63dfda..b1ec97a 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
@@ -216,8 +216,8 @@
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:
218 <literal>source 218 <literal>source
219 &lt;AF-THinstall-dir&gt;/testHarness/bin/activate</literal>.</para> 219 &lt;AF-TH-install-dir&gt;/testHarness-venv/bin/activate</literal>.</para>
220 220
221 <para>Furthermore, if a user wants to use a new uCPE Manager instance for 221 <para>Furthermore, if a user wants to use a new uCPE Manager instance for
222 a new session, the user also has to re-run the 222 a new session, the user also has to re-run the
223 <filename>setupuCPEManager.yml</filename> playbook with the corresponding 223 <filename>setupuCPEManager.yml</filename> playbook with the corresponding