bats tests

Signed-off-by: Ricardo Zanini <zanini@redhat.com>
jboss-container-images · May 9, 2019 · e4da5a0 · e4da5a0
1 parent 2699d24
commit e4da5a0
Show file tree

Hide file tree

Showing 8 changed files with 285 additions and 2 deletions.
diff --git a/os-eap-sso/added/keycloak.sh b/os-eap-sso/added/keycloak.sh
@@ -481,19 +481,28 @@ function discover_routes() {
   echo $(query_routes_from_service $podsuffix)
 }
 
+# Verify if the container is on OpenShift. The variable K8S_ENV could be set to emulate this behavior
+function is_running_on_openshift() {
+  if [ -e /var/run/secrets/kubernetes.io/serviceaccount/token ] || [ "${K8S_ENV}" = true ] ; then
+    return 0
+  else
+    return 1
+  fi
+}
+
 # Queries the Routes from the Kubernetes API based on the service name
 # ${1} - service name
 # see: https://docs.openshift.com/container-platform/3.11/rest_api/apis-route.openshift.io/v1.Route.html#Get-apis-route.openshift.io-v1-routes
 function query_routes_from_service() {
   local serviceName=${1}
   # only execute the following lines if this container is running on OpenShift
-  if [ -e /var/run/secrets/kubernetes.io/serviceaccount/token ]; then
+  if is_running_on_openshift; then
     local namespace=$(cat /var/run/secrets/kubernetes.io/serviceaccount/namespace)
     local token=$(cat /var/run/secrets/kubernetes.io/serviceaccount/token)
     local response=$(curl -s -w "%{http_code}" --cacert /var/run/secrets/kubernetes.io/serviceaccount/ca.crt \
         -H "Authorization: Bearer $token" \
         -H 'Accept: application/json' \
-        https://${KUBERNETES_SERVICE_HOST:-kubernetes.default.svc}:${KUBERNETES_SERVICE_PORT:-443}/apis/route.openshift.io/v1/namespaces/${namespace}/routes?fieldSelector=spec.to.name=${serviceName})
+        ${KUBERNETES_SERVICE_PROTOCOL:-https}://${KUBERNETES_SERVICE_HOST:-kubernetes.default.svc}:${KUBERNETES_SERVICE_PORT:-443}/apis/route.openshift.io/v1/namespaces/${namespace}/routes?fieldSelector=spec.to.name=${serviceName})
     if [[ "${response: -3}" = "200" && "${response::- 3},," = *"items"* ]]; then
       routes=$(echo ${response::- 3} | \
           python -c 'import json,sys;obj=json.load(sys.stdin); \

diff --git a/os-eap-sso/tests/bats/common.bash b/os-eap-sso/tests/bats/common.bash
@@ -0,0 +1,31 @@
+echo $BATS_TEST_DIRNAME
+load $BATS_TEST_DIRNAME/../../../test-common/log_utils.bash
+
+export JBOSS_HOME=$BATS_TMPDIR/jboss_home
+export K8S_ENV=false
+export KUBERNETES_SERVICE_HOST="localhost"
+export KUBERNETES_SERVICE_PORT=8080
+export KUBERNETES_SERVICE_PROTOCOL="http"
+
+if [ -e /var/run/secrets/kubernetes.io/serviceaccount/token ]; then
+  K8S_ENV=true
+fi
+
+mkdir -p $JBOSS_HOME/bin/launch
+mkdir -p $JBOSS_HOME/responses
+cp $BATS_TEST_DIRNAME/../../added/keycloak.sh $JBOSS_HOME/bin/launch
+cp $BATS_TEST_DIRNAME/../../../test-common/logging.sh $JBOSS_HOME/bin/launch
+cp $BATS_TEST_DIRNAME/server/shinatra.sh $JBOSS_HOME/bin/launch
+cp $BATS_TEST_DIRNAME/mock_responses/* $JBOSS_HOME/responses
+
+source $JBOSS_HOME/bin/launch/keycloak.sh
+source $JBOSS_HOME/bin/launch/shinatra.sh
+
+# {1} mock_response
+setup_k8s_api() {
+  local mock_response=${1}
+  local data=$(cat $JBOSS_HOME/responses/${mock_response}.json | tr -d \\n)
+  start_mock_server ${KUBERNETES_SERVICE_PORT} "${data}" >&2 &
+  local pid=$!
+  echo ${pid}
+}
diff --git a/os-eap-sso/tests/bats/hostname-discovery.bats b/os-eap-sso/tests/bats/hostname-discovery.bats
@@ -0,0 +1,45 @@
+#!/usr/bin/env bats
+
+load common
+
+# Runs the base api test
+# {1} mock_response
+function run_api_test {
+    local mock_response=${1}
+    local server_pid=$(setup_k8s_api ${mock_response})
+    K8S_ENV=true
+    local routes=$(discover_routes)
+    pkill -P $server_pid
+    echo $routes
+}
+
+@test "Kubernetes Route API not available" {
+    local expected=""
+    if [ "$K8S_ENV" = true ]; then
+      skip "This test supposed to be run outside a kubernetes environment"
+    fi
+    run discover_routes
+    [ "$status" -eq 0 ]
+    [ "${lines[0]}" = "${expected}" ]
+}
+
+@test "Kubernetes Route API found no routes for the pod" {
+    local expected=""
+    local mock_response="no-route"
+    result=$(run_api_test $mock_response)
+    [ "${result}" = "$expected" ]
+}
+
+@test "Kubernetes Route API found one route for the pod" {
+    local expected="https://eap-app-bsig-cloud.192.168.99.100.nip.io"
+    local mock_response="single-route"
+    result=$(run_api_test $mock_response)
+    [ "${result}" = "$expected" ]
+}
+
+@test "Kubernetes Route API found multiple routes for the pod" {
+    local expected="http://bc-authoring-rhpamcentr-bsig-cloud.192.168.99.100.nip.io;https://secure-bc-authoring-rhpamcentr-bsig-cloud.192.168.99.100.nip.io"
+    local mock_response="multi-route"
+    result=$(run_api_test $mock_response)
+    [ "${result}" = "$expected" ]
+}
diff --git a/os-eap-sso/tests/bats/mock_responses/multi-route.json b/os-eap-sso/tests/bats/mock_responses/multi-route.json
@@ -0,0 +1,115 @@
+{
+    "kind": "RouteList",
+    "apiVersion": "route.openshift.io/v1",
+    "metadata": {
+        "selfLink": "/apis/route.openshift.io/v1/namespaces/bsig-cloud/routes",
+        "resourceVersion": "1633753"
+    },
+    "items": [
+        {
+            "metadata": {
+                "name": "bc-authoring-rhpamcentr",
+                "namespace": "bsig-cloud",
+                "selfLink": "/apis/route.openshift.io/v1/namespaces/bsig-cloud/routes/bc-authoring-rhpamcentr",
+                "uid": "d81990d6-6d27-11e9-b294-080027e8c7bc",
+                "resourceVersion": "1241102",
+                "creationTimestamp": "2019-05-02T22:15:50Z",
+                "labels": {
+                    "app": "rhpam74-authoring",
+                    "application": "bc-authoring",
+                    "rhpam": "1.0",
+                    "service": "bc-authoring-rhpamcentr",
+                    "template": "rhpam74-authoring"
+                },
+                "annotations": {
+                    "description": "Route for Business Central's http service.",
+                    "haproxy.router.openshift.io/timeout": "60s",
+                    "openshift.io/generated-by": "OpenShiftNewApp",
+                    "openshift.io/host.generated": "true"
+                }
+            },
+            "spec": {
+                "host": "bc-authoring-rhpamcentr-bsig-cloud.192.168.99.100.nip.io",
+                "to": {
+                    "kind": "Service",
+                    "name": "bc-authoring-rhpamcentr",
+                    "weight": 100
+                },
+                "port": {
+                    "targetPort": "http"
+                },
+                "wildcardPolicy": "None"
+            },
+            "status": {
+                "ingress": [
+                    {
+                        "host": "bc-authoring-rhpamcentr-bsig-cloud.192.168.99.100.nip.io",
+                        "routerName": "router",
+                        "conditions": [
+                            {
+                                "type": "Admitted",
+                                "status": "True",
+                                "lastTransitionTime": "2019-05-02T22:15:51Z"
+                            }
+                        ],
+                        "wildcardPolicy": "None"
+                    }
+                ]
+            }
+        },
+        {
+            "metadata": {
+                "name": "secure-bc-authoring-rhpamcentr",
+                "namespace": "bsig-cloud",
+                "selfLink": "/apis/route.openshift.io/v1/namespaces/bsig-cloud/routes/secure-bc-authoring-rhpamcentr",
+                "uid": "d8347fb0-6d27-11e9-b294-080027e8c7bc",
+                "resourceVersion": "1241107",
+                "creationTimestamp": "2019-05-02T22:15:50Z",
+                "labels": {
+                    "app": "rhpam74-authoring",
+                    "application": "bc-authoring",
+                    "rhpam": "1.0",
+                    "service": "bc-authoring-rhpamcentr",
+                    "template": "rhpam74-authoring"
+                },
+                "annotations": {
+                    "description": "Route for Business Central's https service.",
+                    "haproxy.router.openshift.io/timeout": "60s",
+                    "openshift.io/generated-by": "OpenShiftNewApp",
+                    "openshift.io/host.generated": "true"
+                }
+            },
+            "spec": {
+                "host": "secure-bc-authoring-rhpamcentr-bsig-cloud.192.168.99.100.nip.io",
+                "to": {
+                    "kind": "Service",
+                    "name": "bc-authoring-rhpamcentr",
+                    "weight": 100
+                },
+                "port": {
+                    "targetPort": "https"
+                },
+                "tls": {
+                    "termination": "passthrough"
+                },
+                "wildcardPolicy": "None"
+            },
+            "status": {
+                "ingress": [
+                    {
+                        "host": "secure-bc-authoring-rhpamcentr-bsig-cloud.192.168.99.100.nip.io",
+                        "routerName": "router",
+                        "conditions": [
+                            {
+                                "type": "Admitted",
+                                "status": "True",
+                                "lastTransitionTime": "2019-05-02T22:15:51Z"
+                            }
+                        ],
+                        "wildcardPolicy": "None"
+                    }
+                ]
+            }
+        }
+    ]
+}
diff --git a/os-eap-sso/tests/bats/mock_responses/no-route.json b/os-eap-sso/tests/bats/mock_responses/no-route.json
@@ -0,0 +1,9 @@
+{
+    "kind": "RouteList",
+    "apiVersion": "route.openshift.io/v1",
+    "metadata": {
+        "selfLink": "/apis/route.openshift.io/v1/namespaces/bsig-cloud/routes",
+        "resourceVersion": "1633866"
+    },
+    "items": []
+}
diff --git a/os-eap-sso/tests/bats/mock_responses/single-route.json b/os-eap-sso/tests/bats/mock_responses/single-route.json
@@ -0,0 +1,60 @@
+{
+    "kind": "RouteList",
+    "apiVersion": "route.openshift.io/v1",
+    "metadata": {
+        "selfLink": "/apis/route.openshift.io/v1/namespaces/bsig-cloud/routes",
+        "resourceVersion": "1633112"
+    },
+    "items": [
+        {
+            "metadata": {
+                "name": "eap-app",
+                "namespace": "bsig-cloud",
+                "selfLink": "/apis/route.openshift.io/v1/namespaces/bsig-cloud/routes/eap-app",
+                "uid": "eb9ed521-6d0a-11e9-8682-080027e8c7bc",
+                "resourceVersion": "1194535",
+                "creationTimestamp": "2019-05-02T18:48:48Z",
+                "labels": {
+                    "app": "eap72-basic-s2i",
+                    "application": "eap-app",
+                    "template": "eap72-basic-s2i",
+                    "xpaas": "1.0.0"
+                },
+                "annotations": {
+                    "description": "Route for application's https service.",
+                    "openshift.io/generated-by": "OpenShiftNewApp",
+                    "openshift.io/host.generated": "true"
+                }
+            },
+            "spec": {
+                "host": "eap-app-bsig-cloud.192.168.99.100.nip.io",
+                "to": {
+                    "kind": "Service",
+                    "name": "eap-app",
+                    "weight": 100
+                },
+                "tls": {
+                    "termination": "edge",
+                    "insecureEdgeTerminationPolicy": "Redirect"
+                },
+                "wildcardPolicy": "None"
+            },
+            "status": {
+                "ingress": [
+                    {
+                        "host": "eap-app-bsig-cloud.192.168.99.100.nip.io",
+                        "routerName": "router",
+                        "conditions": [
+                            {
+                                "type": "Admitted",
+                                "status": "True",
+                                "lastTransitionTime": "2019-05-02T18:48:48Z"
+                            }
+                        ],
+                        "wildcardPolicy": "None"
+                    }
+                ]
+            }
+        }
+    ]
+}
diff --git a/os-eap-sso/tests/bats/server/README.md b/os-eap-sso/tests/bats/server/README.md
@@ -0,0 +1,2 @@
+Based on:
+https://github.com/benrady/shinatra
diff --git a/os-eap-sso/tests/bats/server/shinatra.sh b/os-eap-sso/tests/bats/server/shinatra.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+# Starts the server
+# {1} port
+# {2} response
+function start_mock_server() {
+  RESPONSE="HTTP/1.1 200 OK\r\nConnection: close\r\n\r\n${2:-"OK"}\r\n"
+  while { echo -en "$RESPONSE"; } | nc -l "${1:-8080}"; do
+      echo "==============================="
+  done
+}
+