/
test_main.py
673 lines (548 loc) · 21.2 KB
/
test_main.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
# 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.
import contextlib
import os
import sys
from pathlib import Path
from unittest import mock
import pytest
import nox
import nox.__main__
import nox._options
import nox.registry
import nox.sessions
try:
import importlib.metadata as metadata
except ImportError:
import importlib_metadata as metadata
RESOURCES = os.path.join(os.path.dirname(__file__), "resources")
VERSION = metadata.version("nox")
# This is needed because CI systems will mess up these tests due to the
# way nox handles the --session parameter's default value. This avoids that
# mess.
os.environ.pop("NOXSESSION", None)
def test_main_no_args(monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the config looks correct.
config = execute.call_args[1]["global_config"]
assert config.noxfile == "noxfile.py"
assert config.sessions is None
assert not config.no_venv
assert not config.reuse_existing_virtualenvs
assert not config.stop_on_first_error
assert config.posargs == []
def test_main_long_form_args():
sys.argv = [
sys.executable,
"--noxfile",
"noxfile.py",
"--envdir",
".other",
"--sessions",
"1",
"2",
"--default-venv-backend",
"venv",
"--force-venv-backend",
"none",
"--no-venv",
"--reuse-existing-virtualenvs",
"--stop-on-first-error",
]
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the config looks correct.
config = execute.call_args[1]["global_config"]
assert config.noxfile == "noxfile.py"
assert config.envdir.endswith(".other")
assert config.sessions == ["1", "2"]
assert config.default_venv_backend == "venv"
assert config.force_venv_backend == "none"
assert config.no_venv is True
assert config.reuse_existing_virtualenvs is True
assert config.stop_on_first_error is True
assert config.posargs == []
def test_main_no_venv(monkeypatch, capsys):
# Check that --no-venv overrides force_venv_backend
monkeypatch.setattr(
sys,
"argv",
[
"nox",
"--noxfile",
os.path.join(RESOURCES, "noxfile_pythons.py"),
"--no-venv",
"-s",
"snack(cheese='cheddar')",
],
)
with mock.patch("sys.exit") as sys_exit:
nox.__main__.main()
stdout, stderr = capsys.readouterr()
assert stdout == "Noms, cheddar so good!\n"
assert (
"Session snack is set to run with venv_backend='none', IGNORING its python"
in stderr
)
assert "Session snack(cheese='cheddar') was successful." in stderr
sys_exit.assert_called_once_with(0)
def test_main_no_venv_error():
# Check that --no-venv can not be set together with a non-none --force-venv-backend
sys.argv = [
sys.executable,
"--noxfile",
"noxfile.py",
"--force-venv-backend",
"conda",
"--no-venv",
]
with pytest.raises(ValueError, match="You can not use"):
nox.__main__.main()
def test_main_short_form_args(monkeypatch):
monkeypatch.setattr(
sys,
"argv",
[
sys.executable,
"-f",
"noxfile.py",
"-s",
"1",
"2",
"-db",
"venv",
"-fb",
"conda",
"-r",
],
)
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the config looks correct.
config = execute.call_args[1]["global_config"]
assert config.noxfile == "noxfile.py"
assert config.sessions == ["1", "2"]
assert config.default_venv_backend == "venv"
assert config.force_venv_backend == "conda"
assert config.reuse_existing_virtualenvs is True
def test_main_explicit_sessions(monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable, "-e", "1", "2"])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the explicit sessions are listed in the config.
config = execute.call_args[1]["global_config"]
assert config.sessions == ["1", "2"]
def test_main_explicit_sessions_with_spaces_in_names(monkeypatch):
monkeypatch.setattr(
sys, "argv", [sys.executable, "-e", "unit tests", "the unit tests"]
)
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the explicit sessions are listed in the config.
config = execute.call_args[1]["global_config"]
assert config.sessions == ["unit tests", "the unit tests"]
@pytest.mark.parametrize(
"env,sessions", [("foo", ["foo"]), ("foo,bar", ["foo", "bar"])]
)
def test_main_session_from_nox_env_var(monkeypatch, env, sessions):
monkeypatch.setenv("NOXSESSION", env)
monkeypatch.setattr(sys, "argv", [sys.executable])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the sessions from the env var are listed in the config.
config = execute.call_args[1]["global_config"]
assert len(config.sessions) == len(sessions)
for session in sessions:
assert session in config.sessions
def test_main_positional_args(capsys, monkeypatch):
fake_exit = mock.Mock(side_effect=ValueError("asdf!"))
monkeypatch.setattr(sys, "argv", [sys.executable, "1", "2", "3"])
with mock.patch.object(sys, "exit", fake_exit), pytest.raises(
ValueError, match="asdf!"
):
nox.__main__.main()
_, stderr = capsys.readouterr()
assert "Unknown argument(s) '1 2 3'" in stderr
fake_exit.assert_called_once_with(2)
fake_exit.reset_mock()
monkeypatch.setattr(sys, "argv", [sys.executable, "1", "2", "3", "--"])
with mock.patch.object(sys, "exit", fake_exit), pytest.raises(
ValueError, match="asdf!"
):
nox.__main__.main()
_, stderr = capsys.readouterr()
assert "Unknown argument(s) '1 2 3'" in stderr
fake_exit.assert_called_once_with(2)
def test_main_positional_with_double_hyphen(monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable, "--", "1", "2", "3"])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the positional args are listed in the config.
config = execute.call_args[1]["global_config"]
assert config.posargs == ["1", "2", "3"]
def test_main_positional_flag_like_with_double_hyphen(monkeypatch):
monkeypatch.setattr(
sys, "argv", [sys.executable, "--", "1", "2", "3", "-f", "--baz"]
)
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(0)
assert execute.called
# Verify that the positional args are listed in the config.
config = execute.call_args[1]["global_config"]
assert config.posargs == ["1", "2", "3", "-f", "--baz"]
def test_main_version(capsys, monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable, "--version"])
with contextlib.ExitStack() as stack:
execute = stack.enter_context(mock.patch("nox.workflow.execute"))
exit_mock = stack.enter_context(mock.patch("sys.exit"))
nox.__main__.main()
_, err = capsys.readouterr()
assert VERSION in err
exit_mock.assert_not_called()
execute.assert_not_called()
def test_main_help(capsys, monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable, "--help"])
with contextlib.ExitStack() as stack:
execute = stack.enter_context(mock.patch("nox.workflow.execute"))
exit_mock = stack.enter_context(mock.patch("sys.exit"))
nox.__main__.main()
out, _ = capsys.readouterr()
assert "help" in out
exit_mock.assert_not_called()
execute.assert_not_called()
def test_main_failure(monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 1
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_once_with(1)
def test_main_nested_config(capsys, monkeypatch):
monkeypatch.setattr(
sys,
"argv",
[
"nox",
"--noxfile",
os.path.join(RESOURCES, "noxfile_nested.py"),
"-s",
"snack(cheese='cheddar')",
],
)
with mock.patch("sys.exit") as sys_exit:
nox.__main__.main()
stdout, stderr = capsys.readouterr()
assert stdout == "Noms, cheddar so good!\n"
assert "Session snack(cheese='cheddar') was successful." in stderr
sys_exit.assert_called_once_with(0)
def test_main_session_with_names(capsys, monkeypatch):
monkeypatch.setattr(
sys,
"argv",
[
"nox",
"--noxfile",
os.path.join(RESOURCES, "noxfile_spaces.py"),
"-s",
"cheese list(cheese='cheddar')",
],
)
with mock.patch("sys.exit") as sys_exit:
nox.__main__.main()
stdout, stderr = capsys.readouterr()
assert stdout == "Noms, cheddar so good!\n"
assert "Session cheese list(cheese='cheddar') was successful." in stderr
sys_exit.assert_called_once_with(0)
@pytest.fixture
def run_nox(capsys, monkeypatch):
def _run_nox(*args):
monkeypatch.setattr(sys, "argv", ["nox", *args])
with mock.patch("sys.exit") as sys_exit:
nox.__main__.main()
stdout, stderr = capsys.readouterr()
returncode = sys_exit.call_args[0][0]
return returncode, stdout, stderr
return _run_nox
@pytest.mark.parametrize(
("normalized_name", "session"),
[
("test(arg='Jane')", "test(arg='Jane')"),
("test(arg='Jane')", 'test(arg="Jane")'),
("test(arg='Jane')", 'test(arg = "Jane")'),
("test(arg='Jane')", 'test ( arg = "Jane" )'),
('test(arg="Joe\'s")', 'test(arg="Joe\'s")'),
('test(arg="Joe\'s")', "test(arg='Joe\\'s')"),
("test(arg='\"hello world\"')", "test(arg='\"hello world\"')"),
("test(arg='\"hello world\"')", 'test(arg="\\"hello world\\"")'),
("test(arg=[42])", "test(arg=[42])"),
("test(arg=[42])", "test(arg=[42,])"),
("test(arg=[42])", "test(arg=[ 42 ])"),
("test(arg=[42])", "test(arg=[0x2a])"),
(
"test(arg=datetime.datetime(1980, 1, 1, 0, 0))",
"test(arg=datetime.datetime(1980, 1, 1, 0, 0))",
),
(
"test(arg=datetime.datetime(1980, 1, 1, 0, 0))",
"test(arg=datetime.datetime(1980,1,1,0,0))",
),
(
"test(arg=datetime.datetime(1980, 1, 1, 0, 0))",
"test(arg=datetime.datetime(1980, 1, 1, 0, 0x0))",
),
],
)
def test_main_with_normalized_session_names(run_nox, normalized_name, session):
noxfile = os.path.join(RESOURCES, "noxfile_normalization.py")
returncode, _, stderr = run_nox(f"--noxfile={noxfile}", f"--session={session}")
assert returncode == 0
assert normalized_name in stderr
@pytest.mark.parametrize(
"session",
[
"syntax error",
"test(arg=Jane)",
"test(arg='Jane ')",
"_test(arg='Jane')",
"test(arg=42)",
"test(arg=[42.0])",
"test(arg=[43])",
"test(arg=<user_nox_module.Foo object at 0x123456789abc>)",
"test(arg=datetime.datetime(1980, 1, 1))",
],
)
def test_main_with_bad_session_names(run_nox, session):
noxfile = os.path.join(RESOURCES, "noxfile_normalization.py")
returncode, _, stderr = run_nox(f"--noxfile={noxfile}", f"--session={session}")
assert returncode != 0
assert session in stderr
def test_main_noxfile_options(monkeypatch):
monkeypatch.setattr(
sys,
"argv",
[
"nox",
"-l",
"-s",
"test",
"--noxfile",
os.path.join(RESOURCES, "noxfile_options.py"),
],
)
with mock.patch("nox.tasks.honor_list_request") as honor_list_request:
honor_list_request.return_value = 0
with mock.patch("sys.exit"):
nox.__main__.main()
assert honor_list_request.called
# Verify that the config looks correct.
config = honor_list_request.call_args[1]["global_config"]
assert config.reuse_existing_virtualenvs is True
def test_main_noxfile_options_disabled_by_flag(monkeypatch):
monkeypatch.setattr(
sys,
"argv",
[
"nox",
"-l",
"-s",
"test",
"--no-reuse-existing-virtualenvs",
"--noxfile",
os.path.join(RESOURCES, "noxfile_options.py"),
],
)
with mock.patch("nox.tasks.honor_list_request") as honor_list_request:
honor_list_request.return_value = 0
with mock.patch("sys.exit"):
nox.__main__.main()
assert honor_list_request.called
# Verify that the config looks correct.
config = honor_list_request.call_args[1]["global_config"]
assert config.reuse_existing_virtualenvs is False
def test_main_noxfile_options_sessions(monkeypatch):
monkeypatch.setattr(
sys,
"argv",
["nox", "-l", "--noxfile", os.path.join(RESOURCES, "noxfile_options.py")],
)
with mock.patch("nox.tasks.honor_list_request") as honor_list_request:
honor_list_request.return_value = 0
with mock.patch("sys.exit"):
nox.__main__.main()
assert honor_list_request.called
# Verify that the config looks correct.
config = honor_list_request.call_args[1]["global_config"]
assert config.sessions == ["test"]
@pytest.fixture
def generate_noxfile_options_pythons(tmp_path):
"""Generate noxfile.py with test and launch_rocket sessions.
The sessions are defined for both the default and alternate Python versions.
The ``default_session`` and ``default_python`` parameters determine what
goes into ``nox.options.sessions`` and ``nox.options.pythons``, respectively.
"""
def generate_noxfile(default_session, default_python, alternate_python):
path = Path(RESOURCES) / "noxfile_options_pythons.py"
text = path.read_text()
text = text.format(
default_session=default_session,
default_python=default_python,
alternate_python=alternate_python,
)
path = tmp_path / "noxfile.py"
path.write_text(text)
return str(path)
return generate_noxfile
python_current_version = f"{sys.version_info.major}.{sys.version_info.minor}"
python_next_version = f"{sys.version_info.major}.{sys.version_info.minor + 1}"
def test_main_noxfile_options_with_pythons_override(
capsys, monkeypatch, generate_noxfile_options_pythons
):
noxfile = generate_noxfile_options_pythons(
default_session="test",
default_python=python_next_version,
alternate_python=python_current_version,
)
monkeypatch.setattr(
sys, "argv", ["nox", "--noxfile", noxfile, "--python", python_current_version]
)
with mock.patch("sys.exit") as sys_exit:
nox.__main__.main()
_, stderr = capsys.readouterr()
sys_exit.assert_called_once_with(0)
for python_version in [python_current_version, python_next_version]:
for session in ["test", "launch_rocket"]:
line = f"Running session {session}-{python_version}"
if session == "test" and python_version == python_current_version:
assert line in stderr
else:
assert line not in stderr
def test_main_noxfile_options_with_sessions_override(
capsys, monkeypatch, generate_noxfile_options_pythons
):
noxfile = generate_noxfile_options_pythons(
default_session="test",
default_python=python_current_version,
alternate_python=python_next_version,
)
monkeypatch.setattr(
sys, "argv", ["nox", "--noxfile", noxfile, "--session", "launch_rocket"]
)
with mock.patch("sys.exit") as sys_exit:
nox.__main__.main()
_, stderr = capsys.readouterr()
sys_exit.assert_called_once_with(0)
for python_version in [python_current_version, python_next_version]:
for session in ["test", "launch_rocket"]:
line = f"Running session {session}-{python_version}"
if session == "launch_rocket" and python_version == python_current_version:
assert line in stderr
else:
assert line not in stderr
@pytest.mark.parametrize(("isatty_value", "expected"), [(True, True), (False, False)])
def test_main_color_from_isatty(monkeypatch, isatty_value, expected):
monkeypatch.delenv("FORCE_COLOR", raising=False)
monkeypatch.setattr(sys, "argv", [sys.executable])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
with mock.patch("sys.stdout.isatty") as isatty:
isatty.return_value = isatty_value
# Call the main function.
with mock.patch.object(sys, "exit"):
nox.__main__.main()
config = execute.call_args[1]["global_config"]
assert config.color == expected
@pytest.mark.parametrize(
("color_opt", "expected"),
[
("--forcecolor", True),
("--nocolor", False),
("--force-color", True),
("--no-color", False),
],
)
def test_main_color_options(monkeypatch, color_opt, expected):
monkeypatch.delenv("FORCE_COLOR", raising=False)
monkeypatch.setattr(sys, "argv", [sys.executable, color_opt])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 0
# Call the main function.
with mock.patch.object(sys, "exit"):
nox.__main__.main()
config = execute.call_args[1]["global_config"]
assert config.color == expected
def test_main_color_conflict(capsys, monkeypatch):
monkeypatch.setattr(sys, "argv", [sys.executable, "--forcecolor", "--nocolor"])
with mock.patch("nox.workflow.execute") as execute:
execute.return_value = 1
# Call the main function.
with mock.patch.object(sys, "exit") as exit:
nox.__main__.main()
exit.assert_called_with(1)
_, err = capsys.readouterr()
assert "color" in err
def test_main_force_python(monkeypatch):
monkeypatch.setattr(sys, "argv", ["nox", "--force-python=3.10"])
with mock.patch("nox.workflow.execute", return_value=0) as execute:
with mock.patch.object(sys, "exit"):
nox.__main__.main()
config = execute.call_args[1]["global_config"]
assert config.pythons == config.extra_pythons == ["3.10"]
def test_main_reuse_existing_virtualenvs_no_install(monkeypatch):
monkeypatch.setattr(sys, "argv", ["nox", "-R"])
with mock.patch("nox.workflow.execute", return_value=0) as execute:
with mock.patch.object(sys, "exit"):
nox.__main__.main()
config = execute.call_args[1]["global_config"]
assert config.reuse_existing_virtualenvs and config.no_install