chore: Rename BASE_DIR environment variable to ASDF_DEV_BASE_DIR

New users to `asdf` who wish to contribute will run into the following
errors when running `./scripts/test.bash`:

```
 ✗ help should show dummy plugin help specific to version when version is present [7]
   (from function `setup_asdf_dir' in file test/test_helpers.bash, line 16,
    from function `setup' in test file test/help_command.bats, line 6)
     `setup_asdf_dir' failed
   mkdir: cannot create directory ‘/w spacetest_help_should_show_dummy_plugin_help_specific_to_version_when_version_is_present’: Permission denied
```

This is due to paths within the various test suites relying on the
`BASE_DIR` environment variable, which is not set by default.

This pull request adds the following:
* Renames `BASE_DIR` to `ASDF_DEV_BASE_DIR` to clarify intent of the
  variable.
* Modifies `scripts/test.bash` to correctly export `ASDF_DEV_BASE_DIR`

Note: I am a long-time asdf user, who would like to contribute to the
project and noticed this while setting up my dev environment on an
up-to-date Arch Linux system. My intention is to work on this issue:

#2042

* Rename `BASE_DIR` to `ASDF_DEV_BASE_DIR` to clarify intent of variable.
* Modify `test.bash` to export `ASDF_DEV_BASE_DIR`

Author: lukebakken

cmd/asdf/main_test.go

@@ -124,7 +124,7 @@ func runBatsFile(t *testing.T, dir, filename string) {
 	cmd.Stderr = &stderr
 
 	// Add dir to asdf test variables
-	asdfTestHome := fmt.Sprintf("BASE_DIR=%s", dir)
+	asdfTestHome := fmt.Sprintf("ASDF_DEV_BASE_DIR=%s", dir)
 	asdfBinPath := fmt.Sprintf("ASDF_BIN=%s", dir)
 	cmd.Env = []string{asdfBinPath, asdfTestHome}
 

scripts/test.bash

@@ -1,7 +1,6 @@
 #!/usr/bin/env bash
 
 set -euo pipefail
-IFS=$'\n\t'
 
 print.info() {
   printf '[INFO] %s\n' "$1"
@@ -11,18 +10,21 @@ print.error() {
   printf '[ERROR] %s\n' "$1" >&2
 }
 
-{
-  repo_dir=$(git rev-parse --show-toplevel)
-  current_dir=$(pwd -P)
-  if [ "$repo_dir" != "$current_dir" ]; then
-    print.error "This scripts requires execution from the repository root directory."
-    printf "\t%s\t%s\n" "Repo root dir:" "$repo_dir"
-    printf "\t%s\t%s\n\n" "Current dir:" "$current_dir"
-    exit 1
-  fi
-}
+ASDF_DEV_BASE_DIR="$(git rev-parse --show-toplevel)"
+readonly ASDF_DEV_BASE_DIR
+export ASDF_DEV_BASE_DIR
+
+current_dir="$(pwd -P)"
+readonly current_dir
+
+if [[ $ASDF_DEV_BASE_DIR != "$current_dir" ]]; then
+  print.error "This script requires execution from the repository root directory."
+  printf "\t%s\t%s\n" "asdf repo root dir:" "$ASDF_DEV_BASE_DIR" >&2
+  printf "\t%s\t%s\n\n" "current dir:" "$current_dir" >&2
+  exit 1
+fi
 
-test_directory="./test"
+readonly test_directory="$ASDF_DEV_BASE_DIR/test"
 bats_options=(--timing --print-output-on-failure)
 
 if command -v parallel >/dev/null; then
@@ -35,5 +37,5 @@ else
   print.info "For faster test execution, install GNU parallel."
 fi
 
-print.info "Running Bats in directory '${test_directory}' with options:" "${bats_options[@]}"
+print.info "Running Bats in directory '${test_directory}' with options: '${bats_options[*]}'"
 bats "${bats_options[@]}" "${test_directory}"

test/asdf_nu.bats

@@ -118,7 +118,7 @@ run_nushell() {
 #@test "parses the output of asdf plugin list --urls" {
 #  setup_repo
 #  install_mock_plugin_repo "dummy"
-#  asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+#  asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
 #  run_nushell "asdf plugin list --urls | to csv -n"
 
@@ -133,7 +133,7 @@ run_nushell() {
 #@test "parses the output of asdf plugin list --refs" {
 #  setup_repo
 #  install_mock_plugin_repo "dummy"
-#  asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+#  asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
 #  run_nushell "asdf plugin list --refs | to csv -n"
 
@@ -149,7 +149,7 @@ run_nushell() {
 #@test "parses the output of asdf plugin list --urls --refs" {
 #  setup_repo
 #  install_mock_plugin_repo "dummy"
-#  asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+#  asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
 #  run_nushell "asdf plugin list --urls --refs | to csv -n"
 

test/plugin_add_command.bats

@@ -14,7 +14,7 @@ teardown() {
 @test "plugin_add command with plugin name matching all valid regex chars succeeds" {
   install_mock_plugin_repo "plugin_with-all-valid-chars-123"
 
-  run asdf plugin add "plugin_with-all-valid-chars-123" "${BASE_DIR}/repo-plugin_with-all-valid-chars-123"
+  run asdf plugin add "plugin_with-all-valid-chars-123" "${ASDF_DEV_BASE_DIR}/repo-plugin_with-all-valid-chars-123"
   [ "$status" -eq 0 ]
 
   run asdf plugin list
@@ -29,7 +29,7 @@ teardown() {
 
   # https://stackoverflow.com/questions/52570103/regular-expression-a-za-z-seems-to-not-include-letter-w-and-wA
   # https://github.com/asdf-vm/asdf/issues/1237
-  run asdf plugin add "plugin-with-w" "${BASE_DIR}/repo-plugin-with-w"
+  run asdf plugin add "plugin-with-w" "${ASDF_DEV_BASE_DIR}/repo-plugin-with-w"
   [ "$status" -eq 0 ]
 
   run asdf plugin list
@@ -89,7 +89,7 @@ teardown() {
 @test "plugin_add command with URL specified adds a plugin using repo" {
   install_mock_plugin_repo "dummy"
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
   [ "$status" -eq 0 ]
 
   run asdf plugin list
@@ -100,8 +100,8 @@ teardown() {
 @test "plugin_add command with URL specified twice returns success on second time" {
   install_mock_plugin_repo "dummy"
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
   [ "$status" -eq 0 ]
   [ "$output" = "Plugin named dummy already added" ]
 }
@@ -115,8 +115,8 @@ teardown() {
 @test "plugin_add command executes post-plugin add script" {
   install_mock_plugin_repo "dummy"
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
-  [ "$output" = "plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy" ]
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
+  [ "$output" = "plugin add path=${ASDF_DIR}/plugins/dummy source_url=${ASDF_DEV_BASE_DIR}/repo-dummy" ]
 }
 
 @test "plugin_add command executes configured pre hook (generic)" {
@@ -126,10 +126,10 @@ teardown() {
 pre_asdf_plugin_add = echo ADD ${@}
 EOM
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
   local expected_output="ADD dummy
-plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy"
+plugin add path=${ASDF_DIR}/plugins/dummy source_url=${ASDF_DEV_BASE_DIR}/repo-dummy"
   [ "$output" = "${expected_output}" ]
 }
 
@@ -140,10 +140,10 @@ plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy"
 pre_asdf_plugin_add_dummy = echo ADD
 EOM
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
   local expected_output="ADD
-plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy"
+plugin add path=${ASDF_DIR}/plugins/dummy source_url=${ASDF_DEV_BASE_DIR}/repo-dummy"
   [ "$output" = "${expected_output}" ]
 }
 
@@ -154,9 +154,9 @@ plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy"
 post_asdf_plugin_add = echo ADD ${@}
 EOM
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
-  local expected_output="plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy
+  local expected_output="plugin add path=${ASDF_DIR}/plugins/dummy source_url=${ASDF_DEV_BASE_DIR}/repo-dummy
 ADD dummy"
   [ "$output" = "${expected_output}" ]
 }
@@ -168,9 +168,9 @@ ADD dummy"
 post_asdf_plugin_add_dummy = echo ADD
 EOM
 
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 
-  local expected_output="plugin add path=${ASDF_DIR}/plugins/dummy source_url=${BASE_DIR}/repo-dummy
+  local expected_output="plugin add path=${ASDF_DIR}/plugins/dummy source_url=${ASDF_DEV_BASE_DIR}/repo-dummy
 ADD"
   [ "$output" = "${expected_output}" ]
 }

test/plugin_test_command.bats

@@ -24,11 +24,11 @@ teardown() {
 }
 
 @test "plugin_test_command works with no options provided" {
-  run asdf plugin test dummy "${BASE_DIR}/repo-dummy"
+  run asdf plugin test dummy "${ASDF_DEV_BASE_DIR}/repo-dummy"
   [ "$status" -eq 0 ]
 }
 
 @test "plugin_test_command works with all options provided" {
-  run asdf plugin test dummy "${BASE_DIR}/repo-dummy" --asdf-tool-version 1.0.0 --asdf-plugin-gitref master
+  run asdf plugin test dummy "${ASDF_DEV_BASE_DIR}/repo-dummy" --asdf-tool-version 1.0.0 --asdf-plugin-gitref master
   [ "$status" -eq 0 ]
 }

test/plugin_update_command.bats

@@ -5,7 +5,7 @@ load test_helpers
 setup() {
   setup_asdf_dir
   install_mock_plugin_repo "dummy"
-  run asdf plugin add "dummy" "${BASE_DIR}/repo-dummy"
+  run asdf plugin add "dummy" "${ASDF_DEV_BASE_DIR}/repo-dummy"
 }
 
 teardown() {
@@ -22,7 +22,7 @@ teardown() {
 
 #@test "asdf plugin update should pull latest default branch (refs/remotes/origin/HEAD) for plugin even if default branch changes" {
 #  install_mock_plugin_repo "dummy-remote"
-#  remote_dir="$BASE_DIR/repo-dummy-remote"
+#  remote_dir="$ASDF_DEV_BASE_DIR/repo-dummy-remote"
 #  # set HEAD to refs/head/main in dummy-remote
 #  git -C "${remote_dir}" checkout -b main
 #  # track & fetch remote repo (dummy-remote) in plugin (dummy)
@@ -40,7 +40,7 @@ teardown() {
 
 #@test "asdf plugin update should pull latest default branch (refs/remotes/origin/HEAD) for plugin even if the default branch contains a forward slash" {
 #  install_mock_plugin_repo "dummy-remote"
-#  remote_dir="$BASE_DIR/repo-dummy-remote"
+#  remote_dir="$ASDF_DEV_BASE_DIR/repo-dummy-remote"
 #  # set HEAD to refs/head/my/default in dummy-remote
 #  git -C "${remote_dir}" checkout -b my/default
 #  # track & fetch remote repo (dummy-remote) in plugin (dummy)
@@ -58,12 +58,12 @@ teardown() {
 
 #@test "asdf plugin update should pull latest default branch (refs/remotes/origin/HEAD) for plugin even if already set to specific ref" {
 #  # set plugin to specific sha
-#  current_sha="$(git --git-dir "${BASE_DIR}/repo-dummy/.git" --work-tree "$BASE_DIR/repo-dummy" rev-parse HEAD)"
+#  current_sha="$(git --git-dir "${ASDF_DEV_BASE_DIR}/repo-dummy/.git" --work-tree "$ASDF_DEV_BASE_DIR/repo-dummy" rev-parse HEAD)"
 #  run asdf plugin update dummy "${current_sha}"
 
 #  # setup mock plugin remote
 #  install_mock_plugin_repo "dummy-remote"
-#  remote_dir="$BASE_DIR/repo-dummy-remote"
+#  remote_dir="$ASDF_DEV_BASE_DIR/repo-dummy-remote"
 #  # set HEAD to refs/head/main in dummy-remote
 #  git -C "${remote_dir}" checkout -b main
 #  # track & fetch remote repo (dummy-remote) in plugin (dummy)
@@ -141,7 +141,7 @@ teardown() {
 
 #  # setup mock plugin remote
 #  install_mock_plugin_repo "dummy-remote"
-#  remote_dir="$BASE_DIR/repo-dummy-remote"
+#  remote_dir="$ASDF_DEV_BASE_DIR/repo-dummy-remote"
 #  # set HEAD to refs/head/main in dummy-remote
 #  git -C "${remote_dir}" checkout -b main
 #  # track & fetch remote repo (dummy-remote) in plugin (dummy)

test/test_helpers.bash

@@ -7,16 +7,16 @@ bats_require_minimum_version 1.7.0
 
 setup_asdf_dir() {
   if [ "$BATS_TEST_NAME" = 'test_shim_exec_should_use_path_executable_when_specified_version_path-3a-3cpath-3e' ]; then
-    BASE_DIR="$BASE_DIR/asdf_with_no_spaces"
+    ASDF_DEV_BASE_DIR="$ASDF_DEV_BASE_DIR/asdf_with_no_spaces"
   else
-    BASE_DIR="$BASE_DIR/w space${BATS_TEST_NAME}"
+    ASDF_DEV_BASE_DIR="$ASDF_DEV_BASE_DIR/w space${BATS_TEST_NAME}"
   fi
 
   # We don't call mktemp anymore so we need to create this sub directory manually
-  mkdir "$BASE_DIR"
+  mkdir "$ASDF_DEV_BASE_DIR"
 
   # HOME is now defined by the Golang test code in main_test.go
-  HOME="$BASE_DIR"
+  HOME="$ASDF_DEV_BASE_DIR"
   export HOME
   ASDF_DIR="$HOME/.asdf"
   mkdir -p "$ASDF_DIR/plugins"
@@ -26,7 +26,7 @@ setup_asdf_dir() {
   # ASDF_BIN is now defined by the Golang test code in main_test.go
   #ASDF_BIN="$(dirname "$BATS_TEST_DIRNAME")/bin"
 
-  ASDF_DATA_DIR="$BASE_DIR/.asdf"
+  ASDF_DATA_DIR="$ASDF_DEV_BASE_DIR/.asdf"
   export ASDF_DATA_DIR
 
   # shellcheck disable=SC2031,SC2153
@@ -63,7 +63,7 @@ install_mock_broken_plugin() {
 
 install_mock_plugin_repo() {
   local plugin_name=$1
-  local location="${BASE_DIR}/repo-${plugin_name}"
+  local location="${ASDF_DEV_BASE_DIR}/repo-${plugin_name}"
   cp -r "$BATS_TEST_DIRNAME/fixtures/dummy_plugin" "${location}"
   init_git_repo "${location}"
 }
@@ -122,7 +122,7 @@ install_dummy_exec_path_script() {
 }
 
 clean_asdf_dir() {
-  rm -rf "$BASE_DIR"
+  rm -rf "$ASDF_DEV_BASE_DIR"
   unset ASDF_DIR
   unset ASDF_DATA_DIR
 }

test/update_command.bats

@@ -3,8 +3,8 @@
 #load test_helpers
 
 #setup() {
-#  BASE_DIR=$(mktemp -dt asdf.XXXX)
-#  HOME="$BASE_DIR/home"
+#  ASDF_DEV_BASE_DIR=$(mktemp -dt asdf.XXXX)
+#  HOME="$ASDF_DEV_BASE_DIR/home"
 #  ASDF_DIR="$HOME/.asdf"
 #  git clone -o local "$(dirname "$BATS_TEST_DIRNAME")" "$ASDF_DIR"
 #  git --git-dir "$ASDF_DIR/.git" remote add origin https://github.com/asdf-vm/asdf.git

test/utils.bats

@@ -247,7 +247,7 @@ teardown() {
 
 @test "get_preset_version_for returns the global version from home when project is outside of home" {
   echo "dummy 0.1.0" >"$HOME/.tool-versions"
-  PROJECT_DIR=$BASE_DIR/project
+  PROJECT_DIR=$ASDF_DEV_BASE_DIR/project
   mkdir -p "$PROJECT_DIR"
   run get_preset_version_for "dummy"
   [ "$status" -eq 0 ]