Add SSH validation functions and update framework configuration

Author: François Chastanet

.bash-compiler

@@ -1 +1,2 @@
 FRAMEWORK_ROOT_DIR=${ROOT_DIR}
+TEMPLATES_ROOT_DIR=${HOME}/fchastanet/bash-compiler/examples/templates

src/Assert/symLinkValid.bats

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# shellcheck source=src/batsHeaders.sh
+source "$(cd "${BATS_TEST_DIRNAME}/.." && pwd)/batsHeaders.sh"
+
+# shellcheck source=/src//Assert/symLinkValid.sh
+source "${srcDir}/Assert/symLinkValid.sh"
+
+teardown() {
+  unstub_all
+  rm -f "${BATS_TEST_TMPDIR}/myFile" "${BATS_TEST_TMPDIR}/link" || true
+}
+
+function Assert::symLinkValid::notExists { #@test
+  run Assert::symLinkValid "fileNotFound"
+  assert_failure 1
+  assert_lines_count 2
+  assert_line --index 0 --partial "INFO    - Check fileNotFound is a valid symlink"
+  assert_line --index 1 --partial "ERROR   - fileNotFound is not existing"
+}
+
+function Assert::symLinkValid::notALink { #@test
+  local file="${BATS_TEST_TMPDIR}/myFile"
+  touch "${file}"
+  run Assert::symLinkValid "${file}"
+  assert_failure 2
+  assert_lines_count 2
+  assert_line --index 0 --partial "INFO    - Check ${BATS_TEST_TMPDIR}/myFile is a valid symlink"
+  assert_line --index 1 --partial "ERROR   - ${BATS_TEST_TMPDIR}/myFile exists but is not a link"
+}
+
+function Assert::symLinkValid::brokenLink { #@test
+  local file="${BATS_TEST_TMPDIR}/myFile"
+  touch "${file}"
+  ln -sf "${file}" "${BATS_TEST_TMPDIR}/link"
+  rm "${file}"
+  run Assert::symLinkValid "${BATS_TEST_TMPDIR}/link"
+  assert_failure 3
+  assert_lines_count 2
+  assert_line --index 0 --partial "INFO    - Check ${BATS_TEST_TMPDIR}/link is a valid symlink"
+  assert_line --index 1 --partial "ERROR   - Broken link ${BATS_TEST_TMPDIR}/link"
+}
+
+function Assert::symLinkValid::valid { #@test
+  local file="${BATS_TEST_TMPDIR}/myFile"
+  touch "${file}"
+  ln -sf "${file}" "${BATS_TEST_TMPDIR}/link"
+  run Assert::symLinkValid "${BATS_TEST_TMPDIR}/link"
+  assert_success
+  assert_lines_count 1
+  assert_line --index 0 --partial "INFO    - Check ${BATS_TEST_TMPDIR}/link is a valid symlink"
+}

src/Assert/symLinkValid.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+# @description asserts that first argument is link to a file
+# that exists
+# @arg $1 link:String expected link
+# @env SUDO String allows to use custom sudo prefix command
+# @exitcode 1 if missing link
+# @exitcode 2 if not a link
+# @exitcode 3 if broken link (missing linked file)
+# @stderr diagnostics information is displayed
+Assert::symLinkValid() {
+  local link="$1"
+  Log::displayInfo "Check ${link} is a valid symlink"
+  if ! ${SUDO:-} test -L "${link}" &>/dev/null; then
+    if ! ${SUDO:-} test -e "${link}" &>/dev/null; then
+      Log::displayError "${link} is not existing"
+      exit 1
+    fi
+    Log::displayError "${link} exists but is not a link"
+    return 2
+  fi
+  if ! ${SUDO:-} test -e "$(readlink "${link}")" &>/dev/null; then
+    Log::displayError "Broken link ${link}"
+    return 3
+  fi
+}

