test(conftest): add utilities "bash_{save,restore}_variable(bash,var)"

Author: akinomyoga

test/t/conftest.py

@@ -329,7 +329,6 @@ def load_completion_for(bash: pexpect.spawn, cmd: str) -> bool:
         return False
     return True
 
-
 def assert_bash_exec(
     bash: pexpect.spawn,
     cmd: str,
@@ -386,6 +385,24 @@ def assert_bash_exec(
 
     return output
 
+def _bash_copy_variable(bash: pexpect.spawn, src_var: str, dst_var: str):
+    assert_bash_exec(
+        bash,
+        "if [[ ${%s+set} ]]; then %s=${%s}; else unset -v %s; fi"
+        % (src_var, dst_var, src_var, dst_var)
+    )
+
+def bash_save_variable(
+    bash: pexpect.spawn,
+    varname: str,
+    new_value: Optional[str] = None
+):
+    _bash_copy_variable(bash, varname, "_bash_completion_test_" + varname)
+    if new_value:
+        assert_bash_exec(bash, "%s=%s" % (varname, shlex.quote(str(new_value))))
+
+def bash_restore_variable(bash: pexpect.spawn, varname: str):
+    _bash_copy_variable(bash, "_bash_completion_test_" + varname, varname)
 
 def get_env(bash: pexpect.spawn) -> List[str]:
     return [
@@ -499,11 +516,7 @@ def assert_complete(
             pytest.xfail(xfail)
     cwd = kwargs.get("cwd")
     if cwd:
-        assert_bash_exec(
-            bash,
-            "if [[ ${OLDPWD+set} ]]; then _bash_completion_test_OLDPWD=$OLDPWD; else unset -v _bash_completion_test_OLDPWD; fi",
-            want_output=None,
-        )
+        bash_save_variable(bash, "OLDPWD")
         assert_bash_exec(bash, "cd '%s'" % cwd)
     env_prefix = "_BASHCOMP_TEST_"
     env = kwargs.get("env", {})
@@ -568,11 +581,7 @@ def assert_complete(
             )
         if cwd:
             assert_bash_exec(bash, "cd - >/dev/null")
-            assert_bash_exec(
-                bash,
-                "if [[ ${_bash_completion_test_OLDPWD+set} ]]; then OLDPWD=$_bash_completion_test_OLDPWD; else unset -v OLDPWD; fi",
-                want_output=None,
-            )
+            bash_restore_variable(bash, "OLDPWD")
     return result
 
 

test/t/test_man.py

@@ -1,6 +1,6 @@
 import pytest
 
-from conftest import assert_bash_exec, assert_complete, prepare_fixture_dir
+from conftest import assert_bash_exec, assert_complete, prepare_fixture_dir, bash_save_variable, bash_restore_variable
 
 
 @pytest.mark.bashcomp(
@@ -103,15 +103,10 @@ def test_9(self, bash, completion):
 
     @pytest.mark.complete(require_cmd=True)
     def test_10(self, request, bash, colonpath):
-        assert_bash_exec(
-            bash,
-            'manpath=${MANPATH-}; export MANPATH="%s:%s/man"'
-            % (TestMan.manpath, colonpath),
-        )
-        request.addfinalizer(
-            lambda: assert_bash_exec(bash, "MANPATH=$manpath")
-        )
+        bash_save_variable(bash, "MANPATH", "%s:%s/man" % (TestMan.manpath, colonpath))
+        assert_bash_exec(bash, 'export MANPATH')
         completion = assert_complete(bash, "man Bash::C")
+        bash_restore_variable(bash, "MANPATH")
         assert completion == "ompletion"
 
     @pytest.mark.complete("man -", require_cmd=True)

test/t/unit/test_unit_known_hosts_real.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from conftest import assert_bash_exec
+from conftest import assert_bash_exec, bash_save_variable, bash_restore_variable
 
 
 @pytest.mark.bashcomp(
@@ -126,27 +126,20 @@ def test_included_configs(self, bash, hosts):
         # fixtures/_known_hosts_real/.ssh/config_question_mark
         expected.append("question_mark")
 
-        assert_bash_exec(
-            bash, 'OLDHOME="$HOME"; HOME="%s/_known_hosts_real"' % bash.cwd
-        )
+        bash_save_variable(bash, "HOME", "%s/_known_hosts_real" % bash.cwd)
         output = assert_bash_exec(
             bash,
             "unset -v COMPREPLY COMP_KNOWN_HOSTS_WITH_HOSTFILE; "
             "_known_hosts_real -aF _known_hosts_real/config_include ''; "
             r'printf "%s\n" "${COMPREPLY[@]}"',
             want_output=True,
         )
-        assert_bash_exec(bash, 'HOME="$OLDHOME"')
+        bash_restore_variable(bash, "HOME")
         assert sorted(set(output.strip().split())) == sorted(expected)
 
     def test_no_globbing(self, bash):
-        assert_bash_exec(
-            bash, 'OLDHOME="$HOME"; HOME="%s/_known_hosts_real"' % bash.cwd
-        )
-        assert_bash_exec(
-            bash,
-            "if [[ ${OLDPWD+set} ]]; then _bash_completion_test_OLDPWD=$OLDPWD; else unset -v _bash_completion_test_OLDPWD; fi",
-        )
+        bash_save_variable(bash, "HOME", "%s/_known_hosts_real" % bash.cwd)
+        bash_save_variable(bash, "OLDPWD")
         output = assert_bash_exec(
             bash,
             "cd _known_hosts_real; "
@@ -156,11 +149,8 @@ def test_no_globbing(self, bash):
             "cd - &>/dev/null",
             want_output=True,
         )
-        assert_bash_exec(
-            bash,
-            "if [[ ${_bash_completion_test_OLDPWD+set} ]]; then OLDPWD=$_bash_completion_test_OLDPWD; else unset -v OLDPWD; fi",
-        )
-        assert_bash_exec(bash, 'HOME="$OLDHOME"')
+        bash_restore_variable(bash, "OLDPWD")
+        bash_restore_variable(bash, "HOME")
         completion = sorted(set(output.strip().split()))
         assert "gee" in completion
         assert "gee-filename-canary" not in completion