feat: Add integration tests for tmux plugin

Author: mandos

bin/t

@@ -35,7 +35,13 @@ fi
 if ! tmux info &>/dev/null; then
   TMP_SESSION_DIR=$(mktemp -d)
   TMP_SESSION_NAME=$(session_name --full-path "$TMP_SESSION_DIR")
-  tmux new-session -d -s "$TMP_SESSION_NAME" -c "$TMP_SESSION_DIR"
+  # Allow for custom tmux config (mostly for testing)
+  if [ -n "$TMUX_CONFIG" ]; then
+    tmux -f "$TMUX_CONFIG" new-session -d -s "$TMP_SESSION_NAME" -c "$TMP_SESSION_DIR"
+  else
+    tmux new-session -d -s "$TMP_SESSION_NAME" -c "$TMP_SESSION_DIR"
+  fi
+
 fi
 
 # Get or create session
@@ -79,7 +85,11 @@ fi
 # https://github.com/tmux/tmux/blob/master/cmd-find.c#L1024C51-L1024C57
 SESSION=$(echo "$SESSION" | sed 's/^~$/\\~/')
 if [ -z "$TMUX" ]; then
-  tmux attach -t "$SESSION"
+  if [ -n "$INTEGRATION_TEST" ]; then
+    echo "Running integrtion test, so not attaching to tmux session"
+  else
+    tmux attach -t "$SESSION"
+  fi
 else
   tmux switch-client -t "$SESSION"
 fi

scripts/run-tests.sh

@@ -4,33 +4,45 @@
 
 PROJECT_ROOT="$(dirname "$(dirname "$(realpath "$0")")")"
 IMAGE="tmux-session-wizard:dev"
+FILTER=""
 
-while getopts "crwh" opt; do
+while getopts "crwhui" opt; do
   case $opt in
-    c) CONTAINER=true
-      ;;
-    r) REBUILD=true
-      ;;
-    w) WATCH=true
-      ;;
-    h)
-      echo "Usage: run-tests.sh"
-      echo "Run tests for the project"
-      echo "  -c  Run tests inside a container (image: ${IMAGE})"
-      echo "  -r  Rebuild the container image before running tests, set also -c opiton by default"
-      echo "  -w  Watch changes in project and then run tests"
-      echo "  -h  Display this help message"
-      exit 0
-      ;;
-    \?)
-      echo "Invalid option: -$OPTARG" >&2
-      exit 1
-      ;;
+  c)
+    CONTAINER=true
+    ;;
+  r)
+    REBUILD=true
+    ;;
+  w)
+    WATCH=true
+    ;;
+  u)
+    FILTER="$FILTER --filter-tags unit"
+    ;;
+  i)
+    FILTER="$FILTER --filter-tags integration"
+    ;;
+  h)
+    echo "Usage: run-tests.sh"
+    echo "Run tests for the project"
+    echo "  -c  Run tests inside a container (image: ${IMAGE})"
+    echo "  -r  Rebuild the container image before running tests, set also -c opiton by default"
+    echo "  -w  Watch changes in project and then run tests"
+    echo "  -u  Run only unit tests"
+    echo "  -i  Run only integration tests"
+    echo "  -h  Display this help message"
+    exit 0
+    ;;
+  \?)
+    echo "Invalid option: -$OPTARG" >&2
+    exit 1
+    ;;
   esac
 done
 
 # Basic command to run tests
-CMD=(bats "$PROJECT_ROOT/tests")
+CMD=(bats $FILTER --recursive "$PROJECT_ROOT/tests")
 
 # Run tests in watch mode
 if [ "$WATCH" = true ]; then
@@ -43,13 +55,12 @@ if [ "$CONTAINER" = true ] || [ "$REBUILD" = true ]; then
   IS_IMAGE_EXISTS=$(docker images -q ${IMAGE})
 fi
 
-if [ -z "$IS_IMAGE_EXISTS" ] &&  [ "$CONTAINER" = true ] || [ "$REBUILD" = true ] ; then
+if [ -z "$IS_IMAGE_EXISTS" ] && [ "$CONTAINER" = true ] || [ "$REBUILD" = true ]; then
   docker build -t ${IMAGE} -f "$PROJECT_ROOT/Dockerfile" "$PROJECT_ROOT"
 fi
 
 echo "----------------------------------------------------------------------------"
