Merge pull request #452 from TypedDevs/fix/447-assert-snapshot

Fix broken core snapshot tests

Author: Chemaclass

.github/workflows/tests.yml

@@ -118,3 +118,17 @@ jobs:
       - name: Run Tests
         run: |
           ./bashunit --parallel tests/
+
+  nixos:
+    name: "NixOS"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Run Tests
+        run: |
+          docker run --rm -v "$(pwd)":/project -w /project nixos/nix:latest \
+            nix-shell -p bash --run "./bashunit --simple tests/"

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Unreleased
+
+- Fix broken core snapshot tests
+- Improve NixOS support
+
 ## [0.22.1](https://github.com/TypedDevs/bashunit/compare/0.22.0...0.22.1) - 2025-07-23
 
 - Fix prevents writing in src dir during tests

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__"
+function assert_match_snapshot() {
+  local actual=$(echo -n "$1" | tr -d '\r')
+  local snapshot_file=$(snapshot::resolve_file "${2:-}" "${FUNCNAME[1]}")
 
-  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
-  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
+  if [[ ! -f "$snapshot_file" ]]; then
+    snapshot::initialize "$snapshot_file" "$actual"
+    return
   fi
+
+  snapshot::compare "$actual" "$snapshot_file" "${FUNCNAME[1]}"
 }
 
-# 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
+function assert_match_snapshot_ignore_colors() {
+  local actual=$(echo -n "$1" | sed 's/\x1B\[[0-9;]*[mK]//g' | tr -d '\r')
+  local snapshot_file=$(snapshot::resolve_file "${2:-}" "${FUNCNAME[1]}")
 
   if [[ ! -f "$snapshot_file" ]]; then
-    mkdir -p "$(dirname "$snapshot_file")"
-    echo "$actual" > "$snapshot_file"
-
-    state::add_assertions_snapshot
+    snapshot::initialize "$snapshot_file" "$actual"
     return
   fi
 
-  local snapshot
-  snapshot=$(tr -d '\r' < "$snapshot_file")
+  snapshot::compare "$actual" "$snapshot_file" "${FUNCNAME[1]}"
+}
 
-  if ! snapshot::match_with_placeholder "$actual" "$snapshot"; then
-    local label
-    label=$(helper::normalize_test_function_name "${FUNCNAME[1]}")
+function snapshot::match_with_placeholder() {
+  local actual="$1"
+  local snapshot="$2"
+  local placeholder="${BASHUNIT_SNAPSHOT_PLACEHOLDER:-::ignore::}"
+  local token="__BASHUNIT_IGNORE__"
 
-    state::add_assertions_failed
-    console_results::print_failed_snapshot_test "$label" "$snapshot_file"
+  local sanitized="${snapshot//$placeholder/$token}"
+  local escaped=$(printf '%s' "$sanitized" | sed -e 's/[.[\\^$*+?{}()|]/\\&/g')
+  local regex="^${escaped//$token/(.|\\n)*}$"
 
-    return
+  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
+    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
-
-  state::add_assertions_passed
 }
 
-# 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 snapshot::resolve_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 snapshot::initialize() {
+  local path="$1"
+  local content="$2"
+  mkdir -p "$(dirname "$path")"
+  echo "$content" > "$path"
+  state::add_assertions_snapshot
+}
 
