Merge pull request #20 from HS-Teams/codex/add-tests-for-hhs-shell-utils

Add Bats coverage for shell utilities

Author: yorevs

tests/hhs-shell-utils.bats

@@ -0,0 +1,306 @@
+#!/usr/bin/env bats
+
+#  Script: hhs-shell-utils.bats
+# Purpose: __hhs_shell-utils tests.
+# Created: Apr 09, 2025
+#  Author: OpenAI ChatGPT (gpt-5-codex)
+# License: Please refer to <https://opensource.org/licenses/MIT>
+#
+# Copyright (c) 2025, HomeSetup team
+
+load test_helper
+load "${HHS_FUNCTIONS_DIR}/hhs-text.bash"
+load "${HHS_FUNCTIONS_DIR}/hhs-shell-utils.bash"
+load_bats_libs
+
+setup() {
+  export HHS_SHOPTS_FILE="${BATS_TEST_TMPDIR}/shopt-state.toml"
+  : >"${HHS_SHOPTS_FILE}"
+
+  HHS_HISTORY_OUTPUT=$' 1  placeholder\n'
+  HHS_TPUT_COLS=80
+
+  unset HHS_HAS_git HHS_HAS_brew HHS_HAS_seq HHS_HAS_jot HHS_HAS_tldr
+  HHS_HAS_git=1
+  HHS_HAS_brew=1
+  HHS_HAS_seq=0
+  HHS_HAS_jot=1
+  HHS_HAS_tldr=1
+
+  declare -gA HHS_SHOPT_STATES=()
+  HHS_SHOPT_STATES=(
+    [cdspell]='off'
+    [globstar]='on'
+    [histappend]='on'
+  )
+
+  HHS_TOML_SET_WRITES=()
+  HHS_MSELECT_STATUS=0
+  HHS_MSELECT_CHOICE=""
+  HHS_CHSH_STATUS=0
+  HHS_CHSH_CALL=""
+  HHS_CLEAR_CALLED=0
+  HHS_GREP_SHELLS_OUTPUT=""
+
+  HHS_DU_LISTING=""
+  HHS_DU_TOTAL=""
+
+  GIT_IS_REPO=1
+  GIT_REMOTE_OUTPUT=""
+  GIT_LOG_OUTPUT=""
+  GIT_BRANCH_OUTPUT=""
+  GIT_DIFF_OUTPUT=""
+}
+
+teardown() {
+  unset HHS_HAS_git HHS_HAS_brew HHS_HAS_seq HHS_HAS_jot HHS_HAS_tldr
+}
+
+__hhs_highlight() {
+  cat
+}
+
+__hhs_has() {
+  local cmd="$1"
+  local var="HHS_HAS_${cmd//[^a-zA-Z0-9]/_}"
+  local override="${!var}"
+  if [[ -n "${override}" ]]; then
+    return "${override}"
+  fi
+  command -v "${cmd}" >/dev/null 2>&1
+}
+
+history() {
+  printf "%s" "${HHS_HISTORY_OUTPUT}"
+}
+
+tput() {
+  if [[ "$1" == "cols" ]]; then
+    echo "${HHS_TPUT_COLS}"
+    return 0
+  fi
+  echo 0
+}
+
+clear() {
+  HHS_CLEAR_CALLED=1
+}
+
+chsh() {
+  HHS_CHSH_CALL="$*"
+  return "${HHS_CHSH_STATUS}"
+}
+
+__hhs_mselect() {
+  local outfile="$1"
+  shift 2
+  if [[ "${HHS_MSELECT_STATUS}" -eq 0 && -n "${HHS_MSELECT_CHOICE}" ]]; then
+    printf "%s\n" "${HHS_MSELECT_CHOICE}" >"${outfile}"
+  fi
+  return "${HHS_MSELECT_STATUS}"
+}
+
+grep() {
+  if [[ "$#" -eq 2 && "$1" == '/.*' && "$2" == '/etc/shells' ]]; then
+    if [[ -n "${HHS_GREP_SHELLS_OUTPUT}" ]]; then
+      printf "%s\n" "${HHS_GREP_SHELLS_OUTPUT}"
+    else
+      printf "%s\n" "/bin/bash" "/bin/sh"
+    fi
+    return 0
+  fi
+  command grep "$@"
+}
+
+shopt() {
+  if [[ $# -eq 0 ]]; then
+    for opt in $(printf "%s\n" "${!HHS_SHOPT_STATES[@]}" | sort); do
+      printf "%s    %s\n" "${opt}" "${HHS_SHOPT_STATES[${opt}]}"
+    done
+    return 0
+  fi
+
+  case "$1" in
+    -s)
+      local opt="$2"
+      HHS_SHOPT_STATES["${opt}"]='on'
+      return 0
+      ;;
+    -u)
+      local opt="$2"
+      HHS_SHOPT_STATES["${opt}"]='off'
+      return 0
+      ;;
+    -q)
+      local opt="$2"
+      [[ "${HHS_SHOPT_STATES[${opt}]}" == 'on' ]]
+      return $?
+      ;;
+    -o)
+      printf "errexit        off\n"
+      return 0
+      ;;
+    -p)
+      for opt in $(printf "%s\n" "${!HHS_SHOPT_STATES[@]}" | sort); do
+        printf "%s  %s\n" "${opt}" "${HHS_SHOPT_STATES[${opt}]}"
+      done
+      return 0
+      ;;
+    *)
+      local opt="$1"
+      printf "%s    %s\n" "${opt}" "${HHS_SHOPT_STATES[${opt}]:-off}"
+      return 0
+      ;;
+  esac
+}
+
+__hhs_toml_set() {
+  local file="$1"
+  local kv="$2"
+  printf "%s\n" "${kv}" >"${file}"
+  HHS_TOML_SET_WRITES+=("${kv}")
+  return 0
+}
+
+__hhs() {
+  printf "__hhs %s\n" "$*"
+}
+
+__hhs_about() {
+  printf "__hhs_about %s\n" "$*"
+}
+
+__hhs_errcho() {
+  printf "%s: %s\n" "$1" "$2" >&2
+}
+
+python() {
+  printf "Python 3.11.0\n"
+}
+
+git() {
+  if [[ "$1" == 'rev-parse' && "$2" == '--is-inside-work-tree' ]]; then
+    return "${GIT_IS_REPO}"
+  elif [[ "$1" == 'remote' && "$2" == '-v' ]]; then
+    printf "%s\n" "${GIT_REMOTE_OUTPUT}"
+    return 0
+  elif [[ "$1" == 'log' && "$2" == '--oneline' ]]; then
+    printf "%s\n" "${GIT_LOG_OUTPUT}"
+    return 0
+  elif [[ "$1" == 'rev-parse' && "$2" == '--abbrev-ref' ]]; then
+    printf "%s\n" "${GIT_BRANCH_OUTPUT}"
+    return 0
+  elif [[ "$1" == 'diff' && "$2" == '--shortstat' ]]; then
+    [[ -n "${GIT_DIFF_OUTPUT}" ]] && printf "%s\n" "${GIT_DIFF_OUTPUT}"
+    return 0
+  fi
+  return 0
+}
+
+du() {
+  if [[ "$1" == '-hk' ]]; then
+    printf "%s" "${HHS_DU_LISTING}"
+    return 0
+  elif [[ "$1" == '-hc' ]]; then
+    printf "%s" "${HHS_DU_TOTAL}"
+    return 0
+  fi
+  command du "$@"
+}
+
+# -- Tests -----------------------------------------------------------------
+
+@test "__hhs_history prints usage when called with help" {
+  run __hhs_history -h
+  assert_failure
+  assert_output --partial "usage: __hhs_history [regex_filter]"
+}
+
+@test "__hhs_history collapses duplicates while keeping latest entries" {
+  HHS_HISTORY_OUTPUT=$' 1  ls\n 2  git status\n 3  ls\n 4  git commit\n'
+  run __hhs_history
+  assert_success
+  assert_line --index 1 --regexp '^ +2 +git status$'
+  assert_line --index 2 --regexp '^ +3 +ls$'
+  assert_line --index 3 --regexp '^ +4 +git commit$'
+}
+
+@test "__hhs_hist_stats renders aggregate counts and bar chart" {
+  HHS_HISTORY_OUTPUT=$' 1  2024-01-01 10:00:00 - 0 ls\n 2  2024-01-01 10:05:00 - 0 git status\n 3  2024-01-01 10:06:00 - 0 ls\n 4  2024-01-01 10:07:00 - 0 git commit\n 5  2024-01-01 10:08:00 - 0 ls\n'
+  HHS_TPUT_COLS=72
+  run __hhs_hist_stats 2
+  assert_success
+  assert_output --partial "Top 2 used commands in history"
+  assert_output --partial "ls"
+  assert_output --partial "git"
+  assert_output --partial "|▄"
+}
+
+@test "__hhs_where_am_i delegates to __hhs help when command is available" {
+  HHS_HAS_sample=0
+  HHS_HAS_tldr=1
+  run __hhs_where_am_i sample
+  assert_success
+  assert_line --index 0 "__hhs help sample"
+}
+
+@test "__hhs_where_am_i prints repository context" {
+  HHS_HAS_git=0
+  GIT_IS_REPO=0
+  GIT_REMOTE_OUTPUT=$'origin git@example.com:repo.git (fetch)'
+  GIT_LOG_OUTPUT=$'abc123 Fix bug'
+  GIT_BRANCH_OUTPUT=$'main'
+  GIT_DIFF_OUTPUT=$' 1 file changed, 2 insertions(+)'
+  run __hhs_where_am_i
+  assert_success
+  assert_output --partial "-=- You are here -=-"
+  assert_output --partial "Remote repository:"
+  assert_output --partial "abc123"
+  assert_output --partial " main"
+  assert_output --partial "1 file changed"
+}
+
+@test "__hhs_shell_select changes default shell when selection succeeds" {
+  local fake_shell_dir
+  fake_shell_dir="${BATS_TEST_TMPDIR}/shells"
+  mkdir -p "${fake_shell_dir}"
+  local fake_shell="${fake_shell_dir}/fakeshell"
+  printf '#!/bin/sh\n' >"${fake_shell}"
+  chmod +x "${fake_shell}"
+
+  HHS_GREP_SHELLS_OUTPUT="${fake_shell}"
+  HHS_MSELECT_CHOICE="${fake_shell}"
+  HHS_CHSH_STATUS=0
+  HHS_HAS_brew=1
+
+  run __hhs_shell_select
+  assert_success
+  assert_output --partial "Your default shell has changed to => '${fake_shell}'"
+  [ "${HHS_CHSH_CALL}" = "-s ${fake_shell}" ]
+  [ "${HHS_CLEAR_CALLED}" -eq 1 ]
+}
+
+@test "__hhs_shopt persists toggled options" {
+  HHS_SHOPT_STATES[cdspell]='off'
+  run __hhs_shopt -s cdspell
+  assert_success
+  assert_output --partial "Shell option cdspell set to on"
+  run cat "${HHS_SHOPTS_FILE}"
+  assert_output "cdspell=on"
+  [ "${HHS_SHOPT_STATES[cdspell]}" = 'on' ]
+}
+
+@test "__hhs_du summarizes directory usage" {
+  local dir="${BATS_TEST_TMPDIR}/du-sample"
+  mkdir -p "${dir}"
+  HHS_DU_LISTING=$'4096\t./alpha\n2048\t./beta\n1024\t.\n'
+  HHS_DU_TOTAL=$'6.0M\ttotal\n'
+
+  run __hhs_du "${dir}" 2 20
+  assert_success
+  assert_output --partial "Top 2 disk usage"
+  assert_output --partial "alpha"
+  assert_output --partial "beta"
+  assert_output --partial "|▄"
+  assert_output --partial "Total: 6.0M"
+}