+echo "Filter: $FILTER"
 echo "Running tests with command: ${CMD[*]}"
 echo "----------------------------------------------------------------------------"
 "${CMD[@]}"
-
-

session-wizard.tmux

@@ -10,6 +10,12 @@ default_height=40
 tmux_option_session_wizard_width="@session-wizard-width"
 default_width=80
 
+set_default_session_wizard_options() {
+  set_tmux_option "@session-wizard" "T"
+  set_tmux_option "@session-wizard-height" "40"
+  set_tmux_option "@session-wizard-width" "80"
+}
+
 # Multiple bindings can be set. Default binding is "T".
 set_session_wizard_options() {
   local key_bindings
@@ -25,6 +31,7 @@ set_session_wizard_options() {
 }
 
 function main {
+  set_default_session_wizard_options
   set_session_wizard_options
 }
 main

src/helpers.sh

@@ -15,6 +15,17 @@ get_tmux_option() {
   fi
 }
 
+# Prevents overriding user's options
+set_tmux_option() {
+  local option="$1"
+  local default_value="$2"
+  local option_value
+  option_value=$(tmux show-option -gqv "$option")
+  if [ -z "$option_value" ]; then
+    tmux set-option -g "$option" "$default_value"
+  fi
+}
+
 session_name() {
   if [ "$1" = "--directory" ]; then
     shift

tests/helpers.bats

@@ -1,3 +1,4 @@
+# bats file_tags=unit
 setup() {
   bats_load_library 'bats-support'
   bats_load_library 'bats-assert'
@@ -48,4 +49,3 @@ unset() {
   run session_name --short-path "$TEST_PATH"
   assert_output "/mo/-f/-moo-foo-bar-baz"
 }
-

tests/integration/tmux.bats

@@ -0,0 +1,60 @@
+# bats file_tags=integration
+_stop_tmux() {
+  run pgrep tmux
+  if [ "$status" -eq 0 ]; then
+    tmux kill-server
+  fi
+}
+
+_add_tmux_plugin() {
+  export _ZO_DATA_DIR=/tmp/zoxite
+  DIR="$(cd "$(dirname "$BATS_TEST_FILENAME")" >/dev/null 2>&1 && pwd)"
+  echo "run-shell $DIR/../../session-wizard.tmux" >/tmp/tmux.conf
+  export TMUX_CONFIG=/tmp/tmux.conf
+}
+
+setup() {
+  bats_require_minimum_version 1.5.0
+  bats_load_library 'bats-support'
+  bats_load_library 'bats-assert'
+
+  DIR="$(cd "$(dirname "$BATS_TEST_FILENAME")" >/dev/null 2>&1 && pwd)"
+  PATH="$DIR/../../bin:$PATH"
+
+  if [ -n "$TMUX" ]; then
+    fail "Plase run these tests outisde of tmux"
+  fi
+  export INTEGRATION_TEST=true
+  _stop_tmux
+  _add_tmux_plugin
+}
+
+assert_tmux_running() {
+  run pgrep tmux
+  assert_success
+}
+
+teardown() {
+  _stop_tmux
+  rm -rf /tmp/zoxite
+  rm -rf /tmp/tmux.conf
+}
+
+@test "Can run 't' with loaded plugin" {
+  t .
+  assert_tmux_running
+  # Checking default key binding for session wizard plugin
+  option=$(tmux show-option -gqv @session-wizard)
+  assert_equal "$option" "T"
+}
+
+@test "Can overwrite default options" {
+  echo "set-option -g @session-wizard 't'" >>/tmp/tmux.conf
+  t .
+  assert_tmux_running
+  # Checking default key binding for session wizard plugin
+  option=$(tmux show-option -gqv @session-wizard-width)
+  assert_equal "$option" "80"
+  option=$(tmux show-option -gqv @session-wizard)
+  assert_equal "$option" "t"
+}