Used cached git sources and enable depends-on

Many, many patches have gone into the master branch to
enable the use of depends-on for role tests and to make
use of the git clones put into place by zuul. This patch
ensures that this functionality is now available for this
branch too.

The primary benefit for doing this would be to make use
of the cached git clones provided by zuul to improve test
reliability.

The secondary benefit would be to have the ability to
use depends-on to test patches together.

However, this will come at the cost of requiring a tox
configuration change, and the implementation of the
tests/tests-repo-clone.sh and run_tests.sh scripts
across all repositories.

Change-Id: Ibb511466d8de0f4fc1bc158993fa2b674d6edb3b
Depends-On: Ia806f19e00703c53f03a2420dbac1da4ba68db6c

run_tests.sh

@@ -35,8 +35,12 @@ source /etc/os-release || source /usr/lib/os-release
 install_pkg_deps() {
     pkg_deps="git"
 
+    # Prefer dnf over yum for CentOS.
+    which dnf &>/dev/null && RHT_PKG_MGR='dnf' || RHT_PKG_MGR='yum'
+
     case ${ID,,} in
-        centos|rhel) pkg_mgr_cmd="yum install -y" ;;
+        *suse*) pkg_mgr_cmd="zypper -n in" ;;
+        centos|rhel) pkg_mgr_cmd="${RHT_PKG_MGR} install -y" ;;
         fedora) pkg_mgr_cmd="dnf -y install" ;;
         ubuntu|debian) pkg_mgr_cmd="apt-get install -y" ;;
         *) echo "unsupported distribution: ${ID,,}"; exit 1 ;;
@@ -45,24 +49,12 @@ install_pkg_deps() {
     eval sudo $pkg_mgr_cmd $pkg_deps
 }
 
-git_clone_repo() {
+# Install the host distro package dependencies
-    if [[ ! -d tests/common ]]; then
-        # The tests repo doesn't need a clone, we can just
-        # symlink it.
-        if [[ "$(basename ${WORKING_DIR})" == "openstack-ansible-tests" ]]; then
-            ln -s ${WORKING_DIR} ${WORKING_DIR}/tests/common
-        else
-            git clone -b stable/ocata \
-                https://git.openstack.org/openstack/openstack-ansible-tests \
-                tests/common
-        fi
-    fi
-}
-
 install_pkg_deps
 
-git_clone_repo
+# Clone the tests repo for access to the common test script
+source tests/tests-repo-clone.sh
 
-# start executing the main test script
+# Execute the common test script
 source tests/common/run_tests_common.sh
 

tests/tests-repo-clone.sh

