🧹 Rewrite unit tests in Golang (#215)

* Rewrite the unit tests to Golang

Signed-off-by: Chris Suszyński <[email protected]>

* Restore Stderr for Prow jobs

* Remove mock tests reports from real reports

* Cleanup before review

Signed-off-by: Chris Suszyński <[email protected]>

* Unit test work without a Prow

Signed-off-by: Chris Suszyński <[email protected]>

Author: cardil

e2e-tests.sh

@@ -76,7 +76,7 @@ function setup_test_cluster() {
   # Setup KO_DOCKER_REPO if it is a GKE cluster. Incorporate an element of
   # randomness to ensure that each run properly publishes images. Don't
   # owerwrite KO_DOCKER_REPO if already set.
-  [ -z "${KO_DOCKER_REPO}" ] && \
+  [ -z "${KO_DOCKER_REPO:-}" ] && \
     [[ "${k8s_cluster}" =~ ^gke_.* ]] && \
     export KO_DOCKER_REPO=gcr.io/${E2E_PROJECT_ID}/${REPO_NAME}-e2e-img/${RANDOM}
 
@@ -120,12 +120,14 @@ function success() {
 }
 
 # Exit test, dumping current state info.
-# Parameters: $1 - error message (optional).
+# Parameters: $* - error message (optional).
 function fail_test() {
-  [[ -n $1 ]] && echo "ERROR: $1"
-  dump_cluster_state
-  dump_metrics
-  exit 1
+  local message="$*"
+  if [[ -n ${message:-} ]]; then
+    message='test failed'
+  fi
+  add_trap "dump_cluster_state;dump_metrics" EXIT
+  abort "${message}"
 }
 
 SKIP_TEARDOWNS=0

infra-library.sh

@@ -91,8 +91,8 @@ function create_test_cluster() {
   fi
 
   case "$1" in
-    gke) create_gke_test_cluster "$2" "$3" "$4" ;;
-    kind) create_kind_test_cluster "$2" "$3" "$4" ;;
+    gke) create_gke_test_cluster "$2" "$3" "${4:-}" ;;
+    kind) create_kind_test_cluster "$2" "$3" "${4:-}" ;;
     *) echo "unsupported provider: $1"; exit 1 ;;
   esac
 
