1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
|
"""Testing dirstack"""
import os
import os.path
import subprocess
import sys
import pytest
from xonsh import dirstack
from xonsh.dirstack import DIRSTACK, _unc_tempDrives
from xonsh.platform import ON_WINDOWS
HERE = os.path.abspath(os.path.dirname(__file__))
PARENT = os.path.dirname(HERE)
def drive_in_use(letter):
return ON_WINDOWS and os.system(f"vol {letter}: 2>nul>nul") == 0
MAX_TEMP_DRIVES = 4
TEMP_DRIVE = []
for d in "zyxwvuts":
if not drive_in_use(d):
TEMP_DRIVE.append(d + ":")
pytestmark = pytest.mark.skipif(
len(TEMP_DRIVE) < MAX_TEMP_DRIVES,
reason="Too many drive letters are already used by Windows to run the tests.",
)
xfail_py310 = pytest.mark.xfail(
sys.version_info >= (3, 10),
reason="throws file-not-found error (todo: fix)",
)
@pytest.fixture(scope="module")
def shares_setup(tmpdir_factory):
"""create some shares to play with on current machine.
Yield (to test case) array of structs: [uncPath, driveLetter, equivLocalPath]
Side effect: `os.chdir(TEST_WORK_DIR)`
"""
if not ON_WINDOWS:
return []
shares = [
[r"uncpushd_test_HERE", TEMP_DRIVE[1], HERE],
[r"uncpushd_test_PARENT", TEMP_DRIVE[3], PARENT],
]
for (
s,
d,
l,
) in (
shares
): # set up some shares on local machine. dirs already exist test case must invoke wd_setup.
rtn = subprocess.call(
["NET", "SHARE", s, "/delete"], universal_newlines=True
) # clean up from previous run after good, long wait.
if rtn != 0:
yield None
return
rtn = subprocess.call(["NET", "SHARE", s + "=" + l], universal_newlines=True)
if rtn != 0:
yield None
return
rtn = subprocess.call(
["NET", "USE", d, r"\\localhost" + "\\" + s], universal_newlines=True
)
if rtn != 0:
yield None
return
yield [[r"\\localhost" + "\\" + s[0], s[1], s[2]] for s in shares]
# we want to delete the test shares we've created, but can't do that if unc shares in DIRSTACK
# (left over from assert fail aborted test)
os.chdir(HERE)
for dl in _unc_tempDrives:
subprocess.call(["net", "use", dl, "/delete"], universal_newlines=True)
for _, d, _ in shares:
subprocess.call(["net", "use", d, "/delete"], universal_newlines=True)
# subprocess.call(['net', 'share', s, '/delete'], universal_newlines=True) # fails with access denied,
# unless I wait > 10 sec. see http://stackoverflow.com/questions/38448413/access-denied-in-net-share-delete
def test_pushdpopd(xession):
"""Simple non-UNC push/pop to verify we didn't break nonUNC case."""
xession.env.update(dict(CDPATH=PARENT, PWD=HERE))
dirstack.cd([PARENT])
owd = os.getcwd()
assert owd.casefold() == xession.env["PWD"].casefold()
dirstack.pushd([HERE])
wd = os.getcwd()
assert wd.casefold() == HERE.casefold()
dirstack.popd([])
assert owd.casefold() == os.getcwd().casefold(), "popd returned cwd to expected dir"
def test_cd_dot(xession):
xession.env.update(dict(PWD=os.getcwd()))
owd = os.getcwd().casefold()
dirstack.cd(["."])
assert owd == os.getcwd().casefold()
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_simple_push_pop(xession, shares_setup):
if shares_setup is None:
return
xession.env.update(dict(CDPATH=PARENT, PWD=HERE))
dirstack.cd([PARENT])
owd = os.getcwd()
assert owd.casefold() == xession.env["PWD"].casefold()
dirstack.pushd([r"\\localhost\uncpushd_test_HERE"])
wd = os.getcwd()
assert os.path.splitdrive(wd)[0].casefold() == TEMP_DRIVE[0]
assert os.path.splitdrive(wd)[1].casefold() == "\\"
dirstack.popd([])
assert owd.casefold() == os.getcwd().casefold(), "popd returned cwd to expected dir"
assert len(_unc_tempDrives) == 0
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_push_to_same_share(xession, shares_setup):
if shares_setup is None:
return
xession.env.update(dict(CDPATH=PARENT, PWD=HERE))
dirstack.cd([PARENT])
owd = os.getcwd()
assert owd.casefold() == xession.env["PWD"].casefold()
dirstack.pushd([r"\\localhost\uncpushd_test_HERE"])
wd = os.getcwd()
assert os.path.splitdrive(wd)[0].casefold() == TEMP_DRIVE[0]
assert os.path.splitdrive(wd)[1].casefold() == "\\"
assert len(_unc_tempDrives) == 1
assert len(DIRSTACK) == 1
dirstack.pushd([r"\\localhost\uncpushd_test_HERE"])
wd = os.getcwd()
assert os.path.splitdrive(wd)[0].casefold() == TEMP_DRIVE[0]
assert os.path.splitdrive(wd)[1].casefold() == "\\"
assert len(_unc_tempDrives) == 1
assert len(DIRSTACK) == 2
dirstack.popd([])
assert os.path.isdir(
TEMP_DRIVE[0] + "\\"
), "Temp drive not unmapped till last reference removed"
dirstack.popd([])
assert owd.casefold() == os.getcwd().casefold(), "popd returned cwd to expected dir"
assert len(_unc_tempDrives) == 0
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_push_other_push_same(xession, shares_setup):
"""push to a, then to b. verify drive letter is TEMP_DRIVE[2], skipping already used TEMP_DRIVE[1]
Then push to a again. Pop (check b unmapped and a still mapped), pop, pop (check a is unmapped)"""
if shares_setup is None:
return
xession.env.update(dict(CDPATH=PARENT, PWD=HERE))
dirstack.cd([PARENT])
owd = os.getcwd()
assert owd.casefold() == xession.env["PWD"].casefold()
dirstack.pushd([r"\\localhost\uncpushd_test_HERE"])
assert os.getcwd().casefold() == TEMP_DRIVE[0] + "\\"
assert len(_unc_tempDrives) == 1
assert len(DIRSTACK) == 1
dirstack.pushd([r"\\localhost\uncpushd_test_PARENT"])
os.getcwd()
assert os.getcwd().casefold() == TEMP_DRIVE[2] + "\\"
assert len(_unc_tempDrives) == 2
assert len(DIRSTACK) == 2
dirstack.pushd([r"\\localhost\uncpushd_test_HERE"])
assert os.getcwd().casefold() == TEMP_DRIVE[0] + "\\"
assert len(_unc_tempDrives) == 2
assert len(DIRSTACK) == 3
dirstack.popd([])
assert os.getcwd().casefold() == TEMP_DRIVE[2] + "\\"
assert len(_unc_tempDrives) == 2
assert len(DIRSTACK) == 2
assert os.path.isdir(TEMP_DRIVE[2] + "\\")
assert os.path.isdir(TEMP_DRIVE[0] + "\\")
dirstack.popd([])
assert os.getcwd().casefold() == TEMP_DRIVE[0] + "\\"
assert len(_unc_tempDrives) == 1
assert len(DIRSTACK) == 1
assert not os.path.isdir(TEMP_DRIVE[2] + "\\")
assert os.path.isdir(TEMP_DRIVE[0] + "\\")
dirstack.popd([])
assert os.getcwd().casefold() == owd.casefold()
assert len(_unc_tempDrives) == 0
assert len(DIRSTACK) == 0
assert not os.path.isdir(TEMP_DRIVE[2] + "\\")
assert not os.path.isdir(TEMP_DRIVE[0] + "\\")
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_push_base_push_rempath(xession):
"""push to subdir under share, verify mapped path includes subdir"""
pass
@pytest.fixture
def toggle_unc_check():
old_wval = None
def _update_key(key_type, value: int):
import winreg
old_wval = 0
with dirstack._win_reg_key(
key_type,
r"software\microsoft\command processor",
access=winreg.KEY_WRITE,
) as key:
try:
wval, wtype = winreg.QueryValueEx(key, "DisableUNCCheck")
old_wval = wval # if values was defined at all
except OSError:
pass
winreg.SetValueEx(key, "DisableUNCCheck", None, winreg.REG_DWORD, value)
return old_wval
def update(value: int):
import winreg
for key_type in (winreg.HKEY_CURRENT_USER, winreg.HKEY_LOCAL_MACHINE):
try:
return _update_key(key_type, value)
except OSError:
pass
def wrapper(value: int):
nonlocal old_wval
old_wval = update(value) or 0
return old_wval
yield wrapper
# revert back to old value
if old_wval is not None:
update(old_wval)
@pytest.fixture()
def with_unc_check_enabled(toggle_unc_check):
return toggle_unc_check(1)
@pytest.fixture()
def with_unc_check_disabled(toggle_unc_check):
return toggle_unc_check(0)
@pytest.fixture()
def xonsh_builtins_cd(xession):
xession.env["CDPATH"] = PARENT
xession.env["PWD"] = os.getcwd()
xession.env["DIRSTACK_SIZE"] = 20
return xession
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_cd_unc_auto_pushd(xonsh_builtins_cd, with_unc_check_enabled):
xonsh_builtins_cd.env["AUTO_PUSHD"] = True
so, se, rc = dirstack.cd([r"\\localhost\uncpushd_test_PARENT"])
if rc != 0:
return
assert os.getcwd().casefold() == TEMP_DRIVE[0] + "\\"
assert len(DIRSTACK) == 1
assert os.path.isdir(TEMP_DRIVE[0] + "\\")
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_cd_unc_nocheck(xonsh_builtins_cd, with_unc_check_disabled):
if with_unc_check_disabled == 0:
return
dirstack.cd([r"\\localhost\uncpushd_test_HERE"])
assert os.getcwd().casefold() == r"\\localhost\uncpushd_test_here"
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_cd_unc_no_auto_pushd(xonsh_builtins_cd, with_unc_check_enabled):
if with_unc_check_enabled == 0:
return
so, se, rc = dirstack.cd([r"\\localhost\uncpushd_test_PARENT"])
assert rc != 0
assert so is None or len(so) == 0
assert "disableunccheck" in se.casefold() and "auto_pushd" in se.casefold()
@pytest.mark.skipif(not ON_WINDOWS, reason="Windows-only UNC functionality")
def test_uncpushd_unc_check():
# emminently suited to mocking, but I don't know how
# need to verify unc_check_enabled correct whether values set in HKCU or HKLM
pass
|