docs/testing/user/userguide/index.rst

   1 .. _functest-userguide:
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5
   6 *******************
   7 Functest User Guide
   8 *******************
   9
  10 .. toctree::
  11    :maxdepth: 2
  12
  13
  14
  15 Introduction
  16 ============
  17
  18 The goal of this document is to describe the OPNFV Functest test cases and to
  19 provide a procedure to execute them.
  20
  21 **IMPORTANT**: It is assumed here that Functest has been properly deployed
  22 following the installation guide procedure  `[1]`_.
  23
  24 .. include:: ./test_overview.rst
  25
  26 .. include:: ./test_details.rst
  27
  28 .. include:: ./runfunctest.rst
  29
  30 .. include:: ./test_results.rst
  31
  32 .. include:: ./reporting.rst
  33
  34 .. figure:: ../../../images/functest-reporting-status.png
  35    :align: center
  36    :alt: Functest reporting portal Fuel status page
  37
  38 .. include:: ./troubleshooting.rst
  39
  40
  41 References
  42 ==========
  43
  44 `[1]`_: Functest configuration guide
  45
  46 `[2]`_: OpenStack Tempest documentation
  47
  48 `[3]`_: Rally documentation
  49
  50 `[4]`_: Functest in depth (Danube)
  51
  52 `[5]`_: Clearwater vIMS blueprint
  53
  54 `[6]`_: NIST web site
  55
  56 `[7]`_: OpenSCAP web site
  57
  58 `[8]`_: Refstack client
  59
  60 `[9]`_: Defcore
  61
  62 `[10]`_: OpenStack interoperability procedure
  63
  64 `[11]`_: Robot Framework web site
  65
  66 `[12]`_: Functest User guide
  67
  68 `[13]`_: SNAPS wiki
  69
  70 `[14]`_: vRouter
  71
  72 `[15]`_: Testing OpenStack Tempest part 1
  73
  74 `[16]`_: Running Functest through internal REST API
  75
  76 `[17]`_: OPNFV Test API
  77
  78 `OPNFV main site`_: OPNFV official web site
  79
  80 `Functest page`_: Functest wiki page
  81
  82 IRC support chan: #opnfv-functest
  83
  84 .. _`[1]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
  85 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
  86 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
  87 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
  88 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
  89 .. _`[6]`: https://scap.nist.gov/
  90 .. _`[7]`: https://github.com/OpenSCAP/openscap
  91 .. _`[8]`: https://github.com/openstack/refstack-client
  92 .. _`[9]`: https://github.com/openstack/defcore
  93 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
  94 .. _`[11]`: http://robotframework.org/
  95 .. _`[12]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
  96 .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO
  97 .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter
  98 .. _`[15]`: https://aptira.com/testing-openstack-tempest-part-1/
  99 .. _`[16]`: https://wiki.opnfv.org/display/functest/Running+test+cases+via+new+Functest+REST+API
 100 .. _`[17]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html
 101 .. _`OPNFV main site`: http://www.opnfv.org
 102 .. _`Functest page`: https://wiki.opnfv.org/functest
 103 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 104 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 105 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/functest/ci/config_functest.yaml
 106 .. _`Functest reporting`: http://testresults.opnfv.org/reporting/master/functest/status-apex.html