Update Sphinx version and versioning process
- Updated to newer Sphinx version
- Changed to use doc8 to check .rst files
- Added a dictionary (dict.txt) and spellchecking
- Reformatted and fixed issues that were found in the content
Change-Id: If7b35e01ee8be25dbbd1ecd0e67b264aa6cc2a94
diff --git a/testing/control-plane-testing.rst b/testing/control-plane-testing.rst
index 7499296..4e6a8ac 100644
--- a/testing/control-plane-testing.rst
+++ b/testing/control-plane-testing.rst
@@ -6,11 +6,13 @@
Setup ONOS Cluster
------------------
-Follow instructions in `Install ONOS Controller <../installation.html#install-controller-onos>`_ to setup and run ONOS cluster
+Follow instructions in `Install ONOS Controller
+<../installation.html#install-controller-onos>`_ to setup and run ONOS cluster
Setup Mininet Environment
-------------------------
+
- Clone Mininet and run the install script
.. code-block:: console
@@ -23,39 +25,51 @@
$ cd util
$ sudo ./install.sh -3fvn # Install OpenFlow 1.3, Open Vswitch and Mininet dependencies
-- Follow `Trellis in a Box <https://github.com/opennetworkinglab/routing/tree/master/trellis>`_ to install Trellis dependencies, such as DHCP server and Quagga.
+- Follow `Trellis in a Box
+ <https://github.com/opennetworkinglab/routing/tree/master/trellis>`_ to
+ install Trellis dependencies, such as DHCP server and Quagga.
.. note::
- If DHCP server does not properly run because of a permission error, please see `this <https://help.ubuntu.com/community/ isc-dhcp-server#Permission_issues_with_ISC-DHCP_server>`_ to solve the problem.
+ If DHCP server does not properly run because of a permission error,
+ please see `this
+ <https://help.ubuntu.com/community/isc-dhcp-server#Permission_issues_with_ISC-DHCP_server>`_
+ to solve the problem.
-- Set environment variables as described in `Create a Cell File <../installation.html#create-a-cell-file>`_
+- Set environment variables as described in `Create a Cell File
+ <../installation.html#create-a-cell-file>`_
Setup Test Station
------------------
-- Follow `TestON installation guide <https://wiki.onosproject.org/display/ONOS/Installation>`_ to install TestON
+
+- Follow `TestON installation guide
+ <https://wiki.onosproject.org/display/ONOS/Installation>`_ to install TestON
+
- (Optional) Add ``OnosSystemTest/TestON/bin`` to ``$PATH`` for convenience
Run Tests
=========
-Before you run any test, it is recommended to run cleanup script to kill any TestON, ssh, and Mininet sessions that are running.
+Before you run any test, it is recommended to run cleanup script to kill any
+TestON, ssh, and Mininet sessions that are running.
.. code-block:: console
cd ~/OnosSystemTest/TestON/bin
./cleanup.sh
-Fabric-related tests are located in ``OnosSystemTest/TestON/tests/USECASE/SegmentRouting/``.
-Each individual test can be run by executing ``cli.py`` script with test name. For example:
+Fabric-related tests are located in
+``OnosSystemTest/TestON/tests/USECASE/SegmentRouting/``.
+
+Each individual test can be run by executing ``cli.py`` script with test name.
+For example:
.. code-block:: console
cd ~/OnosSystemTest/TestON/bin
./cli.py run SRSanity
-
Test Plan
=========
@@ -70,9 +84,10 @@
- L1+L2 and L3+L4 are paired switches.
- All spine links with L1-4 are double links.
- - Hosts take ips with dhcp and there exist 2 external routers.
+ - Hosts take IPs with dhcp and there exist 2 external routers.
- Hosts can use ipv4 or ipv6.
- - We configure untagged/tagged single/dual home hosts in order to test every possible combination.
+ - We configure untagged/tagged single/dual home hosts in order to test every
+ possible combination.
- Most of the hosts reside in different ip subnets.
Tests Steps
@@ -84,8 +99,8 @@
- pingall
- (Optional) ``ping 10.0.99.2`` to check external IPv4 connectivity
- (Optional) ``ping6 2000:9902`` to check external IPv6 connectivity
-- Additional actions and tests defined in each individual test case
+- Additional actions and tests defined in each individual test case
Test Cases
----------
@@ -97,4 +112,7 @@
Test Results
============
ONF runs all Mininet based Trellis tests nightly.
-Test results are automatically published `here <https://wiki.onosproject.org/display/ONOS/1.12-Segment+Routing>`_
\ No newline at end of file
+
+Test results are automatically published `here
+<https://wiki.onosproject.org/display/ONOS/1.12-Segment+Routing>`_
+
diff --git a/testing/data-plane-testing.rst b/testing/data-plane-testing.rst
index 9c194db..75c5a14 100644
--- a/testing/data-plane-testing.rst
+++ b/testing/data-plane-testing.rst
@@ -4,12 +4,19 @@
OFTest Overview
===============
-The oftest framework consists of a test server connected to a target switch through an OpenFlow channel and directly to the data plane ports of the OF switch.
-After programming the switch, oftest inserts packets in the data plane and verifies if the output is as expected.
+The oftest framework consists of a test server connected to a target switch
+through an OpenFlow channel and directly to the data plane ports of the OF
+switch.
+
+After programming the switch, oftest inserts packets in the data plane and
+verifies if the output is as expected.
.. image:: ../images/testing-oftest.png
-We recommend using a server connected to a management network, a switch connected to the same management network, and then a **minimum of 2 ports directly connected between the server and the switch**.
+We recommend using a server connected to a management network, a switch
+connected to the same management network, and then a **minimum of 2 ports
+directly connected between the server and the switch**.
+
A few tests will fail if you have less than 3 ports.
OFTest Setup
@@ -27,10 +34,15 @@
$ git clone https://gerrit.opencord.org/fabric-oftest
Now let's configure the switch and point it to the test server.
-It can be done in the same way as connecting the switch to any controller.
-See `Connect Switch to Controller <../installation.html#connect-switch-to-controller>`_ for more details.
-Assuming that you plugged the ports ``12`` and ``24`` of the switch to interfaces ``eth1`` and ``eth2`` of the server, respectively, then the following command can tell you if everything is working.
+It can be done in the same way as connecting the switch to any controller.
+
+See `Connect Switch to Controller
+<../installation.html#connect-switch-to-controller>`_ for more details.
+
+Assuming that you plugged the ports ``12`` and ``24`` of the switch to
+interfaces ``eth1`` and ``eth2`` of the server, respectively, then the
+following command can tell you if everything is working.
.. code-block:: console
@@ -69,15 +81,16 @@
flows.PacketInSrcMacMiss ... FAIL
flows.PacketInUDP ... ok
-For example, in this case, all the multicast failed because we don't have three ports, the test L3VPN failed as well, and that is a bug of the current build.
+For example, in this case, all the multicast failed because we don't have three
+ports, the test L3VPN failed as well, and that is a bug of the current build.
The **PacketInSrcMac** Miss failed because Mac learning is not enabled.
.. note::
Expected test results can be found in https://github.com/opencord/fabric-oftest/blob/master/README.md
.. tip::
- OFTest can't successfully delete all groups using an OF message, because of that some tests interfere with others.
- If the results seem suspicious, **erase the flow tables and group tables** and run the test alone.
+ OFTest can't successfully delete all groups using an OF message, because of
+ that some tests interfere with others.
-
-
+ If the results seem suspicious, **erase the flow tables and group tables**
+ and run the test alone.