aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide/index.rst
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2018-02-27 14:25:49 +0100
committerCédric Ollivier <cedric.ollivier@orange.com>2018-02-27 14:27:57 +0100
commitbaa8f2d5f67d45e5761f92cb93fe22050f08d0fe (patch)
tree05ddb33dc893cad35369b3286db944eac79ffe4d /docs/testing/developer/devguide/index.rst
parent53cd7f8176c996014decb7311d9f546f6b8f2497 (diff)
Clean all OpenStack related modules
Xtesting is only focused on the framework and entry points. Change-Id: I1a4146ed8519438b13810a20ddf1140c35bb6ecd Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Diffstat (limited to 'docs/testing/developer/devguide/index.rst')
-rw-r--r--docs/testing/developer/devguide/index.rst315
1 files changed, 0 insertions, 315 deletions
diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst
deleted file mode 100644
index 19a1bdcb..00000000
--- a/docs/testing/developer/devguide/index.rst
+++ /dev/null
@@ -1,315 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. SPDX-License-Identifier: CC-BY-4.0
-
-************************
-Functest Developer Guide
-************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
-============
-Introduction
-============
-
-Functest is a project dealing with functional testing.
-The project produces its own internal test cases but can also be considered
-as a framework to support feature and VNF onboarding project testing.
-
-Therefore there are many ways to contribute to Functest. You can:
-
- * Develop new internal test cases
- * Integrate the tests from your feature project
- * Develop the framework to ease the integration of external test cases
-
-Additional tasks involving Functest but addressing all the test projects
-may also be mentioned:
-
- * The API / Test collection framework
- * The dashboards
- * The automatic reporting portals
- * The testcase catalog
-
-This document describes how, as a developer, you may interact with the
-Functest project. The first section details the main working areas of
-the project. The Second part is a list of "How to" to help you to join
-the Functest family whatever your field of interest is.
-
-
-========================
-Functest developer areas
-========================
-
-
-Functest High level architecture
-================================
-
-Functest is a project delivering test containers dedicated to OPNFV.
-It includes the tools, the scripts and the test scenarios.
-In Euphrates Alpine containers have been introduced in order to lighten the
-container and manage testing slicing. The new containers are created according
-to the different tiers:
-
- * functest-core: https://hub.docker.com/r/opnfv/functest-core/
- * functest-healthcheck: https://hub.docker.com/r/opnfv/functest-healthcheck/
- * functest-smoke: https://hub.docker.com/r/opnfv/functest-smoke/
- * functest-features: https://hub.docker.com/r/opnfv/functest-features/
- * functest-components: https://hub.docker.com/r/opnfv/functest-components/
- * functest-vnf: https://hub.docker.com/r/opnfv/functest-vnf/
- * functest-parser: https://hub.docker.com/r/opnfv/functest-parser/
- * functest-restapi: https://hub.docker.com/r/opnfv/functest-restapi/
-
-Standalone functest dockers are maintained for Euphrates but Alpine containers
-are recommended.
-
-Functest can be described as follow::
-
- +----------------------+
- | |
- | +--------------+ | +-------------------+
- | | | | Public | |
- | | Tools | +------------------+ OPNFV |
- | | Scripts | | | System Under Test |
- | | Scenarios | | | |
- | | | | | |
- | +--------------+ | +-------------------+
- | |
- | Functest Docker |
- | |
- +----------------------+
-
-Functest internal test cases
-============================
-The internal test cases in Euphrates are:
-
-
- * api_check
- * connection_check
- * snaps_health_check
- * vping_ssh
- * vping_userdata
- * odl
- * odl_netvirt
- * rally_full
- * rally_sanity
- * tempest_smoke_serial
- * tempest_full_parallel
- * cloudify_ims
-
-By internal, we mean that this particular test cases have been developed and/or
-integrated by functest contributors and the associated code is hosted in the
-Functest repository.
-An internal case can be fully developed or a simple integration of
-upstream suites (e.g. Tempest/Rally developed in OpenStack, or odl suites are
-just integrated in Functest).
-
-The structure of this repository is detailed in `[1]`_.
-The main internal test cases are in the opnfv_tests subfolder of the
-repository, the internal test cases can be grouped by domain:
-
- * sdn: odl, odl_netvirt, odl_fds
- * openstack: api_check, connection_check, snaps_health_check, vping_ssh, vping_userdata, tempest_*, rally_*
- * vnf: cloudify_ims
-
-If you want to create a new test case you will have to create a new folder under
-the testcases directory (See next section for details).
-
-Functest external test cases
-============================
-The external test cases are inherited from other OPNFV projects, especially the
-feature projects.
-
-The external test cases are:
-
- * barometer
- * bgpvpn
- * doctor
- * domino
- * fds
- * parser
- * promise
- * refstack_defcore
- * snaps_smoke
- * functest-odl-sfc
- * orchestra_clearwaterims
- * orchestra_openims
- * vyos_vrouter
- * juju_vepc
-
-External test cases integrated in previous versions but not released in
-Euphrates:
-
- * copper
- * moon
- * netready
- * security_scan
-
-
-The code to run these test cases is hosted in the repository of the project.
-Please note that orchestra test cases are hosted in Functest repository and not
-in orchestra repository. Vyos_vrouter and juju_vepc code is also hosted in
-functest as there are no dedicated projects.
-
-
-Functest framework
-==================
-
-Functest is a framework.
-
-Historically Functest is released as a docker file, including tools, scripts and
-a CLI to prepare the environment and run tests.
-It simplifies the integration of external test suites in CI pipeline and provide
-commodity tools to collect and display results.
-
-Since Colorado, test categories also known as **tiers** have been created to
-group similar tests, provide consistent sub-lists and at the end optimize
-test duration for CI (see How To section).
-
-The definition of the tiers has been agreed by the testing working group.
-
-The tiers are:
- * healthcheck
- * smoke
- * features
- * components
- * vnf
-
-Functest abstraction classes
-============================
-
-In order to harmonize test integration, abstraction classes have been
-introduced:
-
- * testcase: base for any test case
- * unit: run unit tests as test case
- * feature: abstraction for feature project
- * vnf: abstraction for vnf onboarding
-
-The goal is to unify the way to run tests in Functest.
-
-Feature, unit and vnf_base inherit from testcase::
-
- +----------------------------------------------------------------+
- | |
- | TestCase |
- | |
- | - init() |
- | - run() |
- | - push_to_db() |
- | - is_successful() |
- | |
- +----------------------------------------------------------------+
- | | | |
- V V V V
- +--------------------+ +---------+ +------------------------+ +-----------------+
- | | | | | | | |
- | feature | | unit | | vnf | | robotframework |
- | | | | | | | |
- | | | | |- prepare() | | |
- | - execute() | | | |- deploy_orchestrator() | | |
- | BashFeature class | | | |- deploy_vnf() | | |
- | | | | |- test_vnf() | | |
- | | | | |- clean() | | |
- +--------------------+ +---------+ +------------------------+ +-----------------+
-
-
-Testcase
---------
-.. raw:: html
- :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.testcase.html
-
-Feature
--------
-.. raw:: html
- :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.feature.html
-
-Unit
-----
-.. raw:: html
- :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.unit.html
-
-VNF
----
-.. raw:: html
- :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.vnf.html
-
-Robotframework
---------------
-.. raw:: html
- :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.robotframework.html
-
-
-see `[5]`_ to get code samples
-
-
-Functest util classes
-=====================
-
-In order to simplify the creation of test cases, Functest develops also some
-functions that are used by internal test cases.
-Several features are supported such as logger, configuration management and
-Openstack capabilities (tacker,..).
-These functions can be found under <repo>/functest/utils and can be described as
-follows::
-
- functest/utils/
- |-- config.py
- |-- constants.py
- |-- decorators.py
- |-- env.py
- |-- functest_utils.py
- |-- openstack_tacker.py
- `-- openstack_utils.py
-
-It is recommended to use the SNAPS-OO library for deploying OpenStack instances.
-SNAPS `[4]`_ is an OPNFV project providing OpenStack utils.
-
-
-TestAPI
-=======
-Functest is using the Test collection framework and the TestAPI developed by
-the OPNFV community. See `[6]`_ for details.
-
-
-Reporting
-=========
-A web page is automatically generated every day to display the status based on
-jinja2 templates `[3]`_.
-
-
-Dashboard
-=========
-
-Additional dashboarding is managed at the testing group level, see `[7]`_ for
-details.
-
-
-=======
-How TOs
-=======
-
-See How to section on Functest wiki `[8]`_
-
-
-==========
-References
-==========
-
-_`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/index.html Functest configuration guide
-
-_`[2]`: http://artifacts.opnfv.org/functest/docs/userguide/index.html functest user guide
-
-_`[3]`: https://git.opnfv.org/cgit/releng/tree/utils/test/reporting
-
-_`[4]`: https://git.opnfv.org/snaps/
-
-_`[5]` : http://testresults.opnfv.org/functest/framework/index.html
-
-_`[6]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html
-
-_`[7]`: https://opnfv.biterg.io/goto/283dba93ca18e95964f852c63af1d1ba
-
-_`[8]`: https://wiki.opnfv.org/pages/viewpage.action?pageId=7768932
-
-IRC support chan: #opnfv-functest