Merge pull request #183 from DannyBen/add/approvals

Add approvals.bash testing library

Author: DannyBen

lib/bashly/commands/add.rb

@@ -9,6 +9,7 @@ class Add < Base
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
       usage "bashly add validations [--force]"
+      usage "bashly add test [--force]"
       usage "bashly add comp FORMAT [OUTPUT --force]"
       usage "bashly add (-h|--help)"
 
@@ -23,6 +24,7 @@ class Add < Base
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
       command "yaml", "Add standard functions for reading YAML files to the lib directory."
       command "validations", "Add argument validation functions to the lib directory."
+      command "test", "Add approval testing."
       command "comp", "Generate a bash completions script or function."
 
       example "bashly add strings --force"
@@ -55,6 +57,10 @@ def validations_command
         add_lib 'validations'
       end
 
+      def test_command
+        add_lib 'test'
+      end
+
       def comp_command
         format = args['FORMAT']
         output = args['OUTPUT']

lib/bashly/libraries.yml

@@ -23,6 +23,21 @@ strings:
     - source: "templates/strings.yml"
       target: "%{user_source_dir}/bashly-strings.yml"
 
+test:
+  files:
+    - source: "templates/test/approvals.bash"
+      target: "%{user_target_dir}/test/approvals.bash"
+    - source: "templates/test/approve"
+      target: "%{user_target_dir}/test/approve"
+
+  post_install_message: |
+    Edit your tests in !txtgrn!test/approve!txtrst! and then run:
+
+      !txtpur!$ ./test/approve!txtrst!"
+
+    Docs: !undblu!https://github.com/DannyBen/approvals.bash
+
+
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"

lib/bashly/library.rb

@@ -57,7 +57,10 @@ def config
     end
 
     def target_file_args
-      { user_source_dir: Settings.source_dir }
+      {
+        user_source_dir: Settings.source_dir,
+        user_target_dir: Settings.target_dir
+      }
     end
   end
 end

lib/bashly/templates/test/approvals.bash

@@ -0,0 +1,93 @@
+# approvals.bash v0.2.7
+#
+# Interactive approval testing for Bash.
+# https://github.com/DannyBen/approvals.bash
+approve() {
+  local expected approval approval_file actual cmd
+  approvals_dir=${APPROVALS_DIR:=approvals}
+  
+  cmd=$1
+  actual=$(eval "$cmd" 2>&1)  
+  last_exit_code=$?
+  approval=$(printf "%b" "$cmd" | tr -s -c "[:alnum:]" _)
+  approval_file="$approvals_dir/${2:-"$approval"}"
+
+  [[ -d "$approvals_dir" ]] || mkdir "$approvals_dir"
+
+  if [[ -f "$approval_file" ]]; then
+    expected=$(cat "$approval_file")
+  else
+    echo "--- [$(blue "new: $cmd")] ---"
+    printf "%b\n" "$actual"
+    echo "--- [$(blue "new: $cmd")] ---"
+    expected="$actual"
+    user_approval "$cmd" "$actual" "$approval_file"
+    return
+  fi
+
+  if [[ "$(printf "%b" "$actual")" = "$(printf "%b" "$expected")" ]]; then
+    green "PASS $cmd"
+  else
+    echo "--- [$(blue "diff: $cmd")] ---"
+    $diff_cmd <(printf "%b" "$expected\n") <(printf "%b" "$actual\n" )  | tail -n +4
+    echo "--- [$(blue "diff: $cmd")] ---"
+    user_approval "$cmd" "$actual" "$approval_file"
+  fi
+}
+
+describe() {
+  cyan "TEST $*"
+}
+
+fail() {
+  red "FAIL $*"
+  exit 1
+}
+
+pass() {
+  green "PASS $*"
+  return 0
+}
+
+expect_exit_code() {
+  if [[ $last_exit_code == "$1" ]]; then
+    pass "exit $last_exit_code"
+  else
+    fail "Expected exit code $1, got $last_exit_code"
+  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" "$*"; }
+magenta() { printf "\e[35m%b\e[0m\n" "$*"; }
+cyan() { printf "\e[36m%b\e[0m\n" "$*"; }
+
+# Private
+
+user_approval() {
+  local cmd="$1"
+  local actual="$2"
+  local approval_file="$3"
+
+  if [[ -v CI || -v GITHUB_ACTIONS ]]; then
+    fail "$cmd"
+  fi
+
+  echo 
+  printf "[A]pprove? \n"
+  response=$(bash -c "read -n 1 key; echo \$key")
+  printf "\r"
+  if [[ $response =~ [Aa] ]]; then
+    printf "%b\n" "$actual" > "$approval_file"
+    pass "$cmd"
+  else
+    fail "$cmd"
+  fi
+}
+
+if diff --help | grep -- --color > /dev/null 2>&1; then
+  diff_cmd="diff --unified --color=always"
+else
+  diff_cmd="diff --unified"
+fi

lib/bashly/templates/test/approve

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+# Run this from the root directory
+
+cd ./test || exit
+source approvals.bash
+PATH="$PATH:../"
+
+# Update me
+cli=download
+
+# Tests
+describe "root command"
+  approve "$cli"
+  approve "$cli --help"
+
+describe "some other command"
+  approve "$cli other"
+  approve "$cli other --help"
+
+# ...more tests...

spec/approvals/cli/add/help

@@ -7,6 +7,7 @@ Usage:
   bashly add colors [--force]
   bashly add yaml [--force]
   bashly add validations [--force]
+  bashly add test [--force]
   bashly add comp FORMAT [OUTPUT --force]
   bashly add (-h|--help)
 
@@ -32,6 +33,9 @@ Commands:
   validations
     Add argument validation functions to the lib directory.
 
+  test
+    Add approval testing.
+
   comp
     Generate a bash completions script or function.
 

spec/approvals/cli/add/test

@@ -0,0 +1,9 @@
+created spec/tmp/test/approvals.bash
+created spec/tmp/test/approve
+
+Edit your tests in test/approve and then run:
+
+  $ ./test/approve"
+
+Docs: https://github.com/DannyBen/approvals.bash
+

spec/approvals/cli/generate/usage

@@ -5,5 +5,6 @@ Usage:
   bashly add colors [--force]
   bashly add yaml [--force]
   bashly add validations [--force]
+  bashly add test [--force]
   bashly add comp FORMAT [OUTPUT --force]
   bashly add (-h|--help)

spec/approvals/library/config-keys

@@ -4,6 +4,7 @@
 - yaml
 - lib
 - strings
+- test
 - validations
 - completions
 - completions_script

spec/bashly/commands/add_spec.rb

@@ -99,6 +99,20 @@
     end
   end
 
+  context "with test command" do
+    let(:lib_file) { "#{target_dir}/test/approvals.bash" }
+
+    before do
+      reset_tmp_dir create_src: true
+    end
+
+    it "copies the test folder to the user space" do
+      expect { subject.run %w[add test] }.to output_approval('cli/add/test')
+      expect(File).to exist(lib_file)
+    end
+  end
+
+
   context "with colors command" do
     let(:lib_file) { "#{source_dir}/lib/colors.sh" }