Merge pull request #15794 from rabbitmq/capture-mock-auth-backend-http-failure

(selenium) Capture why mock-auth-backend-http fails to start in some jobs in CI

Author: michaelklishin

selenium/README.md

@@ -220,6 +220,15 @@ following command:
 MOCHA_DOCKER_FILE=\location\of\my\Dockerfile ./run-suites.sh
 ```
 
+When you run the tests locally, you need to run them with the environment variable 
+`MOCHA_DOCKER_FILE=Dockerfile.local` so that the scripts that build the docker image
+`mocha-test` which internally downloads npm packages. To download these packages, 
+you need to be in VPN via a gateway and have .npmrc file in the selenium folder 
+with a api key downloaded from Artifactory. There is an internal confluence page 
+that explains how do it.
+
+Without this docker file and .npmrc file, it is impossible to build mocha-test image.
+
 ## Issues deploying UAA 
 
 If you are not able to successfully run any test case that depends on UAA 

selenium/bin/components/fakeportal

@@ -38,6 +38,7 @@ init_fakeportal() {
 start_fakeportal() {
   begin "Starting fakeportal ..."
 
+  build_mocha_image yes
   init_fakeportal
   kill_container_if_exist fakeportal
   mocha_test_tag=($(md5sum $SELENIUM_ROOT_FOLDER/package.json))

selenium/bin/components/fakeproxy

@@ -34,6 +34,7 @@ init_fakeproxy() {
 start_fakeproxy() {
   begin "Starting fakeproxy ..."
 
+  build_mocha_image yes
   init_fakeproxy
   kill_container_if_exist fakeproxy
   mocha_test_tag=($(md5sum $SELENIUM_ROOT_FOLDER/package.json))

selenium/bin/components/mock-auth-backend-http

@@ -23,14 +23,22 @@ start_mock-auth-backend-http() {
   init_mock-auth-backend-http
   kill_container_if_exist mock-auth-backend-http
 
+  local logfile="${MOCK_AUTH_BACKEND_HTTP_LOG:-$LOGS/mock-auth-backend-http.log}"
+  print "> mock-auth-backend-http docker run log: ${logfile}"
+
   docker run \
     --detach \
     --name mock-auth-backend-http \
     --net ${DOCKER_NETWORK} \
     --publish 8888:1080 \
     --env MOCKSERVER_INITIALIZATION_JSON_PATH="/config/defaultExpectations.json" \
     -v ${AUTH_BACKEND_HTTP_DIR}:/config \
-    ${MOCKSERVER_DOCKER_IMAGE}
+    ${MOCKSERVER_DOCKER_IMAGE} 2>&1 | tee -a "${logfile}"
+
+  if [[ ${PIPESTATUS[0]} -ne 0 ]]; then
+    print "docker run failed; see ${logfile}"
+    return 1
+  fi
 
   wait_for_url $AUTH_BACKEND_HTTP_BASEURL/ready
   end "mock-auth-backend-http is ready"

selenium/bin/suite_template

@@ -139,12 +139,20 @@ init_suite() {
   mkdir -p ${SCREENS}
 }
 
+# The mocha-test image is only used when tests run in a container (_test / docker run).
+# Local commands (start-rabbitmq, start-others, stop-others, test via npm, etc.) skip the build.
 build_mocha_image() {
+  local need_mocha_docker_image="${1:-yes}"
   DOCKER_BUILD_ARGS=""
   if [[ -n "$MOCHA_DOCKER_FILE" ]]; then 
     DOCKER_BUILD_ARGS="-f $MOCHA_DOCKER_FILE "
   fi
   begin "Ensuring mocha-test image ($DOCKER_BUILD_ARGS) ..."
+  if [[ "$need_mocha_docker_image" != "yes" ]]; then
+    print "Skipped. Not required"
+    end "mocha-test image skipped"
+    return 0
+  fi
   tag=($(md5sum $SELENIUM_ROOT_FOLDER/package.json))
   print "> tag : $tag"
   if [[ $(docker images -q mocha-test:$tag 2> /dev/null) == "" ]]; then
@@ -570,7 +578,7 @@ run_local_with() {
   init_suite
   ensure_docker_network
   generate_env_file
-  build_mocha_image
+  build_mocha_image no
 
   if [[ "$PROFILES_FOR_OTHER" != "" ]]
   then