IRC Channel¶

The OpenStackClient team doesn’t have regular meetings so if you have questions or anything you want to discuss, come to our channel: #openstack-sdks

Tox prerequisites and installation¶

Install the prerequisites for Tox:

• On Ubuntu or Debian:

  $ apt-get install gcc gettext python3-dev libxml2-dev libxslt1-dev \
    zlib1g-dev
  

  You may need to use pip install for some packages.

• On RHEL or CentOS including Fedora:

  $ yum install gcc python3-devel libxml2-devel libxslt-devel
  

• On openSUSE or SUSE linux Enterprise:

  $ zypper install gcc python3-devel libxml2-devel libxslt-devel
  

Install python-tox:

$ pip install tox

To run the full suite of tests maintained within OpenStackClient.

$ tox

To run tests for one or more specific test environments (for example, the most common configuration of the latest Python version and PEP-8), list the environments with the -e option, separated by spaces:

$ tox -e py38,pep8

See tox.ini for the full list of available test environments.

Running functional tests¶

OpenStackClient also maintains a set of functional tests that are optimally designed to be run against OpenStack’s gate. Optionally, a developer may choose to run these tests against any OpenStack deployment, however depending on the services available, results vary.

To run the entire suite of functional tests:

$ tox -e functional

To run a specific functional test:

$ tox -e functional -- --regex tests.functional.compute.v2.test_server

Running with PDB¶

Using PDB breakpoints with tox and testr normally does not work since the tests fail with a BdbQuit exception rather than stopping at the breakpoint.

To run with PDB breakpoints during testing, use the debug tox environment. For example, passing a test name since you will normally only want to run the test that hits your breakpoint:

$ tox -e debug openstackclient.tests.identity.v3.test_group

For reference, the debug tox environment implements the instructions

Standardize Import Format¶

More information about Import Format, see Import Order Guide.

The import order shows below:

{{stdlib imports in human alphabetical order}}
\n
{{third-party lib imports in human alphabetical order}}
\n
{{project imports in human alphabetical order}}
\n
\n
{{begin your code}}

import copy
import fixtures
import os

from osc_lib.api import auth
from osc_lib import utils

from openstackclient import shell
from openstackclient.tests import utils
from unittest import mock