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
|
from __future__ import annotations
import sys
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from tox.config.cli.parser import ToxParser
from tox.config.sets import ConfigSet
from tox.pytest import ToxProjectCreator
from tox.session.state import State
def test_inline_tox_py(tox_project: ToxProjectCreator) -> None:
def plugin() -> None: # pragma: no cover # the code is copied to a python file
import logging # noqa: PLC0415
from tox.plugin import impl # noqa: PLC0415
@impl
def tox_add_option(parser: ToxParser) -> None:
logging.warning("Add magic")
parser.add_argument("--magic", action="store_true")
project = tox_project({"toxfile.py": plugin})
result = project.run("-h")
result.assert_success()
assert "--magic" in result.out
def test_toxfile_py_w_ephemeral_envs(tox_project: ToxProjectCreator) -> None:
"""Ensure additional ephemeral tox envs can be plugin-injected."""
def plugin() -> None: # pragma: no cover # the code is copied to a python file
from tox.config.loader.memory import MemoryLoader # noqa: PLC0415
from tox.plugin import impl # noqa: PLC0415
env_name = "sentinel-env-name"
@impl
def tox_extend_envs() -> tuple[str]:
return (env_name,)
@impl
def tox_add_core_config(core_conf: ConfigSet, state: State) -> None: # noqa: ARG001
in_memory_config_loader = MemoryLoader(
base=["sentinel-base"],
commands_pre=["sentinel-cmd"],
description="sentinel-description",
)
state.conf.memory_seed_loaders[env_name].append(
in_memory_config_loader, # src/tox/provision.py:provision()
)
project = tox_project({"toxfile.py": plugin})
tox_list_result = project.run("list", "-qq")
tox_list_result.assert_success()
expected_additional_env_txt = "\n\nadditional environments:\nsentinel-env-name -> sentinel-description"
assert expected_additional_env_txt in tox_list_result.out
tox_config_result = project.run("config", "-e", "sentinel-env-name", "-qq")
tox_config_result.assert_success()
assert "base = sentinel-base" in tox_config_result.out
tox_run_result = project.run("run", "-e", "sentinel-env-name", "-q")
tox_run_result.assert_failed()
underlying_expected_oserror_msg = (
"[WinError 2] The system cannot find the file specified"
if sys.platform == "win32"
else "[Errno 2] No such file or directory: 'sentinel-cmd'"
)
expected_cmd_lookup_error_txt = (
f"sentinel-env-name: Exception running subprocess {underlying_expected_oserror_msg!s}\n"
)
assert expected_cmd_lookup_error_txt in tox_run_result.out
|
