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
|
from __future__ import annotations
import sys
from typing import TYPE_CHECKING
import pytest
from tox.config.cli.parse import get_options
from tox.session.env_select import _DYNAMIC_ENV_FACTORS, CliEnv, EnvSelector # noqa: PLC2701
from tox.session.state import State
if TYPE_CHECKING:
from tox.pytest import MonkeyPatch, ToxProjectCreator
CURRENT_PY_ENV = f"py{sys.version_info[0]}{sys.version_info[1]}" # e.g. py310
@pytest.mark.parametrize(
("user_input", "env_names", "is_all", "is_default"),
[
(None, (), False, True),
("", (), False, True),
("a1", ("a1",), False, False),
("a1,b2,c3", ("a1", "b2", "c3"), False, False),
(" a1, b2 , c3 ", ("a1", "b2", "c3"), False, False),
# If the user gives "ALL" as any envname, this becomes an "is_all" and other envnames are ignored.
("ALL", (), True, False),
("a1,ALL,b2", (), True, False),
# Zero-length envnames are ignored as being not present. This is not intentional.
(",,a1,,,b2,,", ("a1", "b2"), False, False),
(",,", (), False, True),
# Environment names with "invalid" characters are accepted here; the client is expected to deal with this.
("\x01.-@\x02,xxx", ("\x01.-@\x02", "xxx"), False, False),
# Brace expansion produces the cartesian product of factors.
(
"py{38,39}-pytest{6.x,7.x}",
("py38-pytest6.x", "py38-pytest7.x", "py39-pytest6.x", "py39-pytest7.x"),
False,
False,
),
("a{1,2},b", ("a1", "a2", "b"), False, False),
],
)
def test_clienv(user_input: str, env_names: tuple[str], is_all: bool, is_default: bool) -> None:
ce = CliEnv(user_input)
assert (ce.is_all, ce.is_default_list, tuple(ce)) == (is_all, is_default, tuple(env_names))
assert CliEnv(user_input) == ce
@pytest.mark.parametrize(
("user_input", "expected"),
[
("", False),
("all", False),
("All", False),
("ALL", True),
("a,ALL,b", True),
],
)
def test_clienv_is_all(user_input: str, expected: bool) -> None:
assert CliEnv(user_input).is_all is expected
def test_clienv_iadd() -> None:
cli_env = CliEnv("a,b")
cli_env += CliEnv("c,d")
assert list(cli_env) == ["a", "b", "c", "d"]
def test_clienv_iadd_from_default() -> None:
cli_env = CliEnv()
cli_env += CliEnv("c")
assert list(cli_env) == ["c"]
def test_clienv_iadd_noop() -> None:
cli_env = CliEnv("a")
cli_env += CliEnv()
assert list(cli_env) == ["a"]
def test_env_select_lazily_looks_at_envs() -> None:
state = State(get_options(), [])
env_selector = EnvSelector(state)
# late-assigning env should be reflected in env_selector
state.conf.options.env = CliEnv("py")
assert set(env_selector.iter()) == {"py"}
def test_label_core_can_define(tox_project: ToxProjectCreator) -> None:
ini = """
[tox]
labels =
test = py3{10,9}
static = flake8, type
"""
project = tox_project({"tox.ini": ini})
outcome = project.run("l", "--no-desc")
outcome.assert_success()
outcome.assert_out_err("py\npy310\npy39\nflake8\ntype\n", "")
def test_label_core_select(tox_project: ToxProjectCreator) -> None:
ini = """
[tox]
labels =
test = py3{10,9}
static = flake8, type
"""
project = tox_project({"tox.ini": ini})
outcome = project.run("l", "--no-desc", "-m", "test")
outcome.assert_success()
outcome.assert_out_err("py310\npy39\n", "")
def test_label_select_trait(tox_project: ToxProjectCreator) -> None:
ini = """
[tox]
env_list = py310, py39, flake8, type
[testenv]
labels = test
[testenv:flake8]
labels = static
[testenv:type]
labels = static
"""
project = tox_project({"tox.ini": ini})
outcome = project.run("l", "--no-desc", "-m", "test")
outcome.assert_success()
outcome.assert_out_err("py310\npy39\n", "")
def test_label_core_and_trait(tox_project: ToxProjectCreator) -> None:
ini = """
[tox]
env_list = py310, py39, flake8, type
labels =
static = flake8, type
[testenv]
labels = test
"""
project = tox_project({"tox.ini": ini})
outcome = project.run("l", "--no-desc", "-m", "test", "static")
outcome.assert_success()
outcome.assert_out_err("py310\npy39\nflake8\ntype\n", "")
@pytest.mark.parametrize(
("selection_arguments", "expect_envs"),
[
(
("-f", "cov", "django20"),
("py310-django20-cov", "py39-django20-cov"),
),
(
("-f", "cov-django20"),
("py310-django20-cov", "py39-django20-cov"),
),
(
("-f", "py39", "django20", "-f", "py310", "django21"),
("py310-django21-cov", "py310-django21", "py39-django20-cov", "py39-django20"),
),
],
)
def test_factor_select(
tox_project: ToxProjectCreator,
selection_arguments: tuple[str, ...],
expect_envs: tuple[str, ...],
) -> None:
ini = """
[tox]
env_list = py3{10,9}-{django20,django21}{-cov,}
"""
project = tox_project({"tox.ini": ini})
outcome = project.run("l", "--no-desc", *selection_arguments)
outcome.assert_success()
outcome.assert_out_err("{}\n".format("\n".join(expect_envs)), "")
@pytest.mark.parametrize(
("env_value", "expect_envs"),
[
("cov", ("py310-django20-cov", "py310-django21-cov", "py39-django20-cov", "py39-django21-cov")),
("py39,django20", ("py39-django20-cov", "py39-django20")),
(
"py39;py310",
(
"py310-django20-cov",
"py310-django20",
"py310-django21-cov",
"py310-django21",
"py39-django20-cov",
"py39-django20",
"py39-django21-cov",
"py39-django21",
),
),
],
)
def test_factor_select_via_env_var(
tox_project: ToxProjectCreator,
monkeypatch: MonkeyPatch,
env_value: str,
expect_envs: tuple[str, ...],
) -> None:
ini = """
[tox]
env_list = py3{10,9}-{django20,django21}{-cov,}
"""
monkeypatch.setenv("TOX_FACTORS", env_value)
project = tox_project({"tox.ini": ini})
outcome = project.run("l", "--no-desc")
outcome.assert_success()
outcome.assert_out_err("{}\n".format("\n".join(expect_envs)), "")
def test_tox_skip_env(tox_project: ToxProjectCreator, monkeypatch: MonkeyPatch) -> None:
monkeypatch.setenv("TOX_SKIP_ENV", "m[y]py")
project = tox_project({"tox.ini": "[tox]\nenv_list = py3{10,9},mypy"})
outcome = project.run("l", "--no-desc", "-q")
outcome.assert_success()
outcome.assert_out_err("py310\npy39\n", "")
def test_tox_skip_env_cli(tox_project: ToxProjectCreator, monkeypatch: MonkeyPatch) -> None:
monkeypatch.delenv("TOX_SKIP_ENV", raising=False)
project = tox_project({"tox.ini": "[tox]\nenv_list = py3{10,9},mypy"})
outcome = project.run("l", "--no-desc", "-q", "--skip-env", "m[y]py")
outcome.assert_success()
outcome.assert_out_err("py310\npy39\n", "")
def test_tox_skip_env_logs(tox_project: ToxProjectCreator, monkeypatch: MonkeyPatch) -> None:
monkeypatch.setenv("TOX_SKIP_ENV", "m[y]py")
project = tox_project({"tox.ini": "[tox]\nenv_list = py3{10,9},mypy"})
outcome = project.run("l", "--no-desc")
outcome.assert_success()
outcome.assert_out_err("ROOT: skip environment mypy, matches filter 'm[y]py'\npy310\npy39\n", "")
def test_multiple_e_flags_are_additive(tox_project: ToxProjectCreator) -> None:
proj = tox_project({"tox.ini": "[tox]\nenv_list=a,b,c"})
outcome = proj.run("c", "-e", "a", "-e", "b", "-k", "env_name")
outcome.assert_success()
assert "[testenv:a]" in outcome.out
assert "[testenv:b]" in outcome.out
assert "[testenv:c]" not in outcome.out
def test_cli_env_can_be_specified_in_default(tox_project: ToxProjectCreator) -> None:
proj = tox_project({"tox.ini": "[tox]\nenv_list=exists"})
outcome = proj.run("r", "-e", "exists")
outcome.assert_success()
assert "exists" in outcome.out
assert not outcome.err
def test_cli_env_can_be_specified_in_additional_environments(tox_project: ToxProjectCreator) -> None:
proj = tox_project({"tox.ini": "[testenv:exists]"})
outcome = proj.run("r", "-e", "exists")
outcome.assert_success()
assert "exists" in outcome.out
assert not outcome.err
@pytest.mark.parametrize("env_name", ["py", CURRENT_PY_ENV, ".pkg"])
def test_allowed_implicit_cli_envs(env_name: str, tox_project: ToxProjectCreator) -> None:
proj = tox_project({"tox.ini": ""})
outcome = proj.run("r", "-e", env_name)
outcome.assert_success()
assert env_name in outcome.out
assert not outcome.err
@pytest.mark.parametrize("env_name", ["a", "b", "a-b", "b-a"])
def test_matches_hyphenated_env(env_name: str, tox_project: ToxProjectCreator) -> None:
tox_ini = """
[tox]
env_list=a-b
[testenv]
package=skip
commands_pre =
a: python -c 'print("a")'
b: python -c 'print("b")'
commands=python -c 'print("ok")'
"""
proj = tox_project({"tox.ini": tox_ini})
outcome = proj.run("r", "-e", env_name)
outcome.assert_success()
assert env_name in outcome.out
assert not outcome.err
_MINOR = sys.version_info.minor
@pytest.mark.parametrize(
"env_name",
[
f"3.{_MINOR}",
f"3.{_MINOR}-cov",
"3-cov",
"3",
f"py3.{_MINOR}",
f"py3{_MINOR}-cov",
f"py3.{_MINOR}-cov",
],
)
def test_matches_combined_env(env_name: str, tox_project: ToxProjectCreator) -> None:
tox_ini = """
[testenv]
package=skip
commands =
!cov: python -c 'print("without cov")'
cov: python -c 'print("with cov")'
"""
proj = tox_project({"tox.ini": tox_ini})
outcome = proj.run("r", "-e", env_name)
outcome.assert_success()
assert env_name in outcome.out
assert not outcome.err
@pytest.mark.parametrize(
"env",
[
"py",
"pypy",
"pypy3",
"pypy3.12",
"pypy312",
"py3",
"py3.12",
"py3.12t",
"py312",
"py312t",
"3",
"3t",
"3.12",
"3.12t",
"3.12.0",
"3.12.0t",
],
)
def test_dynamic_env_factors_match(env: str) -> None:
assert _DYNAMIC_ENV_FACTORS.fullmatch(env)
@pytest.mark.parametrize(
"env",
[
"cy3",
"cov",
"py10.1",
],
)
def test_dynamic_env_factors_not_match(env: str) -> None:
assert not _DYNAMIC_ENV_FACTORS.fullmatch(env)
@pytest.mark.parametrize("env_name", ["functional-py312", "functional"])
def test_partial_section_match_rejected(env_name: str, tox_project: ToxProjectCreator) -> None:
tox_ini = "[testenv]\nskip_install = true\ncommands=python -c 'print(1)'\n[testenv:functional{-py310}]\n"
proj = tox_project({"tox.ini": tox_ini})
outcome = proj.run("r", "-e", env_name)
outcome.assert_failed(code=-2)
assert "provided environments not found in configuration file" in outcome.out
def test_factor_conditional_compound_accepted(tox_project: ToxProjectCreator) -> None:
tox_ini = f"""
[tox]
env_list = py3{{{_MINOR},{_MINOR + 1}}}
[testenv]
package = skip
commands =
np: python -c 'print("np")'
np-cov: python -c 'print("cov")'
"""
proj = tox_project({"tox.ini": tox_ini})
outcome = proj.run("r", "-e", f"py3{_MINOR}-np-cov")
outcome.assert_success()
assert f"py3{_MINOR}-np-cov" in outcome.out
def test_suggest_env(tox_project: ToxProjectCreator) -> None:
tox_ini = f"[testenv:release]\n[testenv:py3{_MINOR}]\n[testenv:alpha-py3{_MINOR}]\n"
proj = tox_project({"tox.ini": tox_ini})
outcome = proj.run("r", "-e", f"releas,p3{_MINOR},magic,alph-p{_MINOR}")
outcome.assert_failed(code=-2)
assert not outcome.err
msg = (
"ROOT: HandledError| provided environments not found in configuration file:\n"
f"releas - did you mean release?\np3{_MINOR} - did you mean py3{_MINOR}?\nmagic\n"
f"alph-p{_MINOR} - did you mean alpha-py3{_MINOR}?\n"
)
assert outcome.out == msg
def test_unavailable_runner_in_config_not_explicitly_requested(tox_project: ToxProjectCreator) -> None:
"""Unavailable runner in config should be marked NOT AVAILABLE if not explicitly requested."""
tox_toml = """
[tool.tox]
env_list = ["available", "unavailable"]
[tool.tox.env_run_base]
skip_install = true
[tool.tox.env.available]
commands = [["python", "-c", "print('available')"]]
[tool.tox.env.unavailable]
runner = "nonexistent-runner"
commands = [["python", "-c", "print('unavailable')"]]
"""
proj = tox_project({"pyproject.toml": tox_toml})
outcome = proj.run("r", "-e", "available")
outcome.assert_success()
assert "available: OK" in outcome.out
assert "unavailable: NOT AVAILABLE" in outcome.out
def test_unavailable_runner_explicitly_requested(tox_project: ToxProjectCreator) -> None:
"""Explicitly requesting unavailable runner should fail with clear error."""
tox_toml = """
[tool.tox.env_run_base]
skip_install = true
[tool.tox.env.unavailable]
runner = "nonexistent-runner"
commands = [["python", "-c", "print('unavailable')"]]
"""
proj = tox_project({"pyproject.toml": tox_toml})
outcome = proj.run("r", "-e", "unavailable")
outcome.assert_failed()
assert "runner 'nonexistent-runner' for environment 'unavailable' is not available" in outcome.out
def test_unavailable_runner_in_env_list(tox_project: ToxProjectCreator) -> None:
"""Unavailable runner in env_list should be shown as NOT AVAILABLE."""
tox_toml = """
[tool.tox]
env_list = ["available", "unavailable"]
[tool.tox.env_run_base]
skip_install = true
[tool.tox.env.available]
commands = [["python", "-c", "print('available')"]]
[tool.tox.env.unavailable]
runner = "nonexistent-runner"
commands = [["python", "-c", "print('unavailable')"]]
"""
proj = tox_project({"pyproject.toml": tox_toml})
outcome = proj.run("r")
outcome.assert_success()
assert "available: OK" in outcome.out
assert "unavailable: NOT AVAILABLE" in outcome.out
def test_multiple_unavailable_runners_implicit(tox_project: ToxProjectCreator) -> None:
"""Multiple unavailable runners should all be marked NOT AVAILABLE when not explicitly requested."""
tox_toml = """
[tool.tox]
env_list = ["available", "unavailable1", "unavailable2"]
[tool.tox.env_run_base]
skip_install = true
[tool.tox.env.available]
commands = [["python", "-c", "print('available')"]]
[tool.tox.env.unavailable1]
runner = "nonexistent-runner-1"
commands = [["python", "-c", "print('unavailable1')"]]
[tool.tox.env.unavailable2]
runner = "nonexistent-runner-2"
commands = [["python", "-c", "print('unavailable2')"]]
"""
proj = tox_project({"pyproject.toml": tox_toml})
outcome = proj.run("r")
outcome.assert_success()
assert "available: OK" in outcome.out
assert "unavailable1: NOT AVAILABLE" in outcome.out
assert "unavailable2: NOT AVAILABLE" in outcome.out
|