dc84423b72
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
106 lines
3.2 KiB
Bash
Executable File
106 lines
3.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# Copyright 2016 Hewlett Packard Enterprise Development Company, L.P.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
# This script is intended to be run as a periodic proposal bot job
|
|
# in OpenStack infrastructure, though you can run it as a one-off.
|
|
#
|
|
# In order to function correctly, the environment in which the
|
|
# script runs must have
|
|
# * a writable doc/source directory relative to the current
|
|
# working directory
|
|
# AND ( (
|
|
# * git
|
|
# * all git repos meant to be searched for plugins cloned and
|
|
# at the desired level of up-to-datedness
|
|
# * the environment variable git_dir pointing to the location
|
|
# * of said git repositories
|
|
# ) OR (
|
|
# * network access to the review.opendev.org Gerrit API
|
|
# working directory
|
|
# * network access to https://opendev.org/openstack
|
|
# ))
|
|
#
|
|
# If a file named doc/source/data/tempest-plugins-registry.header or
|
|
# doc/source/data/tempest-plugins-registry.footer is found relative to the
|
|
# current working directory, it will be prepended or appended to
|
|
# the generated reStructuredText plugins table respectively.
|
|
|
|
set -ex
|
|
|
|
(
|
|
if [[ -r doc/source/data/tempest-plugins-registry.header ]]; then
|
|
cat doc/source/data/tempest-plugins-registry.header
|
|
fi
|
|
|
|
sorted_plugins=$(python tools/generate-tempest-plugins-list.py)
|
|
|
|
name_col_len=$(echo "${sorted_plugins}" | wc -L)
|
|
name_col_len=$(( name_col_len + 20 ))
|
|
|
|
# Print the title underline for a RST table.
|
|
function title_underline {
|
|
printf "== "
|
|
local len=$1
|
|
while [[ $len -gt 0 ]]; do
|
|
printf "="
|
|
len=$(( len - 1))
|
|
done
|
|
printf " ===\n"
|
|
}
|
|
|
|
function print_plugin_table {
|
|
title_underline ${name_col_len}
|
|
printf "%-3s %-${name_col_len}s %s\n" "SR" "Plugin Name" "URL"
|
|
title_underline ${name_col_len}
|
|
|
|
i=0
|
|
for plugin in $1; do
|
|
i=$((i+1))
|
|
giturl="https://opendev.org/${plugin}"
|
|
printf "%-3s %-${name_col_len}s %s\n" "$i" "${plugin}" "${giturl}"
|
|
done
|
|
|
|
title_underline ${name_col_len}
|
|
}
|
|
|
|
printf "\n\n"
|
|
print_plugin_table "${sorted_plugins}"
|
|
|
|
printf "\n\n"
|
|
|
|
# Print NON_ACTIVE_LIST
|
|
if [[ -r doc/source/data/tempest-non-active-plugins-registry.header ]]; then
|
|
cat doc/source/data/tempest-non-active-plugins-registry.header
|
|
fi
|
|
|
|
nonactivelist=$(python tools/generate-tempest-plugins-list.py nonactivelist)
|
|
name_col_len=$(echo "${nonactivelist}" | wc -L)
|
|
name_col_len=$(( name_col_len + 20 ))
|
|
|
|
printf "\n\n"
|
|
print_plugin_table "${nonactivelist}"
|
|
|
|
printf "\n\n"
|
|
|
|
if [[ -r doc/source/data/tempest-plugins-registry.footer ]]; then
|
|
cat doc/source/data/tempest-plugins-registry.footer
|
|
fi
|
|
) > doc/source/plugins/plugin-registry.rst
|
|
|
|
if [[ -n ${1} ]]; then
|
|
cp doc/source/plugins/plugin-registry.rst ${1}/doc/source/plugins/plugin-registry.rst
|
|
fi
|