From d4b184a7d5ff6c19e0a5f6dbcfe4b07d3a7b7f4e Mon Sep 17 00:00:00 2001
From: Ryan Richard <richardry@vmware.com>
Date: Fri, 21 Aug 2020 16:15:48 -0700
Subject: [PATCH] Allow aliases for the first argument of module.sh

- Makes it easier to guess/remember what are the legal arguments
- Also update the output a little to make it easier to tell
  when the command has succeeded
- And run tests using `-count 1` because cached test results are not
  very trustworthy
---
 hack/module.sh | 56 ++++++++++++++++++++++++++++----------------------
 1 file changed, 32 insertions(+), 24 deletions(-)

diff --git a/hack/module.sh b/hack/module.sh
index f51eef06..43ea49c8 100755
--- a/hack/module.sh
+++ b/hack/module.sh
@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
+
 set -euo pipefail
-ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
 
 function tidy_cmd() {
   echo 'go mod tidy -v'
@@ -21,7 +23,7 @@ function test_cmd() {
   else
     cmd='go test'
   fi
-  echo "${cmd} -race ./..."
+  echo "${cmd} -count 1 -race ./..."
 }
 
 function unittest_cmd() {
@@ -30,7 +32,7 @@ function unittest_cmd() {
   else
     cmd='go test'
   fi
-  echo "${cmd} -short -race ./..."
+  echo "${cmd} -count 1 -short -race ./..."
 }
 
 function codegen_cmd() {
@@ -41,21 +43,11 @@ function codegen_verify_cmd() {
   echo "${ROOT}/hack/lib/codegen.sh codegen::verify"
 }
 
-# The race detector is slow, so sometimes you don't want to use it
-function unittest_no_race_cmd() {
-  if [ -x "$(command -v gotest)" ]; then
-    cmd='gotest'
-  else
-    cmd='go test'
-  fi
-  echo "${cmd} -short ./..."
-}
-
 function with_modules() {
   local cmd_function="${1}"
   cmd="$(${cmd_function})"
 
-  pushd "${ROOT}"
+  pushd "${ROOT}" >/dev/null
   for mod_file in $(find . -maxdepth 4 -name go.mod | sort); do
     mod_dir="$(dirname "${mod_file}")"
     (
@@ -64,26 +56,42 @@ function with_modules() {
       cd "${mod_dir}" && ${cmd}
     )
   done
-  popd
+  popd >/dev/null
 }
 
 function usage() {
   echo "Error: <task> must be specified"
-  echo "       do.sh <task> [tidy, lint, test, unittest, unittest_no_race, codegen, codegen_verify]"
+  echo "       module.sh <task> [tidy, lint, test, unittest, codegen, codegen_verify]"
   exit 1
 }
 
 function main() {
   case "${1:-invalid}" in
-    'tidy') with_modules 'tidy_cmd' ;;
-    'lint') with_modules 'lint_cmd' ;;
-    'test') with_modules 'test_cmd' ;;
-    'unittest') with_modules 'unittest_cmd' ;;
-    'unittest_no_race') with_modules 'unittest_no_race_cmd' ;;
-    'codegen') with_modules 'codegen_cmd' ;;
-    'codegen_verify') with_modules 'codegen_verify_cmd' ;;
-    *) usage ;;
+  'tidy')
+    with_modules 'tidy_cmd'
+    ;;
+  'lint' | 'linter' | 'linters')
+    with_modules 'lint_cmd'
+    ;;
+  'test' | 'tests')
+    with_modules 'test_cmd'
+    ;;
+  'unittest' | 'unittests' | 'units' | 'unit')
+    with_modules 'unittest_cmd'
+    ;;
+  'codegen' | 'codegens')
+    with_modules 'codegen_cmd'
+    ;;
+  'codegen_verify' | 'verify_codegen')
+    with_modules 'codegen_verify_cmd'
+    ;;
+  *)
+    usage
+    ;;
   esac
+
+  echo "=> "
+  echo "   \"module.sh $1\" Finished successfully."
 }
 
 main "$@"