diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/index.rst | 122 | ||||
| -rw-r--r-- | docs/userguide/introduction.rst | 98 | ||||
| -rw-r--r-- | docs/userguide/runfunctest.rst | 75 | ||||
| -rw-r--r-- | docs/userguide/troubleshooting.rst | 298 |
4 files changed, 418 insertions, 175 deletions
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 79620789f..dcca57bef 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -1,33 +1,39 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + ========================= OPNFV FUNCTEST user guide ========================= .. toctree:: - :numbered: :maxdepth: 2 Introduction ============ -The goal of this documents is to describe the Functest test cases as well as -provide a procedure about how to execute them. +The goal of this document is to describe the Functest test cases as well as +provide a procedure to execute them. A presentation has been created for the first OPNFV Summit `[4]`_. -It is assumed that Functest container has been properly installed `[1]`_. +This document is a continuation of the Functest Configuration Guide`[1]`_ and it +is assumed that the Functest Docker container is properly deployed. + +**IMPORTANT**: All the instructions described in this guide must be performed +inside the container. .. include:: ./introduction.rst -The different scenarios are described in the section hereafter. +The different test cases are described in the section hereafter. VIM (Virtualized Infrastructure Manager) ---- +---------------------------------------- -vPing_SSH +vPing_ssh ^^^^^^^^^ -Given the script 'ping.sh':: +Given the script **ping.sh**:: #!/bin/sh while true; do @@ -42,9 +48,11 @@ Given the script 'ping.sh':: sleep 1 done -The goal of this test is described as follows:: - vPing test case +The goal of this test is to establish an SSH connection using a floating IP +on the public network and verify that 2 instances can talk on a private network:: + + vPing_ssh test case +-------------+ +-------------+ | | | | | | Boot VM1 with IP1 | | @@ -74,7 +82,7 @@ The goal of this test is described as follows:: | | | | | | If ping: | | | | exit OK | | - | | else (timeout) | | + | | else (timeout): | | | | exit Failed | | | | | | +-------------+ +-------------+ @@ -85,7 +93,10 @@ It is the first basic use case which shall work on any deployment. vPing_userdata ^^^^^^^^^^^^^^ -The goal of this test can be described as follows:: +This test case is similar to vPing_ssh but without the use of floating ips +and the public network. It only checks that 2 instances can talk to each other +on a private network but it also verifies that the Nova metadata service is +properly working:: vPing_userdata test case +-------------+ +-------------+ @@ -111,10 +122,9 @@ The goal of this test can be described as follows:: | | | | +-------------+ +-------------+ -This scenario is similar to the previous one but it uses cloud-init (nova -metadata service) instead of floating IPs and SSH connection. When the second VM -boots it will execute the script automatically and the ping will be detected -capturing periodically the output in the console-log of the second VM. +When the second VM boots it will execute the script passed as userdata +automatically and the ping will be detected capturing periodically the output +in the console-log of the second VM. Tempest @@ -129,24 +139,24 @@ Tempest has batteries of tests for: * Other specific tests useful in validating an OpenStack deployment Functest uses Rally `[3]`_ to run the Tempest suite. -Rally generates automatically the Tempest configuration file (tempest.conf). -Before running the actual test cases, Functest creates the needed resources and -updates the appropriate parameters to the configuration file. +Rally generates automatically the Tempest configuration file **tempest.conf**. +Before running the actual test cases, +Functest creates the needed resources (user, tenant) and +updates the appropriate parameters into the configuration file. When the Tempest suite is executed, each test duration is measured and the full -console output is stored in the tempest.log file for further analysis. +console output is stored in a *log* file for further analysis. As an addition of Arno, Brahmaputra runs a customized set of Tempest test cases. -The list is specificed through *--tests-file* when running Rally. -This option has been introduced in Rally in version 0.1.2. +The list is specificed through *--tests-file* when executing the Rally command. +This option has been introduced in the version 0.1.2 of the Rally framework. -The customized test list is available in the Functest repo `[4]`_. -This list contains more than 200 Tempest test cases and can be divided +This customized list contains more than 200 Tempest test cases and can be divided into two main sections: - 1) Set of tempest smoke test cases + 1) Set of Tempest smoke test cases 2) Set of test cases from DefCore list `[8]`_ -The goal of the Tempest test suite is to check the basic functionalities of +The goal of the Tempest test suite is to check the basic functionalities of the different OpenStack components on an OPNFV fresh installation using the corresponding REST API interfaces. @@ -154,14 +164,14 @@ the corresponding REST API interfaces. Rally bench test suites ^^^^^^^^^^^^^^^^^^^^^^^ -Rally `[3]`_ is a benchmarking tool that answers the question:: +Rally `[3]`_ is a benchmarking tool that answers the question: - “How does OpenStack work at scale?”. +*How does OpenStack work at scale?* -The goal of this test suite is to benchmark the different OpenStack modules and +The goal of this test suite is to benchmark all the different OpenStack modules and get significant figures that could help to define Telco Cloud KPIs. -The OPNFV scenarios are based on the collection of the existing Rally scenarios: +The OPNFV Rally scenarios are based on the collection of the actual Rally scenarios: * authenticate * cinder @@ -180,11 +190,10 @@ SDN Controllers --------------- Brahmaputra introduces new SDN controllers. -There are currently 3 possible controllers: +There are currently 2 available controllers: * OpenDaylight (ODL) * ONOS - * OpenContrail (OCL) OpenDaylight ^^^^^^^^^^^^ @@ -241,7 +250,7 @@ TestON Framework is used to test the ONOS SDN controller functions. The test cases deal with L2 and L3 functions. The ONOS test suite can be run on any ONOS compliant scenario. -The test cases may be described as follows: +The test cases are described as follows: * onosfunctest: The main executable file contains the initialization of the docker environment and functions called by FUNCvirNetNB and @@ -280,17 +289,19 @@ The test cases may be described as follows: NULL in ONOS or not -OpenContrail -^^^^^^^^^^^^ -TODO OVNO - - - Features -------- vIMS ^^^^ +The IP Multimedia Subsystem or IP Multimedia Core Network Subsystem (IMS) is an +architectural framework for delivering IP multimedia services. + +vIMS has been integrated in Functest to demonstrate the capability to deploy a +relatively complex NFV scenario on the OPNFV platform. The deployment of a complete +functional VNF allows the test of most of the +essential functions needed for a NFV platform. + The goal of this test suite consists of: * deploy a VNF orchestrator (Cloudify) @@ -304,13 +315,7 @@ The Clearwater architecture is described as follows: :align: center :alt: vIMS architecture -Two types of information are stored in the Test Database: - * the duration of each step (orchestion deployment, VNF deployment and test) - * the test results - -The deployment of a complete functional VNF allows the test of most of the -essential functions needed for a NFV platform. Promise ^^^^^^^ @@ -345,31 +350,19 @@ The available 33 test cases can be grouped into 7 test suites: #. Cleanup test allocations: Destroys all allocations in OpenStack. -The specific parameters for Promise can be found in config_functest.yaml and -include:: - - promise: - general: - tenant_name: Name of the OpenStack tenant/project (e.g. promise) - tenant_description: Description of the OpenStack tenant (e.g. promise Functionality Testing) - user_name: Name of the user tenant (e.g. promiser) - user_pwd: Password of the user tenant (e.g. test) - image_name: Name of the software image (e.g. promise-img) - flavor_name: Name of the flavor (e.g. promise-flavor with 1 vCPU and 512 MB RAM) - flavor_vcpus: 1 - flavor_ram: 512 - flavor_disk: 0 -However, these parameters must not be changed, as they are the values expected -by the Promise test suite. .. include:: ./runfunctest.rst Test results ============ -For Brahmaputra test results, see the functest results document at: -http://artifacts.opnfv.org/functest/brahmaputra/docs/results/index.html +For Brahmaputra test results, see the functest results document at `[12]`_ + +Note that the results are documented per scenario basis. Although most of the test +cases might show the same output, some of them are not supported by +certain scenario. Please select the appropriate scenario and compare the results +to the referenced in the documentation. Test Dashboard @@ -385,7 +378,7 @@ The URL of this dashboard is TODO LF References ========== -.. _`[1]`: Functest configuration guide URL +.. _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/#functional-testing-installation .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf @@ -396,6 +389,7 @@ References .. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml .. _`[10]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/rally_cert/task.yaml .. _`[11]`: http://robotframework.org/ +.. _`[12]`: http://artifacts.opnfv.org/functest/brahmaputra/docs/results/index.html OPNFV main site: opnfvmain_. diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index 4e4d33c2a..03039ef87 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + Overview of the functest suites =============================== @@ -5,54 +8,59 @@ 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:: +The current list of test suites can be distributed in 3 main domains: VIM +(Virtualised Infrastructure Manager), Controllers and Features. + ++----------------+----------------+-------------------------------------------+ +| Domain | Test suite | Comments | ++================+================+===========================================+ +| VIM | vPing | NFV "Hello World" using SSH connection | +| | | and floatting IP | +| +----------------+-------------------------------------------+ +| | vPing_userdata | Ping using userdata and cloud-init | +| | | mechanism | +| +----------------+-------------------------------------------+ +| | Tempest | OpenStack reference test suite `[2]`_ | +| +----------------+-------------------------------------------+ +| | Rally bench | OpenStack testing tool benchmarking | +| | | OpenStack modules `[3]`_ | ++----------------+----------------+-------------------------------------------+ +| | OpenDaylight | Opendaylight Test suite | +| +----------------+-------------------------------------------+ +| Controllers | ONOS | Test suite of ONOS L2 and L3 functions | +| | | See `ONOSFW User Guide`_ for details | ++----------------+----------------+-------------------------------------------+ +| 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. | +| | | See `Promise User Guide`_ for details | +| +----------------+-------------------------------------------+ +| | Doctor | Doctor platform, as of Brahmaputra release| +| | | , provides the two features: | +| | | * Immediate Notification | +| | | * Consistent resource state awareness | +| | | (compute), see `Doctor User Guide`_ for | +| | | details | ++----------------+----------------+-------------------------------------------+ - +----------------+----------------+-------------------------------------------+ - | 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, +of the tests are developed by Functest team members whereas others are +integrated from upstream communities or other OPNFV projects. For example, `Tempest <http://docs.openstack.org/developer/tempest/overview.html>`_ 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 @@ -68,12 +76,14 @@ 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) + * 2 controllers (OpenDayligh, ONOS) * 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 - +.. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html +.. _`[3]`: https://rally.readthedocs.org/en/latest/index.html +.. _`Doctor User Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/featureusage-doctor.html +.. _`Promise User Guide`: http://artifacts.opnfv.org/promise/brahmaputra/docs/userguide/index.html +.. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html diff --git a/docs/userguide/runfunctest.rst b/docs/userguide/runfunctest.rst index 364333740..79364bfd5 100644 --- a/docs/userguide/runfunctest.rst +++ b/docs/userguide/runfunctest.rst @@ -1,14 +1,22 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + Executing the functest suites ============================= Manual testing -------------- -Once the Functest docker container is running and Functest environment ready -(through */home/opnfv/repos/functest/docker/prepare_env.sh* script), the system is -ready to run the tests. +This section assumes the following: + * The Functest Docker container is running + * The docker prompt is shown + * The Functest environment is ready (prepare_env.sh has been executed) + +If any of the above steps is missing please refer to the Functest Config Guide +as they are a prerequisite and all the commands explained in this section **must** be +performed **inside the container**. -The script *run_tests.sh* launches the test in an automated way. +The script **run_tests.sh** launches the test in an automated way. Although it is possible to execute the different tests manually, it is recommended to use the previous shell script which makes the call to the actual scripts with the appropriate parameters. @@ -29,7 +37,7 @@ several options:: -s|--serial run tests in one thread -t|--test run specific set of tests <test_name> one or more of the following separated by comma: - vping_ssh,vping_userdata,odl,rally,tempest,vims,onos,promise,ovno + vping_ssh,vping_userdata,odl,onos,tempest,rally,vims,promise,doctor examples: run_tests.sh @@ -43,28 +51,38 @@ and special conditions to push data. The *-t* option can be used to specify the list of a desired test to be launched, by default Functest will launch all the test suites in the following order: -vPing, Tempest, vIMS, Rally. + + 1) vPing test cases + 2) Tempest suite + 3) SDN controller suites + 4) Feature project tests cases (Promise, Doctor, ...) + 5) vIMS suite + 6) Rally suite + +Please note that for some scenarios some test cases might not be launched. +Functest calculates automatically which test can be executed and which cannot given +the environment variable **DEPLOY_SCENARIO** to the docker container. A single or set of test may be launched at once using *-t <test_name>* specifying the test name or names separated by commas in the following list: -*[vping,vping_userdata,odl,rally,tempest,vims,onos,promise]*. - -The *-n* option is used for preserving all the possible OpenStack resources created -by the tests after their execution. +*[vping_ssh,vping_userdata,odl,onos,rally,tempest,vims,promise,doctor]*. -Please note that Functest includes cleaning mechanism in order to remove -all the VIM resources except what was present before running any test. The script +Functest includes cleaning mechanism in order to remove +all the OpenStack resources except what was present before running any test. The script *$repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/generate_defaults.py* is called once by *prepare_env.sh* when setting up the Functest environment to snapshot all the OpenStack resources (images, networks, volumes, security groups, tenants, users) so that an eventual cleanup does not remove any of this defaults. +The *-n* option is used for preserving all the possible OpenStack resources created +by the tests after their execution. + The *-s* option forces execution of test cases in a single thread. Currently this option affects Tempest test cases only and can be used e.g. for troubleshooting concurrency problems. -The script -*$repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py* +The script **clean_openstack.py** which is located in +*$repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/* is normally called after a test execution if the *-n* is not specified. It is in charge of cleaning the OpenStack resources that are not specified in the defaults file generated previously which is stored in @@ -77,21 +95,22 @@ flag is not specified in the *run_tests.sh* command. The reason to include this cleanup meachanism in Functest is because some test suites such as Tempest or Rally create a lot of resources (users, tenants, networks, volumes etc.) that are not always properly cleaned, so this -cleaning function has been set to keep the system as clean as it was before a +function has been set to keep the system as clean as it was before a full Functest execution. Within the Tempest test suite it is possible to define which test cases to execute -by editing *test_list.txt* file before executing *run_tests.sh* script. This file +by editing **test_list.txt** file before executing **run_tests.sh** script. This file is located in *$repos_dir/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt* -Although *run_tests.sh* provides an easy way to run any test, it is possible to -do a direct call to the desired test script. For example:: - python $repos_dir/functest/testcases/vPing/vPing.py -d +Although **run_tests.sh** provides an easy way to run any test, it is possible to +do a direct call to the desired test script. For example: + + python $repos_dir/functest/testcases/vPing/vPing_ssh.py -d Automated testing ----------------- -As mentioned in `[1]`, the *prepare-env.sh* and *run_test.sh* can be called within +As mentioned previously, the **prepare-env.sh** and **run_test.sh** can be called within the container from Jenkins. There are 2 jobs that automate all the manual steps explained in the previous section. One job runs all the tests and the other one allows testing test suite by test suite specifying the test name. The user might use one or @@ -104,8 +123,6 @@ detect whether a given test is runnable or not on the given scenario. Some Functest test suites cannot be systematically run (e.g. ODL suite can not be run on an ONOS scenario). - - CI provides some useful information passed to the container as environment variables: @@ -135,8 +152,8 @@ The constraints per test case are defined in the Functest configuration file scenario: 'onos' .... -At the end of the Functest environment creation (prepare_env.sh see `[1]`_), a -file */home/opnfv/functest/conf/testcase-list.txt* is created with the list of +At the end of the Functest environment creation, a file +*/home/opnfv/functest/conf/testcase-list.txt* is created with the list of all the runnable tests. Functest considers the static constraints as regular expressions and compare them with the given scenario name. @@ -162,10 +179,12 @@ The order of execution is also described in the Functest configuration file:: The tests are executed in the following order: - * Basic scenario (vPing_ssh, vPing_userdata, Tempest) - * Controller suites: ODL or ONOS or OpenContrail - * Feature projects (promise, vIMS) - * Rally (benchmark scenario) + 1) vPing test cases + 2) Tempest suite + 3) SDN controller suites + 4) Feature project tests cases (Promise, Doctor, ...) + 5) vIMS suite + 6) Rally suite As explained before, at the end of an automated execution, the OpenStack resources might be eventually removed. diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst index f669025ff..5c56ec157 100644 --- a/docs/userguide/troubleshooting.rst +++ b/docs/userguide/troubleshooting.rst @@ -1,53 +1,226 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 Troubleshooting =============== +This section gives some guidelines about how to troubleshoot the test cases +owned by Functest. + +**IMPORTANT**: As in the previous section, the steps defined below must be +executed inside the Functest Docker container and after sourcing the OpenStack credentials:: + + . $creds + +or:: + + source /home/opnfv/functest/conf/openstack.creds + VIM --- +This section covers the test cases related to the VIM (vPing, Tempest, Rally). + +vPing common +^^^^^^^^^^^^ +For both vPing test cases (**vPing_ssh**, and **vPing_userdata**), the first steps are +similar: + + * Create Glance image + * Create Network + * Create Security Group + * Create instances + +After these actions, the test cases differ and will be explained in their respective section. + +These test cases can be run inside the container as follows:: + + $repos_dir/functest/docker/run_tests.sh -t vping_ssh + $repos_dir/functest/docker/run_tests.sh -t vping_userdata + +The **run_tests.sh** script is basically calling internally the corresponding +vPing scripts, located in +*$repos_dir/functest/testcases/vPing/CI/libraries/vPing_ssh.py* and +*$repos_dir/functest/testcases/vPing/CI/libraries/vPing_userdata.py* with the +appropriate flags. + +After finishing the test execution, the corresponding script will remove all +created resources in OpenStack (image, instances, network and security group). +When troubleshooting, it is advisable sometimes to keep those resources in case the +test fails and a manual testing is needed. This can be achieved by adding the flag *-n*:: + + $repos_dir/functest/docker/run_tests.sh -n -t vping_ssh + $repos_dir/functest/docker/run_tests.sh -n -t vping_userdata + + +Some of the common errors that can appear in this test case are:: + + vPing_ssh- ERROR - There has been a problem when creating the neutron network.... + +This means that there has been some problems with Neutron, even before creating the +instances. Try to create manually a Neutron network and a Subnet to see if that works. +The debug messages will also help to see when it failed (subnet and router creation). +Example of Neutron commands (using 10.6.0.0/24 range for example):: + + neutron net-create net-test + neutron subnet-create --name subnet-test --allocation-pool start=10.6.0.2,end=10.6.0.100 --gateway 10.6.0.254 net-test 10.6.0.0/24 + neutron router-create test_router + neutron router-interface-add <ROUTER_ID> test_subnet + neutron router-gateway-set <ROUTER_ID> <EXT_NET_NAME> + +Another related error can occur while creating the Security Groups for the instances:: + + vPing_ssh- ERROR - Failed to create the security group... + +In this case, proceed to create it manually. These are some hints:: + + neutron security-group-create sg-test + neutron security-group-rule-create sg-test --direction ingress --protocol icmp --remote-ip-prefix 0.0.0.0/0 + neutron security-group-rule-create sg-test --direction ingress --ethertype IPv4 --protocol tcp --port-range-min 80 --port-range-max 80 --remote-ip-prefix 0.0.0.0/0 + neutron security-group-rule-create sg-test --direction egress --ethertype IPv4 --protocol tcp --port-range-min 80 --port-range-max 80 --remote-ip-prefix 0.0.0.0/0 + +The next step is to create the instances. The image used is located in +*/home/opnfv/functest/data/cirros-0.3.4-x86_64-disk.img* and a Glance image is created +with the name **functest-vping**. If booting the instances fails (i.e. the status +is not **ACTIVE**), you can check why it failed by doing:: + + nova list + nova show <INSTANCE_ID> + +It might show some messages about the booting failure. To try that manually:: + + nova boot --flavor 2 --image functest-vping --nic net-id=<NET_ID> nova-test + +This will spawn a VM using the network created previously manually. +In all the OPNFV tested scenarios from CI, it never has been a problem with the +previous actions. Further possible problems are explained in the following sections. + + vPing_SSH ^^^^^^^^^ +This test case creates a floating IP on the external network and assigns it to +the second instance **opnfv-vping-2**. The purpose of this is to establish +a SSH connection to that instance and SCP a script that will ping the first instance. +This script is located in the repository under +*$repos_dir/functest/testcases/vPing/CI/libraries/ping.sh* and takes an IP as +a parameter. When the SCP is completed, the test will do an SSH call to that script +inside the second instance. Some problems can happen here:: + + vPing_ssh- ERROR - Cannot establish connection to IP xxx.xxx.xxx.xxx. Aborting + +If this is displayed, stop the test or wait for it to finish (if you have used the flag +*-n* in **run_tests.sh** explained previously) so that the test does not clean +the OpenStack resources. It means that the Container can not reach the public +IP assigned to the instance **opnfv-vping-2**. There are many possible reasons, and +they really depend on the chosen scenario. For most of the ODL-L3 and ONOS scenarios +this has been noticed and it is a known limitation. + +First, make sure that the instance **opnfv-vping-2** succeeded to get an IP from +the DHCP agent. It can be checked by doing:: + + nova console-log opnfv-vping-2 + +If the message *Sending discover* and *No lease, failing* is shown, it probably +means that the Neutron dhcp-agent failed to assign an IP or even that it was not +responding. At this point it does not make sense to try to ping the floating IP. + +If the instance got an IP properly, try to ping manually the VM from the container:: + + nova list + <grab the public IP> + ping <public IP> + +If the ping does not return anything, try to ping from the Host where the Docker +container is running. If that solves the problem, check the iptable rules because +there might be some rules rejecting ICMP or TCP traffic coming/going from/to the container. + +At this point, if the ping does not work either, try to reproduce the test +manually with the steps described above in the vPing common section with the addition:: + + neutron floatingip-create <EXT_NET_NAME> + nova floating-ip-associate nova-test <FLOATING_IP> + + +Further troubleshooting is out of scope of this document, as it might be due to +problems with the SDN controller. Contact the installer team members or send an +email to the corresponding OPNFV mailing list for more information. -vPing should work on all the scenarios. In case of timeout, check your network -connectivity. The test case creates its own security group to allow SSH access, -check your network settings and your security rules. vPing_userdata ^^^^^^^^^^^^^^ +This test case does not create any floating IP neither establishes an SSH +connection. Instead, it uses nova-metadata service when creating an instance +to pass the same script as before (ping.sh) but as 1-line text. This script +will be executed automatically when the second instance **opnfv-vping-2** is booted. + +The only known problem here for this test to fail is mainly the lack of support +of cloud-init (nova-metadata service). Check the console of the instance:: + + nova console-log opnfv-vping-2 + +If this text or similar is shown:: + + checking http://169.254.169.254/2009-04-04/instance-id + failed 1/20: up 1.13. request failed + failed 2/20: up 13.18. request failed + failed 3/20: up 25.20. request failed + failed 4/20: up 37.23. request failed + failed 5/20: up 49.25. request failed + failed 6/20: up 61.27. request failed + failed 7/20: up 73.29. request failed + failed 8/20: up 85.32. request failed + failed 9/20: up 97.34. request failed + failed 10/20: up 109.36. request failed + failed 11/20: up 121.38. request failed + failed 12/20: up 133.40. request failed + failed 13/20: up 145.43. request failed + failed 14/20: up 157.45. request failed + failed 15/20: up 169.48. request failed + failed 16/20: up 181.50. request failed + failed 17/20: up 193.52. request failed + failed 18/20: up 205.54. request failed + failed 19/20: up 217.56. request failed + failed 20/20: up 229.58. request failed + failed to read iid from metadata. tried 20 + +it means that the instance failed to read from the metadata service. Contact +the Functest or installer teams for more information. + +NOTE: Cloud-init in not supported on scenario dealing with ONOS and the tests have been +excluded from CI in those scenarios. -Cloud-init in not supported on scenario dealing with ONOS. Tempest ^^^^^^^ In the upstream OpenStack CI all the Tempest test cases are supposed to pass. If some test cases fail in an OPNFV deployment, the reason is very probably one -of the following:: - - +-----------------------------+------------------------------------------------+ - | Error | Details | - +=============================+================================================+ - | Resources required for test | Such resources could be e.g. an external | - | case execution are missing | network and access to the management subnet | - | | (adminURL) from the Functest docker container. | - +-----------------------------+------------------------------------------------+ - | OpenStack components or | Check running services in the controller and | - | services are missing or not | compute nodes (e.g. with "systemctl" or | - | configured properly | "service" commands). Configuration parameters | - | | can be verified from related .conf files | - | | located under /etc/<component> directories. | - +-----------------------------+------------------------------------------------+ - | Some resources required for | The tempest.conf file, automatically generated | - | execution test cases are | by Rally in Functest, does not contain all the | - | missing | needed parameters or some parameters are not | - | | set properly. | - | | The tempest.conf file is located in /home/opnfv| - | | /.rally/tempest/for-deployment-<UUID> in | - | | Functest container | - | | Use "rally deployment list" command in order to| - | | check UUID of current deployment. | - +-----------------------------+------------------------------------------------+ +of the following + ++-----------------------------+------------------------------------------------+ +| Error | Details | ++=============================+================================================+ +| Resources required for test | Such resources could be e.g. an external | +| case execution are missing | network and access to the management subnet | +| | (adminURL) from the Functest docker container. | ++-----------------------------+------------------------------------------------+ +| OpenStack components or | Check running services in the controller and | +| services are missing or not | compute nodes (e.g. with "systemctl" or | +| configured properly | "service" commands). Configuration parameters | +| | can be verified from related .conf files | +| | located under /etc/<component> directories. | ++-----------------------------+------------------------------------------------+ +| Some resources required for | The tempest.conf file, automatically generated | +| execution test cases are | by Rally in Functest, does not contain all the | +| missing | needed parameters or some parameters are not | +| | set properly. | +| | The tempest.conf file is located in /home/opnfv| +| | /.rally/tempest/for-deployment-<UUID> in | +| | Functest container | +| | Use "rally deployment list" command in order to| +| | check UUID of current deployment. | ++-----------------------------+------------------------------------------------+ When some Tempest test case fails, captured traceback and possibly also related @@ -59,7 +232,55 @@ related Rally deployment folder. Rally ^^^^^ -Same error causes than for Tempest mentioned above may lead to error in Rally. +Same error causes than for Tempest mentioned above may lead to errors in Rally. + +It is possible to run only one Rally scenario, instead of the whole suite. +To do that, call the python script (instead of *run_tests.sh*) as follows:: + + python $repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/run_rally-cert.py -h + usage: run_rally-cert.py [-h] [-d] [-r] [-s] [-v] [-n] test_name + + positional arguments: + test_name Module name to be tested. Possible values are : [ + authenticate | glance | cinder | heat | keystone | neutron | + nova | quotas | requests | vm | all ] The 'all' value + performs all possible test scenarios + + optional arguments: + -h, --help show this help message and exit + -d, --debug Debug mode + -r, --report Create json result file + -s, --smoke Smoke test mode + -v, --verbose Print verbose info about the progress + -n, --noclean Don't clean the created resources for this test. + +For example, to run the Glance scenario with debug information:: + + python $repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/run_rally-cert.py -d glance + +Possible scenarios are: + * authenticate + * glance + * cinder + * heat + * keystone + * neutron + * nova + * quotas + * requests + * vm + +To know more about what those scenarios are doing, they are defined in: +*$repos_dir/functest/testcases/VIM/OpenStack/CI/suites*. For more info about +Rally scenario definition please refer to the Rally official documentation. + +If the flag *all* is specified, it will run all the scenarios one by one. Please +note that this might take some time (~1,5hr), taking around 1 hour to complete the +Nova scenario. + +To check any possible problems with rally, the logs are stored under +*/home/opnfv/functest/results/rally/* in the Functest container. + Controllers ----------- @@ -77,11 +298,7 @@ due to wrong return code. ONOS ^^^^ -TODO - -OpenContrail -^^^^^^^^^^^^ - +Please refer to the ONOS documentation. Feature ------- @@ -91,9 +308,9 @@ vIMS vIMS deployment may fail for several reasons, the most frequent ones are described in the following table: -+===================================+====================================+ -| Error | Comments | +-----------------------------------+------------------------------------+ +| Error | Comments | ++===================================+====================================+ | Keystone admin API not reachable | Impossible to create vIMS user and | | | tenant | +-----------------------------------+------------------------------------+ @@ -111,12 +328,15 @@ described in the following table: | SSH connection issue between the | if vPing test fails, vIMS test will| | Test container and the VM | fail... | +-----------------------------------+------------------------------------+ -| No Internet access from a VM | the VMs of the VNF must have an | +| No Internet access from the VM | the VMs of the VNF must have an | | | external access to Internet | +-----------------------------------+------------------------------------+ +| No access to OpenStack API from | Orchestrator can be installed but | +| the VM | the vIMS VNF installation fails | ++-----------------------------------+------------------------------------+ Promise ^^^^^^^ -TODO +Please refer to the Promise documentation. |