@@ -126,11 +126,11 @@ function create_gke_test_cluster() {
   # We are disabling logs and metrics on Boskos Clusters by default as they are not used. Manually set ENABLE_GKE_TELEMETRY to true to enable telemetry
   # and ENABLE_PREEMPTIBLE_NODES to true to create preemptible/spot VMs. VM Preemption is a rare event and shouldn't be distruptive given the fault tolerant nature of our tests.
   local extra_gcloud_flags=""
-  if [[ "$ENABLE_GKE_TELEMETRY" != "true" ]]; then
+  if [[ "${ENABLE_GKE_TELEMETRY:-}" != "true" ]]; then
     extra_gcloud_flags="${extra_gcloud_flags} --logging=NONE --monitoring=NONE"
   fi
 
-  if [[ "$ENABLE_PREEMPTIBLE_NODES" == "true" ]]; then
+  if [[ "${ENABLE_PREEMPTIBLE_NODES:-}" == "true" ]]; then
     extra_gcloud_flags="${extra_gcloud_flags} --preemptible"
   fi
   run_kntest kubetest2 gke "${_custom_flags[@]}" --test-command="${_test_command[*]}" --extra-gcloud-flags="${extra_gcloud_flags}"

library.sh

@@ -40,7 +40,19 @@ fi
 readonly IS_PROW
 [[ ! -v REPO_ROOT_DIR ]] && REPO_ROOT_DIR="$(git rev-parse --show-toplevel)"
 readonly REPO_ROOT_DIR
-readonly REPO_NAME="${REPO_NAME:-$(basename "${REPO_ROOT_DIR}")}"
+
+# Resolves the repository name given a root directory.
+# Parameters: $1 - repository root directory.
+function __resolveRepoName() {
+  local repoName
+  repoName="$(basename "${1:-$(git rev-parse --show-toplevel)}")"
+  repoName="${repoName#knative-sandbox-}" # Remove knative-sandbox- prefix if any
+  repoName="${repoName#knative-}" # Remove knative- prefix if any
+  echo "${repoName}"
+}
+default_repo_name="$(__resolveRepoName "${REPO_ROOT_DIR}")"
+readonly REPO_NAME="${REPO_NAME:-$default_repo_name}"
+unset default_repo_name
 
 # Useful flags about the current OS
 IS_LINUX=0
@@ -65,10 +77,6 @@ if [[ -z "${ARTIFACTS:-}" ]]; then
 fi
 mkdir -p "$ARTIFACTS"
 
-
-# On a Prow job, redirect stderr to stdout so it's synchronously added to log
-(( IS_PROW )) && exec 2>&1
-
 # Return the major version of a release.
 # For example, "v0.2.1" returns "0"
 # Parameters: $1 - release version label.
@@ -94,23 +102,63 @@ function patch_version() {
   echo "${tokens[2]}"
 }
 
-# Print error message and exit 1
+# Calculates the hashcode for a given string.
+# Parameters: $* - string to be hashed.
+# See: https://stackoverflow.com/a/48863502/844449
+function hashCode() {
+  local input="$1"
+  local -i h=0
+  for ((i = 0; i < ${#input}; i++)); do
+    # val is ASCII val
+    printf -v val "%d" "'${input:$i:1}"
+    hval=$((31 * h + val))
+    # hash scheme
+    if ((hval > 2147483647)); then
+      h=$(( (hval - 2147483648) % 2147483648 ))
+    elif ((hval < -2147483648)); then
+      h=$(( (hval + 2147483648) % 2147483648 ))
+    else
+      h=$(( hval ))
+    fi
+  done
+  # final hashCode in decimal
+  printf "%d" $h
+}
+
+# Calculates the retcode for a given string. Makes sure the return code is
+# non-zero.
+# Parameters: $* - string to be hashed.
+function calcRetcode() {
+  local rc=1
+  local rcc
+  rcc="$(hashCode "$*")"
+  if [[ $rcc != 0 ]]; then
+    rc=$(( rcc % 255 ))
+  fi
+  echo "$rc"
+}
+
+# Print error message and call exit(n) where n calculated from the error message.
 # Parameters: $1..$n - error message to be displayed
+# Globals: abort_retcode will change the default retcode to be returned
 function abort() {
-  echo "error: $*" >&2
-  exit 1
+  make_banner '*' "ERROR: $*" >&2
+  readonly abort_retcode="${abort_retcode:-$(calcRetcode "$*")}"
+  exit "$abort_retcode"
 }
 
 # Display a box banner.
 # Parameters: $1 - character to use for the box.
 #             $2 - banner message.
 function make_banner() {
   local msg="$1$1$1$1 $2 $1$1$1$1"
-  local border="${msg//[-0-9A-Za-z _.,\/()\']/$1}"
+  local border="${msg//[^$1]/$1}"
   echo -e "${border}\n${msg}\n${border}"
   # TODO(adrcunha): Remove once logs have timestamps on Prow
   # For details, see https://github.com/kubernetes/test-infra/issues/10100
-  echo -e "$1$1$1$1 $(TZ='UTC' date)\n${border}"
+  if (( IS_PROW )); then
+    echo -e "$1$1$1$1 $(TZ='UTC' date --rfc-3339=ns)\n${border}"
+  fi
 }
 
 # Simple header for logging purposes.
@@ -126,7 +174,7 @@ function subheader() {
 
 # Simple warning banner for logging purposes.
 function warning() {
-  make_banner '!' "$*" >&2
+  make_banner '!' "WARN: $*" >&2
 }
 
 # Checks whether the given function exists.
@@ -448,14 +496,14 @@ function report_go_test() {
   logfile="${xml/junit_/go_test_}"
   logfile="${logfile/.xml/.jsonl}"
   echo "Running go test with args: ${go_test_args[*]}"
+  local gotest_retcode=0
   go_run gotest.tools/[email protected] \
     --format "${GO_TEST_VERBOSITY:-testname}" \
     --junitfile "${xml}" \
     --junitfile-testsuite-name relative \
     --junitfile-testcase-classname relative \
     --jsonfile "${logfile}" \
-    -- "${go_test_args[@]}"
-  local gotest_retcode=$?
+    -- "${go_test_args[@]}" || gotest_retcode=$?
   echo "Finished run, return code is ${gotest_retcode}"
 
   echo "XML report written to ${xml}"
@@ -558,6 +606,9 @@ function go_run() {
   if [[ "$package" != *@* ]]; then
     abort 'Package for "go_run" needs to have @version'
   fi
+  if [[ "$package" == *@latest ]] && [[ "$package" != knative.dev* ]]; then
+    warning 'Using @latest version for external dependencies is unsafe. Use numbered version!'
+  fi
   shift 1
   GORUN_PATH="${GORUN_PATH:-$(go env GOPATH)}"
   # Some CI environments may have non-writable GOPATH

presubmit-tests.sh

@@ -240,15 +240,14 @@ function run_integration_tests() {
 # Default integration test runner that runs all `test/e2e-*tests.sh`.
 function default_integration_test_runner() {
   local failed=0
-  find test/ ! -name "$(printf "*\n*")" -name "e2e-*tests.sh" -maxdepth 1 > tmp
-  while IFS= read -r e2e_test
-  do
+
+  while IFS= read -r e2e_test; do
     echo "Running integration test ${e2e_test}"
     if ! ${e2e_test}; then
       failed=1
       step_failed "${e2e_test}"
     fi
-  done < tmp
+  done < <(find test/ ! -name "$(printf "*\n*")" -name "e2e-*tests.sh" -maxdepth 1)
   return ${failed}
 }
 
@@ -284,16 +283,16 @@ function main() {
     git version
     echo ">> ko version"
     [[ -f /ko_version ]] && cat /ko_version || echo "unknown"
-    if [[ "${DOCKER_IN_DOCKER_ENABLED}" == "true" ]]; then
+    if [[ "${DOCKER_IN_DOCKER_ENABLED:-}" == "true" ]]; then
       echo ">> docker version"
       docker version
     fi
     if type java > /dev/null; then
       echo ">> java version"
       java -version
-      echo "JAVA_HOME: $JAVA_HOME"
+      echo "JAVA_HOME: ${JAVA_HOME:-}"
     fi
-    if type mvn > /dev/null; then
+    if command -v mvn > /dev/null; then
       echo ">> maven version"
       mvn --version
     fi

test/e2e-tests.sh

@@ -23,21 +23,24 @@
 # Calling this script without arguments will create a new cluster in
 # project $PROJECT_ID, run the tests and delete the cluster.
 
-set -Eeo pipefail
+set -Eeuo pipefail
 
 source "$(dirname "${BASH_SOURCE[0]:-$0}")/../e2e-tests.sh"
 
 function knative_setup() {
   start_latest_knative_serving
 }
 
+function dump_metrics() {
+  header ">> Starting kube proxy"
+  header ">> Grabbing k8s metrics"
+}
+
 # Script entry point.
 initialize "$@" --max-nodes=1 --machine=e2-standard-2 \
   --enable-workload-identity --cluster-version=latest \
   --extra-gcloud-flags "--enable-stackdriver-kubernetes --no-enable-ip-alias --no-enable-autoupgrade"
 
-set -Eeuo pipefail
-
 go_test_e2e ./test/e2e || fail_test
 
 success

test/library_test.go

@@ -45,7 +45,7 @@ func TestFails(t *testing.T) {
 
 func TestFailsWithFatal(t *testing.T) {
 	// Simulate a zap.Fatal() call.
-	fmt.Println("fatal\tTestFailsWithFatal\tsimple_test.go:999\tFailed with logger.Fatal()")
+	fmt.Println("fatal\tTestFailsWithFatal\tlibrary_test.go:48\tFailed with logger.Fatal()")
 	signal(os.Kill)
 }
 

test/presubmit-tests.sh

@@ -23,8 +23,6 @@
 
 set -Eeuo pipefail
 
-export REPO_NAME=hack
-
 source "$(dirname "${BASH_SOURCE[0]:-$0}")/../presubmit-tests.sh"
 
 # Run our custom build tests after the standard build tests.
@@ -38,19 +36,6 @@ function post_build_tests() {
   return ${failed}
 }
 
-# Run our custom unit tests after the standard unit tests.
-
-function post_unit_tests() {
-  local failed=0
-  for test in ./test/unit/*-tests.sh; do
-    subheader "Running tests in ${test}"
-    ${test} || { failed=$?; echo "--- FAIL: ${test}"; }
-    if (( failed )); then
-      return ${failed}
-    fi
-  done
-}
-
 # We use the default integration test runner.
 
 main "$@"

test/unit/.gitignore

@@ -0,0 +1 @@
+unittest-*.bash

test/unit/e2e_helpers_test.go

@@ -0,0 +1,34 @@
+package unit_test
+
+import "testing"
+
+func TestE2eHelpers(t *testing.T) {
+	t.Parallel()
+	sc := newShellScript(loadFile(
+		"fake-prow-job.bash",
+		"source-e2e-tests.bash",
+		"smoke-test-custom-flag.bash",
+		"fake-dumps.bash",
+	))
+	tcs := []testCase{{
+		name:   `initialize --smoke-test-custom-flag`,
+		stdout: lines(">> All tests passed"),
+	}, {
+		name: `fail_test`,
+		commands: []string{
+			`initialize --run-test true`,
+			`fail_test`,
+		},
+		stderr:  aborted("test failed"),
+		retcode: retcode(111),
+		stdout: []check{
+			contains(">> DUMPING THE CLUSTER STATE"),
+			contains(">> STARTING KUBE PROXY"),
+			contains(">> GRABBING K8S METRICS"),
+		},
+	}}
+	for _, tc := range tcs {
+		tc := tc
+		t.Run(tc.name, tc.test(sc))
+	}
+}