feat: host IP aliases

Author: sublimino

Makefile

@@ -139,6 +139,7 @@ test-local-docker: ## test against local container
 
 	# test against local container
 	make build CONTAINER_NAME="$(CONTAINER_NAME_TESTING)"
+
 	docker rm --force netassert-http-echo 2>/dev/null || true;
 
 	# start echo server
@@ -147,14 +148,14 @@ test-local-docker: ## test against local container
 		hashicorp/http-echo \
 		-listen=:59942 -text 'netassert test endpoint'
 
-	set -x; COUNT=0; \
+	COUNT=0; \
 	until [[ "$$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' netassert-http-echo)" != "" ]]; do \
 			sleep 0.5; \
 			if [[ $$((COUNT++)) -gt 10 ]]; then echo 'Container did not start'; exit 1; fi; \
 	done;
 
 	# get IP to template into test file
-	bash -euxo pipefail -c " \
+	bash -euo pipefail -c " \
 		TMP_TEST_FILE=$$(mktemp); \
 		\
 		cat test/test-localhost-docker-TEMPLATE.yaml \
@@ -166,6 +167,7 @@ test-local-docker: ## test against local container
 			| tee -a \$${TMP_TEST_FILE}; \
 		\
 		./netassert \
+			--verbose \
 			--image $(CONTAINER_NAME_TESTING) \
 			--no-pull \
 			--ssh-user $${SSH_USER:-root} \

entrypoint.sh

@@ -79,7 +79,9 @@ if [[ "${DEBUG:-}" == "1" ]]; then
 fi
 
 mkdir -p ~/.ssh
-cp /home/netassert/.ssh ~/ -a || true
+if [[ -d /home/netassert/.ssh ]]; then
+  cp /home/netassert/.ssh ~/ -a || true
+fi
 chown "$(whoami)" -R ${HOME}/.ssh
 
 if [[ "${DEBUG:-}" == "1" ]]; then

netassert

