Merge pull request #18 from buildkite-plugins/sup-4558-add-env-var

Add  BUILDKITE_GIT_FETCH_FLAGS (SUP-4558)

Author: pzeballos

hooks/checkout

@@ -42,13 +42,23 @@ if [[ ! -d .git ]]; then
 fi
 
 git clean -ffxdq
-# fetch branch if commit is HEAD
+
+FETCH_FLAGS=()
+if [[ -n "${BUILDKITE_GIT_FETCH_FLAGS:-}" ]]; then
+    # Use read -a to split the flags safely and shellcheck-compliantly
+    read -r -a FETCH_FLAGS <<< "${BUILDKITE_GIT_FETCH_FLAGS}"
+fi
+
+FETCH_FLAGS+=(--depth 1 origin)
+
 if [[ ${BUILDKITE_COMMIT} = "HEAD" ]]; then
-    git fetch --depth 1 origin "${BUILDKITE_BRANCH}"
+    FETCH_FLAGS+=( "${BUILDKITE_BRANCH}" )
 else
-    git fetch --depth 1 origin "${BUILDKITE_COMMIT}"
+    FETCH_FLAGS+=( "${BUILDKITE_COMMIT}" )
 fi
 
+git fetch "${FETCH_FLAGS[@]}"
+
 git sparse-checkout set ${NO_CONE_PARAM:+--no-cone} "${CHECKOUT_PATHS[@]}"
 if [[ ${BUILDKITE_COMMIT} = "HEAD" ]]; then
    git checkout FETCH_HEAD

tests/checkout.bats

@@ -80,3 +80,23 @@ setup() {
 
   unstub git
 }
+
+@test "Respects BUILDKITE_GIT_FETCH_FLAGS in git fetch" {
+  export BUILDKITE_GIT_FETCH_FLAGS="--prune --verbose"
+  export BUILDKITE_COMMIT="HEAD"
+  export BUILDKITE_BRANCH="main"
+
+  stub ssh-keyscan "* : echo 'keyscan'"
+  stub git "clean * : echo 'git clean'"
+  stub git "fetch --prune --verbose --depth 1 origin * : echo 'git fetch with flags'"
+  stub git "sparse-checkout set * * : echo 'git sparse-checkout'"
+  stub git "checkout * : echo 'checkout'"
+
+  run "$PWD"/hooks/checkout
+
+  assert_success
+  assert_output --partial 'git fetch with flags'
+
+  unstub ssh-keyscan
+  unstub git
+}