Merge pull request #540 from SAP/marcusholl/integrationtests/removeRedundanciesInIntegrationTests

Provide integration test controller

.travis.yml

@@ -1,6 +1,7 @@
 branches:
   only:
   - master
+  - /^it\/.*$/
 language: groovy
 sudo: required
 services:
@@ -35,10 +36,9 @@ jobs:
         cp -r documentation/docs documentation/docs-tmp
         documentation/bin/createDocu.sh vars documentation/docs-tmp/steps
         docker run --rm -it -v ${TRAVIS_BUILD_DIR}:/docs -w /docs/documentation squidfunk/mkdocs-material:3.0.4 build --clean --verbose --strict
-    - name: Consumer Tests for s4sdk pipeline (CloudFoundry)
-      script: cd consumer-test/s4sdk/CloudFoundry && chmod +x runTests.sh && ./runTests.sh
-    - name: Consumer Tests for s4sdk pipeline (Neo Environment)
-      script: cd consumer-test/s4sdk/NeoEnvironment && chmod +x runTests.sh && ./runTests.sh
+    - name: Consumer Tests
+      if: repo = "SAP/jenkins-library" && ( (type != pull_request && branch =~ /^master$|^it\/.*$/) || (type == pull_request && head_repo = "SAP/jenkins-library" && head_branch =~ /^it\/.*$/) )
+      script: cd consumer-test && chmod +x integrationTestController.sh && ./integrationTestController.sh
 
     - stage: Docs
       name: Deploy

consumer-test/integrationTestController.sh

@@ -0,0 +1,138 @@
+#!/bin/bash
+
+function fail() {
+    local message="$1"
+    local returnCode=${2:-1}
+    echo "[ERROR] ${message}" >&2
+    exit "${returnCode}"
+}
+
+function notify() {
+
+    local state=${1}
+    local description=${2}
+    local hash=${3}
+
+    echo "[INFO] Notifying about state \"${state}\" for commit \"${hash}\"."
+
+    curl -X POST \
+        --fail \
+        --silent \
+        --output /dev/null \
+        --data "{\"state\": \"${state}\", \"target_url\": \"${TRAVIS_BUILD_WEB_URL}\", \"description\": \"${description}\", \"context\": \"integration-tests\"}" \
+        --user "${INTEGRATION_TEST_VOTING_USER}:${INTEGRATION_TEST_VOTING_TOKEN}" \
+    "https://api.github.com/repos/SAP/jenkins-library/statuses/${hash}" || fail "Cannot send notification. curl return code: $?"
+}
+
+function cleanup() {
+    [ -z "${notificationThreadPid}" ] || kill -PIPE "${notificationThreadPid}" &>/dev/null
+}
+
+trap cleanup EXIT
+
+#
+# In case the build is performed for a pull request TRAVIS_COMMIT is a merge
+# commit between the base branch and the PR branch HEAD. That commit is actually built.
+# But for notifying about a build status we need the commit which is currenty
+# the HEAD of the PR branch.
+#
+# In case the build is performed for a simple branch (not associated with a PR)
+# In this case there is no merge commit between any base branch and HEAD of a PR branch.
+# The commit which we need for notifying about a build status is in this case simply
+# TRAVIS_COMMIT itself.
+#
+COMMIT_HASH_FOR_STATUS_NOTIFICATIONS="${TRAVIS_PULL_REQUEST_SHA}"
+[ -z "${COMMIT_HASH_FOR_STATUS_NOTIFICATIONS}" ] && COMMIT_HASH_FOR_STATUS_NOTIFICATIONS="${TRAVIS_COMMIT}"
+
+notify "pending" "Integration tests in progress." "${COMMIT_HASH_FOR_STATUS_NOTIFICATIONS}"
+
+WORKSPACES_ROOT=workspaces
+[ -e "${WORKSPACES_ROOT}"  ] && rm -rf ${WORKSPACES_ROOT}
+
+TEST_CASES=$(find testCases -name '*.yml')
+
+# This auxiliar thread is needed in order to produce some output while the
+# test are running. Otherwise the job will be canceled after 10 minutes without
+# output.
+while true; do sleep 10; echo "[INFO] Integration tests still running."; done &
+notificationThreadPid=$!
+
+declare -a processes
+i=0
+for f in ${TEST_CASES}
+do
+    testCase=$(basename "${f%.*}")
+    area=$(dirname "${f#*/}")
+    echo "[INFO] Running test case \"${testCase}\" in area \"${area}\"."
+    TEST_CASE_ROOT="${WORKSPACES_ROOT}/${area}/${testCase}"
+    [ -e "${TEST_CASE_ROOT}" ] && rm -rf "${TEST_CASE_ROOT}"
+    mkdir -p "${TEST_CASE_ROOT}" || fail "Cannot create test case root directory for test case \"${testCase}\"." 1
+    source ./runTest.sh "${testCase}" "${TEST_CASE_ROOT}" &> "${TEST_CASE_ROOT}/log.txt" &
+    pid=$!
+    processes[$i]="${area}/${testCase}:${pid}"
+    echo "[INFO] Test case \"${testCase}\" in area \"${area}\" launched. (PID: \"${pid}\")."
+    let i=i+1
+done
+
+[ "${i}" == 0 ] && fail "No tests has been executed." 1
+
+#
+# wait for the test cases and cat the log
+for p in "${processes[@]}"
+do
+    area=$(dirname "${p%:*}")
+    testCase=$(basename "${p%:*}")
+    processId="${p#*:}"
+    echo "[INFO] Waiting for test case \"${testCase}\" in area \"${area}\" (PID: \"${processId}\")."
+    wait "${processId}"
+    echo "[INFO] Test case \"${testCase}\" in area \"${area}\" finished (PID: \"${processId}\")."
+done
+
+kill -PIPE "${notificationThreadPid}" &>/dev/null && notificationThreadPid=""
+
+#
+# provide the logs
+for p in "${processes[@]}"
+do
+    area=$(dirname "${p%:*}")
+    testCase=$(basename "${p%:*}")
+    echo "[INFO] === START === Logs for test case \"${testCase}\" ===."
+    cat "${TEST_CASE_ROOT}/log.txt"
+    echo "[INFO] === END === Logs for test case \"${testCase}\" ===."
+done
+
+#
+# list test case status
+echo "[INFO] Build status:"
+failure="false"
+for p in "${processes[@]}"
+do
+    status="UNDEFINED"
+    area=$(dirname "${p%:*}")
+    testCase=$(basename "${p%:*}")
+    TEST_CASE_ROOT="${WORKSPACES_ROOT}/${area}/${testCase}"
+    if [ -f "${TEST_CASE_ROOT}/SUCCESS" ]
+    then
+        status="SUCCESS"
+    else
+        status="FAILURE"
+        failure="true"
+    fi
+    printf "[INFO] %-30s: %s\n" "${testCase}" "${status}"
+done
+
+STATUS_DESCRIPTION="The integration tests failed."
+STATUS_STATE="failure"
+
+if [ "${failure}" == "false" ]
+then
+    STATUS_DESCRIPTION="The integration tests succeeded."
+    STATUS_STATE="success"
+fi
+
+notify "${STATUS_STATE}" "${STATUS_DESCRIPTION}" "${COMMIT_HASH_FOR_STATUS_NOTIFICATIONS}"
+
+[ "${failure}" != "false" ] && fail "Integration tests failed." 1
+
+echo "[INFO] Integration tests succeeded."
+exit 0