src/Ssh/checkAccess.bats

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+# shellcheck source=src/batsHeaders.sh
+source "$(cd "${BATS_TEST_DIRNAME}/.." && pwd)/batsHeaders.sh"
+# shellcheck source=src/Ssh/checkAccess.sh
+source "${srcDir}/Ssh/checkAccess.sh"
+
+setup() {
+  export HOME="${BATS_TEST_TMPDIR}"
+  mkdir -p "${BATS_TEST_TMPDIR}/.ssh"
+}
+
+teardown() {
+  unstub_all
+}
+
+function Ssh::checkAccess::missingHost { #@test
+  run Ssh::checkAccess
+
+  assert_failure 2
+  assert_output --partial "ERROR   - You must provide a host as first argument"
+}
+
+function Ssh::checkAccess::sshFailure { #@test
+  stub ssh '-q -o PubkeyAuthentication=yes -o PasswordAuthentication=no -o KbdInteractiveAuthentication=no -o ChallengeResponseAuthentication=no host exit : exit 1'
+  run Ssh::checkAccess "host"
+
+  assert_failure 1
+  assert_output --partial "INFO    - Checking host can be accessed non interactively using ssh"
+}
+
+function Ssh::checkAccess::hostOnlySshSuccess { #@test
+  stub ssh '-q -o PubkeyAuthentication=yes -o PasswordAuthentication=no -o KbdInteractiveAuthentication=no -o ChallengeResponseAuthentication=no host exit : exit 0'
+  run Ssh::checkAccess "host"
+
+  assert_success
+  assert_output --partial "INFO    - Checking host can be accessed non interactively using ssh"
+}
+
+function Ssh::checkAccess::MultipleArgsSshSuccess { #@test
+  stub ssh '-q -o PubkeyAuthentication=yes -o PasswordAuthentication=no -o KbdInteractiveAuthentication=no -o ChallengeResponseAuthentication=no host arg1 arg2 exit : exit 0'
+  run Ssh::checkAccess "host" arg1 arg2
+
+  assert_success
+  assert_output --partial "INFO    - Checking host can be accessed non interactively using ssh"
+}

src/Ssh/checkAccess.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# @description check if host can accessed using ssh private key
+# without requiring interactivity
+# @arg $1 host:String the host to join
+# @arg $@ args:String[] other parameters to pass to the ssh command
+# @exitcode 1 if ssh fails
+# @exitcode 2 if missing host argument
+# @require Ssh::requireSshCommand
+Ssh::checkAccess() {
+  local host="$1"
+  shift 1 || true
+  if [[ -z "${host}" ]]; then
+    Log::displayError "You must provide a host as first argument"
+    exit 2
+  fi
+  Log::displayInfo "Checking ${host} can be accessed non interactively using ssh"
+  ssh \
+    -q \
+    -o PubkeyAuthentication=yes \
+    -o PasswordAuthentication=no \
+    -o KbdInteractiveAuthentication=no \
+    -o ChallengeResponseAuthentication=no \
+    "${host}" "$@" exit
+}

src/Ssh/requireSshCommand.bats

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC2154
+# shellcheck disable=SC2034
+
+# shellcheck source=src/batsHeaders.sh
+source "$(cd "${BATS_TEST_DIRNAME}/.." && pwd)/batsHeaders.sh"
+# shellcheck source=src/Ssh/requireSshCommand.sh
+source "${srcDir}/Ssh/requireSshCommand.sh"
+
+function Ssh::requireSshCommand::failure { #@test
+  function Assert::commandExists() {
+    return 1
+  }
+
+  run Ssh::requireSshCommand
+
+  assert_failure 1
+  assert_output ""
+}
+
+function Ssh::requireSshCommand::success { #@test
+  function Assert::commandExists() {
+    return 0
+  }
+
+  run Ssh::requireSshCommand
+
+  assert_success
+  assert_output ""
+}

src/Ssh/requireSshCommand.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# @description ensure command ssh is available
+# @exitcode 1 if ssh command not available
+# @stderr diagnostics information is displayed
+Ssh::requireSshCommand() {
+  Assert::commandExists ssh
+}

src/_binaries/commandDefinitions/frameworkConfig.yaml

@@ -10,7 +10,7 @@ compilerConfig: &defaultFrameworkConfig
     - ${FRAMEWORK_ROOT_DIR}/src
   binDir: ${FRAMEWORK_ROOT_DIR}/bin
   templateDirs:
-    - ${COMPILER_ROOT_DIR}/examples/templates
+    - ${TEMPLATES_ROOT_DIR}
   templateFile: binFile.gtpl
   relativeRootDirBasedOnTargetDir: ..