refactor: unit/assert_snapshot_test more

Author: Chemaclass

src/assert_snapshot.sh

@@ -1,108 +1,88 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2155
 
 function snapshot::match_with_placeholder() {
   local actual="$1"
   local snapshot="$2"
   local placeholder="${BASHUNIT_SNAPSHOT_PLACEHOLDER:-::ignore::}"
   local token="__BASHUNIT_IGNORE__"
 
-  local sanitized_snapshot="${snapshot//$placeholder/$token}"
-  local regex
-  regex=$(printf '%s' "$sanitized_snapshot" | sed -e 's/[.[\\^$*+?{}()|]/\\&/g')
-  regex="${regex//$token/(.|\\n)*}"
-  regex="^${regex}$"
-
-  if command -v perl >/dev/null 2>&1; then
-    if REGEX="$regex" perl -0 -e 'my $r=$ENV{REGEX}; exit((join("",<>)) =~ /$r/s ? 0 : 1);' <<< "$actual"; then
-      return 0
-    else
-      return 1
-    fi
+  local sanitized="${snapshot//$placeholder/$token}"
+  local escaped=$(printf '%s' "$sanitized" | sed -e 's/[.[\\^$*+?{}()|]/\\&/g')
+  local regex="^${escaped//$token/(.|\\n)*}$"
+
+  if which perl >/dev/null 2>&1; then
+    echo "$actual" | REGEX="$regex" perl -0 -e '
+      my $r = $ENV{REGEX};
+      my $input = join("", <STDIN>);
+      exit($input =~ /$r/s ? 0 : 1);
+    ' && return 0 || return 1
   else
-    # fallback: only supports single-line ignores
-    local fallback_pattern
-    fallback_pattern=$(printf '%s' "$snapshot" | sed "s|$placeholder|.*|g")
-    # escape other special regex chars
-    fallback_pattern=$(printf '%s' "$fallback_pattern" | sed -e 's/[][\.^$*+?{}|()]/\\&/g')
-    fallback_pattern="^${fallback_pattern}$"
-
-    if printf '%s\n' "$actual" | grep -Eq "$fallback_pattern"; then
-      return 0
-    else
-      return 1
-    fi
+    local fallback=$(printf '%s' "$snapshot" | sed -e "s|$placeholder|.*|g" -e 's/[][\.^$*+?{}|()]/\\&/g')
+    fallback="^${fallback}$"
+    echo "$actual" | grep -Eq "$fallback" && return 0 || return 1
   fi
 }
 
-# shellcheck disable=SC2155
 function assert_match_snapshot() {
-  local actual
-  actual=$(echo -n "$1" | tr -d '\r')
-  local snapshot_file="${2-}"
-
-  if [[ -z "$snapshot_file" ]]; then
-    local directory="./$(dirname "${BASH_SOURCE[1]}")/snapshots"
-    local test_file="$(helper::normalize_variable_name "$(basename "${BASH_SOURCE[1]}")")"
-    local snapshot_name="$(helper::normalize_variable_name "${FUNCNAME[1]}").snapshot"
-    snapshot_file="${directory}/${test_file}.${snapshot_name}"
-  fi
+  local actual=$(echo -n "$1" | tr -d '\r')
+  local snapshot_file=$(_resolve_snapshot_file "${2:-}" "${FUNCNAME[1]}")
 
   if [[ ! -f "$snapshot_file" ]]; then
-    mkdir -p "$(dirname "$snapshot_file")"
-    echo "$actual" > "$snapshot_file"
-
-    state::add_assertions_snapshot
+    _initialize_snapshot "$snapshot_file" "$actual"
     return
   fi
 
-  local snapshot
-  snapshot=$(tr -d '\r' < "$snapshot_file")
-
-  if ! snapshot::match_with_placeholder "$actual" "$snapshot"; then
-    local label
-    label=$(helper::normalize_test_function_name "${FUNCNAME[1]}")
+  _compare_snapshot "$actual" "$snapshot_file" "${FUNCNAME[1]}"
+}
 
-    state::add_assertions_failed
-    console_results::print_failed_snapshot_test "$label" "$snapshot_file"
+function assert_match_snapshot_ignore_colors() {
+  local actual=$(echo -n "$1" | sed 's/\x1B\[[0-9;]*[mK]//g' | tr -d '\r')
+  local snapshot_file=$(_resolve_snapshot_file "${2:-}" "${FUNCNAME[1]}")
 
+  if [[ ! -f "$snapshot_file" ]]; then
+    _initialize_snapshot "$snapshot_file" "$actual"
     return
   fi
 
-  state::add_assertions_passed
+  _compare_snapshot "$actual" "$snapshot_file" "${FUNCNAME[1]}"
 }
 
-# shellcheck disable=SC2155
-function assert_match_snapshot_ignore_colors() {
-  local actual
-  actual=$(echo -n "$1" | sed -r 's/\x1B\[[0-9;]*[mK]//g' | tr -d '\r')
-
-  local snapshot_file="${2-}"
-  if [[ -z "$snapshot_file" ]]; then
-    local directory="./$(dirname "${BASH_SOURCE[1]}")/snapshots"
-    local test_file="$(helper::normalize_variable_name "$(basename "${BASH_SOURCE[1]}")")"
-    local snapshot_name="$(helper::normalize_variable_name "${FUNCNAME[1]}").snapshot"
-    snapshot_file="${directory}/${test_file}.${snapshot_name}"
+function _resolve_snapshot_file() {
+  local file_hint="$1"
+  local func_name="$2"
+
+  if [[ -n "$file_hint" ]]; then
+    echo "$file_hint"
+  else
+    local dir="./$(dirname "${BASH_SOURCE[2]}")/snapshots"
+    local test_file="$(helper::normalize_variable_name "$(basename "${BASH_SOURCE[2]}")")"
+    local name="$(helper::normalize_variable_name "$func_name").snapshot"
+    echo "${dir}/${test_file}.${name}"
   fi
+}
 
-  if [[ ! -f "$snapshot_file" ]]; then
-    mkdir -p "$(dirname "$snapshot_file")"
-    echo "$actual" > "$snapshot_file"
+function _initialize_snapshot() {
+  local path="$1"
+  local content="$2"
+  mkdir -p "$(dirname "$path")"
+  echo "$content" > "$path"
+  state::add_assertions_snapshot
+}
 
-    state::add_assertions_snapshot
-    return
-  fi
+function _compare_snapshot() {
+  local actual="$1"
+  local snapshot_path="$2"
+  local func_name="$3"
 
   local snapshot
-  snapshot=$(tr -d '\r' < "$snapshot_file")
+  snapshot=$(tr -d '\r' < "$snapshot_path")
 
   if ! snapshot::match_with_placeholder "$actual" "$snapshot"; then
-    local label
-    label=$(helper::normalize_test_function_name "${FUNCNAME[1]}")
-
+    local label=$(helper::normalize_test_function_name "$func_name")
     state::add_assertions_failed
-    console_results::print_failed_snapshot_test "$label" "$snapshot_file"
-
-    return
+    console_results::print_failed_snapshot_test "$label" "$snapshot_path"
+    return 1
   fi
 
   state::add_assertions_passed