consumer-test/runTest.sh

@@ -1,14 +1,15 @@
 #!/usr/bin/env bash
 
-EXAMPLE_PROJECT_BRANCH=$1
+TEST_CASE=$1
+TEST_CASE_ROOT=$2
+TEST_CASE_WORKSPACE="${TEST_CASE_ROOT}/workspace"
 
 LIBRARY_VERSION_UNDER_TEST=$(git log --format="%H" -n 1)
 REPOSITORY_UNDER_TEST=${TRAVIS_REPO_SLUG:-SAP/jenkins-library}
 
-rm -rf workspace
-git clone -b "${EXAMPLE_PROJECT_BRANCH}" https://github.com/sap/cloud-s4-sdk-book workspace
-cp -f ../jenkins.yml workspace
-cd workspace || exit 1
+git clone -b "${TEST_CASE}" https://github.com/sap/cloud-s4-sdk-book "${TEST_CASE_WORKSPACE}"
+cp -f jenkins.yml "${TEST_CASE_WORKSPACE}"
+cd "${TEST_CASE_WORKSPACE}" || exit 1
 
 # Configure path to library-repository under test in Jenkins config
 sed -i -e "s:__REPO_SLUG__:${REPOSITORY_UNDER_TEST}:g" jenkins.yml
@@ -18,3 +19,12 @@ echo "@Library(\"piper-library-os@$LIBRARY_VERSION_UNDER_TEST\") _" | cat - Jenk
 
 # Commit the changed version because artifactSetVersion expects the git repo not to be dirty
 git commit --all --author="piper-testing-bot <piper-testing-bot@example.com>" --message="Set piper lib version for test"
+
+docker run -v /var/run/docker.sock:/var/run/docker.sock -v "${PWD}":/workspace -v /tmp -e CASC_JENKINS_CONFIG=/workspace/jenkins.yml \
+    -e CX_INFRA_IT_CF_USERNAME -e CX_INFRA_IT_CF_PASSWORD -e BRANCH_NAME="${TEST_CASE}" ppiper/jenkinsfile-runner
+
+RC=$?
+
+cd - &> /dev/null || { echo "[ERROR] change directory back into integration test root folder failed."; exit 1; }
+
+[ "${RC}" == 0 ] && touch "${TEST_CASE_ROOT}/SUCCESS"

consumer-test/s4sdk/CloudFoundry/runTests.sh

@@ -1,6 +0,0 @@
-#!/bin/bash -e
-
-source ../prepareTests.sh consumer-test
-
-docker run -v /var/run/docker.sock:/var/run/docker.sock -v "${PWD}":/workspace -v /tmp -e CASC_JENKINS_CONFIG=/workspace/jenkins.yml \
-    -e CX_INFRA_IT_CF_USERNAME -e CX_INFRA_IT_CF_PASSWORD -e BRANCH_NAME=consumer-test ppiper/jenkinsfile-runner

consumer-test/s4sdk/NeoEnvironment/runTests.sh

@@ -1,6 +0,0 @@
-#!/bin/bash -e
-
-source ../prepareTests.sh consumer-test-neo
-
-docker run -v /var/run/docker.sock:/var/run/docker.sock -v "${PWD}":/workspace -v /tmp -e CASC_JENKINS_CONFIG=/workspace/jenkins.yml \
-    -e CX_INFRA_IT_CF_USERNAME -e CX_INFRA_IT_CF_PASSWORD -e BRANCH_NAME=consumer-test-neo ppiper/jenkinsfile-runner

consumer-test/testCases/s4sdk/consumer-test-neo.yml

@@ -0,0 +1,2 @@
+# Empty for the moment.
+# Might contain test configuration in the future.

consumer-test/testCases/s4sdk/consumer-test.yml

@@ -0,0 +1,2 @@
+# Empty for the moment.
+# Might contain test configuration in the future.