Check spelling in rst files

It fixes a few typos too and installs enchant in TravisCI and CircleCI
jobs.

Change-Id: Id5dbf5f926edc8b0b4e4337d11bf63e21ea7e173
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

diff --git a/.circleci/config.yml b/.circleci/config.yml
index e57f61d..8ef97b3 100644 (file)
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -8,7 +8,7 @@ jobs:
       - checkout
       - run:
           name: Install dependendencies
       - checkout
       - run:
           name: Install dependendencies

-          command: sudo apt-get install python2.7-dev
+          command: sudo apt-get install python2.7-dev enchant

       - run:
           name: Run tox
           command: sudo pip install tox && tox
       - run:
           name: Run tox
           command: sudo pip install tox && tox

diff --git a/.travis.yml b/.travis.yml
index e6b7cdf..79efaaf 100644 (file)
--- a/.travis.yml
+++ b/.travis.yml
@@ -9,7 +9,7 @@ addons:
       - libssl1.0.0
 
 before_script:
       - libssl1.0.0
 
 before_script:

-  - sudo apt-get -y install qemu-user-static
+  - sudo apt-get -y install qemu-user-static enchant

   - sudo add-apt-repository -y ppa:deadsnakes/ppa
   - sudo apt-get update
   - sudo apt-get install python3.7 python3.7-dev
   - sudo add-apt-repository -y ppa:deadsnakes/ppa
   - sudo apt-get update
   - sudo apt-get install python3.7 python3.7-dev

diff --git a/docs/conf.py b/docs/conf.py
index 2be6a5a..7a8d185 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -175,3 +175,5 @@ texinfo_documents = [
      'One line description of project.',
      'Miscellaneous'),
 ]
      'One line description of project.',
      'Miscellaneous'),
 ]

+
+spelling_word_list_filename = 'spelling_wordlist.txt'

diff --git a/docs/release/release-notes/functest-release.rst b/docs/release/release-notes/functest-release.rst
index fb3f40b..1f5d80d 100644 (file)
--- a/docs/release/release-notes/functest-release.rst
+++ b/docs/release/release-notes/functest-release.rst
@@ -99,7 +99,7 @@ Docker tag for master: latest
 Documents
 ---------
 
 Documents
 ---------
 

- * Functests Guides: https://functest.readthedocs.io/en/latest/
+ * Functest Guides: https://functest.readthedocs.io/en/latest/

  * API Docs: https://functest-api.readthedocs.io/en/latest/
 
 Version change
  * API Docs: https://functest-api.readthedocs.io/en/latest/
 
 Version change

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
new file mode 100644 (file)
index 0000000..32881e6
--- /dev/null
+++ b/docs/spelling_wordlist.txt
@@ -0,0 +1,145 @@
+ABot
+admin
+adminURL
+api
+auth
+backend
+barbican
+benchmarking
+Benchmarking
+bgpvpn
+cacerts
+chan
+ci
+Clearwater
+cloudify
+Cloudify
+conf
+config
+dashboarding
+defcore
+Defcore
+Deliverables
+dhcp
+dockerhub
+enduser
+env
+EnvironmentVariable
+epc
+fds
+frontend
+functest
+Functest
+guestbook
+Guestbook
+healthcheck
+Healthcheck
+http
+https
+ims
+ini
+init
+interop
+Interop
+interoperability
+intra
+iptables
+jenkins
+Joid
+juju
+Juju
+jumphost
+Jumphost
+kube
+kubernetes
+Kubernetes
+kvm
+linux
+metadata
+Metadata
+middleware
+nfv
+nofeature
+noha
+nosdn
+octavia
+odl
+onboarding
+ons
+Opendaylight
+openstack
+Openstack
+opnfv
+orchestrator
+Orchestrator
+organised
+os
+ovs
+patrole
+Patrole
+plugin
+pre
+proxified
+Reachability
+reconnection
+redis
+refactored
+refstack
+Refstack
+repo
+resolv
+restapi
+Restconf
+runnable
+screenshot
+sdn
+sfc
+signalling
+singlevm
+src
+su
+subfolder
+subnet
+Subnet
+subnets
+sudo
+systemctl
+Telco
+tenantnetwork
+testcase
+testcases
+TLS
+txt
+un
+url
+userdata
+userid
+username
+usr
+util
+utils
+UUID
+vdb
+vEPC
+verifier
+versioned
+vIMS
+Virtualised
+Virtualized
+vm
+VM
+vmready
+vmtp
+vnf
+Vnf
+vping
+vPing
+vrouter
+vRouter
+vyos
+wconsole
+wiki
+Workflow
+xrally
+xtesting
+yaml

diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst
index 88f728c..f0583f2 100644 (file)
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -177,8 +177,8 @@ Functest Dockers for Kubernetes deployment
 Docker images are available on the dockerhub:
 
   * opnfv/functest-kubernetes-core
 Docker images are available on the dockerhub:
 
   * opnfv/functest-kubernetes-core

-  * opnfv/functest-kubernetest-healthcheck
-  * opnfv/functest-kubernetest-smoke
+  * opnfv/functest-kubernetes-healthcheck
+  * opnfv/functest-kubernetes-smoke

 
 Preparing your environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Preparing your environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^


@@ -228,7 +228,7 @@ Results shall be displayed as follows::
 Environment variables
 =====================
 
 Environment variables
 =====================
 

-Several environement variables may be specified:
+Several environment variables may be specified:

 
   * INSTALLER_IP=<Specific IP Address>
   * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
 
   * INSTALLER_IP=<Specific IP Address>
   * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>

diff --git a/docs/testing/user/configguide/prerequisites.rst b/docs/testing/user/configguide/prerequisites.rst
index c7b52dc..dab4a9e 100644 (file)
--- a/docs/testing/user/configguide/prerequisites.rst
+++ b/docs/testing/user/configguide/prerequisites.rst
@@ -92,4 +92,4 @@ should thus be known. Ensure you can reach each node in the SUT, from the
 Jumphost using the 'ping' command using the respective IP address on the
 public/external network for each node in the SUT. The details of how to
 determine the needed IP addresses for each node in the SUT may vary according
 Jumphost using the 'ping' command using the respective IP address on the
 public/external network for each node in the SUT. The details of how to
 determine the needed IP addresses for each node in the SUT may vary according

-to the used installer and are therefore ommitted here.
+to the used installer and are therefore omitted here.

diff --git a/docs/testing/user/userguide/reporting.rst b/docs/testing/user/userguide/reporting.rst
index 7c8c48e..8fad55d 100644 (file)
--- a/docs/testing/user/userguide/reporting.rst
+++ b/docs/testing/user/userguide/reporting.rst
@@ -48,7 +48,7 @@ and features) corresponding to this scenario.
 All the testcases (X) listed in the table are runnable on os-odl_l2-nofeature
 scenarios.
 Please note that other test cases (e.g. sfc_odl, bgpvpn) need ODL configuration
 All the testcases (X) listed in the table are runnable on os-odl_l2-nofeature
 scenarios.
 Please note that other test cases (e.g. sfc_odl, bgpvpn) need ODL configuration

-addons and, as a consequence, specific scenario.
+add-ons and, as a consequence, specific scenario.

 There are not considered as runnable on the generic odl_l2 scenario.
 
 
 There are not considered as runnable on the generic odl_l2 scenario.
 
 


@@ -82,7 +82,7 @@ Therefore the scoring provides 3 types of indicators:
   * the maturity: if the percentage (scoring/target scoring * 100) is high, it
     means that all the tests are PASS
   * the stability: as the number of iteration is included in the calculation,
   * the maturity: if the percentage (scoring/target scoring * 100) is high, it
     means that all the tests are PASS
   * the stability: as the number of iteration is included in the calculation,

-    the pecentage can be high only if the scenario is run regularly (at least
+    the percentage can be high only if the scenario is run regularly (at least

     more than 4 iterations over the last 10 days in CI)
 
 In any case, the scoring is used to give feedback to the other projects and
     more than 4 iterations over the last 10 days in CI)
 
 In any case, the scoring is used to give feedback to the other projects and

diff --git a/docs/testing/user/userguide/test_overview.rst b/docs/testing/user/userguide/test_overview.rst
index 5aef27c..bc3e79d 100644 (file)
--- a/docs/testing/user/userguide/test_overview.rst
+++ b/docs/testing/user/userguide/test_overview.rst
@@ -17,7 +17,7 @@ The current list of test suites can be distributed over 5 main domains:
 Functest test suites are also distributed in the OPNFV testing categories:
 healthcheck, smoke, benchmarking, VNF, Stress tests.
 
 Functest test suites are also distributed in the OPNFV testing categories:
 healthcheck, smoke, benchmarking, VNF, Stress tests.
 

-All the Healthcheck and smoke tests of a given scenario must be succesful to
+All the Healthcheck and smoke tests of a given scenario must be successful to

 validate the scenario for the release.
 
 +-------------+---------------+------------+----------------------------------+
 validate the scenario for the release.
 
 +-------------+---------------+------------+----------------------------------+


