From 5a954c00c15a7ad8092b3db1d4af4ff304204fc5 Mon Sep 17 00:00:00 2001
From: Yoriyasu Yano <430092+yorinasub17@users.noreply.github.com>
Date: Wed, 3 Mar 2021 12:39:41 -0600
Subject: [PATCH] Expose ref parameter in fetch (#60)

* Regression test for ref param

* Expose ref parameter from fetch
---
 gruntwork-install        | 19 +++++++++++++------
 test/integration-test.sh |  8 +++++++-
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/gruntwork-install b/gruntwork-install
index d3e3d66..7b9c0f4 100755
--- a/gruntwork-install
+++ b/gruntwork-install
@@ -38,7 +38,8 @@ function print_usage {
   echo -e "  --download-dir\tThe directory to which the module will be downloaded and from which it will be installed. Default: $DEFAULT_MODULES_DOWNLOAD_DIR"
   echo -e "  --binary-install-dir\tThe directory to which the binary will be installed. Only applies to binaries (not modules). Default: $DEFAULT_BIN_DIR"
   echo -e "  --no-sudo\t\tWhen true, don't use sudo to install the binary into the install directory. Only applies to binaries (not modules). Default: false"
-  echo -e "  --branch\t\tDownload the latest commit from this branch in --repo. This is an alternative to --tag, used only for testing."
+  echo -e "  --branch\t\tDownload the latest commit from this branch in --repo. Does not work with installing binaries (--binary-name). This is an alternative to --tag, used only for testing."
+  echo -e "  --ref\t\tDownload the specific Git ref (branch, tag, or commit SHA) in --repo. Does not work with installing binaries (--binary-name). This is an alternative to --tag and --branch, used only for testing."
   echo -e "  --help\t\tShow this help text and exit."
 
   echo
@@ -47,7 +48,7 @@ function print_usage {
   echo "  gruntwork-install \\"
   echo "    --module-name 'fail2ban' \\"
   echo "    --repo 'https://github.com/gruntwork-io/terraform-aws-security' \\"
-  echo "    --tag 'v0.44.9'"  
+  echo "    --tag 'v0.44.9'"
   echo
 }
 
@@ -123,8 +124,9 @@ function fetch_script_module {
   local -r module_name="$1"
   local -r tag="$2"
   local -r branch="$3"
-  local -r download_dir="$4"
-  local -r repo="$5"
+  local -r ref="$4"
+  local -r download_dir="$5"
+  local -r repo="$6"
 
   # We want to make sure that all folders down to $download_path/$module_name exists, but that $download_path/$module_name itself is empty.
   mkdir -p "$download_dir/$module_name/"
@@ -133,7 +135,7 @@ function fetch_script_module {
   # Note that fetch can safely handle blank arguments for --tag or --branch
   # If both --tag and --branch are specified, --branch will be used
   log_info "Downloading module $module_name from $repo"
-  fetch --repo="$repo" --tag="$tag" --branch="$branch" --source-path="/modules/$module_name" "$download_dir/$module_name"
+  fetch --ref="$ref" --repo="$repo" --tag="$tag" --branch="$branch" --source-path="/modules/$module_name" "$download_dir/$module_name"
 }
 
 # Download a binary asset from a GitHub release using fetch (https://github.com/gruntwork-io/fetch)
@@ -256,6 +258,7 @@ function run_module {
 function install_script_module {
   local tag=""
   local branch=""
+  local ref=""
   local module_name=""
   local binary_name=""
   local binary_sha256_checksum=""
@@ -278,6 +281,10 @@ function install_script_module {
         branch="$2"
         shift
         ;;
+      --ref)
+        ref="$2"
+        shift
+        ;;
       --module-name)
         module_name="$2"
         shift
@@ -355,7 +362,7 @@ function install_script_module {
 
   if [[ -n "$module_name" ]]; then
     log_info "Installing from $module_name..."
-    fetch_script_module "$module_name" "$tag" "$branch" "$download_dir" "$repo"
+    fetch_script_module "$module_name" "$tag" "$branch" "$ref" "$download_dir" "$repo"
     validate_module "$module_name" "$download_dir" "$tag" "$branch" "$repo"
     run_module "$module_name" "$download_dir" "$tag" "$branch" "${module_params[@]}"
   else
diff --git a/test/integration-test.sh b/test/integration-test.sh
index e072e68..3c1fd71 100755
--- a/test/integration-test.sh
+++ b/test/integration-test.sh
@@ -10,7 +10,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 echo "Using local copy of bootstrap installer to install local copy of gruntwork-install"
 ./src/bootstrap-gruntwork-installer.sh --download-url "$LOCAL_INSTALL_URL" --version "ignored-for-local-install"
 
-echo "Using gruntwork-install to install a module from the module-ecs repo"
+echo "Using gruntwork-install to install a module from the module-ecs repo using branch"
 gruntwork-install --module-name "ecs-scripts" --repo "https://github.com/gruntwork-io/module-ecs" --branch "v0.0.1"
 
 echo "Using gruntwork-install to install a module from the module-ecs repo with --download-dir option"
@@ -22,6 +22,12 @@ configure-ecs-instance --help
 echo "Using gruntwork-install to install a module from the gruntwork-install repo and passing args to it via --module-param"
 gruntwork-install --module-name "dummy-module" --repo "https://github.com/gruntwork-io/gruntwork-installer" --tag "v0.0.25" --module-param "file-to-cat=$SCRIPT_DIR/integration-test.sh"
 
+echo "Using gruntwork-install to install a module from the gruntwork-install repo with branch as ref"
+gruntwork-install --module-name "dummy-module" --repo "https://github.com/gruntwork-io/gruntwork-installer" --ref "for-testing-dont-delete" --module-param "file-to-cat=$SCRIPT_DIR/integration-test.sh"
+
+echo "Using gruntwork-install to install a module from the gruntwork-install repo with tag as ref"
+gruntwork-install --module-name "dummy-module" --repo "https://github.com/gruntwork-io/gruntwork-installer" --ref "v0.0.25" --module-param "file-to-cat=$SCRIPT_DIR/integration-test.sh"
+
 echo "Using gruntwork-install to install a test module from the gruntwork-install repo and test that it's args are maintained via --module-param"
 gruntwork-install --module-name "args-test" --repo "https://github.com/gruntwork-io/gruntwork-installer" --tag "v0.0.25" --module-param 'test-args=1 2 3 *'