From dc84423b7294a19cbea4bf1e4b75a59625dec1e9 Mon Sep 17 00:00:00 2001 From: Martin Kopec Date: Thu, 24 Dec 2020 15:57:53 +0000 Subject: 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 --- doc/source/data/tempest-blacklisted-plugins-registry.header | 7 ------- doc/source/data/tempest-non-active-plugins-registry.header | 7 +++++++ doc/source/overview.rst | 2 +- doc/source/stable_branch_support_policy.rst | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) delete mode 100644 doc/source/data/tempest-blacklisted-plugins-registry.header create mode 100644 doc/source/data/tempest-non-active-plugins-registry.header (limited to 'doc') diff --git a/doc/source/data/tempest-blacklisted-plugins-registry.header b/doc/source/data/tempest-blacklisted-plugins-registry.header deleted file mode 100644 index 6b6af1147..000000000 --- a/doc/source/data/tempest-blacklisted-plugins-registry.header +++ /dev/null @@ -1,7 +0,0 @@ -Blacklisted 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 -of the relevant patches gets merged: -https://review.opendev.org/#/q/topic:tempest-sanity-gate+%28status:open%29 diff --git a/doc/source/data/tempest-non-active-plugins-registry.header b/doc/source/data/tempest-non-active-plugins-registry.header new file mode 100644 index 000000000..06d8eaa93 --- /dev/null +++ b/doc/source/data/tempest-non-active-plugins-registry.header @@ -0,0 +1,7 @@ +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 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 -- cgit v1.2.1