Additional Unit Tests for core modules

This patch adds unit tests for vnf and pytest_suite_runner.
It also fixes several pylint warnings/errors.

Additional tests are required to check args values.

Co-Authored-By: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I75a829233481655c794402830e1da037ab7cdb8d
Signed-off-by: ashishk1994 <ashishk.iiit@gmail.com>

Get a logger before printing

It also fixes pylint errors.

Change-Id: I0d973360574a517724d0be3986c788c3ce7f54d4
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Add Energy recording support"

Merge "Conform ODL with last framework updates"

Merge changes from topic 'add_testcase_str'

* changes:
  Remove the former results in DB url
  Implement TestCase __str__()

Merge "Bugfix: initialize the logger for snaps"

Remove the former results in DB url

It conforms generate_report.py with the previous change [1].

[1] https://gerrit.opnfv.org/gerrit/#/c/33511/

Change-Id: I677ebd416f462a591439fc7b637c02d7964e6173
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Add Energy recording support

It adds helpers to send notifications to Energy recording API and
related unit tests.
It requires a dedicated section in functest config file
to set connectivity parameters to Energy recording API.

It is using shared API Recording at http://161.105.253.100:8888

Change-Id: Idcb74d1bf7341ccce7cc1c3926f22338ce24f714
Signed-off-by: Benoit HERARD <benoit.herard@orange.com>

Conform ODL with last framework updates

Now ODL TestCase calculates the ratio between critical tests passed
and failed and saves it in result. Non-critical test cases can fail as
result doesn't take them into account [1].

It also updates default attribute values in TestCase and allows result
to be float.

[1] http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#setting-criticality

Change-Id: Id4a89271b5b1a90cd3c1e2b08591ff26ffaffee0
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Rename VnfOnBoardingBase to VnfOnBoarding

Change-Id: I514340fc6180e29b31ef11bdea9f719aa2bbb738
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Rename vnf_base to vnf

Change-Id: I0b8b9b2e85717fc92a233e4f7344b3419421778d
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Bugfix: initialize the logger for snaps

Testcases about snaps failed due to the absence of attribute 'logger'.

Change-Id: I78c85e51f63afa767fa73aa12faea066ad432371
Signed-off-by: Linda Wang <wangwulin@huawei.com>

Implement TestCase __str__()

It's designed to be called by run_tests.py when printing the results of
test cases and when generating the global report.

Change-Id: If4a6f023ef2344bbc4f940d07dde4b776dce5d68
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Rename TestCase check_result() to is_successful()"

Merge "Print the real testcase duration"

Rename TestCase check_result() to is_successful()

Change-Id: I41cea33b4c1dae79e75231e7c7e069fc89736f34
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Print the real testcase duration

TestCase offers a new public method to calculate and print the duration.
It also adds the related unit tests and adapts run_tests.py.

Change-Id: Ib6a7e637dafacb9027146199aeb033c2dcb986c6
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Replace CONST.* by getattribute/setattr"

Merge "Extended the timeout for Opera"

Replace CONST.* by getattribute/setattr

Directories affected:
 - ci
 - core

and respective unit tests

Change-Id: I6a3d5aa68de29fc5a37ae543a067ff797eba33e6
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

Merge "Add iniparse to requirements.txt"

Merge "Check open args in test_odl"

Merge "Replace project_name by case_name in result file name"

Replace project_name by case_name in result file name

It avoids erasing functest.log when project_name = functest.

Change-Id: Icae898abb8b51c89b79bb1124adfadab8b0b3b99
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Add iniparse to requirements.txt

Package iniparse is absent for functest, while it is required by
rally.py

Change-Id: Ia50216cfebdc9033f6a5f4abc6338951aaa2e8ab
Signed-off-by: Linda Wang <wangwulin@huawei.com>

Check open args in test_odl

Change-Id: I4b0060502621c7491820b9aa42d8f2f63b06a9ae
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Add Danube 2.0 reporting status

Change-Id: Icc09b824a4e7906dfab031b679ba3d0aa86ab0cd
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

Merge "Forbid calling generate_report from cmdline"

Merge "Define loggers as class-private members"

Merge "Delete functest.utils.functest_logger"

Forbid calling generate_report from cmdline

Change-Id: Ic9ea7507dc5f1f781b57c4573e971a2c8a8ca9ef
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Define loggers as class-private members

This mangling ensures that all info messages printed from core packages
are shown in console. It also avoids sphinx to print them.

