From 62e2c71ba557e805acb62483f89d268737d4fc74 Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Tue, 16 Feb 2016 10:26:44 +0100 Subject: Renaming the description text to include in composite docs. testusage.rst will be automatically pulled into the composite docs. I have updated the heading and included a link to the functest userguide. Change-Id: I9ff980f8c33898cc43570b4d544a1dc2d5219222 --- docs/userguide/description.rst | 75 -------------------------------------- docs/userguide/index.rst | 2 +- docs/userguide/testusage.rst | 81 +++++++++++++++++++++++++++++++++++++++--- 3 files changed, 78 insertions(+), 80 deletions(-) delete mode 100644 docs/userguide/description.rst (limited to 'docs') diff --git a/docs/userguide/description.rst b/docs/userguide/description.rst deleted file mode 100644 index b47d5ef62..000000000 --- a/docs/userguide/description.rst +++ /dev/null @@ -1,75 +0,0 @@ -Overview of the test suites -============================= - -Functest is the OPNFV project primarily targeting function testing. -In the Continuous Integration pipeline, it is launched after an OPNFV fresh -installation to validate and verify the basic functions of the infrastructure. - -The current list of test suites can be distributed in 3 main domains:: - - +----------------+----------------+-------------------------------------------+ - | Domain | Test suite | Comments | - +================+================+===========================================+ - | | vPing | NFV "Hello World" using SSH connection | - | | | and floatting IP | - | +----------------+-------------------------------------------+ - | VIM | vPing_userdata | Ping using userdata and cloud-init | - | | | mechanism | - | +----------------+-------------------------------------------+ - |(Virtualised | Tempest | OpenStack reference test suite `[2]`_ | - | Infrastructure +----------------+-------------------------------------------+ - | Manager) | Rally bench | OpenStack testing tool benchmarking | - | | | OpenStack modules `[3]`_ | - +----------------+----------------+-------------------------------------------+ - | | OpenDaylight | Opendaylight Test suite | - | +----------------+-------------------------------------------+ - | Controllers | ONOS | Test suite of ONOS L2 and L3 functions | - | +----------------+-------------------------------------------+ - | | OpenContrail | | - +----------------+----------------+-------------------------------------------+ - | Features | vIMS | Example of a real VNF deployment to show | - | | | the NFV capabilities of the platform. | - | | | The IP Multimedia Subsytem is a typical | - | | | Telco test case, referenced by ETSI. | - | | | It provides a fully functional VoIP System| - | +----------------+-------------------------------------------+ - | | Promise | Resource reservation and management | - | | | project to identify NFV related | - | | | requirements and realize resource | - | | | reservation for future usage by capacity | - | | | management of resource pools regarding | - | | | compute, network and storage. | - | +----------------+-------------------------------------------+ - | | SDNVPN | | - +----------------+----------------+-------------------------------------------+ - -Functest includes different test suites with several test cases within. Some -of the tests are developed by Functest team members whereas others are integrated -from upstream communities or other OPNFV projects. For example, -`Tempest `_ is the -OpenStack integration test suite and Functest is in charge of the selection, -integration and automation of the tests that fit in OPNFV. - -The Tempest suite has been customized but no new test cases have been created. -Some OPNFV feature projects (e.g. SDNVPN) have written some Tempest tests cases -and pushed upstream to be used by Functest. - -The results produced by the tests run from CI are pushed and collected in a NoSQL -database. The goal is to populate the database with results from different sources -and scenarios and to show them on a Dashboard. - -There is no real notion of Test domain or Test coverage. Basic components -(VIM, controllers) are tested through their own suites. Feature projects also -provide their own test suites with different ways of running their tests. - -vIMS test case was integrated to demonstrate the capability to deploy a -relatively complex NFV scenario on top of the OPNFV infrastructure. - -Functest considers OPNFV as a black box. -OPNFV, since the Brahmaputra release, offers lots of potential combinations: - - * 3 controllers (OpenDayligh, ONOS, OpenContrail) - * 4 installers (Apex, Compass, Fuel, Joid) - -Most of the tests are runnable on any combination, but some others might have -restrictions imposed by the installers or the available deployed features. diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 727acfcdf..3ee7923ad 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -17,7 +17,7 @@ A presentation has been created for the first OPNFV Summit `[4]`_. It is assumed that Functest container has been properly installed `[1]`_. -.. include:: ./description.rst +.. include:: ./testusage.rst The different scenarios are described in the section hereafter. diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst index 268eaf9f1..4e4d33c2a 100644 --- a/docs/userguide/testusage.rst +++ b/docs/userguide/testusage.rst @@ -1,6 +1,79 @@ +Overview of the functest suites =============================== -Functest capabilities and usage -=============================== -.. include:: ./description.rst -.. include:: ./runfunctest.rst +Functest is the OPNFV project primarily targeting function testing. +In the Continuous Integration pipeline, it is launched after an OPNFV fresh +installation to validate and verify the basic functions of the infrastructure. + +The current list of test suites can be distributed in 3 main domains:: + + +----------------+----------------+-------------------------------------------+ + | Domain | Test suite | Comments | + +================+================+===========================================+ + | | vPing | NFV "Hello World" using SSH connection | + | | | and floatting IP | + | +----------------+-------------------------------------------+ + | VIM | vPing_userdata | Ping using userdata and cloud-init | + | | | mechanism | + | +----------------+-------------------------------------------+ + |(Virtualised | Tempest | OpenStack reference test suite `[2]`_ | + | Infrastructure +----------------+-------------------------------------------+ + | Manager) | Rally bench | OpenStack testing tool benchmarking | + | | | OpenStack modules `[3]`_ | + +----------------+----------------+-------------------------------------------+ + | | OpenDaylight | Opendaylight Test suite | + | +----------------+-------------------------------------------+ + | Controllers | ONOS | Test suite of ONOS L2 and L3 functions | + | +----------------+-------------------------------------------+ + | | OpenContrail | | + +----------------+----------------+-------------------------------------------+ + | Features | vIMS | Example of a real VNF deployment to show | + | | | the NFV capabilities of the platform. | + | | | The IP Multimedia Subsytem is a typical | + | | | Telco test case, referenced by ETSI. | + | | | It provides a fully functional VoIP System| + | +----------------+-------------------------------------------+ + | | Promise | Resource reservation and management | + | | | project to identify NFV related | + | | | requirements and realize resource | + | | | reservation for future usage by capacity | + | | | management of resource pools regarding | + | | | compute, network and storage. | + | +----------------+-------------------------------------------+ + | | SDNVPN | | + +----------------+----------------+-------------------------------------------+ + +Functest includes different test suites with several test cases within. Some +of the tests are developed by Functest team members whereas others are integrated +from upstream communities or other OPNFV projects. For example, +`Tempest `_ is the +OpenStack integration test suite and Functest is in charge of the selection, +integration and automation of the tests that fit in OPNFV. + +The Tempest suite has been customized but no new test cases have been created. +Some OPNFV feature projects (e.g. SDNVPN) have written some Tempest tests cases +and pushed upstream to be used by Functest. + +The results produced by the tests run from CI are pushed and collected in a NoSQL +database. The goal is to populate the database with results from different sources +and scenarios and to show them on a Dashboard. + +There is no real notion of Test domain or Test coverage. Basic components +(VIM, controllers) are tested through their own suites. Feature projects also +provide their own test suites with different ways of running their tests. + +vIMS test case was integrated to demonstrate the capability to deploy a +relatively complex NFV scenario on top of the OPNFV infrastructure. + +Functest considers OPNFV as a black box. +OPNFV, since the Brahmaputra release, offers lots of potential combinations: + + * 3 controllers (OpenDayligh, ONOS, OpenContrail) + * 4 installers (Apex, Compass, Fuel, Joid) + +Most of the tests are runnable on any combination, but some others might have +restrictions imposed by the installers or the available deployed features. + +Details on working with the functest suites can be found at +http://artifacts.opnfv.org/functest/brahmaputra/userguide/index.html + -- cgit 1.2.3-korg