diff options
| author | Martin Kopec <mkopec@redhat.com> | 2020-12-24 15:57:53 +0000 |
|---|---|---|
| committer | Martin Kopec <mkopec@redhat.com> | 2021-01-20 08:40:57 +0000 |
| commit | dc84423b7294a19cbea4bf1e4b75a59625dec1e9 (patch) | |
| tree | 2a2dcccc14f61255d6232822140fe8c13ce6f0c6 /doc | |
| parent | 3e05a15d9c4c889aba8c4aad9e24ba8a8a71b7f3 (diff) | |
| download | tempest-dc84423b7294a19cbea4bf1e4b75a59625dec1e9.tar.gz | |
Inclusive jargon
Following stestr's example where arguments such as --blacklist-file,
--black-regex and --whitelist-file are deprecated since its
3.1.0 release, let's do the change here as well in order to
get tempest consumers some time for the transition.
This change deprecates the following arguments and replaces them
by new ones which are functionally equivavelnt:
* --black-regex is replaced by --exclude-regex
* --blacklist-file is replaced by --exclude-list
* --whitelist-file is replaced by --include-list
For now, Tempest will accept both (new and old) arguments to make
the transition smoother for all consumers.
The patch also bumps min version of tox to 3.18.0 in order to
replace tox's whitelist_externals by allowlist_externals option:
https://github.com/tox-dev/tox/blob/master/docs/changelog.rst#v3180-2020-07-23
Change-Id: I3e09b31f63d2cd7ea41c48e62432bd3bc54fcf44
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/data/tempest-non-active-plugins-registry.header (renamed from doc/source/data/tempest-blacklisted-plugins-registry.header) | 4 | ||||
| -rw-r--r-- | doc/source/overview.rst | 2 | ||||
| -rw-r--r-- | doc/source/stable_branch_support_policy.rst | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/doc/source/data/tempest-blacklisted-plugins-registry.header b/doc/source/data/tempest-non-active-plugins-registry.header index 6b6af1147..06d8eaa93 100644 --- a/doc/source/data/tempest-blacklisted-plugins-registry.header +++ b/doc/source/data/tempest-non-active-plugins-registry.header @@ -1,7 +1,7 @@ -Blacklisted Plugins +Non Active Plugins =================== List of Tempest plugin projects that are stale or unmaintained for a long -time (6 months or more). They can be moved out of blacklist state once one +time (6 months or more). They can be moved out of nonactivelist state once one of the relevant patches gets merged: https://review.opendev.org/#/q/topic:tempest-sanity-gate+%28status:open%29 diff --git a/doc/source/overview.rst b/doc/source/overview.rst index e51b90b96..2eaf72f18 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -113,7 +113,7 @@ as it is simpler, and quicker to work with. There is also the option to use `stestr`_ directly. For example, from the workspace dir run:: - $ stestr run --black-regex '\[.*\bslow\b.*\]' '^tempest\.(api|scenario)' + $ stestr run --exclude-regex '\[.*\bslow\b.*\]' '^tempest\.(api|scenario)' will run the same set of tests as the default gate jobs. Or you can use `unittest`_ compatible test runners such as `stestr`_, `pytest`_ etc. diff --git a/doc/source/stable_branch_support_policy.rst b/doc/source/stable_branch_support_policy.rst index 87e3ad1e8..9c2d1ed66 100644 --- a/doc/source/stable_branch_support_policy.rst +++ b/doc/source/stable_branch_support_policy.rst @@ -20,7 +20,7 @@ Tempest from master as long as possible. But, because we won't be actively testing branches in these phases, it's possible that we'll introduce changes to Tempest on master which will break support on *Extended Maintenance* phase branches. When this happens the expectation for those branches is to either -switch to running Tempest from a tag with support for the branch, or blacklist +switch to running Tempest from a tag with support for the branch, or exclude a newly introduced test (if that is the cause of the issue). Tempest will not be creating stable branches to support *Extended Maintenance* phase branches, as the burden is on the *Extended Maintenance* phase branche maintainers, not the Tempest |