-    state::add_assertions_snapshot
-    return
-  fi
+function snapshot::compare() {
+  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

src/check_os.sh

@@ -11,6 +11,8 @@ function check_os::init() {
       _DISTRO="Ubuntu"
     elif check_os::is_alpine; then
       _DISTRO="Alpine"
+    elif check_os::is_nixos; then
+      _DISTRO="NixOS"
     else
       _DISTRO="Other"
     fi
@@ -32,6 +34,11 @@ function check_os::is_alpine() {
   command -v apk > /dev/null
 }
 
+function check_os::is_nixos() {
+  [[ -f /etc/NIXOS ]] && return 0
+  grep -q '^ID=nixos' /etc/os-release 2>/dev/null
+}
+
 function check_os::is_linux() {
   [[ "$(uname)" == "Linux" ]]
 }
@@ -71,3 +78,4 @@ export _DISTRO
 export -f check_os::is_alpine
 export -f check_os::is_busybox
 export -f check_os::is_ubuntu
+export -f check_os::is_nixos

tests/unit/assert_snapshot_test.sh

@@ -1,26 +1,25 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2155
 
 function set_up() {
   export BASHUNIT_SIMPLE_OUTPUT=false
+  unset BASHUNIT_SNAPSHOT_PLACEHOLDER
 }
 
 function test_successful_assert_match_snapshot() {
   assert_empty "$(assert_match_snapshot "Hello World!")"
 }
 
 function test_creates_a_snapshot() {
-  local snapshot_path=tests/unit/snapshots/assert_snapshot_test_sh.test_creates_a_snapshot.snapshot
+  local snapshot_path="$(temp_dir)/assert_snapshot_test_sh.test_creates_a_snapshot.snapshot"
   local expected=$((_ASSERTIONS_SNAPSHOT + 1))
 
-  assert_file_not_exists $snapshot_path
-
-  assert_match_snapshot "Expected snapshot"
+  assert_file_not_exists "$snapshot_path"
+  assert_match_snapshot "Expected snapshot" "$snapshot_path"
 
   assert_same "$expected" "$_ASSERTIONS_SNAPSHOT"
-  assert_file_exists $snapshot_path
-  assert_same "Expected snapshot" "$(cat $snapshot_path)"
-
-  rm $snapshot_path
+  assert_file_exists "$snapshot_path"
+  assert_same "Expected snapshot" "$(cat "$snapshot_path")"
 }
 
 function test_unsuccessful_assert_match_snapshot() {
@@ -35,34 +34,27 @@ function test_unsuccessful_assert_match_snapshot() {
     Expected to match the snapshot")"
   fi
 
-  local actual
-  actual="$(assert_match_snapshot "Expected snapshot")"
+  local actual="$(assert_match_snapshot "Expected snapshot")"
 
   assert_equals "$expected" "$actual"
 }
 
 function test_successful_assert_match_snapshot_ignore_colors() {
-  local colored
-  colored=$(printf '\e[31mHello\e[0m World!')
+  local colored=$(printf '\e[31mHello\e[0m World!')
   assert_empty "$(assert_match_snapshot_ignore_colors "$colored")"
 }
 
 function test_creates_a_snapshot_ignore_colors() {
-  local snapshot_path=tests/unit/snapshots/assert_snapshot_test_sh.test_creates_a_snapshot_ignore_colors.snapshot
+  local snapshot_path="$(temp_dir)/assert_snapshot_test_sh.test_creates_a_snapshot_ignore_colors.snapshot"
   local expected=$((_ASSERTIONS_SNAPSHOT + 1))
 
-  assert_file_not_exists $snapshot_path
-
-  local colored
-  colored=$(printf '\e[32mExpected\e[0m snapshot')
-
-  assert_match_snapshot_ignore_colors "$colored"
+  assert_file_not_exists "$snapshot_path"
+  local colored=$(printf '\e[32mExpected\e[0m snapshot')
+  assert_match_snapshot_ignore_colors "$colored" "$snapshot_path"
 
   assert_same "$expected" "$_ASSERTIONS_SNAPSHOT"
-  assert_file_exists $snapshot_path
-  assert_same "Expected snapshot" "$(cat $snapshot_path)"
-
-  rm $snapshot_path
+  assert_file_exists "$snapshot_path"
+  assert_same "Expected snapshot" "$(cat "$snapshot_path")"
 }
 
 function test_unsuccessful_assert_match_snapshot_ignore_colors() {
@@ -77,41 +69,31 @@ function test_unsuccessful_assert_match_snapshot_ignore_colors() {
     Expected to match the snapshot")"
   fi
 
-  local actual
-  local colored
-  colored=$(printf '\e[31mExpected snapshot\e[0m')
-  actual="$(assert_match_snapshot_ignore_colors "$colored")"
+  local colored=$(printf '\e[31mExpected snapshot\e[0m')
+  local actual="$(assert_match_snapshot_ignore_colors "$colored")"
 
   assert_equals "$expected" "$actual"
 }
 
 function test_assert_match_snapshot_with_placeholder() {
-  if check_os::is_alpine; then
-    skip "not supported on alpine" && return
+  if ! dependencies::has_perl; then
+    skip "perl not available" && return
   fi
 
-  local temp_dir
-  temp_dir=$(mktemp -d)
-  local snapshot_path="$temp_dir/assert_snapshot_test_sh.test_assert_match_snapshot_with_placeholder.snapshot"
+  local snapshot_path="$(temp_dir)/assert_snapshot_test_sh.test_assert_match_snapshot_with_placeholder.snapshot"
   echo 'Run at ::ignore::' > "$snapshot_path"
 
-  assert_empty "$(assert_match_snapshot "Run at $(date)" "$snapshot_path")"
-
-  rm -rf "$temp_dir"
+  assert_empty "$(assert_match_snapshot "Run at $(date -u '+%F %T UTC')" "$snapshot_path")"
 }
 
 function test_assert_match_snapshot_with_custom_placeholder() {
-  if check_os::is_alpine; then
-    skip "not supported on alpine" && return
+  if ! dependencies::has_perl; then
+    skip "perl not available" && return
   fi
 
-  local temp_dir
-  temp_dir=$(mktemp -d)
-  local snapshot_path="$temp_dir/assert_snapshot_test_sh.test_assert_match_snapshot_with_custom_placeholder.snapshot"
+  local snapshot_path="$(temp_dir)/assert_snapshot_test_sh.test_assert_match_snapshot_with_custom_placeholder.snapshot"
   echo 'Value __ANY__' > "$snapshot_path"
 
   export BASHUNIT_SNAPSHOT_PLACEHOLDER='__ANY__'
   assert_empty "$(assert_match_snapshot "Value 42" "$snapshot_path")"
-
-  rm -rf "$temp_dir"
 }