Change-Id: I07db9f33060c195bce3b48b06a6640eb6c56c2eb
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Delete functest.utils.functest_logger

It deletes functest.utils.functest_logger and the related unit tests.
Then it modifies all functest modules to get all loggers via
logging.getLogger(). __name__ is mainly used as getLogger arg as
proposed by logging [1].

All loggers and handlers are now defined via functest/ci/logging.ini
instead of a dict loaded by an external json file.

Now only warn messages and info messages from ci and core packages are
printed in console.

[1] https://docs.python.org/2/library/logging.html

Change-Id: Ic192855e0f9bf94825d8f7ec73549a0f3b8d44c5
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Update tempest.conf to enable tempest from external server"

Merge "Update rally_conf.json for creating deployment"

Merge "Add the choice of interface for keystoneclient"

Merge "Publish framework presentation"

Merge changes from topic 'remove_openstack_dir'

* changes:
  Remove openstack directory
  Remove create_instance_and_ip.py

Merge "refstack-client userguide"

Extended the timeout for Opera

Change-Id: Ifeb4aecf66d75c9bb98d5dafdbe20be78423565e
Signed-off-by: helenyao <yaohelan@huawei.com>

Merge "Update INFO file for Euphrates"

Remove openstack directory

It is useles right now and won't be used in the future.

Change-Id: I9aa121544051f49f7e7e794ae3b2c4a9ea516e47
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

Update tempest.conf to enable tempest from external server

1. The endpoint type to use for OpenStack Identity API v3
   "v3_endpoint_type" is set to be "adminURL" by default, which should
   be updated to the env OS_ENDPOINT_TYPE with the value "publicURL"
2. Reset the identity region name to "RegionOne"
3. For keystone api v3 in Newton, 5 testcases aimming at identity admin
   v2 test should be omitted.

JIRA: FUNCTEST-801

Change-Id: I47ae41a80de0a52d32d25c9783860955f465099c
Signed-off-by: Linda Wang <wangwulin@huawei.com>

Merge "Updated basic attributes for opera testcase"

refstack-client userguide

JIRA: FUNCTEST-758

container setup steps are skipped, since they already
included in the functest userguide documents.

Change-Id: I729d4c3174b03706624a7235da24cb3043b28c2c
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>

Updated basic attributes for opera testcase

The original value as unknown is not reasonable.

Change-Id: I23672ea70fff9b3badb2d2cf4f32dc3e038d7bb3
Signed-off-by: helenyao <yaohelan@huawei.com>

Merge "Remove missing statements in test_odl"

Merge "Restrict coverage output to all functest packages"

Merge "Fix pylint warnings in snaps"

Remove create_instance_and_ip.py

JIRA: FUNCTEST-817

Change-Id: Ib297ec656a19c9ea4e06c6f2e133ed514a1dbf35
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

Merge "rename tempest.conf to refstack_tempest.conf"

Publish framework presentation

This is the first version prepared before merging "Switch TestCase
attribute criteria to result" [1].
It will also be updated to integrate VNF classes as soon as they are
ready (UT, pylint, docstrings...).

[1] https://gerrit.opnfv.org/gerrit/#/c/33695/

Change-Id: I2fc8f4ae377afee70e083cd51e5725eccda15431
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Add the choice of interface for keystoneclient

1. When functest is running on external host not jumpserver,
   keystoneclient is used to retrieve or create projects/tenants
   and users, which would fail to establish connection to the admin
   endpoint.
2. Keystoneclient will connect to the public endpoint by setting the
   env OS_INTERFACE to be public.
3. Remove the admin endpoint check in check_os.sh.

JIRA: FUNCTEST-801

Change-Id: I324f5c8fdf61447319070a23f6b6bc6b1bbc1d48
Signed-off-by: Linda Wang <wangwulin@huawei.com>

Remove missing statements in test_odl

It mainly removes _fake_url_for() which is useless since get_endpoint()
is not called for identity.

Coverage for functest/tests/unit/odl/test_odl.py : 100%

Change-Id: I5809c5eac4021c44113e70379621ab311187c669
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Restrict coverage output to all functest packages

