From 459f50252ef2410bcb46c2069ec4a5055d6f8864 Mon Sep 17 00:00:00 2001 From: Linda Wang Date: Wed, 29 Nov 2017 09:29:24 +0000 Subject: Update documentation of Functest Mainly update the robotframework part, according to this patch: https://gerrit.opnfv.org/gerrit/#/c/47841/ Change-Id: If4dee6233ba65dd83734e0465d0dc6e8d5753da3 Signed-off-by: Linda Wang --- docs/testing/developer/devguide/index.rst | 53 ++++++++++++++----------- docs/testing/user/configguide/configguide.rst | 1 + docs/testing/user/userguide/troubleshooting.rst | 2 +- 3 files changed, 31 insertions(+), 25 deletions(-) diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index 12325c66c..11d541ae2 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -134,7 +134,7 @@ The external test cases are: * functest-odl-sfc * orchestra_clearwaterims * orchestra_openims - * cloudify_vrouter + * vyos_vrouter * juju_vepc External test cases integrated in previous versions but not released in @@ -148,7 +148,7 @@ Euphrates: 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. Cloudify_vrouter and juju_vepc code is also hosted in +in orchestra repository. Vyos_vrouter and juju_vepc code is also hosted in functest as there are no dedicated projects. @@ -190,28 +190,28 @@ 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 - +--------------------+ +--------------+ +--------------------------+ - | | | | | | - | feature | | unit | | vnf | - | | | | | | - | | | | | - prepare() | - | - execute() | | | | - deploy_orchestrator() | - | BashFeature class | | | | - deploy_vnf() | - | | | | | - test_vnf() | - | | | | | - clean() | - +--------------------+ +--------------+ +--------------------------+ + +----------------------------------------------------------------+ + | | + | 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 @@ -234,6 +234,11 @@ 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 diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst index f455d18c2..6bc1b5e37 100644 --- a/docs/testing/user/configguide/configguide.rst +++ b/docs/testing/user/configguide/configguide.rst @@ -423,6 +423,7 @@ The structure of functest repo can be described as follows:: │   |-- functest-complete.sh |-- core │   |-- feature.py + │   |-- robotframework.py │   |-- testcase.py │   |-- unit.py │   |-- vnf.py diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst index 62587de34..becc24a3d 100644 --- a/docs/testing/user/userguide/troubleshooting.rst +++ b/docs/testing/user/userguide/troubleshooting.rst @@ -375,4 +375,4 @@ described in the following table: Please note that this test case requires resources (8 VM (2Go) + 1 VM (4Go)), it is there fore not recommended to run it on a light configuration. -.. _`OPNFV Functest Developer Guide`: http://artifacts.opnfv.org/functest/docs/devguide/# +.. _`OPNFV Functest Developer Guide`: http://artifacts.opnfv.org/functest/docs/testing_developer_devguide/index.html# -- cgit 1.2.3-korg