tests: update tests to use the packaged version of the scripts

dhellmann · dhellmann · commit 389179cef690 · 2023-02-11T11:31:05.000-05:00
The tests were always running the local source copy of
virtualenvwrapper.sh, which does not ensure we are packaging and
installing that file properly. This commit changes the logic for
loading the wrappers so when the job is running under tox we always
look in the virtualenv's bin directory.
diff --git a/tests/setup.sh b/tests/setup.sh
@@ -10,3 +10,19 @@ export WORKON_HOME=$(mktemp -d -t "WORKON_HOME.XXXX.$$")
 export PROJECT_HOME=$(mktemp -d -t "PROJECT_HOME.XXXX.$$")
 
 #unset HOOK_VERBOSE_OPTION
+
+SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# This should point to VIRTUAL_ENV/bin when running under tox.
+TEST_BIN_DIR=$(dirname $(which python))
+
+load_wrappers() {
+    if [ "$USING_TOX" = "1" ]; then
+        # Use the version of the scripts installed as part of the
+        # package.
+        source "$TEST_BIN_DIR/virtualenvwrapper.sh"
+    else
+        echo "USING SOURCE VERSION OF SCRIPT"
+        source "$SCRIPTDIR/../virtualenvwrapper.sh"
+    fi
+}
diff --git a/tests/test.sh b/tests/test.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_add2virtualenv.sh b/tests/test_add2virtualenv.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh" >/dev/null 2>&1
+    load_wrappers >/dev/null 2>&1
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_allvirtualenv.sh b/tests/test_allvirtualenv.sh
@@ -6,8 +6,8 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
+    load_wrappers
     unset VIRTUAL_ENV
-    source "$test_dir/../virtualenvwrapper.sh"
     # These three env names must sort the same whether the OS considers leading whitespace or not.
     # "test" is after " env" and after "env", so the asserts work on OSX and Linux.
     mkvirtualenv test1 >/dev/null 2>&1
diff --git a/tests/test_cd.sh b/tests/test_cd.sh
@@ -6,8 +6,8 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
+    load_wrappers
     unset VIRTUAL_ENV
-    source "$test_dir/../virtualenvwrapper.sh"
     mkvirtualenv cd-test >/dev/null 2>&1
     deactivate
 }
diff --git a/tests/test_cd_alias.sh b/tests/test_cd_alias.sh
@@ -6,8 +6,8 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
+    load_wrappers
     unset VIRTUAL_ENV
-    source "$test_dir/../virtualenvwrapper.sh"
     mkvirtualenv cd-test >/dev/null 2>&1
     deactivate
 }