The next packages/modules are not yet covered:
  - functest/cli/setup.py
  - functest/core/pytest_suite_runner.py
  - functest/opnfv_tests/mano
  - functest/opnfv_tests/openstack/examples
  - functest/opnfv_tests/openstack/snaps
  - functest/opnfv_tests/openstack/vping
  - functest/opnfv_tests/sdn/onos
  - functest/opnfv_tests/vnf/aaa
  - functest/opnfv_tests/vnf/ims
  - functest/opnfv_tests/vnf/router
  - functest/utils/openstack

Change-Id: Id62749796864537615f0ca8b162ce77b6c1a3309
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Fix pylint warnings in snaps

Pylint only warns about missing module docstrings now.

Change-Id: I989ff800cd2628fed80a2d3510ef37ce2876cbd4
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Update rally_conf.json for creating deployment

1. The rally_conf.json is obtained via def get_credentials_for_rally(),
   where the parameter endpoint_type is supposed to get from the env
   OS_ENDPOINT_TYPE or OS_INTERFACE, just as the def
   get_creds_from_env_vars() in rally project [1].

[1] https://github.com/openstack/rally/blob/master/rally/cli/envutils.py

JIRA: FUNCTEST-801

Change-Id: I6b6be82b9ff7f04948b47c4fca836d415fe13f8b
Signed-off-by: Linda Wang <wangwulin@huawei.com>

Fix the instance initialization error for OnosSfc

Change-Id: I1820bed1bbb7dbddd3923ea6439f58592595f5c8
Signed-off-by: helenyao <yaohelan@huawei.com>

Logger must be a singleton

It avoids creating a python object for every message printed.

Change-Id: Ia42b59db9f7ce4eadc7e91da4d193db646b54d85
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Fix false positives in test_tempest

It fixes the return values and the side effects expected from the next
methods:
  - configure_tempest
  - create_tempest_resources
  - generate_test_list
  - apply_tempest_blacklist
  - run_verifier_tests
  - parse_verifier_result

JIRA: FUNCTEST-803

Change-Id: Ib7dbd28e003cf0f27f497ad8e63cf7ae5ce564de
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Catch os.makedirs() exceptions in tempest.py

It can raise an error exception if the leaf directory already exists or
cannot be created [1].

[1] https://docs.python.org/2/library/os.html

JIRA: FUNCTEST-804

Change-Id: Ie410bccf1bb2dfd36df6e918c152ecf94844b5d7
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Manage criteria in TestCase

It converts all criteria values to the corresponding percent in
functest/ci/testcases.yaml.

Result is expected to be equal or greater than criteria. If both are 0,
result is considered as false.

It is compatible with the old behavior but warns to update.
It will allow a safer remove.

It also fixes a bug in test_tempest to allow merging [1] and
tier_handler.py which required that type criteria was str.

[1] https://gerrit.opnfv.org/gerrit/#/c/27949/

Change-Id: Ib6edcfa3103b7d51b0bdc83119f1cea2a8be9fbc
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Switch TestCase attribute criteria to result

It mainly avoids mixing input and output.
Criteria is now an input set in functest/ci/testcases.yaml and then
must be passed as __init__() args (which will be proposed in an
additional change).

Then it also renames the related TestCase method to
check_result().

Change-Id: Ifc3c8e3ea6cde7e3edf7174bed4bf2bf0894e8e3
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Remove the useless opnfv_tests dir in tests"

Remove the useless opnfv_tests dir in tests

Change-Id: I41a8db181adf6c0c67b9de8380c3ccdd1ad3b529
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Remove useless lines of code in barometer.py

Change-Id: Ie312dbd296a85a35096294331c28a45f8dc10d0c
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

rename tempest.conf to refstack_tempest.conf

since for tempest smoke/full, etc, will also use a file named
tempest.conf this wil cover the refstack tempest.conf,
rename it to refstack_tempest.conf, then easily for users to
debug to check if the configure file is correct or not.

Change-Id: Ic2f93fb05effb1a61276cb6ba755076a0404caad
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>

Switch testcase to test case in docstrings

Change-Id: Iea64673788a3d5ab5eb3028522f659de183440ed
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Minor changes in docstrings"

Merge "Ignore _build (sphinx output dir)"

Merge "Remove exec right for ci config files"

Merge "Fix pylint warnings in decorators.py"

Merge "Stop hardcoding results suffix in push_to_db"

[VNF_base] Support existing tenant and user

Support existing tenant and user with a get_or_create_tenant method.
If the tenant and user already exist it only get the id of those

JIRA: FUNCTEST-799

Change-Id: Id5daf2904592e42199471bdd3547e861e6db6e32
Signed-off-by: boucherv <valentin.boucher@orange.com>

