#!/bin/bash
#
# Functions for tests for the Node.js image.
#
# IMAGE_NAME specifies a name of the candidate image used for testing.
# The image has to be available before this script is executed.
#
THISDIR=$(dirname ${BASH_SOURCE[0]})
source "${THISDIR}/test-lib.sh"
source "${THISDIR}/test-lib-openshift.sh"
info() {
echo -e "\n\e[1m[INFO] $@...\e[0m\n"
}
image_exists() {
docker inspect $1 &>/dev/null
}
container_exists() {
image_exists $(cat $cid_file)
}
container_ip() {
docker inspect --format="{{ .NetworkSettings.IPAddress }}" $(cat $cid_file)
}
container_logs() {
docker logs $(cat $cid_file)
}
run_s2i_build() {
ct_s2i_build_as_df file://${test_dir}/test-app ${IMAGE_NAME} ${IMAGE_NAME}-testapp ${s2i_args} $(ct_build_s2i_npm_variables) $1
}
run_s2i_build_proxy() {
ct_s2i_build_as_df file://${test_dir}/test-hw ${IMAGE_NAME} ${IMAGE_NAME}-testhw ${s2i_args} $(ct_build_s2i_npm_variables) -e HTTP_PROXY=$1 -e http_proxy=$1 -e HTTPS_PROXY=$2 -e https_proxy=$2
}
run_s2i_build_client() {
ct_s2i_build_as_df \
"file://${test_dir}/$1" "${IMAGE_NAME}" "${IMAGE_NAME}-$1" \
${s2i_args} \
$(ct_build_s2i_npm_variables) -e NODE_ENV=development
}
run_s2i_build_binary() {
ct_s2i_build_as_df file://${test_dir}/test-binary ${IMAGE_NAME} ${IMAGE_NAME}-testbinary ${s2i_args} $(ct_build_s2i_npm_variables) $1
}
run_s2i_multistage_build() {
ct_s2i_multistage_build file://${test_dir}/test-app ${FULL_IMAGE} ${IMAGE_NAME} ${IMAGE_NAME}-testapp $(ct_build_s2i_npm_variables)
}
prepare_dummy_git_repo() {
git init
for key in "${!gitconfig[@]}"; do
git config --local "$key" "${gitconfig[$key]}"
done
git add --all
git commit -m "Sample commit"
}
prepare_client_repo() {
git clone \
--config advice.detachedHead="false" \
--branch "$3" --depth 1 \
"$2" "$1"
pushd "$1" >/dev/null || return
for key in "${!gitconfig[@]}"; do
git config --local "$key" "${gitconfig[$key]}"
done
popd >/dev/null || return
}
prepare_minimal_build() {
suffix=$1
# Build the app using the full assemble-capable image
[ -z "$(docker images -q "$FULL_IMAGE")" ] && docker pull "$FULL_IMAGE"
case "$suffix" in
testapp)
run_s2i_multistage_build #>/tmp/build-log 2>&1
;;
testhw)
IMAGE_NAME=$FULL_IMAGE run_s2i_build_proxy http://user.password@0.0.0.0:8000 https://user.password@0.0.0.0:8000 >/tmp/build-log 2>&1
# Get the application from the assembled image and into the minimal
tempdir=$(mktemp -d)
chown 1001:0 "$tempdir"
docker run -u 0 --rm -ti -v "$tempdir:$tempdir:Z" "$FULL_IMAGE-$suffix" bash -c "cp -ar /opt/app-root/src $tempdir"
pushd "$tempdir" >/dev/null || return
cat <<EOF >Dockerfile
FROM $IMAGE_NAME
ADD src/* /opt/app-root/src
CMD /usr/libexec/s2i/run
EOF
# Check if CA autority is present on host and add it into Dockerfile
[ -f "$(full_ca_file_path)" ] && cat <<EOF >>Dockerfile
USER 0
RUN cd /etc/pki/ca-trust/source/anchors && update-ca-trust extract
USER 1001
EOF
docker build -t "$IMAGE_NAME-$suffix" $(ct_build_s2i_npm_variables | grep -o -e '\(-v\)[[:space:]]\.*\S*') .
popd >/dev/null || return
;;
*)
echo "Please specify a valid test application"
exit 1
;;
esac
}
prepare() {
if ! image_exists ${IMAGE_NAME}; then
echo "ERROR: The image ${IMAGE_NAME} must exist before this script is executed."
exit 1
fi
case "$1" in
# TODO: STI build require the application is a valid 'GIT' repository, we
# should remove this restriction in the future when a file:// is used.
app|hw|express-webapp|binary)
pushd "${test_dir}/test-${1}" >/dev/null
prepare_dummy_git_repo
popd >/dev/null
;;
*)
if [[ " ${CLIENT_LIST[*]} " =~ "${test_case} " ]];
then
PREFIX=$1
REPO="${PREFIX^^}"_REPO
REVISION="${PREFIX^^}"_REVISION
prepare_client_repo "${test_dir}/$1" "${!REPO}" "${!REVISION}"
else
echo "Please specify a valid test application"
exit 1
fi
;;
esac
}
run_test_application() {
case "$1" in
app|hw|express-webapp|binary)
docker run -d --user=100001 $(ct_mount_ca_file) --rm --cidfile=${cid_file} $2 ${IMAGE_NAME}-test$1
;;
*)
echo "No such test application"
exit 1
;;
esac
}
run_client_test_suite() {
docker run --user=100001 $(ct_mount_ca_file) --rm --cidfile=${cid_file} ${IMAGE_NAME}-$1 npm test
}
kill_test_application() {
docker kill $(cat $cid_file)
rm $cid_file
}
cleanup() {
if [ -f $cid_file ]; then
if container_exists; then
docker stop $(cat $cid_file)
fi
fi
for image in "${IMAGE_NAME}"-{test{app,hw,express-webapp,binary}}; do
image_exists "$image" || continue
docker rmi -f "$image"
done
for client in "${CLIENT_LIST[@]}"; do
image="${IMAGE_NAME}-${client}"
image_exists "$image" || continue
docker rmi -f "$image"
done
rm -rf ${test_dir}/test-app/.git
rm -rf ${test_dir}/test-hw/.git
rm -rf ${test_dir}/test-binary/.git
for client in "${CLIENT_LIST[@]}"; do
rm -rf "${test_dir}/${client}"
done
rm -rf ${test_dir}/test-express-webapp/.git
echo "$test_short_summary"
if [ $TESTSUITE_RESULT -eq 0 ] ; then
echo "Tests for ${IMAGE_NAME} succeeded."
else
echo "Tests for ${IMAGE_NAME} failed."
fi
exit $TESTSUITE_RESULT
}
check_result() {
local result="$1"
if [[ "$result" != "0" ]]; then
echo "S2I image '${IMAGE_NAME}' test FAILED (exit code: ${result})"
TESTCASE_RESULT=1
fi
return $result
}
wait_for_cid() {
local max_attempts=20
local sleep_time=1
local attempt=1
local result=1
while [ $attempt -le $max_attempts ]; do
[ -f $cid_file ] && [ -s $cid_file ] && break
echo "Waiting for container start..."
attempt=$(( $attempt + 1 ))
sleep $sleep_time
done
}
test_s2i_usage() {
echo "Testing 's2i usage'..."
ct_s2i_usage ${IMAGE_NAME} ${s2i_args} &>/dev/null
check_result $?
}
test_docker_run_usage() {
echo "Testing 'docker run' usage..."
docker run --rm ${IMAGE_NAME} &>/dev/null
check_result $?
}
test_connection() {
echo "Testing HTTP connection..."
local max_attempts=10
local sleep_time=1
local attempt=1
local result=1
while [ $attempt -le $max_attempts ]; do
echo "Sending GET request to http://$(container_ip):${test_port}/"
response_code=$(curl -s -w %{http_code} -o /dev/null http://$(container_ip):${test_port}/)
status=$?
if [ $status -eq 0 ]; then
if [ $response_code -eq 200 ]; then
result=0
fi
break
fi
attempt=$(( $attempt + 1 ))
sleep $sleep_time
done
return $result
}
scl_usage() {
# Verify the 'usage' script is working properly when running the base image with 's2i usage ...'
local run_cmd="$1"
local expected="$2"
echo "Testing the image SCL enable ..."
out=$(docker run --rm ${IMAGE_NAME} /bin/bash -c "${run_cmd}")
if ! echo "${out}" | grep -q "${expected}"; then
echo "ERROR[/bin/bash -c "${run_cmd}"] Expected '${expected}', got '${out}'"
return 1
fi
out=$(docker exec $(cat ${cid_file}) /bin/bash -c "${run_cmd}" 2>&1)
if ! echo "${out}" | grep -q "${expected}"; then
echo "ERROR[exec /bin/bash -c "${run_cmd}"] Expected '${expected}', got '${out}'"
return 1
fi
out=$(docker exec $(cat ${cid_file}) /bin/sh -ic "${run_cmd}" 2>&1)
if ! echo "${out}" | grep -q "${expected}"; then
echo "ERROR[exec /bin/sh -ic "${run_cmd}"] Expected '${expected}', got '${out}'"
return 1
fi
}
function test_scl_usage() {
scl_usage "node --version" "v${VERSION//-minimal/}."
check_result $?
}
validate_default_value() {
local label=$1
IFS=':' read -a label_vals <<< $(docker inspect -f "{{index .Config.Labels \"$label\"}}" ${IMAGE_NAME})
label_var=${label_vals[0]}
default_label_val=${label_vals[1]}
actual_label_val=$(docker run --rm $IMAGE_NAME /bin/bash -c "echo $"$label_var)
if [ "$actual_label_val" != "$default_label_val" ]; then
echo "ERROR default value for $label with environment variable $label_var; Expected $default_label_val, got $actual_label_val"
return 1
fi
}
# Gets the NODE_ENV environment variable from the container.
get_node_env_from_container() {
local dev_mode="$1"
local node_env="$2"
IFS=':' read -a label_val <<< $(docker inspect -f '{{index .Config.Labels "com.redhat.dev-mode"}}' $IMAGE_NAME)
dev_mode_label_var="${label_val[0]}"
echo $(docker run --rm --env $dev_mode_label_var=$dev_mode --env NODE_ENV=$node_env $IMAGE_NAME /bin/bash -c 'echo "$NODE_ENV"')
}
# Ensures that a docker container run with '--env NODE_ENV=$current_val' produces a NODE_ENV value of $expected when
# DEV_MODE=dev_mode.
validate_node_env() {
local current_val="$1"
local dev_mode_val="$2"
local expected="$3"
actual=$(get_node_env_from_container "$dev_mode_val" "$current_val")
if [ "$actual" != "$expected" ]; then
echo "ERROR default value for NODE_ENV when development mode is $dev_mode_val; should be $expected but is $actual"
return 1
fi
}
test_dev_mode() {
local app=$1
local dev_mode=$2
local node_env=$3
echo "Testing $app DEV_MODE=$dev_mode NODE_ENV=$node_env"
run_test_application $app "-e DEV_MODE=$dev_mode"
wait_for_cid
test_connection
check_result $?
logs=$(container_logs)
echo ${logs} | grep -q DEV_MODE=$dev_mode
check_result $?
echo ${logs} | grep -q DEBUG_PORT=5858
check_result $?
echo ${logs} | grep -q NODE_ENV=$node_env
check_result $?
kill_test_application
}
test_incremental_build() {
npm_variables=$(ct_build_s2i_npm_variables)
build_log1=$(ct_s2i_build_as_df file://${test_dir}/test-incremental ${IMAGE_NAME} ${IMAGE_NAME}-testapp ${s2i_args} ${npm_variables})
check_result $?
build_log2=$(ct_s2i_build_as_df file://${test_dir}/test-incremental ${IMAGE_NAME} ${IMAGE_NAME}-testapp ${s2i_args} ${npm_variables} --incremental)
check_result $?
if [ "$VERSION" == "6" ]; then
# Different npm output for version 6
if echo "$build_log2" | grep -e "\-\- yarn@[0-9\.]*"; then
echo "ERROR Incremental build failed: yarn package is getting installed in incremental build"
check_result 1
fi
else
first=$(echo "$build_log1" | grep -o -e "added [0-9]* packages" | awk '{ print $2 }')
second=$(echo "$build_log2" | grep -o -e "added [0-9]* packages" | awk '{ print $2 }')
if [ "$first" == "$second" ]; then
echo "ERROR Incremental build failed: both builds installed $first packages"
check_result 1
fi
fi
}
function test_scl_variables_in_dockerfile() {
if [ "$OS" == "rhel7" ] || [ "$OS" == "centos7" ]; then
# autocleanup only enabled here as only the following tests so far use it
CID_FILE_DIR=$(mktemp -d)
ct_enable_cleanup
echo "Testing npm availability in Dockerfile"
ct_binary_found_from_df npm
check_result $?
info "Testing variable presence during \`docker exec\`"
ct_check_exec_env_vars
check_result $?
info "Checking if all scl variables are defined in Dockerfile"
ct_check_scl_enable_vars
check_result $?
fi
}
# test express webapp
run_s2i_build_express_webapp() {
local result
prepare express-webapp
ct_s2i_build_as_df file://${test_dir}/test-express-webapp ${IMAGE_NAME} ${IMAGE_NAME}-testexpress-webapp ${s2i_args} $(ct_build_s2i_npm_variables)
run_test_application express-webapp
wait_for_cid
ct_test_response http://$(container_ip):${test_port} 200 'Welcome to Express Testing Application'
result=$?
kill_test_application
return $result
}
function test_build_express_webapp() {
echo "Running express webapp test"
run_s2i_build_express_webapp
check_result $?
}
function test_running_client_js {
echo "Running $1 test suite"
prepare "$1"
run_s2i_build_client "$1"
check_result $?
run_client_test_suite "$1"
check_result $?
}
function test_check_build_using_dockerfile() {
info "Check building using a Dockerfile"
ct_test_app_dockerfile ${THISDIR}/examples/from-dockerfile/Dockerfile 'https://github.com/sclorg/nodejs-ex.git' 'Welcome to your Node.js application on OpenShift' app-src
check_result $?
ct_test_app_dockerfile ${THISDIR}/examples/from-dockerfile/Dockerfile.s2i 'https://github.com/sclorg/nodejs-ex.git' 'Welcome to your Node.js application on OpenShift' app-src
check_result $?
}
function test_npm_functionality() {
echo "Testing npm availability"
ct_npm_works
check_result $?
}
function test_nodemon_removed() {
# Test that the development dependencies (nodemon) have been removed (npm prune)
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "! test -d ./node_modules/nodemon")
check_result "$?"
}
function test_nodemon_present() {
# Test that the development dependencies (nodemon) have been removed (npm prune)
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "test -d ./node_modules/nodemon")
check_result "$?"
}
function test_npm_cache_cleared() {
# Test that the npm cache has been cleared
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "! test -d \$(npm config get cache)")
check_result "$?"
}
function test_npm_cache_exists() {
# Test that the npm cache has been cleared
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "test -d \$(npm config get cache)")
check_result "$?"
}
function test_npm_tmp_cleared() {
# Test that the npm tmp has been cleared
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "! ls \$(npm config get tmp)/npm-* 2>/dev/null")
check_result "$?"
}
function test_dev_mode_false_production() {
# DEV_MODE=false NODE_ENV=production
test_dev_mode app false production
}
function test_dev_mode_true_development() {
# DEV_MODE=true NODE_ENV=development
test_dev_mode app true development
}
function test_dev_mode_false_development() {
# DEV_MODE=false NODE_ENV=development
test_dev_mode app false development
}
function test_run_app_application() {
# Verify that the HTTP connection can be established to test application container
run_test_application app
# Wait for the container to write it's CID file
wait_for_cid
}
function test_run_hw_application() {
# Verify that the HTTP connection can be established to test application container
run_test_application hw
# Wait for the container to write it's CID file
wait_for_cid
check_result $?
kill_test_application
}
function test_run_binary_application() {
# Test is suppressed because of https://github.com/Blizzard/node-rdkafka/issues/910
# The newest version of node-rdkafka works only with gcc-8 and higher
# On RHEL7 and CentOS7 is gcc-4.8
if [ "$OS" != "rhel7" ] && [ "$OS" != "centos7" ]; then
prepare binary
run_s2i_build_binary
check_result $?
# Verify that the HTTP connection can be established to test application container
run_test_application binary
# Wait for the container to write it's CID file
wait_for_cid
kill_test_application
fi
}
function test_safe_logging() {
if [[ $(grep redacted /tmp/build-log | wc -l) -eq 4 ]]; then
grep redacted /tmp/build-log
check_result 0
else
echo "Some proxy log-in credentials were left in log file"
grep Setting /tmp/build-log
check_result 1
fi
}
function run_all_tests() {
local APP_NAME="$1"
for test_case in $TEST_SET; do
info "Running test $test_case ...."
TESTCASE_RESULT=0
if [[ " ${CLIENT_LIST[*]} " =~ "${test_case} " ]];
then
rm -f $cid_file
test_running_client_js "${test_case}"
else
$test_case
fi
check_result $?
local test_msg
if [ $TESTCASE_RESULT -eq 0 ]; then
test_msg="[PASSED]"
else
test_msg="[FAILED]"
TESTSUITE_RESULT=1
fi
printf -v test_short_summary "%s %s for '%s' %s\n" "${test_short_summary}" "${test_msg}" "${APP_NAME}" "$test_case"
[ -n "${FAIL_QUICKLY:-}" ] && cleanup "${APP_NAME}" && return 1
done;
}
# Check the imagestream
function test_nodejs_imagestream() {
case ${OS} in
rhel7|centos7) ;;
*) echo "Imagestream testing not supported for $OS environment." ; return 0 ;;
esac
ct_os_test_image_stream_quickstart "${THISDIR}/../imagestreams/nodejs-${OS%[0-9]*}.json" \
"https://raw.githubusercontent.com/sclorg/nodejs-ex/master/openshift/templates/nodejs.json" \
"${IMAGE_NAME}" \
'nodejs' \
"Welcome to your Node.js application on OpenShift" \
8080 http 200 "-p SOURCE_REPOSITORY_REF=master -p SOURCE_REPOSITORY_URL=https://github.com/sclorg/nodejs-ex.git -p NODEJS_VERSION=${VERSION} -p NAME=nodejs-testing"
}
# vim: set tabstop=2:shiftwidth=2:expandtab: