Tools used by OpenStack Documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

259 lines
7.4 KiB

#!/bin/bash
# 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.
set -e
HERE=$(pwd)
VENVDIR=$HERE/venv
SOURCESDIR=$HERE/sources
MANUALSREPO=$SOURCESDIR/openstack-manuals
AUTOHELP="python $HERE/autohelp.py"
EXTRACT_SWIFT="python $HERE/extract_swift_flags.py"
GITBASE=git://git.openstack.org/openstack
GITPROJ=git://git.openstack.org/openstack
PROJECTS="aodh ceilometer cinder glance heat ironic keystone manila neutron nova sahara swift trove"
MANUALS_PROJECTS="openstack-manuals oslo-incubator"
BRANCH=master
FAST=0
usage() {
echo "Wrapper for autohelp.py"
echo "Usage:"
echo " $(basename $0) [ OPTIONS ] create|update|docbook|rst|setup [ project1 ... ]"
echo
echo "Subcommands:"
echo " create: Create an initial flagmapping file"
echo " update: Update the flagmapping files"
echo " docbook: Generate the options tables in docbook format"
echo " rst: Generate the options tables in RST format"
echo " setup: Install the environment only"
echo
echo "Options:"
echo " -b BRANCH: Work on this branch (defaults to master)"
echo " -g GITPROJ: Use this location for the project git repos "
echo " (defaults to git://git.openstack.org/openstack)"
echo " -c: Recreate the virtual environment"
echo " -f: Work offline: Do not change environment or sources"
echo " -e PATH: Create the virtualenv in PATH"
echo " -v LEVEL: Verbose message (1 or 2)"
echo " (check various python modules imported or not)"
}
setup_venv() {
project=$1
if [ ! -e $VENVDIR/$project/bin/activate ]; then
mkdir -p $VENVDIR/$project
virtualenv $VENVDIR/$project
fi
activate_venv $project
}
activate_venv() {
project=$1
. $VENVDIR/$project/bin/activate
pip install --upgrade pip setuptools
}
get_project() {
project=$1
git_url=$GITPROJ
if [ ! -e $SOURCESDIR/$project ]; then
if [[ $MANUALS_PROJECTS =~ (^| )$project($| ) ]]; then
git_url=$GITBASE
fi
git clone $git_url/$project $SOURCESDIR/$project
if [ -e extra_repos/$project-$RELEASE.txt ]; then
while read extra; do
git clone $git_url/$extra $SOURCESDIR/$extra
done < extra_repos/$project-$RELEASE.txt
fi
else
if [ $project != openstack-manuals ]; then
(cd $SOURCESDIR/$project && git pull)
fi
if [ -e extra_repos/$project-$RELEASE.txt ]; then
while read extra; do
(cd $SOURCESDIR/$extra && git pull)
done < extra_repos/$project-$RELEASE.txt
fi
fi
}
setup_tools() {
(cd $SOURCESDIR/oslo-incubator && python setup.py install)
pip install -rrequirements.txt
}
while getopts :b:g:e:v:cf opt; do
case $opt in
b)
BRANCH=$OPTARG
;;
g)
GITPROJ=$OPTARG
;;
c)
rm -rf $VENVDIR
;;
e)
VENVDIR=$OPTARG
;;
f)
FAST=1
;;
v)
AUTOOPT="-v"
if [ $OPTARG = 2 ]; then
AUTOOPT="-vv"
fi
;;
\?)
usage
exit 1
;;
esac
done
shift $(($OPTIND - 1))
if [ $# -lt 1 ]; then
usage
exit 1
fi
ACTION=$1
shift
case $ACTION in
create|update|docbook|rst|setup) ;;
*)
usage
exit 1
;;
esac
if [ ! -e autohelp.py ]; then
echo "Execute this script in the autogenerate_config_docs directory."
exit 1
fi
[ $# != 0 ] && PROJECTS="$*"
RELEASE=$(echo $BRANCH | sed 's,^stable.,,')
if [ "$FAST" -eq 0 ] ; then
get_project oslo-incubator
get_project openstack-manuals
for project in $PROJECTS; do
setup_venv $project
setup_tools
if [ -e requirements/$project-$RELEASE.txt ]; then
pip install -r requirements/$project-$RELEASE.txt \
--allow-all-external
fi
get_project $project
(
cd $SOURCESDIR/$project
find $project -name "*.pyc" -delete
GIT_CMD="git show-ref --verify --quiet refs/heads/$BRANCH"
if $GIT_CMD; then
git checkout $BRANCH
else
git checkout -b $BRANCH remotes/origin/$BRANCH
fi
pip install -rrequirements.txt -rtest-requirements.txt
python setup.py install
if [ -e extra_repos/$project-$RELEASE.txt ]; then
while read extra; do
(
cd $SOURCESDIR/$extra
pip install -rrequirements.txt \
-rtest-requirements.txt
python setup.py install
)
done < extra_repos/$project-$RELEASE.txt
fi
)
done
fi
for project in $PROJECTS; do
echo "Working on $project..."
activate_venv $project
if [ "$ACTION" = "setup" ]; then
break
fi
if [ -e extra_repos/$project-$RELEASE.txt ]; then
extra_flags=
while read extra; do
package=$(echo $extra | tr - _)
if [ $package = "networking_midonet" ]; then
package="midonet"
fi
if [ $package = "networking_hyperv" ]; then
package="hyperv"
fi
if [ $package = "networking_edge_vpn" ]; then
package="networking-edge-vpn"
fi
if [ $package = "networking_zvm" ]; then
package="neutron"
cp -r $SOURCESDIR/networking-zvm/neutron/plugins/zvm $SOURCESDIR/neutron/neutron/plugins
cp -r $SOURCESDIR/networking-zvm/neutron/plugins/ml2/drivers/zvm $SOURCESDIR/neutron/neutron/plugins/ml2/drivers
fi
extra_flags="$extra_flags -i $SOURCESDIR/$extra/$package"
done < extra_repos/$project-$RELEASE.txt
fi
cd $MANUALSREPO/tools/autogenerate-config-flagmappings
case $ACTION in
create)
[ "$project" = "swift" ] && continue
file=$MANUALSREPO/tools/autogenerate-config-flagmappings/$project.flagmappings
if [ -e $file ]; then
echo "$project.flagmappings already exists, ignoring."
continue
fi
$AUTOHELP create $project -i $SOURCESDIR/$project/$project $AUTOOPT
;;
update)
[ "$project" = "swift" ] && continue
$AUTOHELP update $project -i $SOURCESDIR/$project/$project $extra_flags $AUTOOPT
mv $project.flagmappings.new $project.flagmappings
;;
docbook)
if [ "$project" = "swift" ]; then
$EXTRACT_SWIFT docbook -m $MANUALSREPO -s $SOURCESDIR/swift
else
$AUTOHELP docbook $project -i $SOURCESDIR/$project/$project $extra_flags $AUTOOPT
fi
;;
rst)
if [ "$project" = "swift" ]; then
$EXTRACT_SWIFT rst -m $MANUALSREPO -s $SOURCESDIR/swift
else
$AUTOHELP rst $project -i $SOURCESDIR/$project/$project $extra_flags $AUTOOPT
fi
;;
esac
done