diff --git a/tests/test_cd_space_in_name.sh b/tests/test_cd_space_in_name.sh
@@ -7,8 +7,8 @@ oneTimeSetUp() {
     export WORKON_HOME="$WORKON_HOME/ this has spaces"
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
+    load_wrappers
     unset VIRTUAL_ENV
-    source "$test_dir/../virtualenvwrapper.sh"
     # Only test with leading and internal spaces. Directory names with trailing spaces are legal,
     # and work with virtualenv on OSX, but error out on Linux.
     mkvirtualenv " env with space" >/dev/null 2>&1
diff --git a/tests/test_cp.sh b/tests/test_cp.sh
@@ -6,14 +6,14 @@ source "$test_dir/setup.sh"
 setUp () {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     rm -f "$TMPDIR/catch_output"
     echo
 }
 
 tearDown() {
     if type deactivate >/dev/null 2>&1
-    then 
+    then
         deactivate
     fi
     rm -rf "$WORKON_HOME"
diff --git a/tests/test_cpvirtualenv.sh b/tests/test_cpvirtualenv.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 setUp () {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     echo
 }
 
diff --git a/tests/test_deactivate.sh b/tests/test_deactivate.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     mkvirtualenv "env1"
 }
 
diff --git a/tests/test_derive_workon_home.sh b/tests/test_derive_workon_home.sh
@@ -7,7 +7,7 @@ TMP_WORKON_HOME="$WORKON_HOME"
 oneTimeSetUp() {
     rm -rf "$TMP_WORKON_HOME"
     mkdir -p "$TMP_WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     echo $PYTHONPATH
 }
 
diff --git a/tests/test_dir_stack.sh b/tests/test_dir_stack.sh
@@ -14,7 +14,7 @@ oneTimeTearDown() {
 setUp () {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     mkdir "$WORKON_HOME/start_here"
     mkdir "$WORKON_HOME/on_the_stack"
     echo
diff --git a/tests/test_expandpath.sh b/tests/test_expandpath.sh
@@ -5,7 +5,7 @@ source "$test_dir/setup.sh"
 TMP_WORKON_HOME="$WORKON_HOME"
 
 oneTimeSetUp() {
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     echo $PYTHONPATH
 }
 
diff --git a/tests/test_hook_dir.sh b/tests/test_hook_dir.sh
@@ -23,7 +23,7 @@ RUN_SCRIPTS="premkvirtualenv prermvirtualenv postrmvirtualenv preactivate get_en
 
 test_virtualenvwrapper_initialize() {
     export VIRTUALENVWRAPPER_HOOK_DIR="$WORKON_HOME/hooks"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     for hook in $SOURCE_SCRIPTS
     do
         assertTrue "Global $WORKON_HOME/$hook was not created" "[ -f $WORKON_HOME/hooks/$hook ]"
diff --git a/tests/test_log_file.sh b/tests/test_log_file.sh
@@ -9,13 +9,13 @@ setUp () {
 
 test_set_by_user() {
     export VIRTUALENVWRAPPER_LOG_FILE="$WORKON_HOME/hooks.log"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     assertTrue "Log file was not created" "[ -f $VIRTUALENVWRAPPER_LOG_FILE ]"
 }
 
 test_file_permissions() {
     export VIRTUALENVWRAPPER_LOG_FILE="$WORKON_HOME/hooks.log"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     perms=$(ls -l "$VIRTUALENVWRAPPER_LOG_FILE" | cut -f1 -d' ')
     #echo $perms
     assertTrue "Log file permissions are wrong: $perms" "echo $perms | grep '^-rw-rw'"
@@ -25,7 +25,7 @@ test_not_set_by_user() {
     unset WORKON_HOME
     unset VIRTUALENVWRAPPER_LOG_FILE
     unset VIRTUALENVWRAPPER_HOOK_DIR
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     assertSame "" "$VIRTUALENVWRAPPER_LOG_FILE"
 }
 
diff --git a/tests/test_ls.sh b/tests/test_ls.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_mktmpenv.sh b/tests/test_mktmpenv.sh
@@ -7,7 +7,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_mkvirtualenv.sh b/tests/test_mkvirtualenv.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_mkvirtualenv_associate.sh b/tests/test_mkvirtualenv_associate.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_mkvirtualenv_install.sh b/tests/test_mkvirtualenv_install.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_mkvirtualenv_requirements.sh b/tests/test_mkvirtualenv_requirements.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_project.sh b/tests/test_project.sh
@@ -21,7 +21,7 @@ setUp () {
 }
 
 test_initialize() {
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     for hook in  premkproject postmkproject
     do
         assertTrue "Global $hook was not created" "[ -f $WORKON_HOME/$hook ]"
@@ -32,7 +32,7 @@ test_initialize() {
 test_initialize_hook_dir() {
     export VIRTUALENVWRAPPER_HOOK_DIR="$WORKON_HOME/hooks"
     mkdir -p "$VIRTUALENVWRAPPER_HOOK_DIR"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     for hook in  premkproject postmkproject
     do
         assertTrue "Global $hook was not created" "[ -f $VIRTUALENVWRAPPER_HOOK_DIR/$hook ]"
diff --git a/tests/test_project_activate.sh b/tests/test_project_activate.sh
@@ -8,7 +8,7 @@ oneTimeSetUp() {
     mkdir -p "$WORKON_HOME"
     rm -rf "$PROJECT_HOME"
     mkdir -p "$PROJECT_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 # oneTimeTearDown() {
diff --git a/tests/test_project_cd.sh b/tests/test_project_cd.sh
@@ -8,7 +8,7 @@ oneTimeSetUp() {
     mkdir -p "$WORKON_HOME"
     rm -rf "$PROJECT_HOME"
     mkdir -p "$PROJECT_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_project_mk.sh b/tests/test_project_mk.sh
@@ -9,7 +9,7 @@ oneTimeSetUp() {
     rm -rf "$PROJECT_HOME"
     mkdir -p "$PROJECT_HOME"
     export VIRTUALENVWRAPPER_HOOK_DIR="$WORKON_HOME/hooks"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_project_templates.sh b/tests/test_project_templates.sh
@@ -9,7 +9,7 @@ oneTimeSetUp() {
     mkdir -p "$WORKON_HOME"
     rm -rf "$PROJECT_HOME"
     mkdir -p "$PROJECT_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_rmvirtualenv.sh b/tests/test_rmvirtualenv.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_run_hook.sh b/tests/test_run_hook.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_setvirtualenvproject.sh b/tests/test_setvirtualenvproject.sh
@@ -8,7 +8,7 @@ oneTimeSetUp() {
     mkdir -p "$WORKON_HOME"
     rm -rf "$PROJECT_HOME"
     mkdir -p "$PROJECT_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_support.sh b/tests/test_support.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
 }
 
 oneTimeTearDown() {
diff --git a/tests/test_tempfile.sh b/tests/test_tempfile.sh
@@ -8,7 +8,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     echo $PYTHONPATH
 }
 
diff --git a/tests/test_virtualenvwrapper.sh b/tests/test_virtualenvwrapper.sh
@@ -21,7 +21,7 @@ setUp () {
 }
 
 test_virtualenvwrapper_script_set() {
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     assertTrue "VIRTUALENVWRAPPER_SCRIPT is not right: $VIRTUALENVWRAPPER_SCRIPT" \
         "echo $VIRTUALENVWRAPPER_SCRIPT | grep -q /virtualenvwrapper.sh"
 }
diff --git a/tests/test_wipeenv.sh b/tests/test_wipeenv.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 setUp () {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     echo
 }
 
diff --git a/tests/test_workon.sh b/tests/test_workon.sh
@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"
 oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     mkvirtualenv "test1" >/dev/null 2>&1
     mkvirtualenv "test2" >/dev/null 2>&1
     # Only test with leading and internal spaces. Directory names with trailing spaces are legal,
diff --git a/tox.ini b/tox.ini
@@ -7,15 +7,15 @@ pass_env =
     HOME
     USER
 setenv =
-    TOXIC = true
+    USING_TOX = 1
     SHELL = /bin/bash
 allowlist_externals =
     bash
     zsh
 
 [testenv:fast]
 setenv =
-    TOXIC = true
+    USING_TOX = 1
     SHELL = /bin/bash
     FAIL_FAST = true
 
@@ -25,6 +25,7 @@ commands = flake8 virtualenvwrapper docs/source/conf.py
 
 [testenv:zsh]
 setenv =
+  USING_TOX = 1
   SHELL = /bin/zsh
   test_shell_opts = -o shwordsplit
 commands =  zsh -o shwordsplit ./tests/run_tests {envdir} []

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"`
`6`	`6`	`oneTimeSetUp() {`
`7`	`7`	`rm -rf "$WORKON_HOME"`
`8`	`8`	`mkdir -p "$WORKON_HOME"`
`9`		`- source "$test_dir/../virtualenvwrapper.sh"`
	`9`	`+ load_wrappers`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`oneTimeTearDown() {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ source "$test_dir/setup.sh"`
`6`	`6`	`setUp () {`
`7`	`7`	`rm -rf "$WORKON_HOME"`
`8`	`8`	`mkdir -p "$WORKON_HOME"`
`9`		`- source "$test_dir/../virtualenvwrapper.sh"`
	`9`	`+ load_wrappers`
`10`	`10`	`echo`
`11`	`11`	`}`
`12`	`12`