Merge pull request #443 from TypedDevs/feat/allow-init-with-dir

Support custom dir to --init

Author: Chemaclass

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## Unreleased
 
-- Add `--init` option to get you started quickly
+- Add `--init [dir]` option to get you started quickly
+    - Init with custom directory updates `.env` with `BASHUNIT_BOOTSTRAP`
 - Fix process time always shows as 0 ms
 - Fixed terminal width detection first tput and fall back stty
 - Refactor clock optimizing the implementation used to get the time

bashunit

@@ -103,7 +103,12 @@ while [[ $# -gt 0 ]]; do
       trap '' EXIT && exit 0
       ;;
     --init)
-      init::init
+      if [[ -n ${2:-} && ${2:0:1} != "-" ]]; then
+        init::project "$2"
+        shift
+      else
+        init::project
+      fi
       trap '' EXIT && exit 0
       ;;
     -h|--help)

docs/command-line.md

@@ -372,13 +372,15 @@ Upgrade **bashunit** to latest version.
 
 ## Init
 
-> `bashunit --init`
+> `bashunit --init [dir]`
 
-Generates a `tests` folder with a sample test and bootstrap file to get you started quickly.
+Generates a `tests` folder (or the provided `dir`) with a sample test and bootstrap file to get you started quickly.
+When a custom directory is used, bashunit writes `BASHUNIT_BOOTSTRAP=<dir>/bootstrap.sh` to a `.env` file. If `.env` already defines
+`BASHUNIT_BOOTSTRAP`, the existing line is commented out and the new value appended.
 
 ::: code-group
 ```bash [Example]
-./bashunit --init
+./bashunit --init tests
 ```
 ```bash [Output]
 > bashunit initialized in tests

src/console_header.sh

@@ -97,6 +97,10 @@ Options:
   --upgrade
     Upgrade to latest version of bashunit.
 
+  --init [dir]
+    Generate a tests folder (or the provided directory) with a sample test
+    and bootstrap file to get you started quickly.
+
   -h, --help
     This message.
 

src/init.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
-function init::init() {
-  local tests_dir="$BASHUNIT_DEFAULT_PATH"
+function init::project() {
+  local tests_dir="${1:-$BASHUNIT_DEFAULT_PATH}"
   mkdir -p "$tests_dir"
 
   local bootstrap_file="$tests_dir/bootstrap.sh"
@@ -28,5 +28,20 @@ SH
     echo "> Created $example_test"
   fi
 
+  local env_file=".env"
+  local env_line="BASHUNIT_BOOTSTRAP=$bootstrap_file"
+  if [[ -f "$env_file" ]]; then
+    if grep -q "^BASHUNIT_BOOTSTRAP=" "$env_file"; then
+      if check_os::is_macos; then
+        sed -i '' -e "s/^BASHUNIT_BOOTSTRAP=/#&/" "$env_file"
+      else
+        sed -i -e "s/^BASHUNIT_BOOTSTRAP=/#&/" "$env_file"
+      fi
+    fi
+    echo "$env_line" >> "$env_file"
+  else
+    echo "$env_line" > "$env_file"
+  fi
+
   echo "> bashunit initialized in $tests_dir"
 }

tests/acceptance/bashunit_init_test.sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2317
+
 set -euo pipefail
 
 TMP_DIR="tmp/init"
@@ -22,3 +24,22 @@ function test_bashunit_init_creates_structure() {
   # return to the original working directory
   popd >/dev/null
 }
+
+function test_bashunit_init_custom_directory() {
+  pushd "$TMP_DIR" >/dev/null
+  ../../bashunit --init custom > /tmp/init.log
+  assert_file_exists custom/example_test.sh
+  assert_file_exists custom/bootstrap.sh
+  popd >/dev/null
+}
+
+function test_bashunit_init_updates_env() {
+  pushd "$TMP_DIR" >/dev/null
+  echo "BASHUNIT_BOOTSTRAP=old/bootstrap.sh" > .env
+  ../../bashunit --init custom > /tmp/init.log
+  assert_file_exists custom/example_test.sh
+  assert_file_exists custom/bootstrap.sh
+  assert_file_contains .env "#BASHUNIT_BOOTSTRAP=old/bootstrap.sh"
+  assert_file_contains .env "BASHUNIT_BOOTSTRAP=custom/bootstrap.sh"
+  popd >/dev/null
+}

tests/acceptance/snapshots/bashunit_path_test_sh.test_bashunit_without_path_env_nor_argument.snapshot

@@ -44,6 +44,10 @@ Options:
   --upgrade
     Upgrade to latest version of bashunit.
 
+  --init [dir]
+    Generate a tests folder (or the provided directory) with a sample test
+    and bootstrap file to get you started quickly.
+
   -h, --help
     This message.
 

tests/acceptance/snapshots/bashunit_test_sh.test_bashunit_should_display_help.snapshot

@@ -43,6 +43,10 @@ Options:
   --upgrade
     Upgrade to latest version of bashunit.
 
+  --init [dir]
+    Generate a tests folder (or the provided directory) with a sample test
+    and bootstrap file to get you started quickly.
+
   -h, --help
     This message.