Bash interactive approval testing (MOVED to https://github.com/DannyBen/approvals.bash)

approvals.bash

# Interactive approval testing for Bash.
# Author: Danny Ben Shitrit (https://github.com/dannyben)
#
# This utility will compare the output of a command with an expected output
# stored in the approvals folder.
# 
# - When the approval file does not exist, the actual output will be shown to
#   you, and you will be prompted to approve (and save) it.
# - When the approval file exists, but contains different data, the diff will
#   be shown to you, and you will be prompted to approve (and save) it.
# - When the approval file exists and contains matching data, the approval
#   test will pass.
# - When a new/updated approval is rejected, we will exit immediately with
#   exit code 1
# - When running in a CI environment (CI variable exists), we will run in non
#   interactive mode (so tests will fail automatically if they do not match).
#
# Usage
#   source approvals.bash
#   approve <command> [<approval file name>]
#
# Exapmple
#   approve "ls -la"
#   approve "ls -la" "ls"
#
approve() {
  local expected approval approval_file actual cmd
  
  cmd=$1
  actual=$(eval "$cmd" 2>&1)  
  approval=$(printf "%b" "$cmd" | tr -s -c "[:alnum:]" _)
  approval_file="approvals/${2:-"$approval"}"

  [[ -d "approvals" ]] || mkdir approvals

  if [[ -f "$approval_file" ]]; then
    expected=$(cat "$approval_file")
  else
    echo "--- [$(blue "$cmd")] ---"
    printf "%b\n" "$actual"
    echo "--- [$(blue "$cmd")] ---"
    expected="$actual"
    user_approval "$cmd" "$actual" "$approval_file"
  fi

  if [[ "$(printf "%b" "$actual")" = "$(printf "%b" "$expected")" ]]; then
    green "\rPASS $cmd"
  else
    echo "--- [$(blue "$cmd")] ---"
    diff --unified --color=always <(printf "%b" "$expected\n") <(printf "%b" "$actual\n" )  | tail -n +4
    echo "--- [$(blue "$cmd")] ---"
    user_approval "$cmd" "$actual" "$approval_file"
  fi
}

user_approval() {
  local cmd="$1"
  local actual="$2"
  local approval_file="$3"

  if [[ -v CI ]]; then
    red "\rFAIL $cmd"
    exit 1
  fi

  echo 
  printf "[A]pprove? \n"
  read -r -n 1 response
  if [[ $response =~ [Aa] ]]; then
    printf "%b\n" "$actual" > "$approval_file"
    green "\rPASS $cmd"
  else
    red "\rFAIL $cmd"
    exit 1
  fi
}

red() { printf "\e[31m%b\e[0m\n" "$*"; }
green() { printf "\e[32m%b\e[0m\n" "$*"; }
blue() { printf "\e[34m%b\e[0m\n" "$*"; }