From 79140281403a83ecfededbd1b58bf668bd4d1901 Mon Sep 17 00:00:00 2001 From: Linda Wang Date: Tue, 10 Oct 2017 11:29:42 +0000 Subject: Fix the format issue of documentation Also update the structure of functest code. Change-Id: Id3fa012d6c3204a0a8d7e6e4ba3159c52b68c6f5 Signed-off-by: Linda Wang --- docs/testing/developer/devguide/index.rst | 17 ++++------ docs/testing/user/configguide/configguide.rst | 48 +++++++++++++++------------ docs/testing/user/userguide/test_details.rst | 45 +++++++++++++------------ 3 files changed, 55 insertions(+), 55 deletions(-) (limited to 'docs') diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index 1eae33f65..96ba53e6d 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -197,12 +197,7 @@ The tiers are: * smoke * features * components - * performance * vnf - * stress - -Note Functest deals with healthcheck, smoke, features, components and vnf tiers. -Performance and stress tiers are out of scope. Functest abstraction classes ============================ @@ -217,7 +212,7 @@ introduced: The goal is to unify the way to run tests in Functest. -Feature, unit and vnf_base inherit from testcase: +Feature, unit and vnf_base inherit from testcase:: +-----------------------------------------+ | | @@ -225,12 +220,12 @@ Feature, unit and vnf_base inherit from testcase: | | | - init() | | - run() | - | - publish_report() | - | - check_criteria() | + | - push_to_db() | + | - is_successful() | | | +-----------------------------------------+ - | | - V V + | | | + V V V +--------------------+ +--------------+ +--------------------------+ | | | | | | | feature | | unit | | vnf | @@ -280,7 +275,7 @@ follows:: functest/utils/ |-- config.py |-- constants.py - |-- decoratos.py + |-- decorators.py |-- env.py |-- functest_utils.py |-- openstack_clean.py diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst index 9d0179c80..e41700b23 100644 --- a/docs/testing/user/configguide/configguide.rst +++ b/docs/testing/user/configguide/configguide.rst @@ -353,16 +353,14 @@ includes two main directories: src and repos directories are used to host third party code used for the tests. -The functest code is under /usr/lib/python2.7/site-packages/functest -The structure can be described as follows:: +The structure of functest repo can be described as follows:: |-- INFO |-- LICENSE |-- api | `-- apidoc |-- build.sh - |-- commons - | |-- docker + |-- docker | |-- Dockerfile | |-- Dockerfile.aarch64.patch | |-- components @@ -373,7 +371,9 @@ The structure can be described as follows:: | |-- healthcheck | |-- smoke | |-- vnf - | `-- thirdparty-requirements.txt + | |-- parser + | |-- restapi + | |-- thirdparty-requirements.txt |-- docs | |-- com | |-- images @@ -392,13 +392,20 @@ The structure can be described as follows:: | |-- urls.py | |-- common | | |-- api_utils.py - | | `-- error.py + | | |-- thread.py | `-- resources | `-- v1 | |-- creds.py | |-- envs.py | |-- testcases.py - | `-- tiers.py + | |-- tiers.py + | |-- tasks.py + | `-- database + | |-- db.py + | `-- v1 + | |-- handlers.py + | |-- models.py + | `-- swagger |-- ci │   |-- check_deployment.py │   |-- config_aarch64_patch.yaml @@ -412,36 +419,32 @@ The structure can be described as follows:: │   |-- run_tests.py │   |-- testcases.yaml │   |-- tier_builder.py - │   `-- tier_handler.py + │   |-- tier_handler.py |-- cli │   |-- cli_base.py │   |-- commands │   │   |-- cli_env.py │   │   |-- cli_os.py │   │   |-- cli_testcase.py - │   │   `-- cli_tier.py + │   │   |-- cli_tier.py │   |-- functest-complete.sh |-- core │   |-- feature.py │   |-- testcase.py │   |-- unit.py - │   `-- vnf.py + │   |-- vnf.py |-- energy │   |-- energy.py - │   `-- energy.pyc |-- opnfv_tests - │   |-- mano - │   │   |-- orchestra.py - │   |-- openstack - │   │   |-- rally - │   │   |-- refstack_client - │   │   |-- snaps - │   │   |-- tempest - │   │   `-- vping - │   |-- sdn + │   `-- openstack + │      |-- rally + │      |-- refstack_client + │      |-- snaps + │      |-- tempest + │      |-- vping + │   `-- sdn │   │   `-- odl │   `-- vnf - │   |-- aaa │   |-- ims │   `-- router |-- tests @@ -490,7 +493,8 @@ We may distinguish several directories, the first level has 5 directories: * **functest**: This directory contains all the code needed to run functest internal cases and OPNFV onboarded feature or VNF test cases. -Functest directory has 7 sub-directories: +Functest directory has 7 sub-directories, which is located under +/usr/lib/python2.7/site-packages/functest: * **api**: This directory is dedicated for the internal Functest API and the API (framework) documentations. * **ci**: This directory contains test structure definition files diff --git a/docs/testing/user/userguide/test_details.rst b/docs/testing/user/userguide/test_details.rst index c9ef63d38..56cdd3b66 100644 --- a/docs/testing/user/userguide/test_details.rst +++ b/docs/testing/user/userguide/test_details.rst @@ -426,28 +426,29 @@ The Clearwater architecture is described as follows: :align: center :alt: vIMS architecture - cloudify_ims_perf - ^^^^^^^^^^^^ - This testcase extends the cloudify_ims test case. - The first part is similar but the testing part is different. - The testing part consists in automating a realistic signaling load on the vIMS - using an Ixia loader (proprietary tools) - - You need to have access to an Ixia licence server - defined in the configuration file. - - To start this test you need to have access to an Ixia licence server and have ixia image locally - - - case_name: cloudify_ims_perf - project_name: functest - criteria: 100 - blocking: false - description: '' - dependencies: - installer: '' - scenario: 'o' - run: - module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf' - class: 'CloudifyImsPerf' + +cloudify_ims_perf +^^^^^^^^^^^^^^^^^ +This testcase extends the cloudify_ims test case. +The first part is similar but the testing part is different. +The testing part consists in automating a realistic signaling load on the vIMS +using an Ixia loader (proprietary tools) + - You need to have access to an Ixia licence server defined in the configuration + file. + +To start this test you need to have access to an Ixia licence server and have ixia image locally + - + case_name: cloudify_ims_perf + project_name: functest + criteria: 100 + blocking: false + description: '' + dependencies: + installer: '' + scenario: '' + run: + module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf' + class: 'CloudifyImsPerf' orchestra_openims ^^^^^^^^^^^^^^^^^ -- cgit 1.2.3-korg