History

Tetsuro Nakamura c9f5c48bed Create ProviderTreeDBHelperTestCase AllocationCandidatesTestCase includes tests using get_by_requests(). However, it also includes two tests for specific functions, test_get_trees_matching_all() and test_get_trees_with_traits(). This patch separates the two tests creating a new test class, ProviderTreeDBHelperTestCase. Change-Id: I83fc00a96353b985aa2aa60fb146329dd2f4e767		2019-03-15 14:24:54 +00:00
..
functional	Create ProviderTreeDBHelperTestCase	2019-03-15 14:24:54 +00:00
unit	Remove InventoryList class	2019-03-13 21:24:34 +00:00
README.rst	Link to tempest doc in tests/README.rst	2018-09-14 09:32:27 -06:00
__init__.py	Rename the 'nova' directories to 'placement'	2018-09-04 10:31:22 -05:00
fixtures.py	Move Trait and TraitList to own module	2019-03-13 21:24:34 +00:00

README.rst

OpenStack Placement Testing Infrastructure

This README file attempts to provides some brief guidance for writing tests when fixing bugs or adding features to placement.

For a lot more information see the contributor docs.

Test Types: Unit vs. Functional vs. Integration

Placement tests are divided into three types:

Unit: tests which confirm the behavior of individual pieces of the code (individual methods or classes) with minimal dependency on other code or on externals like the database.
Functional: tests which confirm a chunk of behavior, end to end, such as an HTTP endpoint accepting a body from a request and returning the expected response but without reliance on code or services that are external to placement.
Integration: tests that confirm that things work with other services, such as nova.

Placement uses all three, but the majority are functional tests. This is the result of the fairly direct architecture of placement: It is a WSGI application that talks to a database.

Writing Unit Tests

Placement unit tests are based on the TestCase that comes with the testtools package. Use mocks only as necessary. If you find that you need multiple mocks to make a test for the code you are testing may benefit from being refactored to smaller units.

Writing Functional Tests

There are two primary classes of functional test in placement:

Testing database operations. These are based on placement.tests.functional.base.TestCase which is responsible for starting an in-memory database and a reasonable minimal configuration.
Testing the HTTP API using gabbi.

Writing Integration Tests

Placement configures its gate and check jobs via the .zuul.yaml file in the root of the code repository. Some of the entries in that file configure integration jobs, many of which use tempest.