Merge pull request #7 from first-aml/main

Add additional option to skip ssh-keyscan, update README

Author: mcncl

README.md

@@ -20,6 +20,10 @@ Paths accepted by `git sparse-checkout set`.
 
 Whether to pass `--no-cone` to `git sparse-checkout` so that the paths are considered to be a list of patterns.
 
+#### `skip_ssh_keyscan` ('true' or 'false')
+
+Whether to skip ssh-keyscan step. This will skip adding each ssh public key into the known-hosts file. Only use if ssh keys are already setup.
+
 ## Example
 
 Below is an example for using sparse-checkout plugin.

hooks/checkout

@@ -18,9 +18,15 @@ else
     exit 1
 fi
 
-echo "Scanning SSH keys for remote git repository"
-[[ -d ~/.ssh ]] || mkdir -p ~/.ssh
-ssh-keyscan "${BUILDKITE_REPO_SSH_HOST}" >> ~/.ssh/known_hosts
+SKIP_SSH_KEYSCAN_OPTION="$(plugin_read_config SKIP_SSH_KEYSCAN "false")"
+
+if [ "$SKIP_SSH_KEYSCAN_OPTION" = "false" ]; then
+    echo "Scanning SSH keys for remote git repository"
+    [[ -d ~/.ssh ]] || mkdir -p ~/.ssh
+    ssh-keyscan "${BUILDKITE_REPO_SSH_HOST}" >> ~/.ssh/known_hosts
+else
+    echo "Skipped SSH keyscan"
+fi
 
 echo "Creating sparse-checkout with paths: ${CHECKOUT_PATHS[*]}"
 

plugin.yml

@@ -10,6 +10,9 @@ configuration:
     no_cone:
       type: boolean
       default: false
+    skip_ssh_keyscan:
+      type: boolean
+      default: false
   required:
     - paths
   additionalProperties: false

tests/checkout.bats

@@ -0,0 +1,47 @@
+#!/usr/bin/env bats
+
+setup() {
+  load "${BATS_PLUGIN_PATH}/load.bash"
+
+  # Uncomment to enable stub debugging
+  # export CURL_STUB_DEBUG=/dev/tty
+
+  # you can set variables common to all tests here
+  export BUILDKITE_PLUGIN_SPARSE_CHECKOUT_PATHS="default_path"
+  export BUILDKITE_REPO_SSH_HOST="default_host"
+  export BUILDKITE_COMMIT="dummy-commit-hash"
+}
+
+@test "Skip ssh-keyscan when option provided" {
+  export BUILDKITE_PLUGIN_SPARSE_CHECKOUT_SKIP_SSH_KEYSCAN='true'
+
+  stub git "clean \* : echo 'git clean'"
+  stub git "fetch --depth 1 origin \* : echo 'git fetch'"
+  stub git "sparse-checkout set \* \* : echo 'git sparse-checkout'" 
+  stub git "checkout \* : echo 'checkout'"
+
+  run "$PWD"/hooks/checkout
+
+  assert_success
+  assert_output --partial 'Skipped SSH keyscan'
+
+  unstub git
+}
+
+@test "Run ssh-keyscan when no option provided" {
+  unset BUILDKITE_PLUGIN_SPARSE_CHECKOUT_SKIP_SSH_KEYSCAN
+  
+  stub ssh-keyscan "\* : echo 'keyscan'"
+  stub git "clean \* : echo 'git clean'"
+  stub git "fetch --depth 1 origin \* : echo 'git fetch'"
+  stub git "sparse-checkout set \* \* : echo 'git sparse-checkout'" 
+  stub git "checkout \* : echo 'checkout'"
+
+  run "$PWD"/hooks/checkout
+
+  assert_success
+  assert_output --partial 'Scanning SSH keys for remote git repository'
+  
+  unstub git
+  unstub ssh-keyscan
+}