convert test scripts to use tox instead of home-grown multi-version system in the Makefile

Author: dhellmann

.hgignore

@@ -15,6 +15,7 @@ tests/testpackage/testpackage.egg-info
 trace.txt
 virtualenvwrapper.egg-info
 virtualenvwrapper/docs
+.tox
 
 syntax: re
 .DS_Store

ChangeLog

@@ -1,3 +1,26 @@
+2010-12-24  Doug Hellmann  <[email protected]>
+
+	* virtualenvwrapper.sh (cpvirtualenv): Ensure that both pre hooks
+	are run, even if one produces an error.
+
+	* virtualenvwrapper/user_scripts.py: Change log message format.
+
+	* tox.ini: Configuration file for running tests under tox.
+
+	* tests/test_run_hook.sh (test_virtualenvwrapper_run_hook_permissions):
+	Fix the expected output message.
+
+	* tests/*: Make sure all of the test scripts have execute permission.
+
+	* tests/test.sh (test_virtualenvwrapper_verify_workon_home_missing_dir_quiet_init):
+	Use source instead of starting another shell, since zsh doesn't
+	play nicely with inheriting environment settings otherwise.
+	(test_python_interpreter_set_incorrectly): Force
+	VIRTUALENVWRAPPER_PYTHON before running the script in a sub-shell.
+
+	* tests/run_tests: Script to run through all of the other test
+	scripts one at a time.
+
 2010-09-18  Doug Hellmann  <[email protected]>
 
 	* virtualenvwrapper.sh: Apply patch from Zach Voase to fix

Makefile

@@ -1,24 +1,6 @@
 # Get the version of the app.  This is used in the doc build.
 export VERSION=$(shell python setup.py --version)
 
-# Locations of Python interpreter binaries
-PYTHON27=/Users/dhellmann/Devel/virtualenvwrapper/Python/2.7b1/bin/python2.7
-ifeq ($VIRTUAL_ENV,)
-PYTHON26=$(shell which python2.6)
-else
-PYTHON26=/Library/Frameworks/Python.framework/Versions/2.6/bin/python2.6
-endif
-PYTHON25=/Library/Frameworks/Python.framework/Versions/2.5/bin/python2.5
-PYTHON24=/Users/dhellmann/Devel/virtualenvwrapper/Python/2.4.6/bin/python2.4
-
-# The test-quick pattern changes the definition of
-# this variable to only run against a single version of python.
-ifeq ($(PYTHON_BINARIES),)
-PYTHON_BINARIES=$(PYTHON26) $(PYTHON27) $(PYTHON25) $(PYTHON24)
-endif
-
-SUPPORTED_SHELLS=bash sh ksh zsh
-
 # Default target is to show help
 help:
 	@echo "sdist          - Source distribution"
@@ -67,56 +49,11 @@ register:
 	python setup.py register
 
 # Testing
-TEST_SCRIPTS=$(wildcard tests/test*.sh)
-
 test:
-	for name in $(SUPPORTED_SHELLS) ; do \
-		$(MAKE) test-$$name || exit 1 ; \
-	done
-	$(MAKE) test-install
+	tox
+
+test-quick:
+	tox -e py27
 
 develop:
 	python setup.py develop
-
-test-bash test-ksh test-sh:
-	TEST_SHELL=$(subst test-,,$@) $(MAKE) test-loop
-
-test-zsh:
-	TEST_SHELL="zsh -o shwordsplit" $(MAKE) test-loop
-
-# For each supported version of Python,
-# - Create a new virtualenv in a temporary directory.
-# - Install virtualenvwrapper into the new virtualenv
-# - Run each test script in tests
-test-loop:
-	for py_bin in $(PYTHON_BINARIES) ; do \
-		(cd $$TMPDIR/ && rm -rf virtualenvwrapper-test-env \
-			&& virtualenv -p $$py_bin --no-site-packages virtualenvwrapper-test-env) \
-			|| exit 1 ; \
-		$$TMPDIR/virtualenvwrapper-test-env/bin/python setup.py install || exit 1 ; \
-		for test_script in tests/test*.sh ; do \
-			echo ; \
-	 		echo '********************************************************************************' ; \
-			echo "Running $$test_script with $(TEST_SHELL) under Python $(basename $$py_bin)" ; \
-			echo ; \
-			HOOK_VERBOSE_OPTION=-v VIRTUALENVWRAPPER_PYTHON=$$TMPDIR/virtualenvwrapper-test-env/bin/python SHUNIT_PARENT=$$test_script $(TEST_SHELL) $$test_script || exit 1 ; \
-			echo ; \
-		done \
-	done
-
-test-quick:: test-26
-
-test-24:
-	PYTHON_BINARIES=$(PYTHON24) $(MAKE) test-bash
-
-test-25:
-	PYTHON_BINARIES=$(PYTHON25) $(MAKE) test-bash
-
-test-26:
-	PYTHON_BINARIES=$(PYTHON26) $(MAKE) test-bash
-
-test-27:
-	PYTHON_BINARIES=$(PYTHON27) $(MAKE) test-bash
-
-test-install:
-	bash ./tests/manual_test_install.sh `pwd`/dist "$(VERSION)"

docs/en/developers.rst

@@ -65,6 +65,8 @@ Running Tests
 =============
 
 The test suite for virtualenvwrapper uses `shunit2
-<http://shunit2.googlecode.com/>`_.  To run the tests under bash, sh,
-and zsh, use ``make test``.  In order to add new tests, you will need
-to modify or create an appropriate script in the ``tests`` directory.
+<http://shunit2.googlecode.com/>`_ and `tox
+<http://codespeak.net/tox>`_.  To run the tests under bash, sh, and
+zsh, use ``make test`` or just ``tox``.  In order to add new tests,
+you will need to modify or create an appropriate script in the
+``tests`` directory.

tests/run_tests

@@ -0,0 +1,56 @@
+#!/bin/sh
+
+##
+## ONLY RUN THIS VIA TOX
+##
+
+#set -x
+
+envdir="$1"
+shift
+scripts="$*"
+if [ -z "$scripts" ]
+then
+    scripts=$(ls tests/test*.sh)
+fi
+
+# Force the tox virtualenv to be active.  
+#
+# Since this script runs from within a separate shell created by tox,
+# the name of the virtualenv (in $VIRTUAL_ENV) is inherited, but the
+# shell functions and other settings created by the activate script
+# are *not* inherited.
+#
+source "$envdir/bin/activate"
+
+# Set up virtualenvwrapper.hook_loader to print more details than usual for debugging.
+export HOOK_VERBOSE_OPTION=-vvv
+
+# Force virtualenvwrapper to use the python interpreter in the
+# tox-created virtualenv.
+export VIRTUALENVWRAPPER_PYTHON="$envdir/bin/python"
+
+if [ -n "${ZSH_VERSION:-}" ]
+then
+    export SHELL=$(which zsh)
+fi
+
+# Run the test scripts with a little formatting around them to make it
+# easier to find where each script output starts.
+for test_script in $scripts
+do
+	echo
+ 	echo '********************************************************************************'
+	echo "Running $test_script"
+    echo "  VIRTUAL_ENV=$VIRTUAL_ENV"
+    echo "  VIRTUALENVWRAPPER_PYTHON=$VIRTUALENVWRAPPER_PYTHON"
+    echo "    $($VIRTUALENVWRAPPER_PYTHON -V 2>&1)"
+    echo "  PYTHONPATH=$PYTHONPATH"
+    echo "  SHELL=$SHELL"
+	echo
+    export SHUNIT_PARENT="$test_script"
+	$test_script || exit 1
+	echo
+done
+
+exit 0

tests/test.sh

@@ -10,7 +10,6 @@ oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
     source "$test_dir/../virtualenvwrapper.sh"
-    echo $PYTHONPATH
 }
 
 oneTimeTearDown() {
@@ -63,7 +62,7 @@ test_virtualenvwrapper_verify_workon_home_missing_dir_grep_options() {
 test_virtualenvwrapper_verify_workon_home_missing_dir_quiet_init() {
     old_home="$WORKON_HOME"
     export WORKON_HOME="$WORKON_HOME/not_there"
-    output=`$SHELL $test_dir/../virtualenvwrapper.sh 2>&1`
+    output=$(source $test_dir/../virtualenvwrapper.sh 2>&1)
     assertSame "" "$output"
     WORKON_HOME="$old_home"
 }
@@ -79,7 +78,7 @@ test_python_interpreter_set_incorrectly() {
     cd "$WORKON_HOME"
     mkvirtualenv --no-site-packages no_wrappers
     expected="ImportError: No module named virtualenvwrapper.hook_loader"
-    output=$(VIRTUALENVWRAPPER_PYTHON=$VIRTUAL_ENV/bin/python $SHELL $return_to/virtualenvwrapper.sh 2>&1)
+    output=$(VIRTUALENVWRAPPER_PYTHON=$(which python) $SHELL $return_to/virtualenvwrapper.sh 2>&1)
     echo "$output" | grep "$expected" 2>&1
     found=$?
     assertTrue "Expected \"$expected\", got: \"$output\"" "[ $found -eq 0 ]"

tests/test_add2virtualenv.sh

@@ -63,12 +63,20 @@ test_hooks () {
     mkvirtualenv "source"
 
     export pre_test_dir=$(cd "$test_dir"; pwd)
+
+    # Set the interpreter of the hook script to the simple shell
+    echo "#!/bin/sh" > "$WORKON_HOME/premkvirtualenv"
     echo "echo GLOBAL premkvirtualenv \`pwd\` \"\$@\" >> \"$pre_test_dir/catch_output\"" >> "$WORKON_HOME/premkvirtualenv"
     chmod +x "$WORKON_HOME/premkvirtualenv"
+
     echo "echo GLOBAL postmkvirtualenv >> $test_dir/catch_output" > "$WORKON_HOME/postmkvirtualenv"
+
+    # Set the interpreter of the hook script to the simple shell
     echo "#!/bin/sh" > "$WORKON_HOME/precpvirtualenv"
     echo "echo GLOBAL precpvirtualenv \`pwd\` \"\$@\" >> \"$pre_test_dir/catch_output\"" >> "$WORKON_HOME/precpvirtualenv"
     chmod +x "$WORKON_HOME/precpvirtualenv"
+
+    # Set the interpreter of the hook script to the simple shell
     echo "#!/bin/sh" > "$WORKON_HOME/postcpvirtualenv"
     echo "echo GLOBAL postcpvirtualenv >> $test_dir/catch_output" > "$WORKON_HOME/postcpvirtualenv"
 
@@ -83,6 +91,7 @@ GLOBAL postmkvirtualenv
 GLOBAL postcpvirtualenv"
 
     assertSame "$expected" "$output"
+
     rm -f "$WORKON_HOME/premkvirtualenv"
     rm -f "$WORKON_HOME/postmkvirtualenv"
 }