X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Ftesting%2Fuser%2Fuserguide%2Frunfunctest.rst;h=a8f5a46945ad660e45d5629db14f19f9b17f6132;hb=920e8d3cd4386e4d9085b5557b0c381d5f043830;hp=db85c18ffad4ddd0718de2ffce582a7d127613d9;hpb=bcfb795ef4307b91c10205f6531bed1d11efd489;p=functest.git diff --git a/docs/testing/user/userguide/runfunctest.rst b/docs/testing/user/userguide/runfunctest.rst index db85c18ff..a8f5a4694 100644 --- a/docs/testing/user/userguide/runfunctest.rst +++ b/docs/testing/user/userguide/runfunctest.rst @@ -1,6 +1,4 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - +.. SPDX-License-Identifier: CC-BY-4.0 Executing Functest suites ========================= @@ -12,7 +10,7 @@ Assuming that you pulled the container and your environement is ready, you can simply run the tiers by typing (e.g. with functest-healthcheck):: sudo docker run --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-healthcheck @@ -38,54 +36,20 @@ The result tables show the results by test case, it can be:: Manual run ========== -If you want to run the test step by step, you may add docker option then run the -different commands within the docker. +If you want to run the test step by step, you may add docker option then run +the different commands within the docker. Considering the healthcheck example, running functest manaully means:: sudo docker run -ti --env-file env \ - -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds \ + -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \ -v $(pwd)/images:/home/opnfv/functest/images \ opnfv/functest-healthcheck /bin/bash The docker prompt shall be returned. Then within the docker run the following commands:: - $ source /home/opnfv/functest/conf/openstack.creds - -Prepare environment -------------------- -Prior to commencing the Functest environment preparation, we can check -the initial status of the environment. Issue the **functest env status** -command at the prompt:: - - # functest env status - # Functest environment is not installed. - -To prepare the Functest docker container for test case execution, type:: - - # functest env prepare - # ... - # Functest environment ready to run tests. - -you may also type prepare_env instead of functest env prepare. - -To list some basic information about an already prepared Functest -docker container environment, issue the **functest env show** at the -prompt:: - bash-4.3# functest env show - +------------------------------+---------------------------------+ - | FUNCTEST ENVIRONMENT | VALUE | - +------------------------------+---------------------------------+ - | STATUS | ready | - | SCENARIO | os-nosdn-nofeature-noha | - | DEBUG FLAG | false | - | BUILD_TAG | None | - | INSTALLER | compass | - | POD | huawei-pod1 | - +------------------------------+---------------------------------+ - -See configuration guide for details on Functest environnement variables. + $ source /home/opnfv/functest/conf/env_file Tier ---- @@ -119,7 +83,7 @@ Testcases can be listed, shown and run though the CLI:: +-------------------+--------------------------------------------------+------------------+---------------------------+ | TEST CASE | DESCRIPTION | CRITERIA | DEPENDENCY | +-------------------+--------------------------------------------------+------------------+---------------------------+ - | api_check | This test case verifies the retrieval of | 100 | ^((?!netvirt).)*$ | + | api_check | This test case verifies the retrieval of | 100 | ^((?!lxd).)*$ | | | OpenStack clients: Keystone, Glance, | | | | | Neutron and Nova and may perform some | | | | | simple queries. When the config value of | | | @@ -138,7 +102,7 @@ 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 +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