/
test_virtualenv.py
947 lines (724 loc) · 29.5 KB
/
test_virtualenv.py
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
# Copyright 2016 Alethea Katherine Flowers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import functools
import os
import re
import shutil
import subprocess
import sys
import types
from pathlib import Path
from textwrap import dedent
from typing import NamedTuple
from unittest import mock
import pytest
from packaging import version
import nox.virtualenv
if sys.version_info < (3, 8):
import importlib_metadata as metadata
else:
from importlib import metadata
IS_WINDOWS = nox.virtualenv._SYSTEM == "Windows"
HAS_CONDA = shutil.which("conda") is not None
HAS_UV = shutil.which("uv") is not None
RAISE_ERROR = "RAISE_ERROR"
VIRTUALENV_VERSION = metadata.version("virtualenv")
has_uv = pytest.mark.skipif(not HAS_UV, reason="Missing uv command.")
has_conda = pytest.mark.skipif(not HAS_CONDA, reason="Missing conda command.")
class TextProcessResult(NamedTuple):
stdout: str
returncode: int = 0
@pytest.fixture
def make_one(tmpdir):
def factory(*args, venv_backend: str = "virtualenv", **kwargs):
location = tmpdir.join("venv")
try:
venv_fn = nox.virtualenv.ALL_VENVS[venv_backend]
except KeyError:
venv_fn = functools.partial(
nox.virtualenv.VirtualEnv, venv_backend=venv_backend
)
venv = venv_fn(location.strpath, *args, **kwargs)
return (venv, location)
return factory
@pytest.fixture
def make_conda(tmpdir):
def factory(*args, **kwargs):
location = tmpdir.join("condaenv")
venv = nox.virtualenv.CondaEnv(location.strpath, *args, **kwargs)
return (venv, location)
return factory
@pytest.fixture
def patch_sysfind(monkeypatch):
"""Provides a function to patch ``sysfind`` with parameters for tests related
to locating a Python interpreter in the system ``PATH``.
"""
def patcher(only_find, sysfind_result, sysexec_result):
"""Monkeypatches python discovery, causing specific results to be found.
Args:
only_find (Tuple[str]): The strings for which ``shutil.which`` should be successful,
e.g. ``("python", "python.exe")``
sysfind_result (Optional[str]): The ``path`` string to create the returned
mocked ``path`` object with which will represent the found Python interpreter,
or ``None``.
sysexec_result (str): A string that should be returned when executing the
mocked ``path`` object. Usually a Python version string.
Use the global ``RAISE_ERROR`` to have ``sysexec`` fail.
"""
def special_which(name, path=None):
if sysfind_result is None:
return None
if name.lower() in only_find:
return sysfind_result or name
return None
monkeypatch.setattr(shutil, "which", special_which)
def special_run(cmd, *args, **kwargs):
return TextProcessResult(sysexec_result)
monkeypatch.setattr(subprocess, "run", special_run)
return patcher
def test_process_env_constructor():
penv = nox.virtualenv.PassthroughEnv()
assert not penv.bin_paths
with pytest.raises(
ValueError, match=r"^The environment does not have a bin directory\.$"
):
print(penv.bin)
penv = nox.virtualenv.PassthroughEnv(env={"SIGIL": "123"})
assert penv.env["SIGIL"] == "123"
penv = nox.virtualenv.PassthroughEnv(bin_paths=["/bin"])
assert penv.bin == "/bin"
def test_process_env_create():
with pytest.raises(TypeError):
nox.virtualenv.ProcessEnv()
def test_invalid_venv_create(make_one):
with pytest.raises(ValueError):
make_one(venv_backend="invalid")
def test_condaenv_constructor_defaults(make_conda):
venv, _ = make_conda()
assert venv.location
assert venv.interpreter is None
assert venv.reuse_existing is False
def test_condaenv_constructor_explicit(make_conda):
venv, _ = make_conda(interpreter="3.5", reuse_existing=True)
assert venv.location
assert venv.interpreter == "3.5"
assert venv.reuse_existing is True
@has_conda
def test_condaenv_create(make_conda):
venv, dir_ = make_conda()
venv.create()
if IS_WINDOWS:
assert dir_.join("python.exe").check()
assert dir_.join("Scripts", "pip.exe").check()
assert dir_.join("Library").check()
else:
assert dir_.join("bin", "python").check()
assert dir_.join("bin", "pip").check()
assert dir_.join("lib").check()
# Test running create on an existing environment. It should be deleted.
dir_.ensure("test.txt")
venv.create()
assert not dir_.join("test.txt").check()
# Test running create on an existing environment with reuse_existing
# enabled, it should not be deleted.
dir_.ensure("test.txt")
assert dir_.join("test.txt").check()
venv.reuse_existing = True
venv.create()
assert dir_.join("test.txt").check()
assert venv._reused
@has_conda
def test_condaenv_create_with_params(make_conda):
venv, dir_ = make_conda(venv_params=["--verbose"])
venv.create()
if IS_WINDOWS:
assert dir_.join("python.exe").check()
assert dir_.join("Scripts", "pip.exe").check()
else:
assert dir_.join("bin", "python").check()
assert dir_.join("bin", "pip").check()
@has_conda
def test_condaenv_create_interpreter(make_conda):
venv, dir_ = make_conda(interpreter="3.7")
venv.create()
if IS_WINDOWS:
assert dir_.join("python.exe").check()
assert dir_.join("python37.dll").check()
assert dir_.join("python37.pdb").check()
assert not dir_.join("python37.exe").check()
else:
assert dir_.join("bin", "python").check()
assert dir_.join("bin", "python3.7").check()
@has_conda
def test_conda_env_create_verbose(make_conda):
venv, dir_ = make_conda()
with mock.patch("nox.virtualenv.nox.command.run") as mock_run:
venv.create()
args, kwargs = mock_run.call_args
assert kwargs["log"] is False
nox.options.verbose = True
with mock.patch("nox.virtualenv.nox.command.run") as mock_run:
venv.create()
args, kwargs = mock_run.call_args
assert kwargs["log"]
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
def test_condaenv_bin_windows(make_conda):
venv, dir_ = make_conda()
assert [
dir_.strpath,
dir_.join("Library", "mingw-w64", "bin").strpath,
dir_.join("Library", "usr", "bin").strpath,
dir_.join("Library", "bin").strpath,
dir_.join("Scripts").strpath,
dir_.join("bin").strpath,
] == venv.bin_paths
@has_conda
def test_condaenv_(make_conda):
venv, dir_ = make_conda()
assert not venv.is_offline()
@has_conda
def test_condaenv_detection(make_conda):
venv, dir_ = make_conda()
venv.create()
proc_result = subprocess.run(
[shutil.which("conda"), "list"],
env=venv.env,
check=True,
capture_output=True,
)
output = proc_result.stdout.decode()
path_regex = re.compile(r"packages in environment at (?P<env_dir>.+):")
assert path_regex.search(output).group("env_dir") == dir_.strpath
@has_uv
def test_uv_creation(make_one):
venv, _ = make_one(venv_backend="uv")
assert venv.location
assert venv.interpreter is None
assert venv.reuse_existing is False
assert venv.venv_backend == "uv"
venv.create()
assert venv._check_reused_environment_type()
def test_constructor_defaults(make_one):
venv, _ = make_one()
assert venv.location
assert venv.interpreter is None
assert venv.reuse_existing is False
assert venv.venv_backend == "virtualenv"
@pytest.mark.skipif(IS_WINDOWS, reason="Not testing multiple interpreters on Windows.")
def test_constructor_explicit(make_one):
venv, _ = make_one(interpreter="python3.5", reuse_existing=True)
assert venv.location
assert venv.interpreter == "python3.5"
assert venv.reuse_existing is True
def test_env(monkeypatch, make_one):
monkeypatch.setenv("SIGIL", "123")
venv, _ = make_one()
assert venv.env["SIGIL"] == "123"
assert len(venv.bin_paths) == 1
assert venv.bin_paths[0] in venv.env["PATH"]
assert venv.bin_paths[0] not in os.environ["PATH"]
def test_blacklisted_env(monkeypatch, make_one):
monkeypatch.setenv("__PYVENV_LAUNCHER__", "meep")
venv, _ = make_one()
assert len(venv.bin_paths) == 1
assert venv.bin_paths[0] == venv.bin
assert "__PYVENV_LAUNCHER__" not in venv.bin
def test__clean_location(monkeypatch, make_one):
venv, dir_ = make_one()
# Don't reuse existing, but doesn't currently exist.
# Should return True indicating that the venv needs to be created.
monkeypatch.setattr(
nox.virtualenv.VirtualEnv, "_check_reused_environment_type", mock.MagicMock()
)
monkeypatch.setattr(
nox.virtualenv.VirtualEnv,
"_check_reused_environment_interpreter",
mock.MagicMock(),
)
monkeypatch.delattr(nox.virtualenv.shutil, "rmtree")
assert not dir_.check()
assert venv._clean_location()
# Reuse existing, and currently exists.
# Should return False indicating that the venv doesn't need to be created.
dir_.mkdir()
assert dir_.check()
venv.reuse_existing = True
assert not venv._clean_location()
# Don't reuse existing, and currently exists.
# Should return True indicating the venv needs to be created.
monkeypatch.undo()
assert dir_.check()
venv.reuse_existing = False
assert venv._clean_location()
assert not dir_.check()
# Reuse existing, but doesn't exist.
# Should return True indicating the venv needs to be created.
venv.reuse_existing = True
assert venv._clean_location()
def test_bin_paths(make_one):
venv, dir_ = make_one()
assert len(venv.bin_paths) == 1
assert venv.bin_paths[0] == venv.bin
if IS_WINDOWS:
assert dir_.join("Scripts").strpath == venv.bin
else:
assert dir_.join("bin").strpath == venv.bin
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
def test_bin_windows(make_one):
venv, dir_ = make_one()
assert len(venv.bin_paths) == 1
assert venv.bin_paths[0] == venv.bin
assert dir_.join("Scripts").strpath == venv.bin
def test_create(monkeypatch, make_one):
monkeypatch.setenv("CONDA_PREFIX", "no-prefix-allowed")
monkeypatch.setenv("NOT_CONDA_PREFIX", "something-else")
venv, dir_ = make_one()
venv.create()
assert "CONDA_PREFIX" not in venv.env
assert "NOT_CONDA_PREFIX" in venv.env
if IS_WINDOWS:
assert dir_.join("Scripts", "python.exe").check()
assert dir_.join("Scripts", "pip.exe").check()
assert dir_.join("Lib").check()
else:
assert dir_.join("bin", "python").check()
assert dir_.join("bin", "pip").check()
assert dir_.join("lib").check()
# Test running create on an existing environment. It should be deleted.
dir_.ensure("test.txt")
venv.create()
assert not dir_.join("test.txt").check()
# Test running create on an existing environment with reuse_existing
# enabled, it should not be deleted.
dir_.ensure("test.txt")
assert dir_.join("test.txt").check()
venv.reuse_existing = True
venv.create()
assert venv._reused
assert dir_.join("test.txt").check()
def test_create_reuse_environment(make_one):
venv, location = make_one(reuse_existing=True)
venv.create()
reused = not venv.create()
assert reused
def test_create_reuse_environment_with_different_interpreter(make_one, monkeypatch):
# Making the reuse requirement more strict
monkeypatch.setenv("NOX_ENABLE_STALENESS_CHECK", "1")
venv, location = make_one(reuse_existing=True)
venv.create()
# Pretend that the environment was created with a different interpreter.
monkeypatch.setattr(venv, "_check_reused_environment_interpreter", lambda: False)
# Create a marker file. It should be gone after the environment is re-created.
location.join("marker").ensure()
reused = not venv.create()
assert not reused
assert not location.join("marker").check()
@has_uv
def test_create_reuse_stale_venv_environment(make_one):
venv, location = make_one(reuse_existing=True)
venv.create()
# Drop a uv-style pyvenv.cfg into the environment.
pyvenv_cfg = """\
home = /usr/bin
include-system-site-packages = false
version = 3.9.6
uv = 0.1.9
"""
location.join("pyvenv.cfg").write(dedent(pyvenv_cfg))
reused = not venv.create()
assert not reused
def test_not_stale_virtualenv_environment(make_one, monkeypatch):
# Making the reuse requirement more strict
monkeypatch.setenv("NOX_ENABLE_STALENESS_CHECK", "1")
venv, location = make_one(reuse_existing=True, venv_backend="virtualenv")
venv.create()
venv, location = make_one(reuse_existing=True, venv_backend="virtualenv")
reused = not venv.create()
assert reused
@has_conda
def test_stale_virtualenv_to_conda_environment(make_one):
venv, location = make_one(reuse_existing=True, venv_backend="virtualenv")
venv.create()
venv, location = make_one(reuse_existing=True, venv_backend="conda")
reused = not venv.create()
# The environment is not reused because it is now conda style
# environment.
assert not reused
@has_conda
def test_reuse_conda_environment(make_one):
venv, _ = make_one(reuse_existing=True, venv_backend="conda")
venv.create()
venv, _ = make_one(reuse_existing=True, venv_backend="conda")
reused = not venv.create()
assert reused
# This mocks micromamba so that it doesn't need to be installed.
@has_conda
def test_micromamba_environment(make_one, monkeypatch):
conda_path = shutil.which("conda")
which = shutil.which
monkeypatch.setattr(
shutil, "which", lambda x: conda_path if x == "micromamba" else which(x)
)
venv, _ = make_one(reuse_existing=True, venv_backend="micromamba")
run = mock.Mock()
monkeypatch.setattr(nox.command, "run", run)
venv.create()
run.assert_called_once()
# .args requires Python 3.8+
((args,), _) = run.call_args
assert args[0] == "micromamba"
assert "--channel=conda-forge" in args
# This mocks micromamba so that it doesn't need to be installed.
@pytest.mark.parametrize(
"params",
[["--channel=default"], ["-cdefault"], ["-c", "default"], ["--channel", "default"]],
)
@has_conda
def test_micromamba_channel_environment(make_one, monkeypatch, params):
conda_path = shutil.which("conda")
which = shutil.which
monkeypatch.setattr(
shutil, "which", lambda x: conda_path if x == "micromamba" else which(x)
)
venv, _ = make_one(reuse_existing=True, venv_backend="micromamba")
run = mock.Mock()
monkeypatch.setattr(nox.command, "run", run)
venv.venv_params = params
venv.create()
run.assert_called_once()
# .args requires Python 3.8+
((args,), _) = run.call_args
assert args[0] == "micromamba"
for p in params:
assert p in args
assert "--channel=conda-forge" not in args
@pytest.mark.parametrize(
("frm", "to", "result"),
[
("virtualenv", "venv", True),
("venv", "virtualenv", True),
("virtualenv", "uv", True),
pytest.param("uv", "virtualenv", False, marks=has_uv),
pytest.param("conda", "virtualenv", False, marks=has_conda),
],
)
def test_stale_environment(make_one, frm, to, result, monkeypatch):
monkeypatch.setenv("NOX_ENABLE_STALENESS_CHECK", "1")
venv, _ = make_one(reuse_existing=True, venv_backend=frm)
venv.create()
assert venv.venv_backend == frm
venv, _ = make_one(reuse_existing=True, venv_backend=to)
reused = venv._check_reused_environment_type()
assert venv.venv_backend == to
assert reused == result
def test_passthrough_environment_venv_backend(make_one):
venv, _ = make_one(venv_backend="none")
venv.create()
assert venv.venv_backend == "none"
@has_uv
def test_create_reuse_stale_virtualenv_environment(make_one, monkeypatch):
monkeypatch.setenv("NOX_ENABLE_STALENESS_CHECK", "1")
venv, location = make_one(reuse_existing=True, venv_backend="venv")
venv.create()
# Drop a uv-style pyvenv.cfg into the environment.
pyvenv_cfg = """\
home = /usr
implementation = CPython
version_info = 3.9.6.final.0
uv = 0.1.9
include-system-site-packages = false
base-prefix = /usr
base-exec-prefix = /usr
base-executable = /usr/bin/python3.9
"""
location.join("pyvenv.cfg").write(dedent(pyvenv_cfg))
reused = not venv.create()
# The environment is not reused because it does not look like a
# venv-style environment.
assert not reused
@has_uv
def test_create_reuse_uv_environment(make_one):
venv, location = make_one(reuse_existing=True, venv_backend="uv")
venv.create()
# Place a spurious occurrence of "uv" in the pyvenv.cfg.
pyvenv_cfg = location.join("pyvenv.cfg")
pyvenv_cfg.write(pyvenv_cfg.read() + "bogus = uv\n")
reused = not venv.create()
# The environment is reused because it looks like a uv environment
assert reused
UV_IN_PIPX_VENV = "/home/user/.local/pipx/venvs/nox/bin/uv"
@pytest.mark.parametrize(
["which_result", "find_uv_bin_result", "found", "path"],
[
("/usr/bin/uv", UV_IN_PIPX_VENV, True, UV_IN_PIPX_VENV),
("/usr/bin/uv", FileNotFoundError, True, "uv"),
(None, UV_IN_PIPX_VENV, True, UV_IN_PIPX_VENV),
(None, FileNotFoundError, False, "uv"),
],
)
def test_find_uv(monkeypatch, which_result, find_uv_bin_result, found, path):
def find_uv_bin():
if find_uv_bin_result is FileNotFoundError:
raise FileNotFoundError
return find_uv_bin_result
monkeypatch.setattr(shutil, "which", lambda _: which_result)
monkeypatch.setattr(Path, "samefile", lambda a, b: a == b)
monkeypatch.setitem(
sys.modules, "uv", types.SimpleNamespace(find_uv_bin=find_uv_bin)
)
assert nox.virtualenv.find_uv() == (found, path)
def test_create_reuse_venv_environment(make_one, monkeypatch):
# Making the reuse requirement more strict
monkeypatch.setenv("NOX_ENABLE_STALENESS_CHECK", "1")
venv, location = make_one(reuse_existing=True, venv_backend="venv")
venv.create()
# Place a spurious occurrence of "virtualenv" in the pyvenv.cfg.
pyvenv_cfg = location.join("pyvenv.cfg")
pyvenv_cfg.write(pyvenv_cfg.read() + "bogus = virtualenv\n")
reused = not venv.create()
# The environment should be detected as venv-style and reused.
assert reused
@pytest.mark.skipif(IS_WINDOWS, reason="Avoid 'No pyvenv.cfg file' error on Windows.")
def test_create_reuse_oldstyle_virtualenv_environment(make_one):
venv, location = make_one(reuse_existing=True)
venv.create()
pyvenv_cfg = location.join("pyvenv.cfg")
if not pyvenv_cfg.check():
pytest.skip("Requires virtualenv >= 20.0.0.")
# virtualenv < 20.0.0 does not create a pyvenv.cfg file.
pyvenv_cfg.remove()
reused = not venv.create()
# The environment is detected as virtualenv-style and reused.
assert reused
@pytest.mark.skipif(IS_WINDOWS, reason="Avoid 'No pyvenv.cfg file' error on Windows.")
def test_inner_functions_reusing_venv(make_one, monkeypatch):
monkeypatch.setenv("NOX_ENABLE_STALENESS_CHECK", "1")
venv, location = make_one(reuse_existing=True)
venv.create()
# Drop a venv-style pyvenv.cfg into the environment.
pyvenv_cfg = """\
home = /usr/bin
include-system-site-packages = false
version = 3.10
base-prefix = foo
"""
location.join("pyvenv.cfg").write(dedent(pyvenv_cfg))
base_prefix = venv._read_pyvenv_cfg()["base-prefix"]
assert base_prefix == "foo"
reused_interpreter = venv._check_reused_environment_interpreter()
# The created won't match 'foo'
assert not reused_interpreter
@pytest.mark.skipif(
version.parse(VIRTUALENV_VERSION) >= version.parse("20.22.0"),
reason="Python 2.7 unsupported for virtualenv>=20.22.0",
)
def test_create_reuse_python2_environment(make_one):
venv, location = make_one(reuse_existing=True, interpreter="2.7")
try:
venv.create()
except nox.virtualenv.InterpreterNotFound:
pytest.skip("Requires Python 2.7 installation.")
reused = not venv.create()
assert reused
def test_create_venv_backend(make_one):
venv, dir_ = make_one(venv_backend="venv")
venv.create()
@pytest.mark.skipif(IS_WINDOWS, reason="Not testing multiple interpreters on Windows.")
def test_create_interpreter(make_one):
venv, dir_ = make_one(interpreter="python3")
venv.create()
assert dir_.join("bin", "python").check()
assert dir_.join("bin", "python3").check()
def test__resolved_interpreter_none(make_one):
# Establish that the _resolved_interpreter method is a no-op if the
# interpreter is not set.
venv, _ = make_one(interpreter=None)
assert venv._resolved_interpreter == sys.executable
@pytest.mark.parametrize(
["input_", "expected"],
[
("3", "python3"),
("3.6", "python3.6"),
("3.6.2", "python3.6"),
("3.10", "python3.10"),
("2.7.15", "python2.7"),
],
)
@mock.patch("nox.virtualenv._SYSTEM", new="Linux")
@mock.patch.object(shutil, "which", return_value=True)
def test__resolved_interpreter_numerical_non_windows(which, make_one, input_, expected):
venv, _ = make_one(interpreter=input_)
assert venv._resolved_interpreter == expected
which.assert_called_once_with(expected)
@pytest.mark.parametrize("input_", ["2.", "2.7."])
@mock.patch("nox.virtualenv._SYSTEM", new="Linux")
@mock.patch.object(shutil, "which", return_value=False)
def test__resolved_interpreter_invalid_numerical_id(which, make_one, input_):
venv, _ = make_one(interpreter=input_)
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
which.assert_called_once_with(input_)
@mock.patch("nox.virtualenv._SYSTEM", new="Linux")
@mock.patch.object(shutil, "which", return_value=False)
def test__resolved_interpreter_32_bit_non_windows(which, make_one):
venv, _ = make_one(interpreter="3.6-32")
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
which.assert_called_once_with("3.6-32")
@mock.patch("nox.virtualenv._SYSTEM", new="Linux")
@mock.patch.object(shutil, "which", return_value=True)
def test__resolved_interpreter_non_windows(which, make_one):
# Establish that the interpreter is simply passed through resolution
# on non-Windows.
venv, _ = make_one(interpreter="python3.6")
assert venv._resolved_interpreter == "python3.6"
which.assert_called_once_with("python3.6")
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
@mock.patch.object(shutil, "which")
def test__resolved_interpreter_windows_full_path(which, make_one):
# Establish that if we get a fully-qualified system path (on Windows
# or otherwise) and the path exists, that we accept it.
venv, _ = make_one(interpreter=r"c:\Python36\python.exe")
which.return_value = venv.interpreter
assert venv._resolved_interpreter == r"c:\Python36\python.exe"
which.assert_called_once_with(r"c:\Python36\python.exe")
@pytest.mark.parametrize(
["input_", "expected"],
[
("3.7", r"c:\python37-x64\python.exe"),
("python3.6", r"c:\python36-x64\python.exe"),
("2.7-32", r"c:\python27\python.exe"),
],
)
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
@mock.patch.object(subprocess, "run")
@mock.patch.object(shutil, "which")
def test__resolved_interpreter_windows_pyexe(which, run, make_one, input_, expected):
# Establish that if we get a standard pythonX.Y path, we look it
# up via the py launcher on Windows.
venv, _ = make_one(interpreter=input_)
if input_ == "3.7":
input_ = "python3.7"
# Trick the system into thinking that it cannot find python3.6
# (it likely will on Unix). Also, when the system looks for the
# py launcher, give it a dummy that returns our test value when
# run.
def special_run(cmd, *args, **kwargs):
if cmd[0] == "py":
return TextProcessResult(expected)
return TextProcessResult("", 1)
run.side_effect = special_run
which.side_effect = lambda x: "py" if x == "py" else None
# Okay now run the test.
assert venv._resolved_interpreter == expected
assert which.call_count == 2
which.assert_has_calls([mock.call(input_), mock.call("py")])
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
@mock.patch.object(subprocess, "run")
@mock.patch.object(shutil, "which")
def test__resolved_interpreter_windows_pyexe_fails(which, run, make_one):
# Establish that if the py launcher fails, we give the right error.
venv, _ = make_one(interpreter="python3.6")
# Trick the nox.virtualenv._SYSTEM into thinking that it cannot find python3.6
# (it likely will on Unix). Also, when the nox.virtualenv._SYSTEM looks for the
# py launcher, give it a dummy that fails.
def special_run(cmd, *args, **kwargs):
return TextProcessResult("", 1)
run.side_effect = special_run
which.side_effect = lambda x: "py" if x == "py" else None
# Okay now run the test.
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
which.assert_has_calls([mock.call("python3.6"), mock.call("py")])
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
def test__resolved_interpreter_windows_path_and_version(make_one, patch_sysfind):
# Establish that if we get a standard pythonX.Y path, we look it
# up via the path on Windows.
venv, _ = make_one(interpreter="3.7")
# Trick the system into thinking that it cannot find
# pythonX.Y up until the python-in-path check at the end.
# Also, we don't give it a mock py launcher.
# But we give it a mock python interpreter to find
# in the system path.
correct_path = r"c:\python37-x64\python.exe"
patch_sysfind(
only_find=("python", "python.exe"),
sysfind_result=correct_path,
sysexec_result="3.7.3\\n",
)
# Okay, now run the test.
assert venv._resolved_interpreter == correct_path
@pytest.mark.parametrize("input_", ["2.7", "python3.7", "goofy"])
@pytest.mark.parametrize("sysfind_result", [r"c:\python37-x64\python.exe", None])
@pytest.mark.parametrize("sysexec_result", ["3.7.3\\n", RAISE_ERROR])
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
def test__resolved_interpreter_windows_path_and_version_fails(
input_, sysfind_result, sysexec_result, make_one, patch_sysfind
):
# Establish that if we get a standard pythonX.Y path, we look it
# up via the path on Windows.
venv, _ = make_one(interpreter=input_)
# Trick the system into thinking that it cannot find
# pythonX.Y up until the python-in-path check at the end.
# Also, we don't give it a mock py launcher.
# But we give it a mock python interpreter to find
# in the system path.
patch_sysfind(("python", "python.exe"), sysfind_result, sysexec_result)
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
@mock.patch.object(shutil, "which")
def test__resolved_interpreter_not_found(which, make_one):
# Establish that if an interpreter cannot be found at a standard
# location on Windows, we raise a useful error.
venv, _ = make_one(interpreter="python3.6")
# We are on Windows, and nothing can be found.
which.return_value = None
# Run the test.
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
@mock.patch("nox.virtualenv._SYSTEM", new="Windows")
@mock.patch("nox.virtualenv.locate_via_py", new=lambda _: None)
def test__resolved_interpreter_nonstandard(make_one):
# Establish that we do not try to resolve non-standard locations
# on Windows.
venv, _ = make_one(interpreter="goofy")
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
@mock.patch("nox.virtualenv._SYSTEM", new="Linux")
@mock.patch.object(shutil, "which", return_value=True)
def test__resolved_interpreter_cache_result(which, make_one):
venv, _ = make_one(interpreter="3.6")
assert venv._resolved is None
assert venv._resolved_interpreter == "python3.6"
which.assert_called_once_with("python3.6")
# Check the cache and call again to make sure it is used.
assert venv._resolved == "python3.6"
assert venv._resolved_interpreter == "python3.6"
assert which.call_count == 1
@mock.patch("nox.virtualenv._SYSTEM", new="Linux")
@mock.patch.object(shutil, "which", return_value=None)
def test__resolved_interpreter_cache_failure(which, make_one):
venv, _ = make_one(interpreter="3.7-32")
assert venv._resolved is None
with pytest.raises(nox.virtualenv.InterpreterNotFound) as exc_info:
print(venv._resolved_interpreter)
caught = exc_info.value
which.assert_called_once_with("3.7-32")
# Check the cache and call again to make sure it is used.
assert venv._resolved is caught
with pytest.raises(nox.virtualenv.InterpreterNotFound):
print(venv._resolved_interpreter)
assert which.call_count == 1