[VOL-5307] - bulk cleanup lintcheck errors
sphinx_conf/linkcheck_ignore.py
-------------------------------
o Add more URL exclusions. Was working earlier but urls created by
sphinx template substitution are failing 'make linkcheck'. Not just
ONF urls, maven central, etc.
testing/voltha_test_automation.rst
----------------------------------
o Remove stale URLs referencing deprecated views and jobs.
o Update refrences form 2.8, 2.9 => 2.11 & 2.12.
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: Ib502265a2959b47cef46174b13c5adb368981ef1
diff --git a/VERSION b/VERSION
index d0b3205..9e71221 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.12.38
+2.12.39
diff --git a/sphinx_conf/linkcheck_ignore.py b/sphinx_conf/linkcheck_ignore.py
index d043e08..3401c3d 100644
--- a/sphinx_conf/linkcheck_ignore.py
+++ b/sphinx_conf/linkcheck_ignore.py
@@ -66,6 +66,14 @@
# (voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes: line 71) broken https://github.com/opencord/voltha-protos/blob/v4.0.11/protos/voltha_protos/device.proto#L116 - Anchor 'L116' not found
r'https://github.com/opencord/voltha-protos/blob/v4.0.11/protos/voltha_protos/device.proto#L116',
+
+ # (testing/voltha_test_automation: line 20) broken
+ r'https://jenkins.opencord.org/view/voltha-soak/',
+
+ ## HMMMM: Why are sphinx template substitutions barfing for urls ?
+ # (release_notes/voltha_2.12: line 658) broken
+ r'https://mvnrepository.com/artifact/org.opencord',
+
])
# [SEE ALSO]
diff --git a/testing/voltha_test_automation.rst b/testing/voltha_test_automation.rst
index 75790c5..cd40c4a 100644
--- a/testing/voltha_test_automation.rst
+++ b/testing/voltha_test_automation.rst
@@ -1,10 +1,12 @@
Voltha Test Automation
======================
-This page shows how the Voltha tests are automated to run on `OpenCORD Jenkins <https://jenkins.opencord.org/>`_.
+This page shows how the Voltha tests are automated to run on
+`OpenCORD Jenkins <https://jenkins.opencord.org/>`_.
-Tests of different workflows, i.e. ATT, DT and TT, with various configurations based on either BBSim deployment or
-actual Physical POD run on Jenkins periodically.
+Tests of different workflows, i.e. ATT, DT and TT, with various
+configurations based on either BBSim deployment or actual Physical POD run
+on Jenkins periodically.
.. figure:: ../_static/Voltha_Test_Automation_Jenkins.png
:alt: Voltha OpenCord Jenkins
@@ -14,11 +16,12 @@
Voltha OpenCord Jenkins
Similar set of jobs are kept under similar tabs. Like,
-all the master build jobs are placed under `VOLTHA-2.X-Tests <https://jenkins.opencord.org/view/VOLTHA-2.X-Tests/>`_ tab,
-jobs related to the voltha-2.8 LTS release are in VOLTHA-2.8 tab.
+all the master build jobs are placed under
+`VOLTHA-2.X-Tests <https://jenkins.opencord.org/view/VOLTHA-2.X-Tests/>`_
+tab, jobs related to the voltha-2.12 LTS release are in VOLTHA-2.12 tab.
-Likewise, tests that collect measurements on Voltha performance at scale are placed under `voltha-scale-measurements <https://jenkins.opencord.org/view/voltha-scale-measurements/>`_,
-and the Voltha Soak testing jobs are kept under the tab named `voltha-soak <https://jenkins.opencord.org/view/voltha-soak/>`_.
+Likewise, tests that collect measurements on Voltha performance at scale
+are placed under `voltha-scale-measurements <https://jenkins.opencord.org/view/voltha-scale-measurements/>`_.
Jenkins also host `verification jobs <https://jenkins.opencord.org/view/VOLTHA%202.x%20verify/>`_ that trigger automatically whenever a patch is pushed or updated on Gerrit for the review.
@@ -26,15 +29,16 @@
Job Templates
^^^^^^^^^^^^^
-Templates for the jobs are defined in `ci-management <https://github.com/opencord/ci-management>`__ repo.
+Templates for the jobs are defined in
+`ci-management <https://github.com/opencord/ci-management>`__ repo.
BBSim Jobs
^^^^^^^^^^
-OpenCORD Jenkins host a large number of BBSim based regression jobs that run periodically
-with different deployment configurations to verify Voltha control plane functionality
-for different operator workflows. Such as,
+OpenCORD Jenkins host a large number of BBSim based regression jobs that
+run periodically with different deployment configurations to verify Voltha
+control plane functionality for different operator workflows. Such as,
- `periodic-voltha-test-bbsim <https://jenkins.opencord.org/job/periodic-voltha-test-bbsim/>`_ & `periodic-voltha-multiple-olts-test-bbsim <https://jenkins.opencord.org/job/periodic-voltha-multiple-olts-test-bbsim/>`_ : tests Voltha functional scenarios, recovery and error scenarios, ONOS HA scenarios etc. for ATT
- `periodic-voltha-multi-uni-test-bbsim <https://jenkins.opencord.org/job/periodic-voltha-multi-uni-test-bbsim/>`_ & `periodic-voltha-multi-uni-multiple-olts-test-bbsim <https://jenkins.opencord.org/job/periodic-voltha-multi-uni-multiple-olts-test-bbsim/>`_ : tests Voltha functionality with multiple UNIs enabled, and with single & multiple OLT (BBSim) deployments
@@ -50,9 +54,11 @@
- `periodic-voltha-memory-leak-test-bbsim <https://jenkins.opencord.org/job/periodic-voltha-memory-leak-test-bbsim/>`_ : tests and catches memory leak in Voltha components
Similar to the above mentioned jobs which are based on **master**,
-Jenkins has regression jobs for other Voltha releases as well, like votlha-2.8 and voltha-2.9.
+Jenkins has regression jobs for other Voltha releases as well, like
+votlha-2.11 and voltha-2.12.
-The template for the jobs that run on BBSim based deployment is defined `here <https://github.com/opencord/ci-management/blob/master/jjb/voltha-e2e.yaml>`__.
+The template for the jobs that run on BBSim based deployment is defined
+`here <https://github.com/opencord/ci-management/blob/master/jjb/voltha-e2e.yaml>`__.
BBSim based deployment is also used to test Voltha at scale.
The scale jobs run the tests that collect measurements on Voltha performance.
@@ -66,14 +72,16 @@
Hardware (or Physical POD) Jobs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-OpenCord Jenkins host various regression jobs that runs on the ONF physical pods
-situated at different geographical locations.
-Hardware jobs test both control and dataplane functionality of Voltha.
+OpenCord Jenkins host various regression jobs that runs on the ONF physical
+pods situated at different geographical locations. Hardware jobs test both
+control and dataplane functionality of Voltha.
-These hardware jobs are mostly defined in a combination of a build job and a test job.
-The template for the jobs that run on physical pod is defined `here <https://github.com/opencord/ci-management/blob/master/jjb/voltha-test/voltha-nightly-jobs.yaml>`__.
+These hardware jobs are mostly defined in a combination of a build job and
+a test job. The template for the jobs that run on physical pod is defined
+`here <https://github.com/opencord/ci-management/blob/master/jjb/voltha-test/voltha-nightly-jobs.yaml>`__.
-Some of the configurations that are currently being tested on ONF's Physical Pods are:
+Some of the configurations that are currently being tested on ONF's
+Physical Pods are:
- Default Technology Profile with master or LTS release build for ATT
- 1T4GEM profile with master or LTS release build for ATT
@@ -88,29 +96,42 @@
Per-Patchset Verification Jobs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The verification jobs gets triggered automatically whenever a patch is pushed or updated on Gerrit, e.g.
+The verification jobs gets triggered automatically whenever a patch is
+pushed or updated on Gerrit, e.g.
-- verify_{project}_licensed : This job verifies that there is valid license/copyright on files.
-- verify_{project}_tag-collision : This job checks for changes to version files,
- and that they don't duplicate tags already in the git repo.
+- verify_{project}_licensed : This job verifies that there is valid
+ license/copyright on files.
+- verify_{project}_tag-collision : This job checks for changes to version
+ files, and that they don't duplicate tags already in the git repo.
- verify_{project}_unit-test : This job runs the Makefile based unit tests.
-- verify_{project}_sanity-test : This job verifies that basic Voltha functionality is not broken
- for any of the operator workflows.
+- verify_{project}_sanity-test : This job verifies that basic Voltha
+ functionality is not broken for any of the operator workflows.
-Apart from system triggered jobs, there are some verification jobs which can be triggered by the user
-by providing apt comment in the Gerrit patch, e.g.
+Apart from system triggered jobs, there are some verification jobs which
+can be triggered by the user by providing apt comment in the Gerrit patch,
+e.g.
-- *hardware test functional tests* : This comment triggers the run on a dedicated physical pod
- and executes the entire functional test suite for ATT.
-- *hardware test functional tests DT* : This comment triggers the functional suite tests for DT.
-- *voltha test openonu singleolt* : Triggers patchset-voltha-openonu-go-test-bbsim job.
-- *voltha 2.9 test openonu singleolt* : Triggers patchset-voltha-2.9-openonu-go-test-bbsim job.
-- *voltha 2.8 test openonu singleolt* : Triggers patchset-voltha-2.8-openonu-go-test-bbsim job.
-- *voltha test openonu multiolt* : Triggers patchset-voltha-multiple-olts-openonu-go-test-bbsim job.
-- *voltha 2.9 test openonu multiolt* : Triggers patchset-voltha-2.9-multiple-olts-openonu-go-test-bbsim job.
-- *voltha 2.8 test openonu multiolt* : Triggers patchset-voltha-2.8-multiple-olts-openonu-go-test-bbsim job.
-- *voltha test pm data singleolt* : Triggers patchset-voltha-pm-data-test-bbsim job.
-- *voltha test pm data multiolt* : Triggers patchset-voltha-multiple-olts-pm-data-test-bbsim job.
+- *hardware test functional tests* : This comment triggers the run on a
+ dedicated physical pod and executes the entire functional test suite for ATT.
-The templates for the above mentioned and other similar jobs can be found in the
-`ci-management <https://github.com/opencord/ci-management>`__ repo.
+- *hardware test functional tests DT* : This comment triggers the functional
+ suite tests for DT.
+- *voltha test openonu singleolt* :
+ Triggers patchset-voltha-openonu-go-test-bbsim job.
+- *voltha 2.9 test openonu singleolt* :
+ Triggers patchset-voltha-2.9-openonu-go-test-bbsim job.
+- *voltha 2.8 test openonu singleolt* :
+ Triggers patchset-voltha-2.8-openonu-go-test-bbsim job.
+- *voltha test openonu multiolt* :
+ Triggers patchset-voltha-multiple-olts-openonu-go-test-bbsim job.
+- *voltha 2.9 test openonu multiolt* :
+ Triggers patchset-voltha-2.9-multiple-olts-openonu-go-test-bbsim job.
+- *voltha 2.8 test openonu multiolt* :
+ Triggers patchset-voltha-2.8-multiple-olts-openonu-go-test-bbsim job.
+- *voltha test pm data singleolt* :
+ Triggers patchset-voltha-pm-data-test-bbsim job.
+- *voltha test pm data multiolt* :
+ Triggers patchset-voltha-multiple-olts-pm-data-test-bbsim job.
+
+The templates for the above mentioned and other similar jobs can be found
+in the `ci-management <https://github.com/opencord/ci-management>`__ repo.