openstack/python-glanceclient
Code Issues Proposed changes
590f793c9f
python-glanceclient/glanceclient/tests/functional
History
Cyril Roelandt 6c95122777 Fix functional tests and docs generation 
First, fix test_help(). A commit[1], which first appeared in Python
3.10, changes the output of the help feature of argparse. Options used
to be in a section named "Optional arguments:", and they are now in a
section named "Options:".

Second, tox 4 changes the behaviour of tox, and
{toxinidir}/requirements.txt is no longer installed automagically in the
docs virtual environment. This causes autodoc to fail on some imports.
We explicitely add {toxinidir}/requirements.txt to the list of
dependencies to fix this issue.

These issues should be fixed in separate patches, but since they both
block the CI, they depend on each other.

[1] https://github.com/python/cpython/pull/23858

Change-Id: Ia7866390b31f469bdea95624325a13aaf45a496e
Closes-Bug: #2002566
2023-01-12 14:05:25 +01:00
..
v1 Fix functional tests and docs generation 2023-01-12 14:05:25 +01:00
v2 Fix functional tests and docs generation 2023-01-12 14:05:25 +01:00
__init__.py Create functional test base 2015-04-18 17:43:01 +00:00
base.py Split glanceclient functional tests 2018-03-28 22:32:44 -04:00
README.rst Revise functional testing README file 2017-12-15 16:03:45 -05:00

README.rst

python-glanceclient functional testing

Idea

Run real client/server requests in the gate to catch issues which are difficult to catch with a purely unit test approach.

Many projects (nova, keystone...) already have this form of testing in the gate.

Testing Theory

Since python-glanceclient has two uses, CLI and python API, we should have two sets of functional tests. CLI and python API. The python API tests should never use the CLI. But the CLI tests can use the python API where adding native support to the CLI for the required functionality would involve a non trivial amount of work.

Functional Test Guidelines

The functional tests require:

  1. A working Glance/Keystone installation (for example, devstack)
  2. A yaml file containing valid credentials

If you are using devstack, a yaml file will have been created for you with the name /etc/openstack/clouds.yaml. The test code knows where to find it, so if you're using devstack, you don't need to do anything else.

If you are not using devstack you should create a yaml file with the following format:

clouds:
devstack-admin:
auth:

auth_url: http://10.0.0.1:35357/v2.0 password: example project_domain_id: default project_name: admin user_domain_id: default username: admin

identity_api_version: '2.0' region_name: RegionOne

The tests will look for a file named 'clouds.yaml' in the following locations (in this order, first found wins):

  • current directory
  • ~/.config/openstack
  • /etc/openstack

You may also set the environment variable OS_CLIENT_CONFIG_FILE to the absolute pathname of a file and that location will be inserted at the front of the search list.