diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dovetailtool/dovetail.tool.installation.rst | 27 | ||||
| -rw-r--r-- | docs/dovetailtool/index.rst | 2 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/application/testcases.rst | 5 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/deployment/testcase1.rst | 7 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/deployment/testcase2.rst | 6 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/index.rst | 1 | ||||
| -rw-r--r-- | docs/plugfest/2016.05/test_plan/integration/testcases.rst | 5 | ||||
| -rw-r--r-- | docs/testsuites/ipv6/index.rst | 4 | ||||
| -rw-r--r-- | docs/testsuites/ipv6/ipv6.tc001.specification.rst | 12 | ||||
| -rw-r--r-- | docs/testsuites/ipv6/ipv6.tc026.specification.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/02-certification_criteria.rst | 3 | ||||
| -rw-r--r-- | docs/userguide/03-certification_progress.rst | 3 |
12 files changed, 50 insertions, 27 deletions
diff --git a/docs/dovetailtool/dovetail.tool.installation.rst b/docs/dovetailtool/dovetail.tool.installation.rst index 2f544480..93871e76 100644 --- a/docs/dovetailtool/dovetail.tool.installation.rst +++ b/docs/dovetailtool/dovetail.tool.installation.rst @@ -101,6 +101,22 @@ testarea ``ipv6`` in ``compliance_set`` python run.py --testsuite compliance_set --testarea ipv6 +Dovetail provides some sets, ``debug``, ``proposed_tests`` and ``compliance_set``, +``debug`` is used for locally and Continuous Integration(CI) developing purpose, +which provides typical testcase examples, feel free to edit it when develops locally, such as +only to run a testcase which only takes minutes. ``proposed_tests`` is the testcase +candidate which mainly comes from the wiki link +https://wiki.opnfv.org/display/dovetail/Dovetail+Test+Areas+and+Test+Cases. +``compliance_set`` is used for compliance. Moreover, dovetail tool can be easily +extended to support more complicated compliance requirements, +such as feature set based or scenario based compliance. + +If you want to run ``debug``, just run with + +:: + + python run.py --testsuite debug + Running Dovetail in a Docker container ######################################## @@ -115,6 +131,17 @@ Pull Dovetail Docker image from public Dockerhub <Tag> here is the version, 'latest' is used for the master branch. +(Optional) Create Docker image from Dockerfile +----------------------------------------------- +Instead of an official Docker image, you can build your own Docker image from +Dockerfile(s) located under the ``docker/`` directory. The ``Dockerfile`` +is based on Ubuntu and the ``Dockerfile.centos7`` file is for a CentOS based +Docker image. + +:: + + sudo docker build -t <your_new_image_name> -f <your_Dockerfile> . + Dovetail Docker container creation ---------------------------------- diff --git a/docs/dovetailtool/index.rst b/docs/dovetailtool/index.rst index f528a4f7..676c72db 100644 --- a/docs/dovetailtool/index.rst +++ b/docs/dovetailtool/index.rst @@ -12,6 +12,6 @@ Dovetail Overview dovetail.tool.overview.rst dovetail.tool.installation.rst - dovetail.tool.configuation.rst + dovetail.tool.configuration.rst dovetail.tool.configtemplate.rst dovetail.tool.cli.rst diff --git a/docs/plugfest/2016.05/test_plan/application/testcases.rst b/docs/plugfest/2016.05/test_plan/application/testcases.rst index 0e49c5c8..bb1bba76 100644 --- a/docs/plugfest/2016.05/test_plan/application/testcases.rst +++ b/docs/plugfest/2016.05/test_plan/application/testcases.rst @@ -16,8 +16,3 @@ files in this directory that are imported below the toctree command below. .. toctree:: :maxdepth: 2 - - ./testcase1.rst - ./testcase2.rst - ./testcase_etc.rst - diff --git a/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst b/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst index 6014bda3..f583729a 100644 --- a/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst +++ b/docs/plugfest/2016.05/test_plan/deployment/testcase1.rst @@ -9,12 +9,12 @@ Purpose This test case is the first and therefore most important test case. As the first you should take care to do all the set-up found in the -`Plugfest setup and configuration`_ section. +`Plugfest setup and configuration` section. References ^^^^^^^^^^ -Somewhere in `ETSI`_ there is a useful link. +Somewhere in [ETSI]_ there is a useful link. Test Setup ^^^^^^^^^^ @@ -36,5 +36,4 @@ Expected Results 2. This results is used to indicate the pass/fail status for the test case executor. 3. To pass a test case, it all individual metrics would be expected to “pass”. -.. _ETSI: http://www.etsi.org/ - +.. [ETSI] http://www.etsi.org/ diff --git a/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst b/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst index 9c906146..579bbe7b 100644 --- a/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst +++ b/docs/plugfest/2016.05/test_plan/deployment/testcase2.rst @@ -8,13 +8,13 @@ Purpose ^^^^^^^ This test case is the second and no one really cares for it. -If you have it in you please refer to the `Plugfest setup and configuration`_ section, +If you have it in you please refer to the `Plugfest setup and configuration` section, it's OK to simply amble on at this stage. *(It's only the second test case)* References ^^^^^^^^^^ -Somewhere in `ETSI`_ there may be a useful link. +Somewhere in [ETSI]_ there may be a useful link. Test Setup ^^^^^^^^^^ @@ -36,5 +36,5 @@ Expected Results 2. This results is used to indicate the pass/fail status for the test case itself. 3. To pass a test case, metrics would be expected to “pass” 1 and not stray to 3. -.. _ETSI: http://www.etsi.org/ +.. [ETSI] http://www.etsi.org/ diff --git a/docs/plugfest/2016.05/test_plan/index.rst b/docs/plugfest/2016.05/test_plan/index.rst index 61de3bd5..e4bf5e91 100644 --- a/docs/plugfest/2016.05/test_plan/index.rst +++ b/docs/plugfest/2016.05/test_plan/index.rst @@ -16,4 +16,5 @@ OPNFV Plugfest - test plan ./deployment/testcases.rst ./integration/testcases.rst ./application/testcases.rst + ./templates/template.rst diff --git a/docs/plugfest/2016.05/test_plan/integration/testcases.rst b/docs/plugfest/2016.05/test_plan/integration/testcases.rst index d0f01156..c7211f96 100644 --- a/docs/plugfest/2016.05/test_plan/integration/testcases.rst +++ b/docs/plugfest/2016.05/test_plan/integration/testcases.rst @@ -18,8 +18,3 @@ files in this directory that are imported below the toctree command below. .. toctree:: :maxdepth: 2 - - ./testcase1.rst - ./testcase2.rst - ./testcase_etc.rst - diff --git a/docs/testsuites/ipv6/index.rst b/docs/testsuites/ipv6/index.rst index 72fd6a89..a806d644 100644 --- a/docs/testsuites/ipv6/index.rst +++ b/docs/testsuites/ipv6/index.rst @@ -10,6 +10,10 @@ OPNFV IPv6 Compliance Test Plan :maxdepth: 2 ./testplan.rst + ./testprocedure.rst + ./testspecification.rst + ./designspecification.rst ./ipv6.tc001.specification.rst ./ipv6.tc026.specification.rst + ./ipv6_all_testcases.rst diff --git a/docs/testsuites/ipv6/ipv6.tc001.specification.rst b/docs/testsuites/ipv6/ipv6.tc001.specification.rst index 350ff73d..5afb2095 100644 --- a/docs/testsuites/ipv6/ipv6.tc001.specification.rst +++ b/docs/testsuites/ipv6/ipv6.tc001.specification.rst @@ -6,8 +6,6 @@ Dovetail IPv6 tc001 specification - Bulk Creation and Deletion of IPv6 Networks, Ports and Subnets ================================================================================================== -.. table:: - :class: longtable +-----------------------+----------------------------------------------------------------------------------------------------+ |test case name |Bulk creation and deletion of IPv6 networks, ports and subnets | @@ -45,17 +43,17 @@ Dovetail IPv6 tc001 specification - Bulk Creation and Deletion of IPv6 Networks, | | | +-----------------------+----------------------------------------------------------------------------------------------------+ |input specifications |The parameters needed to execute Neutron network APIs. | -| |Refer to Neutron Networking API v2.0 [1]_ [2]_ | +| |Refer to Neutron Networking API v2.0 `[1]`_ `[2]`_ | +-----------------------+----------------------------------------------------------------------------------------------------+ |output specifications |The responses after executing Network network APIs. | -| |Refer to Neutron Networking API v2.0 [1]_ [2]_ | +| |Refer to Neutron Networking API v2.0 `[1]`_ `[2]`_ | +-----------------------+----------------------------------------------------------------------------------------------------+ |pass/fail criteria |If normal response code 200 is returned, the test passes. | | |Otherwise, the test fails with various error codes. | -| |Refer to Neutron Networking API v2.0 [1]_ [2]_ | +| |Refer to Neutron Networking API v2.0 `[1]`_ `[2]`_ | +-----------------------+----------------------------------------------------------------------------------------------------+ |test report |TBD | +-----------------------+----------------------------------------------------------------------------------------------------+ -.._[1]: http://developer.openstack.org/api-ref/networking/v2/ -.._[2]: http://wiki.openstack.org/wiki/Neutron/APIv2-specification +.. _`[1]`: http://developer.openstack.org/api-ref/networking/v2/ +.. _`[2]`: http://wiki.openstack.org/wiki/Neutron/APIv2-specification diff --git a/docs/testsuites/ipv6/ipv6.tc026.specification.rst b/docs/testsuites/ipv6/ipv6.tc026.specification.rst index a4bb6586..e7fd82e7 100644 --- a/docs/testsuites/ipv6/ipv6.tc026.specification.rst +++ b/docs/testsuites/ipv6/ipv6.tc026.specification.rst @@ -6,8 +6,6 @@ Dovetail IPv6 tc026 specification - Service VM as IPv6 vRouter ============================================================== -.. table:: - :class: longtable +-----------------------+--------------------------------------------------------------------------+ |test case name |Service VM as IPv6 vRouter | diff --git a/docs/userguide/02-certification_criteria.rst b/docs/userguide/02-certification_criteria.rst index e69de29b..7665f9a0 100644 --- a/docs/userguide/02-certification_criteria.rst +++ b/docs/userguide/02-certification_criteria.rst @@ -0,0 +1,3 @@ +================== +Dovetail Criteria +================== diff --git a/docs/userguide/03-certification_progress.rst b/docs/userguide/03-certification_progress.rst index e69de29b..6ee02012 100644 --- a/docs/userguide/03-certification_progress.rst +++ b/docs/userguide/03-certification_progress.rst @@ -0,0 +1,3 @@ +================== +Dovetail Progress +================== |