Migrate unit tests to use Go workspace

Introduce the new functions: run_go_tests and
run_go_test_expanding_packages, which implements (without Shellcheck
exceptions) the old behavior from go_test, simplifying the arguments
received.

Replaced the three possible values mode with:

1. keep_going: By using the KEEP_GOING_TESTS environment variable. This
   mode expanded the relative modules; it can be run by using
   run_go_tests_expanding_packages.
2. parallel: It worked without expanding the relative modules with the
   absolute modules. Therefore, this mode can be run directly using
   run_go_tests.
3. fail_fast: By adding an argument "-failfast", and not setting the
   KEEP_GOING_TESTS environment variable.

The argument flags_for_package_func can be replaced by regular arguments
passed to the function.

These two changes simplify the complexity of the go test wrapper
function and allow further customization in the callers.

The JUnit XML generation works the same way, by reading the
JUNIT_REPORT_DIR or ARTIFACTS environment variable. It generates the
same reports.

Temporarily introduce the get_junit_filename_prefix function, as a
replacement for junitFilenamePrefix. The latter will be removed once all
test targets are using the new functions.

Finally, update the unit tests function to make use of the new
functions, and allow running the tests by using the workspace (i.e.,
there's no need to change directories anymore).

Signed-off-by: Ivan Valdes <ivan@vald.es>

Author: ivanvc

scripts/test.sh

@@ -126,15 +126,15 @@ function build_pass {
 ################# REGULAR TESTS ################################################
 
 # run_unit_tests [pkgs] runs unit tests for a current module and givesn set of [pkgs]
-function run_unit_tests {
-  local pkgs="${1:-./...}"
-  shift 1
-  # shellcheck disable=SC2068 #For context see - https://github.com/etcd-io/etcd/pull/16433#issuecomment-1684312755
-  GOLANG_TEST_SHORT=true go_test "${pkgs}" "parallel" : -short -timeout="${TIMEOUT:-3m}" ${COMMON_TEST_FLAGS[@]:-} ${RUN_ARG[@]:-} "$@"
-}
-
 function unit_pass {
-  run_for_modules run_unit_tests "$@"
+  KEEP_GOING_TESTS=true \
+    run_for_all_workspace_modules \
+    run_go_tests \
+    -short \
+    -timeout="${TIMEOUT:-3m}" \
+    "${COMMON_TEST_FLAGS[@]}" \
+    "${RUN_ARG[@]}" \
+    "$@"
 }
 
 function integration_extra {

scripts/test_lib.sh

@@ -206,6 +206,16 @@ function run_for_modules {
   fi
 }
 
+function get_junit_filename_prefix {
+  local junit_report_dir="$1"
+  if [[ -z "${junit_report_dir}" ]]; then
+    echo ""
+    return
+  fi
+
+  mktemp "${junit_report_dir}/junit_XXXXXXXXXX"
+}
+
 junitFilenamePrefix() {
   if [[ -z "${JUNIT_REPORT_DIR:-}" ]]; then
     echo ""
@@ -335,6 +345,96 @@ function go_test {
   fi
 }
 
+# run_go_tests_expanding_packages [arguments to pass to go test]
+# Expands the packages in the list of arguments, i.e. ./... into a list of
+# packages for that given module. Then, it calls run_go_tests with the expanded
+# packages.
+function run_go_tests_expanding_packages {
+  local packages=()
+  local args=()
+  for arg in "$@"; do
+    if [[ "${arg}" =~ ./ ]]; then
+      packages+=("${arg}")
+    else
+      args+=("${arg}")
+    fi
+  done
+
+  # Expanding patterns (like ./...) into list of packages
+  local unpacked_packages=()
+  while IFS='' read -r line; do unpacked_packages+=("$line"); done < <(
+    go list "${packages[@]}"
+  )
+
+  run_go_tests "${unpacked_packages[@]}" "${args[@]}"
+}
+
+# run_go_test [arguments to pass to go test]
+# The following environment variables affect how the tests run:
+#   - KEEP_GOING_TESTS: If set to true it will keep executing tests even after
+#                       a failure. It collects all failures and reports them at
+#                       the end, if there are failures the return code is 2.
+#                       Defaults to false.
+#   - JUNIT_REPORT_DIR/ARTIFACTS: Enables collecting JUnit XML reports.
+#   - VERBOSE: Sets a verbose output.
+#
+# Example:
+#   KEEP_GOING_TESTS=true run_go_tests "./..." --short
+#
+# The function returns != 0 code in case of test failure.
+function run_go_tests {
+  local go_test_flags=()
+
+  local packages=()
+  local args=()
+  for arg in "$@"; do
+    if [[ "${arg}" =~ ^\./ || "${arg}" =~ ^go\.etcd\.io/etcd ]]; then
+      packages+=("${arg}")
+    else
+      args+=("${arg}")
+    fi
+  done
+
+  local keep_going=${KEEP_GOING_TESTS:-false}
+
+  # If JUNIT_REPORT_DIR is unset, and ARTIFACTS is set, then have them match.
+  local junit_report_dir=${JUNIT_REPORT_DIR:-${ARTIFACTS:-}}
+
+  local go_test_grep_pattern=".*"
+  if [[ -n "${junit_report_dir}" ]]; then
+    # Show only summary lines by matching lines like "status package/test"
+    go_test_grep_pattern="^[^[:space:]]\+[[:space:]]\+[^[:space:]]\+/[^[[:space:]]\+"
+  fi
+
+  if [[ -n "${junit_report_dir}" || "${VERBOSE:-}" == "1" ]]; then
+    go_test_flags+=("-v" "-json")
+  fi
+
+  local failures=()
+  # execution of tests against packages:
+  for pkg in "${packages[@]}"; do
+    local cmd=(go test "${go_test_flags[@]}" "${pkg}" "${args[@]}")
+
+    local junit_filename_prefix
+    junit_filename_prefix=$(get_junit_filename_prefix "${junit_report_dir}")
+
+    if ! run env ETCD_VERIFY="${ETCD_VERIFY}" "${cmd[@]}" | tee ${junit_filename_prefix:+"${junit_filename_prefix}.stdout"} | grep --binary-files=text "${go_test_grep_pattern}" ; then
+      if [ "${keep_going}" = "false" ]; then
+        produce_junit_xmlreport "${junit_filename_prefix}"
+        return 2
+      else
+        failures+=("${pkg}")
+      fi
+    fi
+    produce_junit_xmlreport "${junit_filename_prefix}"
+  done
+
+  if [ -n "${failures[*]}" ]; then
+    log_error -e "FAIL: Tests for following packages failed:\\n  ${failures[*]}"
+    return 2
+  fi
+}
+
 #### Other ####
 
 # tool_exists [tool] [instruction]