@@ -0,0 +1,117 @@
+#!/bin/bash
+# Copyright 2017, Rackspace US, Inc.
+#
+# 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.
+
+# PURPOSE:
+# This script clones the openstack-ansible-tests repository to the
+# tests/common folder in order to be able to re-use test components
+# for role testing.
+
+# WARNING:
+# This file is maintained in the openstack-ansible-tests repository:
+# https://git.openstack.org/cgit/openstack/openstack-ansible-tests
+# If you need to change this script, then propose the change there.
+# Once it merges, the change will be replicated to the other repositories.
+
+## Shell Opts ----------------------------------------------------------------
+
+set -e
+
+## Vars ----------------------------------------------------------------------
+
+export TESTING_HOME=${TESTING_HOME:-$HOME}
+export WORKING_DIR=${WORKING_DIR:-$(pwd)}
+export CLONE_UPGRADE_TESTS=${CLONE_UPGRADE_TESTS:-no}
+export ZUUL_TESTS_CLONE_LOCATION="/home/zuul/src/git.openstack.org/openstack/openstack-ansible-tests"
+
+## Functions -----------------------------------------------------------------
+
+function create_tests_clonemap {
+
+# Prepare the clonemap for zuul-cloner to use
+cat > ${TESTING_HOME}/tests-clonemap.yaml << EOF
+clonemap:
+  - name: openstack/openstack-ansible-tests
+    dest: ${WORKING_DIR}/tests/common
+EOF
+
+}
+
+## Main ----------------------------------------------------------------------
+
+# If zuul-cloner is present, use it so that we
+# also include any dependent patches from the
+# tests repo noted in the commit message.
+# We only want to use zuul-cloner if we detect
+# zuul v2 running, so we check for the presence
+# of the ZUUL_REF environment variable.
+# ref: http://git.openstack.org/cgit/openstack-infra/zuul/tree/zuul/ansible/filter/zuul_filters.py?h=feature/zuulv3#n17
+if [[ -x /usr/zuul-env/bin/zuul-cloner ]] && [[ "${ZUUL_REF:-none}" != "none" ]]; then
+
+    # Prepare the clonemap for zuul-cloner to use
+    create_tests_clonemap
+
+    # Execute the clone
+    /usr/zuul-env/bin/zuul-cloner \
+        --cache-dir /opt/git \
+        --map ${TESTING_HOME}/tests-clonemap.yaml \
+        git://git.openstack.org \
+        openstack/openstack-ansible-tests
+
+    # Clean up the clonemap.
+    rm -f ${TESTING_HOME}/tests-clonemap.yaml
+
+# Alternatively, use a simple git-clone. We do
+# not re-clone if the directory exists already
+# to prevent overwriting any local changes which
+# may have been made.
+elif [[ ! -d tests/common ]]; then
+
+    # The tests repo doesn't need a clone, we can just
+    # symlink it. As zuul v3 clones into a folder called
+    # 'workspace' we have to use one of its environment
+    # variables to determine the project name.
+    if [[ "${ZUUL_SHORT_PROJECT_NAME:-none}" == "openstack-ansible-tests" ]] ||\
+       [[ "$(basename ${WORKING_DIR})" == "openstack-ansible-tests" ]]; then
+        ln -s ${WORKING_DIR} ${WORKING_DIR}/tests/common
+
+    # In zuul v3 any dependent repository is placed into
+    # /home/zuul/src/git.openstack.org, so we check to see
+    # if there is a tests checkout there already. If so, we
+    # symlink that and use it.
+    elif [[ -d "${ZUUL_TESTS_CLONE_LOCATION}" ]]; then
+        ln -s "${ZUUL_TESTS_CLONE_LOCATION}" ${WORKING_DIR}/tests/common
+
+    # Otherwise we're clearly not in zuul or using a previously setup
+    # repo in some way, so just clone it from upstream.
+    else
+        git clone -b stable/ocata \
+            https://git.openstack.org/openstack/openstack-ansible-tests \
+            ${WORKING_DIR}/tests/common
+    fi
+fi
+
+# If this test set includes an upgrade test, the
+# previous stable release tests repo must also be
+# cloned.
+# Note:
+# Dependent patches to the previous stable release
+# tests repo are not supported.
+if [[ "${CLONE_UPGRADE_TESTS}" == "yes" ]]; then
+    if [[ ! -d "${WORKING_DIR}/tests/common/previous" ]]; then
+        git clone -b stable/newton \
+            https://git.openstack.org/openstack/openstack-ansible-tests \
+            ${WORKING_DIR}/tests/common/previous
+  fi
+fi

tox.ini

@@ -23,6 +23,7 @@ passenv =
 whitelist_externals =
     bash
 setenv =
+    PYTHONUNBUFFERED=1
     VIRTUAL_ENV={envdir}
     WORKING_DIR={toxinidir}
 
@@ -50,16 +51,9 @@ commands =
     {posargs}
 
 
-[testenv:tests_clone]
-commands =
-    bash -c "if [ ! -d "{toxinidir}/tests/common" ]; then \
-               git clone -b stable/ocata https://git.openstack.org/openstack/openstack-ansible-tests {toxinidir}/tests/common; \
-             fi"
-
-
 [testenv:pep8]
 commands =
-    {[testenv:tests_clone]commands}
+    bash -c "{toxinidir}/tests/tests-repo-clone.sh"
     bash -c "{toxinidir}/tests/common/test-pep8.sh"
 
 
@@ -72,7 +66,7 @@ ignore=F403
 
 [testenv:bashate]
 commands =
-    {[testenv:tests_clone]commands}
+    bash -c "{toxinidir}/tests/tests-repo-clone.sh"
     bash -c "{toxinidir}/tests/common/test-bashate.sh"
 
 
@@ -80,3 +74,4 @@ commands =
 commands =
     {[testenv:pep8]commands}
     {[testenv:bashate]commands}
+    {[testenv:docs]commands}