Functional testcases for apmec

Purpose of functional testcases is to verify various functionality of apmec features. From apmec home directory, testcases are located at apmec/tests/functional.

Writing a testcase:A testcase is written by declaring a class name derived from class base.BaseApmecTest. BaseApmecTest is class declared in apmec/tests/functional/mead/base.py.

A testcase body typically looks as below:

class meaClassName(base.BaseApmecTest):

  def test_create_delete(self):

    //Testcase operations

    //validations or asserts

    //cleanup

In above example test class 'meaClassName' is derived from base.BaseApmecTest. Testcases typically has sections to setup, test, validate results and finally cleanup.

Input yaml files: These are input files used in testcases for operations like create mead or create mea. The location of files is apmec/tests/etc/samples/.

requirements.txt and test-requirements.txt : The file requirements.txt and test-requirements.txt lists all the packages needed for functional test. These packages are installed during devstack installation. If there are any new packages needed for functional test make sure they are added in test-requirements.txt.

Asserting values in testcase: The base class BaseApmecTest inherits base.TestCase which has inbuild assert functions which can be used in testcase. Eg: assertIsNotNone, assertEqual

Apmec-client: In base.py we instantiate apmecclient object which has apis to create/delete/list mead/mea once given the necessary parameters. Verify apmecclient/v1_0/client.py for all the apmec related apis supported.

Important guidelines to follow:

Install test-requirements.txt with below command:

pip install -r test-requirements.txt

It is important that the test case executed leaves the system in the same state it was prior to test case execution and not leave any stale data on system as this might affect other test cases.
There should not be any dependencies between testcases which assume one testcase should be executed and be passed for second testcase.
Testcases in tox environment may be executed in parallel. The order in which the testcases are executed may vary between two environments.
The code added should meet pep8 standards. This can be verified with following command and ensuring the code does not return any errors.

tox -e pep8

Execution of testcase:

Install apmec server via devstack installation, which registers apmec service and endpoint, creates "mec_user" and "mec" project, and registers default VIM with the created user and project.
Under apmec project dir, to prepare function test env via:

./tools/prepare_functional_test.sh

From apmec directory, all function testcases can be executed using following commands:

tox -e functional

Or from apmec directory, specific testcases can be executed using following commands:

tox -e functional apmec.tests.functional.xxx.yyy.<testcase>

Committing testcase and opening a review:

Once testcase is added in local setup, commit the testcase and open for review using below guidelines: https://docs.openstack.org/infra/manual/developers.html

Sample testcase:

Check sample tests under following directory: https://github.com/openstack/apmec/blob/master/apmec/tests/functional/

3.7 KiB Raw Blame History

Functional testcases for apmec

Important guidelines to follow:

Execution of testcase:

Committing testcase and opening a review:

Sample testcase:

3.7 KiB

Raw Blame History