Merge pull request #7687 from rabbitmq/refactor-selenium-tests

Refactor selenium tests

Author: michaelklishin

deps/rabbitmq_management/selenium/README.md

@@ -11,15 +11,34 @@ To run the tests we need:
 
 All test cases and their configuration files are under the `test` folder and grouped into subfolders based on the area of functionality they are testing. For instance, under `oauth` folder, we have test cases about OAuth 2.0.
 Furthermore, within an area of functionality like OAuth 2.0 we want to test under different configuration.
-For instance under `test/oauth/with-uaa` we group all test cases which run against UAA. Whereas
-under `test/oauth/with-uaa-down` we group all test cases which run against a UAA which is down.
-
-And under `suites` folder we have the test suites where we literally script the following:
-  - the suite's **setup**, e.g. start RabbitMQ and UAA with a specific configuration
-  - the path to the test cases
-  - the path to the test case configuration
-  - the suite's **teardown**, e.g. stop RabbitMQ and UAA
-  - and save all logs and screen captures if any
+For instance under `test/oauth/with-sp-initiated` we group all test cases which run against an Authorization server via the Authorization Code Flow. Whereas under `test/oauth/with-idp-down` we group all test cases which run against an Authorization server which is down.
+
+And under `suites` folder we have the test suites. A test suite is a script which executes all test cases
+under a folder and using a given configuration and launching a number of components the test suite depends on.
+
+Some test cases only depend on RabbitMQ such as the `basic-auth.sh`. In this test suite, we specify the location of the test case relative to the `test` folder.
+And we call the function `run`. We always have to source the file under `bin/suite_template`.
+
+```
+TEST_CASES_PATH=/basic-auth
+
+source $SCRIPT/../bin/suite_template
+run
+````
+
+When our test suite requires of other components such as UAA, we use the function call `runWith` as we see below for the test case `oauth-with-uaa.sh`. In this test case, in addition to declaring the location of the test case, we also specify the location of the configuration files required to launch the components this suite
+depends on. We also specify which profiles are activated which in turn defines the settings and configuration files used in the suite. And said earlier, the suite runs via the function `runWith` specifying the components that should be started and stopped and its logs captured too.
+
+```
+TEST_CASES_PATH=/oauth/with-sp-initiated
+TEST_CONFIG_PATH=/oauth
+PROFILES="uaa uaa-oauth-provider"
+
+source $SCRIPT/../bin/suite_template
+runWith uaa
+
+```
+
 
 # How to run the tests
 

deps/rabbitmq_management/selenium/bin/find-template-files

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+TEST_PATH=${1:?"First parameter must be the test path"}
+TEMPLATE_FILE_PREFIX=${2:?"Second parameter must be the template file prefix"}
+TEMPLATE_FILE_SUFFIX=${3:-""}
+TEST_PARENT_PATH="$(dirname "$TEST_PATH")"
+
+find_templates_files() {
+  find_template_files_in $TEST_PARENT_PATH
+  find_template_files_in $TEST_PATH
+
+}
+find_template_files_in() {
+
+  for file in $1/${TEMPLATE_FILE_PREFIX}.*${TEMPLATE_FILE_SUFFIX}
+  do
+    if [ ! -f $file ]
+    then
+      continue
+    fi
+    entry="$(basename $file)"
+    prefix=${entry#$TEMPLATE_FILE_PREFIX.*}
+    if [[ $prefix == $TEMPLATE_FILE_SUFFIX ]]
+    then
+      echo "$1/${TEMPLATE_FILE_PREFIX}.${TEMPLATE_FILE_SUFFIX}"
+    else
+      profiles=${prefix%.$TEMPLATE_FILE_SUFFIX}
+      matched_entry=true
+      for p in ${profiles//./ }
+      do
+        if [[ "$PROFILES" != *"$p"* && $matched_entry == true ]]; then
+          matched_entry=false
+        fi
+      done
+      if [[ $matched_entry == true ]]; then
+        echo "$file"
+      fi
+    fi
+
+  done
+}
+
+
+find_templates_files

deps/rabbitmq_management/selenium/bin/gen-env-file

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+SCRIPT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+ENV_FILE="/tmp/rabbitmq/.env"
+FIND_PATH=$1
+ENV_FILE=$2
+FIND_PARENT_PATH="$(dirname "$FIND_PATH")"
+
+generate_env_file() {
+  parentdir="$(dirname "$ENV_FILE")"
+  mkdir -p $parentdir
+  echo "" > $ENV_FILE
+
+  for f in $($SCRIPT/find-template-files $FIND_PATH ".env")
+  do
+    cat $f >> $ENV_FILE
+  done
+}
+
+generate_env_file

deps/rabbitmq_management/selenium/bin/gen-keycloak-json

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+SCRIPT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+#set -x
+
+KEYCLOAK_PATH=${1:?First parameter is the directory env and config files are relative to}
+ENV_FILE=${2:?Second parameter is a comma-separated list of .env file which has exported template variables}
+FINAL_CONFIG_FILE=${3:?Forth parameter is the name of the final config file. It is relative to where this script is run from}
+
+source $ENV_FILE
+
+echo "" > $FINAL_CONFIG_FILE
+
+for f in $($SCRIPT/find-template-files $KEYCLOAK_PATH "test-realm" "json")
+do
+  envsubst < $f  >> $FINAL_CONFIG_FILE
+done

deps/rabbitmq_management/selenium/bin/gen-rabbitmq-conf

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+SCRIPT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+#set -x
+
+TEST_PATH=${1:?First parameter is the directory env and config files are relative to}
+ENV_FILE=${2:?Second parameter is a comma-separated list of .env file which has exported template variables}
+FINAL_CONFIG_FILE=${3:?Forth parameter is the name of the final config file. It is relative to where this script is run from}
+
+source $ENV_FILE
+
+echo "" > $FINAL_CONFIG_FILE
+
+for f in $($SCRIPT/find-template-files $TEST_PATH "rabbitmq" "conf")
+do
+  envsubst < $f  >> $FINAL_CONFIG_FILE
+done

deps/rabbitmq_management/selenium/bin/gen-uaa-yml

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+SCRIPT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+#set -x
+
+UAA_PATH=${1:?First parameter is the directory env and config files are relative to}
+ENV_FILE=${2:?Second parameter is a comma-separated list of .env file which has exported template variables}
+FINAL_CONFIG_FILE=${3:?Forth parameter is the name of the final config file. It is relative to where this script is run from}
+
+source $ENV_FILE
+
+echo "" > $FINAL_CONFIG_FILE
+
+for f in $($SCRIPT/find-template-files $UAA_PATH "uaa" "yml")
+do
+  envsubst < $f  >> $FINAL_CONFIG_FILE
+done