Remove exec right for ci config files

Change-Id: Ibf7e549252234fb69dd6e0cc7920b66759469aea
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Ignore _build (sphinx output dir)

Change-Id: I8afb00fb2942d2144968896981532324ac8e322d
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Fix pylint warnings in decorators.py

Change-Id: Ie6c53feb97053248c909d641753b44b5f51c8719
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Minor changes in docstrings

It removes case_name from the list of attributes that run() must set
because it's now managed by run_tests.py (see __init__())

Change-Id: Id6228880257d0e9fb27483c56aa9985197feb04e
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Stop hardcoding results suffix in push_to_db

Adding results in url is useless as it is defined in results
section in config_functest.yaml.

It allows defining the full name in case of dumping to file (see
decorator.py). The commented local file is the value required by
dovetail.

Co-Authored-By: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I35ba9b34d99e138292f099934e28585ee8b85604
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Add mock to requirements.txt

Package mock is absent for functest, while it is required by
decorators.py.

Change-Id: I0d042def0335e369c4e22a349e3068829e1d2c59
Signed-off-by: Linda Wang <wangwulin@huawei.com>

Update INFO file for Euphrates

Change-Id: Iddc36c0c9d3ce897c15393479e7ccb2d2a3230c9
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

Add docstings in feature.py

It also modifies the testcase module docstring.
Now features.py is rated 10/10 by pylint.

Change-Id: I83f2ac385b2a713d116c1ae4b49ba9cc9b26a83c
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Remove former cmd instance attribute

It's now useless as it's passed as run() args.

Change-Id: I97e14bd431a8844cd90905bf2050c48fb00f1cc5
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Fix Sphinx warnings/errors

It takes into account the following warnings/errors:
  - Inline strong start-string without end-string
  - Unexpected indentation

Change-Id: Idb05c7b04ba98ef8f3ef65e6ec7c9bb5b7571cad
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Use Sphinx to create API documentation

The packages/modules which are part of Functest framework are parsed.
It also generates ODL TestCase API as it's well commented.

The content is simply referring to modules.

Change-Id: I873ae1535fc05c9d7e426f5fb54f9579eb01e6d1
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Fix the irc channel

Change-Id: Idb446213274b7dfb03b0ee072717a35e03428609
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Add class attribute docstrings in testcase.py"

Merge "Fix typos in vnf_base.py"

Merge "Add copper section in testcases.yaml"

Add class attribute docstrings in testcase.py

Change-Id: I91a5c6fb14f7c76a348bb4329d023bab53a3804c
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Updated method calls to SNAPS tests."

Fix typos in vnf_base.py

Change-Id: Idf0380930e97e1aa4584ba000f32d742a87d9486
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "Set image and flavor id in tempest config file"

Add copper section in testcases.yaml

JIRA: COPPER-34

Change-Id: I7301745718b9c035493c2e5c162e2a4e117982db
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>

Add license in feature.py

Change-Id: I75f51f216dcbf0db1c563cf381c28efc47241d3c
Signed-off-by: SerenaFeng <feng.xiaowei@zte.com.cn>

Remove deprecated feature modules

All features running bash programs are now simply defined in
testcases.yaml. All deprecated modules and unit tests are removed.

Change-Id: I7047b6f7a1e43cb8ed5ba2d569d5dcecae68fb86
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

Merge "update check_os.sh admin port seds to match public"

update check_os.sh admin port seds to match public

If there's not a / on the end of the admin url then port is not found
public already handled this correctly. updating admin to match public

JIRA: FUNCTEST-793
Change-Id: I01d654dfe247c6102a90ba7ea3921a9f15991789
Signed-off-by: Dan Radez <dradez@redhat.com>

Set image and flavor id in tempest config file

Kingbird tests require that image and flavor are defined in tempest
configuration file.

JIRA: FUNCTEST-783

Change-Id: If96ef8e38e3f1a5946b687f1e5c8c0a6c3a90d54
Signed-off-by: Juha Kosonen <juha.kosonen@nokia.com>

Updated method calls to SNAPS tests.

Due to the refactoring performed in gerrit patch
31435, the calls to the SNAPS tests needed to be
updated.

JIRA: SNAPS-23

Change-Id: I9069ea61b1d15b52a081501b03ae8bf73da10f29
Signed-off-by: spisarski <s.pisarski@cablelabs.com>