From 1a24b0b9db6c3cbd389064f39eef43f44c02a04e Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 5 Feb 2017 15:56:27 +0100
Subject: [PATCH] Prepare for using standard python tests

Add simple script to setup mysql and postgresql databases, this script
can be run by users during testing and will be run by CI systems for
specific setup before running unit tests. This is exactly what is
currently done by OpenStack CI in project-config.

This allows to change in project-config the python-db jobs to
python-jobs since python-jobs will call this script initially.

See also
http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html

Update devref for this.

Needed-By: Iea42a0525b2c5a5cdbf8604eb23a6e7b029f6b48
Change-Id: Ie9bae659077dbe299eea131572117036065bdccf
(cherry picked from commit d60dffc6bef4d2de32b9509a62f894136c434c3c)
---
 doc/source/development.environment.rst |  4 ++
 tools/test-setup.sh                    | 54 ++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100755 tools/test-setup.sh

diff --git a/doc/source/development.environment.rst b/doc/source/development.environment.rst
index ce5d044b0015..b618b1a350cd 100644
--- a/doc/source/development.environment.rst
+++ b/doc/source/development.environment.rst
@@ -147,6 +147,10 @@ See `Running Python Unit Tests`_.
 
 .. _`Running Python Unit Tests`: http://docs.openstack.org/infra/manual/python.html#running-python-unit-tests
 
+Note that some unit and functional tests use a database. See the file
+``tools/test-setup.sh`` on how the databases are set up in the
+OpenStack CI environment and replicate it in your test environment.
+
 Using a remote debugger
 =======================
 
diff --git a/tools/test-setup.sh b/tools/test-setup.sh
new file mode 100755
index 000000000000..00c765e734ac
--- /dev/null
+++ b/tools/test-setup.sh
@@ -0,0 +1,54 @@
+#!/bin/bash -xe
+
+# This script will be run by OpenStack CI before unit tests are run,
+# it sets up the test system as needed.
+# Developers should setup their test systems in a similar way.
+
+# This setup needs to be run as a user that can run sudo.
+
+# The root password for the MySQL database; pass it in via
+# MYSQL_ROOT_PW.
+DB_ROOT_PW=${MYSQL_ROOT_PW:-insecure_slave}
+
+# This user and its password are used by the tests, if you change it,
+# your tests might fail.
+DB_USER=openstack_citest
+DB_PW=openstack_citest
+
+sudo -H mysqladmin -u root password $DB_ROOT_PW
+
+# It's best practice to remove anonymous users from the database.  If
+# an anonymous user exists, then it matches first for connections and
+# other connections from that host will not work.
+sudo -H mysql -u root -p$DB_ROOT_PW -h localhost -e "
+    DELETE FROM mysql.user WHERE User='';
+    FLUSH PRIVILEGES;
+    GRANT ALL PRIVILEGES ON *.*
+        TO '$DB_USER'@'%' identified by '$DB_PW' WITH GRANT OPTION;"
+
+# Now create our database.
+mysql -u $DB_USER -p$DB_PW -h 127.0.0.1 -e "
+    SET default_storage_engine=MYISAM;
+    DROP DATABASE IF EXISTS openstack_citest;
+    CREATE DATABASE openstack_citest CHARACTER SET utf8;"
+
+# Same for PostgreSQL
+
+# Setup user
+root_roles=$(sudo -H -u postgres psql -t -c "
+   SELECT 'HERE' from pg_roles where rolname='$DB_USER'")
+if [[ ${root_roles} == *HERE ]];then
+    sudo -H -u postgres psql -c "ALTER ROLE $DB_USER WITH SUPERUSER LOGIN PASSWORD '$DB_PW'"
+else
+    sudo -H -u postgres psql -c "CREATE ROLE $DB_USER WITH SUPERUSER LOGIN PASSWORD '$DB_PW'"
+fi
+
+# Store password for tests
+cat << EOF > $HOME/.pgpass
+*:*:*:$DB_USER:$DB_PW
+EOF
+chmod 0600 $HOME/.pgpass
+
+# Now create our database
+psql -h 127.0.0.1 -U $DB_USER -d template1 -c "DROP DATABASE IF EXISTS openstack_citest"
+createdb -h 127.0.0.1 -U $DB_USER -l C -T template0 -E utf8 openstack_citest