@@ -70,6 +70,8 @@ main() {
 
   read_config
 
+  parse_host_map || true
+
   count_expected_tests
 
   verbose "${CONFIG}"
@@ -83,6 +85,34 @@ main() {
   iterate_host
 }
 
+get_host_filename() {
+  local HOST="${1:-}"
+  get_host "${HOST}" | base64
+}
+
+get_host() {
+  local HOST="${1:-}"
+
+  if [[ ! "${HOST}" =~ - ]]; then
+    local HOST_CACHE_KEY="HOST_MAP_${HOST//./_}"
+    # attempt to detect invalid cache keys :/
+    if [[ "${!HOST_CACHE_KEY:-}" != "" ]]; then
+      echo "${!HOST_CACHE_KEY} (${HOST})"
+      return 0
+    fi
+  fi
+
+  echo "${HOST}"
+}
+
+# todo(ajm) unsafe
+parse_host_map() {
+  local HOST_ALIAS_MAP=$(jqc "${CONFIG}" -r \
+    ".alias? | to_entries? | map(\"export HOST_MAP_\(.key)='\(.value|tostring)'\") | .[]? | sub(\"\\\.\"; \"_\"; \"g\") ")
+  verbose "${HOST_ALIAS_MAP}"
+  source /dev/stdin < <(echo "${HOST_ALIAS_MAP}") || true
+}
+
 count_expected_tests() {
   EXPECTED_TESTS=$(jqc "${CONFIG}" '[(.host, .k8s.deployment) | keys? | .[]? ] | length')
   info "${EXPECTED_TESTS} tests expected"
@@ -180,7 +210,7 @@ _iterate_k8s_worker() {
       --env TEST_YAML=$(echo "${TEST_DATA}" | to_yaml | base64 -w0) \
       --env DEBUG="${DEBUG}" \
       \
-      | tee "${TEMP_DIR}/${HOST}" >/dev/null; then
+      | tee "${TEMP_DIR}/$(get_host_filename ${HOST})" >/dev/null; then
 
       warning "${HOST} fail"
     else
@@ -202,10 +232,12 @@ configure_parallel() {
 
   parallel --no-notice --record-env
   export -f _iterate_k8s_worker _iterate_host_worker jqc success \
-    info debug verbose error warning ssh_to_node log_message_prefix is_gke to_yaml wait_safe
+    info debug verbose error warning ssh_to_node log_message_prefix \
+    is_gke to_yaml wait_safe get_host get_host_filename
 
   export CONFIG TEMP_DIR THIS_SCRIPT DIR NETASSERT_IMAGE_NAME \
-    DEBUG IS_OFFLINE CONTAINER_BASE_NAME SSH_DEFAULT_OPTIONS SSH_USER SSH_USER_OPTIONS YJ
+    DEBUG IS_OFFLINE CONTAINER_BASE_NAME SSH_DEFAULT_OPTIONS \
+    SSH_USER SSH_USER_OPTIONS YJ
 }
 
 iterate_host() {
@@ -250,24 +282,24 @@ _iterate_host_worker() {
   if [[ -f /opt/ssh_config ]]; then
     CONFIG_FILE_FLAG="-F /opt/ssh_config"
   fi
-  info "Iterating instance targets: $(echo ${HOSTS} | tr ' ' ',')"
+  verbose "Iterating instance targets: $(echo ${HOSTS} | tr ' ' ',')"
 
 
   local CONNECTION="ssh -tt ${SSH_DEFAULT_OPTIONS} ${SSH_USER_OPTIONS} ${CONFIG_FILE_FLAG} "
 
   if [[ "${IS_OFFLINE:-}" != 1 ]]; then
     for HOST in ${HOSTS}; do
       if [[ "${HOST}" == 'localhost' ]]; then
-        (info "$(hostname): pulling image locally" && docker pull "${NETASSERT_IMAGE_NAME}") &
+        (info "$(get_host "$(hostname)"): pulling image locally" && docker pull "${NETASSERT_IMAGE_NAME}") &
         PIDS+="$! "
 
       else
-        local LOG_MESSAGE=$(info "${HOST}: pulling image remotely")
+        local LOG_MESSAGE=$(info "$(get_host "${HOST}"): pulling image remotely")
 
         ${CONNECTION} ${HOST} \
           -- \
           bash -c "echo ${LOG_MESSAGE} && docker pull ${NETASSERT_IMAGE_NAME}" 2>&1 \
-          | tee -a "${TEMP_DIR}/${HOST}" &
+          | tee -a "${TEMP_DIR}/$(get_host_filename "${HOST}")" &
         PIDS+="$! "
       fi
     done
@@ -285,7 +317,7 @@ _iterate_host_worker() {
 
     if [[ "${HOST}" == 'localhost' ]]; then
 
-      info "${HOST}: local test start"
+      info "$(get_host "${HOST}"): local test start"
 
       if ! \
         docker run -t \
@@ -295,15 +327,15 @@ _iterate_host_worker() {
           --env DEBUG="${DEBUG}" \
           "${NETASSERT_IMAGE_NAME}" \
           npm test -s \
-          | tee -a "${TEMP_DIR}/${HOST}" >/dev/null; then
+          | tee -a "${TEMP_DIR}/$(get_host_filename "${HOST}")" >/dev/null; then
 
-        warning "${HOST}: test fail"
+        warning "$(get_host "${HOST}"): test fail"
       else
-        success "${HOST}: test pass"
+        success "$(get_host "${HOST}"): test pass"
       fi
     else
 
-      info "${HOST}: remote test start"
+      info "$(get_host "${HOST}"): remote test start"
 
       if ! \
         ${CONNECTION} ${HOST} \
@@ -319,11 +351,11 @@ _iterate_host_worker() {
             "${NETASSERT_IMAGE_NAME}" \
             npm test -s \
           " \
-        | tee -a "${TEMP_DIR}/${HOST}" >/dev/null; then
+        | tee -a "${TEMP_DIR}/$(get_host_filename "${HOST}")" >/dev/null; then
 
-        warning "${HOST}: test fail"
+        warning "$(get_host "${HOST}"): test fail"
       else
-        success "${HOST}: test pass"
+        success "$(get_host "${HOST}"): test pass"
       fi
     fi
   done <<<"${HOSTS}"
@@ -367,7 +399,7 @@ ssh_to_node() {
     CONNECTION="ssh -tt ${SSH_DEFAULT_OPTIONS} ${SSH_USER_OPTIONS} ${HOST} -- "
   fi
 
-  info "Connecting to ${HOST}..."
+  info "Connecting to $(get_host "${HOST}")..."
 
   local PULL_COMMAND=""
   if [[ "${IS_OFFLINE:-}" != 1 ]]; then
@@ -405,8 +437,15 @@ present_results() {
   local OUTPUT_FAIL_HR=$(printf "%s\n" "${COLOUR_RED}$(hr)${COLOUR_RESET}")
   local OUTPUT_PASS_HR=$(printf "%s\n" "${COLOUR_GREEN}$(hr)${COLOUR_RESET}")
 
-  for RESULT in $(find ${TEMP_DIR}/ -type f); do
+  # todo(ajm) write aliases into test results at runtime
+  while read ALIAS; do
+    sed "s=${ALIAS}=g" -i "${TEMP_DIR}/"*
+  done < <(jqc "${CONFIG}" -r \
+    ".alias? | to_entries? | map(\"\(.key)=\(.value|tostring) (\(.key))\") | .[]? ")
+
+  while read RESULT; do
     local TEST_NAME="${RESULT/${TEMP_DIR}\//}"
+    TEST_NAME=$(base64 -d <<<"${TEST_NAME}")
     RESULT_COUNT=$((RESULT_COUNT + 1))
     local TAP_RESULT=$(
       if ! cat "${RESULT}" | grep -E '^TAP version [0-9]+' -A 9999; then
@@ -432,7 +471,7 @@ present_results() {
         echo "${OUTPUT_PASS_HR}"
         echo)
     fi
-  done
+  done < <(find ${TEMP_DIR}/ -type f)
 
   local OUTPUT_RESULT=$(
     if [[ "${TEST_FAILURES}" -gt 0 ]]; then
@@ -510,8 +549,8 @@ check_dependencies() {
 }
 
 handle_arguments() {
-  parse_arguments "$@"
-  validate_arguments "$@"
+  parse_arguments "${@}"
+  validate_arguments "${@}"
 }
 
 parse_arguments() {

test/netassert-test.js

@@ -12,6 +12,7 @@ process.setMaxListeners(200)
 
 function log () {
   if (debug) {
+    // process.stdout.write('# ')
     console.log.apply(null, arguments)
   }
 }

test/test-localhost-docker-TEMPLATE.yaml

@@ -1,3 +1,7 @@
+alias:
+  ${DOCKER_HOST_IP}: echo-server
+  localhost: my nice local host
+
 host:
   localhost:
     ${DOCKER_HOST_IP}: