diff options
| -rw-r--r-- | .circleci/config.yml | 2 | ||||
| -rw-r--r-- | .travis.yml | 2 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/release/release-notes/functest-release.rst | 2 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 157 | ||||
| -rw-r--r-- | docs/testing/user/configguide/configguide.rst | 8 | ||||
| -rw-r--r-- | docs/testing/user/configguide/prerequisites.rst | 2 | ||||
| -rw-r--r-- | docs/testing/user/userguide/reporting.rst | 4 | ||||
| -rw-r--r-- | docs/testing/user/userguide/test_overview.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/troubleshooting.rst | 6 | ||||
| -rw-r--r-- | test-requirements.txt | 1 | ||||
| -rw-r--r-- | tox.ini | 1 |
12 files changed, 177 insertions, 16 deletions
diff --git a/.circleci/config.yml b/.circleci/config.yml index bfdd54dc6..54a686bd1 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -8,7 +8,7 @@ jobs: - 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 diff --git a/.travis.yml b/.travis.yml index 0f0db3949..b627e97d1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,7 @@ addons: - 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.6 python3.6-dev diff --git a/docs/conf.py b/docs/conf.py index 2be6a5ab7..7a8d1858d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -175,3 +175,5 @@ texinfo_documents = [ '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 1623a69e4..ad61beb68 100644 --- a/docs/release/release-notes/functest-release.rst +++ b/docs/release/release-notes/functest-release.rst @@ -106,7 +106,7 @@ Docker tag for hunter: hunter Documents --------- - * Functests Guides: https://functest.readthedocs.io/en/stable-hunter/ + * Functest Guides: https://functest.readthedocs.io/en/stable-hunter/ * API Docs: https://functest-api.readthedocs.io/en/stable-hunter/ Version change diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt new file mode 100644 index 000000000..a04143a14 --- /dev/null +++ b/docs/spelling_wordlist.txt @@ -0,0 +1,157 @@ +ABot +admin +adminURL +api +auth +backend +barbican +benchmarking +Benchmarking +bgpvpn +cacerts +chan +ci +Clearwater +clearwaterims +cloudify +Cloudify +conf +config +dashboarding +defcore +Defcore +Deliverables +dhcp +dockerhub +enduser +env +EnvironmentVariable +epc +fds +frontend +functest +Functest +guestbook +Guestbook +healthcheck +Healthcheck +http +https +hunter +Hunter +ims +ini +init +interop +Interop +interoperability +intra +iptables +Istio +jenkins +Joid +juju +Juju +jumphost +Jumphost +kube +kubernetes +Kubernetes +kvm +linux +metadata +Metadata +middleware +multisite +netready +nfv +nofeature +noha +nosdn +octavia +odl +onboarding +ons +Opendaylight +openims +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 +stor +su +subfolder +subnet +Subnet +subnets +sudo +systemctl +Telco +tenantnetwork +testcase +testcases +TLS +toolchain +txt +un +url +userdata +userid +username +usr +util +utils +UUID +vdb +vepc +vEPC +verifier +versioned +vgpu +vIMS +Virtualised +Virtualized +vm +VM +vmready +vmtp +vnf +Vnf +vping +vPing +vRNC +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 13a8b591a..f83c2d44a 100644 --- a/docs/testing/user/configguide/configguide.rst +++ b/docs/testing/user/configguide/configguide.rst @@ -196,9 +196,9 @@ Functest Dockers for Kubernetes deployment Docker images are available on the dockerhub: * opnfv/functest-kubernetes-core - * opnfv/functest-kubernetest-healthcheck - * opnfv/functest-kubernetest-smoke - * opnfv/functest-kubernetest-features + * opnfv/functest-kubernetes-healthcheck + * opnfv/functest-kubernetes-smoke + * opnfv/functest-kubernetes-features Preparing your environment ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -265,7 +265,7 @@ Results shall be displayed as follows:: 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> diff --git a/docs/testing/user/configguide/prerequisites.rst b/docs/testing/user/configguide/prerequisites.rst index c7b52dc54..dab4a9e6b 100644 --- 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 -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 7c8c48ece..8fad55d33 100644 --- 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 -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. @@ -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 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 diff --git a/docs/testing/user/userguide/test_overview.rst b/docs/testing/user/userguide/test_overview.rst index e18e32748..8aa05fb21 100644 --- a/docs/testing/user/userguide/test_overview.rst +++ b/docs/testing/user/userguide/test_overview.rst @@ -18,7 +18,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, features, components, performance, 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. +-------------+---------------+------------+----------------------------------+ @@ -129,7 +129,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 | -| | | | Subsytem is a typical Telco test | +| | | | Subsystem is a typical Telco test| | | | | case, referenced by ETSI. | | | | | It provides a fully functional | | | | | VoIP System | @@ -224,7 +224,7 @@ and DEPLOY_SCENARIO) to automatically 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 diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst index 3e1d044b2..b00f38737 100644 --- 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 -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 @@ -158,7 +158,7 @@ container:: 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. diff --git a/test-requirements.txt b/test-requirements.txt index db30c7f85..03bdde60d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -15,3 +15,4 @@ bashate # Apache-2.0 lfdocs-conf sphinx-opnfv-theme bandit +sphinxcontrib-spelling @@ -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 -b spelling -Dextensions=sphinxcontrib.spelling docs docs/_build/spellcheck [testenv:pep8] basepython = python2.7 |