diff options
author | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-06-15 08:15:10 +0200 |
---|---|---|
committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-06-15 15:53:10 +0200 |
commit | ef07bda783fe6fed0c55634e19df95d72338010d (patch) | |
tree | 2bc6836fc3a2c4e487191f8561a0ec8ad52ad520 /docs | |
parent | 7f2d7515e068c2ba072d4f3b4cf0997e06ae8460 (diff) |
Remove cli and api
cli has been deprecated for a while and restapi is uncovered and
unverified. This patch will be partially reverted as soon as next
unit tests cover functest/api.
It partially updates troubleshooting docs which has to be completed
in a second change [1].
[1] https://jira.opnfv.org/browse/FUNCTEST-982
Change-Id: I08e0bd212fcf5f5c5c220eb2500a6b0a6ff46df7
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/testing/user/userguide/index.rst | 7 | ||||
-rw-r--r-- | docs/testing/user/userguide/runfunctest.rst | 32 | ||||
-rw-r--r-- | docs/testing/user/userguide/troubleshooting.rst | 4 |
3 files changed, 6 insertions, 37 deletions
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index 36951fc66..8a40ccf4c 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -51,9 +51,7 @@ References `[15]`_: Testing OpenStack Tempest part 1 -`[16]`_: Running Functest through internal REST API - -`[17]`_: OPNFV Test API +`[16]`_: OPNFV Test API `OPNFV main site`_: OPNFV official web site @@ -76,8 +74,7 @@ IRC support chan: #opnfv-functest .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter .. _`[15]`: https://aptira.com/testing-openstack-tempest-part-1/ -.. _`[16]`: https://wiki.opnfv.org/display/functest/Running+test+cases+via+new+Functest+REST+API -.. _`[17]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html +.. _`[16]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html .. _`OPNFV main site`: http://www.opnfv.org .. _`Functest page`: https://wiki.opnfv.org/functest .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html diff --git a/docs/testing/user/userguide/runfunctest.rst b/docs/testing/user/userguide/runfunctest.rst index a8f5a4694..b5615f3dd 100644 --- a/docs/testing/user/userguide/runfunctest.rst +++ b/docs/testing/user/userguide/runfunctest.rst @@ -103,36 +103,8 @@ Note the list of test cases depend on the installer and the scenario. Reporting results to the test Database ====================================== In OPNFV CI we collect all the results from CI. A test API shall be available -as well as a test database `[17]`_. - -Functest internal API -===================== - -An internal API has been introduced in Euphrates. The goal is to trigger -Functest operations through an API in addition of the CLI. -This could be considered as a first step towards a pseudo micro services -approach where the different test projects could expose and consume APIs to the -other test projects. - -In Euphrates the main method of the APIs are: - - * Show credentials - * Update openrc file - * Show environment - * Update hosts info for domain name - * Prepare environment - * List all testcases - * Show a testcase - * Run a testcase - * List all tiers - * Show a tier - * List all testcases within given tier - * Get the result of the specified task - * Get the log of the specified task - -See `[16]`_ to get examples on how to use the API. +as well as a test database `[16]`_. .. _`[1]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html -.. _`[16]`: https://wiki.opnfv.org/display/functest/Running+test+cases+via+new+Functest+REST+API -.. _`[17]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html +.. _`[16]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst index cce9d009d..375b6ed28 100644 --- a/docs/testing/user/userguide/troubleshooting.rst +++ b/docs/testing/user/userguide/troubleshooting.rst @@ -39,8 +39,8 @@ respective section. These test cases can be run inside the container, using new Functest CLI as follows:: - $ functest testcase run vping_ssh - $ functest testcase run vping_userdata + $ run_tests -t vping_ssh + $ run_tests -t vping_userdata The Functest CLI is designed to route a call to the corresponding internal python scripts, located in paths:: |