@@ -90,7 +90,7 @@ validate the scenario for the release.
 | VNF         | vnf           | cloudify   | Example of a real VNF deployment |
 |             |               | \_ims      | to show the NFV capabilities of  |
 |             |               |            | the platform. The IP Multimedia  |
 | VNF         | vnf           | cloudify   | Example of a real VNF deployment |
 |             |               | \_ims      | to show the NFV capabilities of  |
 |             |               |            | the platform. The IP Multimedia  |

-|             |               |            | Subsytem is a typical Telco test |
+|             |               |            | Subsystem is a typical Telco test|

 |             |               |            | case, referenced by ETSI.        |
 |             |               |            | It provides a fully functional   |
 |             |               |            | VoIP System                      |
 |             |               |            | case, referenced by ETSI.        |
 |             |               |            | It provides a fully functional   |
 |             |               |            | VoIP System                      |


@@ -177,7 +177,7 @@ deployed services. The system uses the environment variables to automatically
 determine the valid test cases, for each given environment.
 
 A convenience Functest CLI utility is also available to simplify setting up the
 determine the valid test cases, for each given environment.
 
 A convenience Functest CLI utility is also available to simplify setting up the

-Functest evironment, management of the OpenStack environment (e.g. resource
+Functest environment, management of the OpenStack environment (e.g. resource

 clean-up) and for executing tests.
 The Functest CLI organised the testcase into logical Tiers, which contain in
 turn one or more testcases. The CLI allows execution of a single specified
 clean-up) and for executing tests.
 The Functest CLI organised the testcase into logical Tiers, which contain in
 turn one or more testcases. The CLI allows execution of a single specified

diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst
index fb53437..66e2433 100644 (file)
--- a/docs/testing/user/userguide/troubleshooting.rst
+++ b/docs/testing/user/userguide/troubleshooting.rst
@@ -133,8 +133,8 @@ here::
     vPing_ssh- ERROR - Cannot establish connection to IP xxx.xxx.xxx.xxx. Aborting
 
 If this is displayed, stop the test or wait for it to finish, if you have used
     vPing_ssh- ERROR - Cannot establish connection to IP xxx.xxx.xxx.xxx. Aborting
 
 If this is displayed, stop the test or wait for it to finish, if you have used

-the special method of test invocation with specific supression of OpenStack
-resource clean-up, as explained earler. It means that the Container can not
+the special method of test invocation with specific suppression of OpenStack
+resource clean-up, as explained earlier. It means that the Container can not

 reach the Public/External IP assigned to the instance **opnfv-vping-2**. There
 are many possible reasons, and they really depend on the chosen scenario. For
 most of the ODL-L3 and ONOS scenarios this has been noticed and it is a known
 reach the Public/External IP assigned to the instance **opnfv-vping-2**. There
 are many possible reasons, and they really depend on the chosen scenario. For
 most of the ODL-L3 and ONOS scenarios this has been noticed and it is a known


@@ -158,7 +158,7 @@ container::
     ping <public IP>
 
 If the ping does not return anything, try to ping from the Host where the
     ping <public IP>
 
 If the ping does not return anything, try to ping from the Host where the

-Docker container is running. If that solves the problem, check the iptable
+Docker container is running. If that solves the problem, check the iptables

 rules because there might be some rules rejecting ICMP or TCP traffic
 coming/going from/to the container.
 
 rules because there might be some rules rejecting ICMP or TCP traffic
 coming/going from/to the container.
 

diff --git a/test-requirements.txt b/test-requirements.txt
index d82076f..37f6945 100644 (file)
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -16,3 +16,4 @@ bashate # Apache-2.0
 lfdocs-conf
 sphinx-opnfv-theme
 bandit
 lfdocs-conf
 sphinx-opnfv-theme
 bandit

+sphinxcontrib-spelling

diff --git a/tox.ini b/tox.ini
index 130e0df..bd2be62 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -30,6 +30,7 @@ commands =
   sphinx-build -W -n -b html docs docs/build/html
   sphinx-build -W -n -b linkcheck docs docs/_build/linkcheck
   sphinx-build -W -n -b html -c docs/lfreleng docs docs/_build/html
   sphinx-build -W -n -b html docs docs/build/html
   sphinx-build -W -n -b linkcheck docs docs/_build/linkcheck
   sphinx-build -W -n -b html -c docs/lfreleng docs docs/_build/html

+  sphinx-build -W -b spelling -Dextensions=sphinxcontrib.spelling docs docs/_build/spellcheck

 
 [testenv:pep8]
 basepython = python3.7
 
 [testenv:pep8]
 basepython = python3.7