Merged in jessamynsmith/virtualenvwrapper/env_with_space (pull request #28)

dhellmann · dhellmann · commit f2602e81af49 · 2015-04-26T21:03:15.000-04:00
Lots of work on handling spaces in names
diff --git a/tests/test_allvirtualenv.sh b/tests/test_allvirtualenv.sh
@@ -8,8 +8,13 @@ oneTimeSetUp() {
     mkdir -p "$WORKON_HOME"
     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
     mkvirtualenv test2 >/dev/null 2>&1
+    # 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
     deactivate
 }
 
@@ -28,6 +33,7 @@ tearDown () {
 test_allvirtualenv_all() {
     assertTrue "Did not find test1" "allvirtualenv pwd | grep -q 'test1$'"
     assertTrue "Did not find test2" "allvirtualenv pwd | grep -q 'test2$'"
+    assertTrue "Did not find ' env with space'" "allvirtualenv pwd | grep -q ' env with space'"
 }
 
 test_allvirtualenv_spaces() {
diff --git a/tests/test_cd_space_in_name.sh b/tests/test_cd_space_in_name.sh
@@ -0,0 +1,55 @@
+# -*- mode: shell-script -*-
+
+test_dir=$(cd $(dirname $0) && pwd)
+source "$test_dir/setup.sh"
+
+oneTimeSetUp() {
+    export WORKON_HOME="$WORKON_HOME/ this has spaces"
+    rm -rf "$WORKON_HOME"
+    mkdir -p "$WORKON_HOME"
+    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
+    deactivate
+}
+
+oneTimeTearDown() {
+    rm -rf "$WORKON_HOME"
+}
+
+setUp () {
+    echo
+}
+
+tearDown () {
+    deactivate >/dev/null 2>&1
+}
+
+cd () {
+    fail "Should not be using override cd function"
+}
+
+test_cdvirtual_space_in_workon_home_space_in_name() {
+    workon " env with space"
+    start_dir="$(pwd)"
+    cdvirtualenv
+    assertSame "$VIRTUAL_ENV" "$(pwd)"
+    cdvirtualenv bin
+    assertSame "$VIRTUAL_ENV/bin" "$(pwd)"
+    virtualenvwrapper_cd "$start_dir"
+}
+
+test_cdsitepackages_space_in_name () {
+    workon " env with space"
+    start_dir="$(pwd)"
+    cdsitepackages
+    pyvers=$(python -V 2>&1 | cut -f2 -d' ' | cut -f1-2 -d.)
+    sitepackages="$VIRTUAL_ENV/lib/python${pyvers}/site-packages"
+    assertSame "$sitepackages" "$(pwd)"
+    virtualenvwrapper_cd "$start_dir"
+}
+
+
+. "$test_dir/shunit2"
diff --git a/tests/test_cp.sh b/tests/test_cp.sh
@@ -40,6 +40,15 @@ test_virtual_env_variable () {
     assertTrue "$WORKON_HOME not in $VIRTUAL_ENV" "echo $VIRTUAL_ENV | grep -q $WORKON_HOME"
 }
 
+test_virtual_env_variable_space_in_name () {
+    # 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 " space source" >/dev/null 2>&1
+    cpvirtualenv " space source" " space destination" >/dev/null 2>&1
+    assertSame "Wrong virtualenv name" " space destination" "$(basename "$VIRTUAL_ENV")"
+    assertTrue "$WORKON_HOME not in $VIRTUAL_ENV" "echo $VIRTUAL_ENV | grep -q $WORKON_HOME"
+}
+
 fake_venv () {
     ###
     # create a silly file to ensure copy happens
diff --git a/tests/test_ls.sh b/tests/test_ls.sh
@@ -32,6 +32,15 @@ test_lssitepackages () {
     deactivate
 }
 
+test_lssitepackages_space_in_name () {
+    # 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 " space lssitepackagestest" >/dev/null 2>&1
+    contents="$(lssitepackages)"    
+    assertTrue "did not find easy_install in site-packages" "echo $contents | grep -q easy_install"
+    deactivate
+}
+
 test_lssitepackages_add2virtualenv () {
     mkvirtualenv "lssitepackagestest" >/dev/null 2>&1
     parent_dir=$(dirname $(pwd))
@@ -75,5 +84,13 @@ test_lsvirtualenv_space_in_workon_home () {
     WORKON_HOME="$old_home"
 }
 
+test_lsvirtualenv_space_in_env_name () {
+    # 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"
+    lsvirtualenv -b >"$WORKON_HOME/output" 2>&1
+    assertTrue "Did not see expected message in \"$output\"" "cat \"$WORKON_HOME/output\" | grep -q ' env with space'"
+}
+
 
 . "$test_dir/shunit2"
diff --git a/tests/test_mkvirtualenv.sh b/tests/test_mkvirtualenv.sh
@@ -29,13 +29,18 @@ test_create() {
 }
 
 test_create_space_in_name() {
-    mkvirtualenv "env with space" >/dev/null 2>&1
-    assertTrue "Environment directory was not created" "[ -d \"$WORKON_HOME/env with space\" ]"
+    # 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
+    assertTrue "Environment directory was not created" "[ -d \"$WORKON_HOME/ env with space\" ]"
     for hook in postactivate predeactivate postdeactivate
     do
-        assertTrue "$hook was not created" "[ -f \"$WORKON_HOME/env with space/bin/$hook\" ]"
-        assertFalse "$hook is executable" "[ -x \"$WORKON_HOME/env with space/bin/$hook\" ]"
+        assertTrue "$hook was not created" "[ -f \"$WORKON_HOME/ env with space/bin/$hook\" ]"
+        assertFalse "$hook is executable" "[ -x \"$WORKON_HOME/ env with space/bin/$hook\" ]"
     done
+    assertTrue virtualenvwrapper_verify_active_environment
+    env_name=$(basename "$VIRTUAL_ENV")
+    assertSame " env with space" "$env_name"
 }
 
 test_activates () {
diff --git a/tests/test_rmvirtualenv.sh b/tests/test_rmvirtualenv.sh
@@ -14,51 +14,53 @@ oneTimeTearDown() {
 }
 
 setUp () {
-    echo
+    mkvirtualenv "deleteme" >/dev/null 2>&1
+    # 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
+    deactivate >/dev/null 2>&1
 }
 
 test_remove () {
-    mkvirtualenv "deleteme" >/dev/null 2>&1
     assertTrue "[ -d $WORKON_HOME/deleteme ]"
-    deactivate
     rmvirtualenv "deleteme"
     assertFalse "[ -d $WORKON_HOME/deleteme ]"
 }
 
+test_remove_space_in_name () {
+    assertTrue "[ -d $WORKON_HOME/\" env with space\" ]"
+    rmvirtualenv " env with space"
+    assertFalse "[ -d $WORKON_HOME/\" env with space\" ]"
+}
+
 test_remove_several_envs () {
-    mkvirtualenv "deleteme" >/dev/null 2>&1
     assertTrue "[ -d $WORKON_HOME/deleteme ]"
-    deactivate
-    mkvirtualenv "deleteme2" >/dev/null 2>&1
-    assertTrue "[ -d $WORKON_HOME/deleteme2 ]"
-    deactivate
-    rmvirtualenv "deleteme deleteme2"
+    assertTrue "[ -d $WORKON_HOME/\" env with space\" ]"
+    rmvirtualenv deleteme " env with space"
     assertFalse "[ -d $WORKON_HOME/deleteme ]"
-    assertFalse "[ -d $WORKON_HOME/deleteme2 ]"
+    assertFalse "[ -d $WORKON_HOME/\" env with space\" ]"
 }
 
 test_within_virtualenv () {
-    mkvirtualenv "deleteme" >/dev/null 2>&1
-    assertTrue "[ -d $WORKON_HOME/deleteme ]"
+    mkvirtualenv "deleteme2" >/dev/null 2>&1
+    assertTrue "[ -d $WORKON_HOME/deleteme2 ]"
     cdvirtualenv
     assertSame "$VIRTUAL_ENV" "$(pwd)"
     deactivate
-    rmvirtualenv "deleteme"
+    rmvirtualenv "deleteme2"
     assertSame "$WORKON_HOME" "$(pwd)"
-    assertFalse "[ -d $WORKON_HOME/deleteme ]"
+    assertFalse "[ -d $WORKON_HOME/deleteme2 ]"
 }
 
 test_rm_aliased () {
-    mkvirtualenv "deleteme" >/dev/null 2>&1
-    deactivate
     alias rm='rm -i'
     rmvirtualenv "deleteme"
     unalias rm
 }
 
 test_no_such_env () {
-    assertFalse "[ -d $WORKON_HOME/deleteme ]"
-    assertTrue "rmvirtualenv deleteme"
+    assertFalse "[ -d $WORKON_HOME/deleteme2 ]"
+    assertTrue "rmvirtualenv deleteme2"
 }
 
 test_no_workon_home () {
diff --git a/tests/test_workon.sh b/tests/test_workon.sh
@@ -7,9 +7,12 @@ oneTimeSetUp() {
     rm -rf "$WORKON_HOME"
     mkdir -p "$WORKON_HOME"
     source "$test_dir/../virtualenvwrapper.sh"
-    mkvirtualenv "env1" >/dev/null 2>&1
-    mkvirtualenv "env2" >/dev/null 2>&1
-    deactivate >/dev/null 2>&1 
+    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,
+    # and work with virtualenv on OSX, but error out on Linux.
+    mkvirtualenv " env with space" >/dev/null 2>&1
+    deactivate >/dev/null 2>&1
 }
 
 oneTimeTearDown() {
@@ -26,9 +29,9 @@ tearDown () {
 }
 
 test_workon () {
-    workon env1
+    workon test1
     assertTrue virtualenvwrapper_verify_active_environment
-    assertSame "env1" $(basename "$VIRTUAL_ENV")
+    assertSame "test1" $(basename "$VIRTUAL_ENV")
 }
 
 test_workon_activate_hooks () {
@@ -38,15 +41,15 @@ test_workon_activate_hooks () {
         echo "echo GLOBAL ${t}activate >> \"$TMPDIR/catch_output\"" >> "$WORKON_HOME/${t}activate"
         chmod +x "$WORKON_HOME/${t}activate"
 
-        echo "#!/bin/sh" > "$WORKON_HOME/env2/bin/${t}activate"
-        echo "echo ENV ${t}activate >> \"$TMPDIR/catch_output\"" >> "$WORKON_HOME/env1/bin/${t}activate"
-        chmod +x "$WORKON_HOME/env1/bin/${t}activate"
+        echo "#!/bin/sh" > "$WORKON_HOME/test2/bin/${t}activate"
+        echo "echo ENV ${t}activate >> \"$TMPDIR/catch_output\"" >> "$WORKON_HOME/test1/bin/${t}activate"
+        chmod +x "$WORKON_HOME/test1/bin/${t}activate"
     done
 
     rm -f "$TMPDIR/catch_output"
     touch "$TMPDIR/catch_output"
 
-    workon env1
+    workon test1
     
     output=$(cat "$TMPDIR/catch_output")
     expected="GLOBAL preactivate
@@ -58,27 +61,29 @@ ENV postactivate"
     
     for t in pre post
     do
-        rm -f "$WORKON_HOME/env1/bin/${t}activate"
+        rm -f "$WORKON_HOME/test1/bin/${t}activate"
         rm -f "$WORKON_HOME/${t}activate"
     done
 }
 
 test_virtualenvwrapper_show_workon_options () {
     mkdir "$WORKON_HOME/not_env"
-    (cd "$WORKON_HOME"; ln -s env1 link_env)
+    (cd "$WORKON_HOME"; ln -s test1 link_env)
     envs=$(virtualenvwrapper_show_workon_options | tr '\n' ' ')
-    assertSame "env1 env2 link_env " "$envs"
+    # On OSX there are two trailing spaces, on Linux one, so compare substring
+    assertSame " env with space link_env test1 test2 " "${envs:0:37}"
     rmdir "$WORKON_HOME/not_env"
     rm -f "$WORKON_HOME/link_env"
 }
 
 test_virtualenvwrapper_show_workon_options_grep_options () {
     mkdir "$WORKON_HOME/not_env"
-    (cd "$WORKON_HOME"; ln -s env1 link_env)
+    (cd "$WORKON_HOME"; ln -s test1 link_env)
     export GREP_OPTIONS="--count"
     envs=$(virtualenvwrapper_show_workon_options | tr '\n' ' ')
     unset GREP_OPTIONS
-    assertSame "env1 env2 link_env " "$envs"
+    # On OSX there are two trailing spaces, on Linux one, so compare substring
+    assertSame " env with space link_env test1 test2 " "${envs:0:37}"
     rmdir "$WORKON_HOME/not_env"
     rm -f "$WORKON_HOME/link_env"
 }
@@ -94,15 +99,17 @@ test_virtualenvwrapper_show_workon_options_chpwd () {
     }
     mkdir "$WORKON_HOME/not_env"
     envs=$(virtualenvwrapper_show_workon_options | tr '\n' ' ')
-    assertSame "env1 env2 " "$envs"
+    # On OSX there are two trailing spaces, on Linux one, so compare substring
+    assertSame " env with space test1 test2 " "${envs:0:28}"
     rmdir "$WORKON_HOME/not_env"
     rm -f "$WORKON_HOME/link_env"
 }
 
 test_virtualenvwrapper_show_workon_options_no_envs () {
     old_home="$WORKON_HOME"
     export WORKON_HOME=${TMPDIR:-/tmp}/$$
-    envs=$(virtualenvwrapper_show_workon_options 2>/dev/null | tr '\n' ' ')
+    # On OSX there is a space and on Linux there is not, so strip all spaces
+    envs=$(virtualenvwrapper_show_workon_options 2>/dev/null | sed 's/\n //g')
     assertSame "" "$envs"
     export WORKON_HOME="$old_home"
 }
@@ -117,10 +124,25 @@ test_no_workon_home () {
 }
 
 test_workon_dot () {
-    cd $WORKON_HOME/env1
+    cd $WORKON_HOME/test1
+    workon .
+    assertTrue virtualenvwrapper_verify_active_environment
+    assertSame "test1" $(basename "$VIRTUAL_ENV")
+}
+
+test_workon_dot_with_space () {
+    cd $WORKON_HOME/" env with space"
     workon .
     assertTrue virtualenvwrapper_verify_active_environment
-    assertSame "env1" $(basename "$VIRTUAL_ENV")
+    env_name=$(basename "$VIRTUAL_ENV")
+    assertSame " env with space" "$env_name"
+}
+
+test_workon_with_space () {
+    workon " env with space"
+    assertTrue virtualenvwrapper_verify_active_environment
+    env_name=$(basename "$VIRTUAL_ENV")
+    assertSame " env with space" "$env_name"
 }
 
 . "$test_dir/shunit2"
diff --git a/virtualenvwrapper.sh b/virtualenvwrapper.sh
