Merge pull request #5 from egurapha/unittests

Setting up Automated Unit Testing

.github/workflows/code_formatting.yml

@@ -1,6 +1,9 @@
 name: Code Formatting
 
 on:
+  push:
+    branches:
+      - main
   pull_request:
     branches:
       - main
@@ -10,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
+      - name: Checkout.
         uses: actions/checkout@v4
 
       - name: Install shfmt.

.github/workflows/unit_testing.yml

@@ -0,0 +1,34 @@
+name: Unit Testing
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  unit-testing:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout.
+        uses: actions/checkout@v4
+
+      - name: Set TERM environment variable
+        run: echo "TERM=xterm-256color" >> $GITHUB_ENV
+
+      - name: Install BATS.
+        run: sudo apt update && sudo apt install -y bats
+
+      - name: Run Unit Tests.
+        run: script -q -c "bats tests/"
+
+      - name: Success.
+        if: success()
+        run: echo "Unit Testing Passed."
+
+      - name: Failure.
+        if: failure()
+        run: echo "Unit Testing Failed."

README.md

@@ -10,8 +10,10 @@
 Shunpo is a minimalist bash tool that tries to make directory navigation in terminal just a little bit faster by providing a simple system to manage bookmarks and jump to directories with only a few keystrokes.
 If you frequently need to use commands like `cd`, `pushd`, or `popd`, Shunpo is for you.  
 
-![Powered by 🍵](https://img.shields.io/badge/Powered%20by-%F0%9F%8D%B5-green)  [![Ko-fi](https://img.shields.io/badge/Ko--fi-Buy%20me%20Tea-ff5f5f?logo=kofi&style=flat-square)](https://ko-fi.com/egurapha)
-![shfmt](https://github.com/egurapha/Shunpo/actions/workflows/code_formatting.yml/badge.svg)  
+![Powered by 🍵](https://img.shields.io/badge/Powered%20by-%F0%9F%8D%B5-blue?style=flat-square)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-Buy%20me%20Tea-ff5f5f?logo=kofi&style=flat-square)](https://ko-fi.com/egurapha)
+![Code Formatting](https://img.shields.io/badge/Code%20Formatting-Passing-green?style=flat-square)
+![Unit Tests](https://img.shields.io/badge/Unit%20Tests-Passing-green?style=flat-square)
 
 Requirements
 ----

install.sh

@@ -13,23 +13,22 @@ setup() {
     touch $SHUNPORC
 }
 
-add_aliases() {
-    aliases=(
-        "sj:source $(realpath $INSTALL_DIR/jump_to_parent.sh)"
-        "sd:source $(realpath $INSTALL_DIR/jump_to_child.sh)"
-        "sb:$(realpath $INSTALL_DIR/add_bookmark.sh)"
-        "sr:$(realpath $INSTALL_DIR/remove_bookmark.sh)"
-        "sg:source $(realpath $INSTALL_DIR/go_to_bookmark.sh)"
-        "sl:$(realpath $INSTALL_DIR/list_bookmarks.sh)"
-        "sc:$(realpath $INSTALL_DIR/clear_bookmarks.sh)"
+add_commands() {
+    INSTALL_DIR="$(realpath "$INSTALL_DIR")"
+
+    functions=(
+        "sj() { source \"$INSTALL_DIR/jump_to_parent.sh\"; }"
+        "sd() { source \"$INSTALL_DIR/jump_to_child.sh\"; }"
+        "sb() { \"$INSTALL_DIR/add_bookmark.sh\" \"\$@\"; }"
+        "sr() { \"$INSTALL_DIR/remove_bookmark.sh\" \"\$@\"; }"
+        "sg() { source \"$INSTALL_DIR/go_to_bookmark.sh\"; }"
+        "sl() { \"$INSTALL_DIR/list_bookmarks.sh\"; }"
+        "sc() { \"$INSTALL_DIR/clear_bookmarks.sh\"; }"
     )
-    for alias_pair in "${aliases[@]}"; do
-        alias_name="${alias_pair%%:*}"
-        alias_command="${alias_pair#*:}"
-        alias_line="alias $alias_name='$alias_command'"
 
-        echo "$alias_line" >>"$SHUNPORC"
-        echo "Added: $alias_line"
+    for func_definition in "${functions[@]}"; do
+        echo "$func_definition" >>"$SHUNPORC"
+        echo "Created Command: ${func_definition%%()*}"
     done
 }
 
@@ -42,17 +41,17 @@ install() {
     sed '/^source.*\.shunporc/d' "$BASHRC" >"$temp_file"
     mv "$temp_file" "$BASHRC"
     echo "$source_rc_line" >>"$BASHRC"
-    echo "Added: $source_rc_line"
+    echo "Added to BASHRC: $source_rc_line"
 
     # record SHUNPO_DIR for uninstallation.
     install_dir_line="export SHUNPO_DIR=$INSTALL_DIR" >>"$BASHRC$"
     temp_file=$(mktemp)
     grep -v '^export SHUNPO_DIR=' "$BASHRC" >"$temp_file"
     mv "$temp_file" "$BASHRC"
     echo "$install_dir_line" >>"$BASHRC"
-    echo "Added: $install_dir_line"
+    echo "Added to BASHRC: $install_dir_line"
 
-    add_aliases
+    add_commands
 }
 
 # Install.

src/jump_to_parent.sh

@@ -19,7 +19,13 @@ trap 'handle_kill; return 1' SIGINT
 jump_to_parent_dir $1
 
 # Handle case where bookmark is not set.
-if [ $? -eq 2 ]; then
+if [ $? -eq 1 ]; then
+
+    if declare -f cleanup >/dev/null; then
+        cleanup
+    fi
+    return 1
+elif [ $? -eq 2 ]; then
     if declare -f cleanup >/dev/null; then
         cleanup
     fi

tests/bats/Notes.md

@@ -0,0 +1,3 @@
+Files in this folder were copied from:
+https://github.com/ztombol/bats-assert
+https://github.com/ztombol/bats-support