environments: add activate/deactivate tests, work wtih `set -u`

- [x] Add shell tests to ensure that `spack env activate`, `spack env
  deactivate`, and `despacktivate` continue to work.

- [x] Also ensure that activate and deactivate both work with `set -u`

3 files changed, 143 insertions, 15 deletions

diff --git a/lib/spack/spack/environment.py b/lib/spack/spack/environment.py
index 69bffce0a0..d72a53dd76 100644
--- a/lib/spack/spack/environment.py
+++ b/lib/spack/spack/environment.py
@@ -145,8 +145,12 @@ def activate(
         cmds += 'export SPACK_ENV=%s;\n' % env.path
         cmds += "alias despacktivate='spack env deactivate';\n"
         if prompt:
-            cmds += 'if [ -z "${SPACK_OLD_PS1}" ]; then\n'
-            cmds += 'export SPACK_OLD_PS1="${PS1}"; fi;\n'
+            cmds += 'if [ -z ${SPACK_OLD_PS1+x} ]; then\n'
+            cmds += '    if [ -z ${PS1+x} ]; then\n'
+            cmds += "        PS1='$$$$';\n"
+            cmds += '    fi;\n'
+            cmds += '    export SPACK_OLD_PS1="${PS1}";\n'
+            cmds += 'fi;\n'
             cmds += 'export PS1="%s ${PS1}";\n' % prompt
 
     if add_view and default_view_name in env.views:
@@ -184,11 +188,17 @@ def deactivate(shell='sh'):
         cmds += 'unsetenv SPACK_OLD_PROMPT;\n'
         cmds += 'unalias despacktivate;\n'
     else:
+        cmds += 'if [ ! -z ${SPACK_ENV+x} ]; then\n'
         cmds += 'unset SPACK_ENV; export SPACK_ENV;\n'
+        cmds += 'fi;\n'
         cmds += 'unalias despacktivate;\n'
-        cmds += 'if [ -n "$SPACK_OLD_PS1" ]; then\n'
-        cmds += 'export PS1="$SPACK_OLD_PS1";\n'
-        cmds += 'unset SPACK_OLD_PS1; export SPACK_OLD_PS1;\n'
+        cmds += 'if [ ! -z ${SPACK_OLD_PS1+x} ]; then\n'
+        cmds += '    if [ "$SPACK_OLD_PS1" = \'$$$$\' ]; then\n'
+        cmds += '        unset PS1; export PS1;\n'
+        cmds += '    else\n'
+        cmds += '        export PS1="$SPACK_OLD_PS1";\n'
+        cmds += '    fi;\n'
+        cmds += '    unset SPACK_OLD_PS1; export SPACK_OLD_PS1;\n'
         cmds += 'fi;\n'
 
     if default_view_name in _active_environment.views:
diff --git a/lib/spack/spack/test/cmd/env.py b/lib/spack/spack/test/cmd/env.py
index cf7dcb93ff..1d2dc5a3ab 100644
--- a/lib/spack/spack/test/cmd/env.py
+++ b/lib/spack/spack/test/cmd/env.py
@@ -766,7 +766,7 @@ def test_env_updates_view_force_remove(
 
 
 def test_env_activate_view_fails(
-        tmpdir, mock_stage, mock_fetch, install_mockery):
+        tmpdir, mock_stage, mock_fetch, install_mockery, env_deactivate):
     """Sanity check on env activate to make sure it requires shell support"""
     out = env('activate', 'test')
     assert "To initialize spack's shell commands:" in out
@@ -1431,3 +1431,41 @@ env:
                 assert not os.path.exists(
                     os.path.join(combin_viewdir, spec.name, '%s-%s' %
                                  (spec.version, spec.compiler.name)))
+
+
+def test_env_activate_sh_prints_shell_output(
+        tmpdir, mock_stage, mock_fetch, install_mockery, env_deactivate
+):
+    """Check the shell commands output by ``spack env activate --sh``.
+
+    This is a cursory check; ``share/spack/qa/setup-env-test.sh`` checks
+    for correctness.
+    """
+    env('create', 'test', add_view=True)
+
+    out = env('activate', '--sh', 'test')
+    assert "export SPACK_ENV=" in out
+    assert "export PS1=" not in out
+    assert "alias despacktivate=" in out
+
+    out = env('activate', '--sh', '--prompt', 'test')
+    assert "export SPACK_ENV=" in out
+    assert "export PS1=" in out
+    assert "alias despacktivate=" in out
+
+
+def test_env_activate_csh_prints_shell_output(
+        tmpdir, mock_stage, mock_fetch, install_mockery, env_deactivate
+):
+    """Check the shell commands output by ``spack env activate --csh``."""
+    env('create', 'test', add_view=True)
+
+    out = env('activate', '--csh', 'test')
+    assert "setenv SPACK_ENV" in out
+    assert "setenv set prompt" not in out
+    assert "alias despacktivate" in out
+
+    out = env('activate', '--csh', '--prompt', 'test')
+    assert "setenv SPACK_ENV" in out
+    assert "set prompt=" in out
+    assert "alias despacktivate" in out
diff --git a/share/spack/qa/setup-env-test.sh b/share/spack/qa/setup-env-test.sh
index f572166b05..6515a99d8c 100755
--- a/share/spack/qa/setup-env-test.sh
+++ b/share/spack/qa/setup-env-test.sh
@@ -69,7 +69,7 @@ pass() {
 #
 succeeds() {
     printf "'%s' succeeds ... " "$*"
-    output=$("$@" 2>&1)
+    output=$($* 2>&1)
     err="$?"
 
     if [ "$err" != 0 ]; then
@@ -137,6 +137,35 @@ contains() {
     fi
 }
 
+#
+# Ensure that a variable is set.
+#
+is_set() {
+    printf "'%s' is set ... " "$1"
+    if eval "[ -z \${${1:-}+x} ]"; then
+        fail
+        echo_msg "$1 was not set!"
+    else
+        pass
+    fi
+}
+
+#
+# Ensure that a variable is not set.
+# Fails and prints the value of the variable if it is set.
+#
+is_not_set() {
+    printf "'%s' is not set ... " "$1"
+    if eval "[ ! -z \${${1:-}+x} ]"; then
+        fail
+        echo_msg "$1 was set:"
+        echo "    $1"
+    else
+        pass
+    fi
+}
+
+
 # -----------------------------------------------------------------------
 # Instead of invoking the module/use/dotkit commands, we print the
 # arguments that Spack invokes the command with, so we can check that
@@ -163,12 +192,17 @@ unuse() {
 # Make sure no environment is active
 unset SPACK_ENV
 
-# fail with undefined variables
+# fail on undefined variables
 set -u
 
 # Source setup-env.sh before tests
 .  share/spack/setup-env.sh
 
+# bash should expand aliases even when non-interactive
+if [ -n "${BASH:-}" ]; then
+    shopt -s expand_aliases
+fi
+
 title "Testing setup-env.sh with $_sp_shell"
 
 # spack command is now avaialble
@@ -191,17 +225,36 @@ b_install=$(spack location -i b)
 b_module=$(spack -m module tcl find b)
 b_dotkit=$(spack -m module dotkit find b)
 
+# create a test environment for tesitng environment commands
+echo "Creating a mock environment"
+spack env create spack_test_env
+test_env_location=$(spack location -e spack_test_env)
+
 # ensure that we uninstall b on exit
 cleanup() {
+    if [ "$?" != 0 ]; then
+        trapped_error=true
+    else
+        trapped_error=false
+    fi
+
+    echo "Removing test environment before exiting."
+    spack env deactivate 2>1 > /dev/null
+    spack env rm -y spack_test_env
+
     title "Cleanup"
-    echo "Removing test package before exiting test script."
-    spack -m uninstall -yf b
-    spack -m uninstall -yf a
+    echo "Removing test packages before exiting."
+    spack -m uninstall -yf b a
 
     echo
     echo "$success tests succeeded."
     echo "$errors tests failed."
-    if [ "$errors" = 0 ]; then
+
+    if [ "$trapped_error" = true ]; then
+        echo "Exited due to an error."
+    fi
+
+    if [ "$errors" = 0 ] && [ "$trapped_error" = false ]; then
         pass
         exit 0
     else
@@ -275,6 +328,10 @@ title 'Testing `spack env`'
 contains "usage: spack env " spack env -h
 contains "usage: spack env " spack env --help
 
+title 'Testing `spack env list`'
+contains " spack env list " spack env list -h
+contains " spack env list " spack env list --help
+
 title 'Testing `spack env activate`'
 contains "No such environment:" spack env activate no_such_environment
 contains "usage: spack env activate " spack env activate
@@ -287,6 +344,29 @@ contains "usage: spack env deactivate " spack env deactivate no_such_environment
 contains "usage: spack env deactivate " spack env deactivate -h
 contains "usage: spack env deactivate " spack env deactivate --help
 
-title 'Testing `spack env list`'
-contains " spack env list " spack env list -h
-contains " spack env list " spack env list --help
+title 'Testing activate and deactivate together'
+echo "Testing 'spack env activate spack_test_env'"
+spack env activate spack_test_env
+is_set SPACK_ENV
+
+echo "Testing 'spack env deactivate'"
+spack env deactivate
+is_not_set SPACK_ENV
+
+echo "Testing 'spack env activate spack_test_env'"
+spack env activate spack_test_env
+is_set SPACK_ENV
+
+echo "Testing 'despacktivate'"
+despacktivate
+is_not_set SPACK_ENV
+
+echo "Testing 'spack env activate --prompt spack_test_env'"
+spack env activate --prompt spack_test_env
+is_set SPACK_ENV
+is_set SPACK_OLD_PS1
+
+echo "Testing 'despacktivate'"
+despacktivate
+is_not_set SPACK_ENV
+is_not_set SPACK_OLD_PS1