tempest/tools/generate-tempest-plugins-list.sh
Masayuki Igawa 6d5a48cbe7
Move data directory under doc/source
This commit moves the data directory under doc/source directory. The
data directory have only tempest-plugins-registry.header which is only
used for documentation. So, this change makes it clearer for the meaning
of the directory.

Change-Id: I73059707cb45bb241128662fbd7a48747332ea7f
2017-09-06 18:31:57 +09:00

67 lines
2.3 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.openstack.org Gerrit API
# working directory
# * network access to https://git.openstack.org/cgit
# ))
#
# 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
(
declare -A plugins
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)
for k in ${sorted_plugins}; do
project=${k:0:28}
giturl="git://git.openstack.org/openstack/${k:0:26}"
printf "|%-28s|%-73s|\n" "${project}" "${giturl}"
printf "+----------------------------+-------------------------------------------------------------------------+\n"
done
if [[ -r doc/source/data/tempest-plugins-registry.footer ]]; then
cat doc/source/data/tempest-plugins-registry.footer
fi
) > doc/source/plugin-registry.rst
if [[ -n ${1} ]]; then
cp doc/source/plugin-registry.rst ${1}/doc/source/plugin-registry.rst
fi