Fix legacy flags, deprecate them and remove --index-url (#2731)

Resolves #2690

Author: gaborbernat

docs/changelog/2690.bugfix.rst

@@ -0,0 +1,2 @@
+Fix legacy CLI flags ``--pre``, ``--force-deps``, ``--sitepackages`` and ``--alwayscopy`` not working, and mark them
+as deprecated - by :user:`gaborbernat`.

docs/faq.rst

@@ -107,6 +107,7 @@ tox 4 - CLI arguments changed
   no longer the case.
 - Running ``--showconfig```or ``--help-ini`` with the ``-v`` flag will add interleaved debugging information, whereas
   tox 3 added additional lines at the start. If you want to generate valid ini files you must not use the ``-v`` flag.
+- The ``--index-url`` is now removed, use ``PIP_INDEX_URL`` in :ref:`set_env` instead.
 
 tox 4 - packaging changes
 +++++++++++++++++++++++++

src/tox/session/cmd/legacy.py

@@ -1,15 +1,21 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import cast
 
-from tox.config.cli.parser import DEFAULT_VERBOSITY, ToxParser
+from packaging.requirements import InvalidRequirement, Requirement
+
+from tox.config.cli.parser import DEFAULT_VERBOSITY, Parsed, ToxParser
+from tox.config.loader.memory import MemoryLoader
+from tox.config.set_env import SetEnv
 from tox.plugin import impl
 from tox.session.cmd.run.common import env_run_create_flags
 from tox.session.cmd.run.parallel import OFF_VALUE, parallel_flags, run_parallel
 from tox.session.cmd.run.sequential import run_sequential
 from tox.session.state import State
+from tox.tox_env.python.pip.req_file import PythonDeps
 
-from ..env_select import CliEnv, register_env_select_flags
+from ..env_select import CliEnv, EnvSelector, register_env_select_flags
 from .devenv import devenv
 from .list_env import list_env
 from .show_config import show_config
@@ -54,16 +60,8 @@ def tox_add_option(parser: ToxParser) -> None:
     our.add_argument(
         "--pre",
         action="store_true",
-        help="install pre-releases and development versions of dependencies. This will pass the --pre option to"
-        "install_command (pip by default).",
-    )
-    our.add_argument(
-        "-i",
-        "--index-url",
-        action="append",
-        default=[],
-        metavar="url",
-        help="set indexserver url (if URL is of form name=url set the url for the 'name' indexserver, specifically)",
+        help="deprecated use PIP_PRE in set_env instead - install pre-releases and development versions of"
+        "dependencies; this will set PIP_PRE=1 environment variable",
     )
     our.add_argument(
         "--force-dep",
@@ -72,17 +70,18 @@ def tox_add_option(parser: ToxParser) -> None:
         default=[],
         help="Forces a certain version of one of the dependencies when configuring the virtual environment. REQ "
         "Examples 'pytest<6.1' or 'django>=2.2'.",
+        type=Requirement,
     )
     our.add_argument(
         "--sitepackages",
         action="store_true",
-        help="override sitepackages setting to True in all envs",
+        help="deprecated use VIRTUALENV_SYSTEM_SITE_PACKAGES=1, override sitepackages setting to True in all envs",
         dest="site_packages",
     )
     our.add_argument(
         "--alwayscopy",
         action="store_true",
-        help="override always copy setting to True in all envs",
+        help="deprecated use VIRTUALENV_ALWAYS_COPY=1, override always copy setting to True in all envs",
         dest="always_copy",
     )
 
@@ -92,16 +91,53 @@ def legacy(state: State) -> int:
     if option.show_config:
         option.list_keys_only = []
         option.show_core = not bool(option.env)
-        return show_config(state)
     if option.list_envs or option.list_envs_all:
         state.envs.on_empty_fallback_py = False
         option.list_no_description = option.verbosity <= DEFAULT_VERBOSITY
         option.list_default_only = not option.list_envs_all
         option.show_core = False
+
+    _handle_legacy_only_flags(option, state.envs)
+
+    if option.show_config:
+        return show_config(state)
+    if option.list_envs or option.list_envs_all:
         return list_env(state)
     if option.devenv_path:
         option.devenv_path = Path(option.devenv_path)
         return devenv(state)
     if option.parallel != 0:  # only 0 means sequential
         return run_parallel(state)
     return run_sequential(state)
+
+
+def _handle_legacy_only_flags(option: Parsed, envs: EnvSelector) -> None:
+    override = {}
+    if getattr(option, "site_packages", False):
+        override["system_site_packages"] = True
+    if getattr(option, "always_copy", False):
+        override["always_copy"] = True
+    set_env = {}
+    if getattr(option, "pre", False):
+        set_env["PIP_PRE"] = "1"
+    forced = {j.name: j for j in getattr(option, "force_dep", [])}
+    if override or set_env or forced:
+        for env in envs.iter(only_active=True, package=False):
+            env_conf = envs[env].conf
+            if override:
+                env_conf.loaders.insert(0, MemoryLoader(**override))
+            if set_env:
+                cast(SetEnv, env_conf["set_env"]).update(set_env, override=True)
+            if forced:
+                to_force = forced.copy()
+                deps = cast(PythonDeps, env_conf["deps"])
+                as_root_args = deps.as_root_args
+                for at, entry in enumerate(as_root_args):
+                    try:
+                        req = Requirement(entry)
+                    except InvalidRequirement:
+                        continue
+                    if req.name in to_force:
+                        as_root_args[at] = str(to_force[req.name])
+                        del to_force[req.name]
+                as_root_args.extend(str(v) for v in to_force.values())

src/tox/tox_env/python/virtual_env/api.py

@@ -112,10 +112,9 @@ def virtualenv_env_vars(self) -> dict[str, str]:
         base_python: list[str] = self.conf["base_python"]
         if "VIRTUALENV_NO_PERIODIC_UPDATE" not in env:
             env["VIRTUALENV_NO_PERIODIC_UPDATE"] = "True"
-        site = getattr(self.options, "site_packages", False) or self.conf["system_site_packages"]
         env["VIRTUALENV_CLEAR"] = "False"
-        env["VIRTUALENV_SYSTEM_SITE_PACKAGES"] = str(site)
-        env["VIRTUALENV_COPIES"] = str(getattr(self.options, "always_copy", False) or self.conf["always_copy"])
+        env["VIRTUALENV_SYSTEM_SITE_PACKAGES"] = str(self.conf["system_site_packages"])
+        env["VIRTUALENV_COPIES"] = str(self.conf["always_copy"])
         env["VIRTUALENV_DOWNLOAD"] = str(self.conf["download"])
         env["VIRTUALENV_PYTHON"] = "\n".join(base_python)
         if hasattr(self.options, "discover"):

tests/config/cli/test_cli_env_var.py

@@ -59,7 +59,6 @@ def test_verbose_no_test() -> None:
         "parallel_live": False,
         "parallel_no_spinner": False,
         "pre": False,
-        "index_url": [],
         "factors": [],
         "labels": [],
         "skip_env": "",
@@ -93,7 +92,6 @@ def test_env_var_exhaustive_parallel_values(
         "env": CliEnv(["py37", "py36"]),
         "force_dep": [],
         "hash_seed": "noset",
-        "index_url": [],
         "install_pkg": None,
         "no_provision": False,
         "list_envs": False,

tests/session/cmd/test_legacy.py

@@ -53,16 +53,17 @@ def test_legacy_list_env_with_empty_or_missing_env_list(tox_project: ToxProjectC
     outcome = tox_project({"tox.ini": configuration}).run("le", "-l")
 
     outcome.assert_success()
-    outcome.assert_out_err("", "")
+    assert not outcome.err
+    assert not outcome.out
 
 
 def test_legacy_list_env_with_no_tox_file(tox_project: ToxProjectCreator) -> None:
     project = tox_project({})
     outcome = project.run("le", "-l")
-
     outcome.assert_success()
     out = f"ROOT: No tox.ini or setup.cfg or pyproject.toml found, assuming empty tox.ini at {project.path}\n"
-    outcome.assert_out_err(out, "")
+    assert not outcome.err
+    assert outcome.out == out
 
 
 @pytest.mark.parametrize("verbose", range(3))
@@ -106,3 +107,26 @@ def test_legacy_run_sequential(tox_project: ToxProjectCreator, mocker: MockerFix
 def test_legacy_help(tox_project: ToxProjectCreator) -> None:
     outcome = tox_project({"tox.ini": ""}).run("le", "-h")
     outcome.assert_success()
+
+
+def test_legacy_cli_flags(tox_project: ToxProjectCreator, mocker: MockerFixture) -> None:
+    session = mocker.MagicMock()
+    session.creator.interpreter.system_executable = "I"
+    virtualenv_session = mocker.patch("tox.tox_env.python.virtual_env.api.session_via_cli", return_value=session)
+    ini = "[testenv]\ndeps = p>6\n c\n -rr.txt\npackage=skip\nset_env = PIP_PRE = 0"
+    proj = tox_project({"tox.ini": ini})
+    (proj.path / "r.txt").write_text("d")
+    execute_calls = proj.patch_execute(lambda r: 0 if "install" in r.run_id else None)
+    args = ["--pre", "--force-dep", "p<1", "--force-dep", "b>2", "--sitepackages", "--alwayscopy"]
+    result = proj.run("le", "-e", "py", *args)
+    result.assert_success()
+
+    calls = [(i[0][0].conf.name, i[0][3].run_id, i[0][3].cmd[5:]) for i in execute_calls.call_args_list]
+    assert calls[0] == ("py", "install_deps", ["c", "p<1", "-r", "r.txt", "b>2"])
+    for call in execute_calls.call_args_list:
+        if call[0][0].name == "py":
+            assert call[0][3].env["PIP_PRE"] == "1"
+    assert len(virtualenv_session.call_args_list) == 1
+    v_env = virtualenv_session.call_args_list[0][1]["env"]
+    assert v_env["VIRTUALENV_SYSTEM_SITE_PACKAGES"] == "True"
+    assert v_env["VIRTUALENV_COPIES"] == "True"

tests/util/test_spinner.py

@@ -72,6 +72,7 @@ def test_spinner_atty(capfd: CaptureFixture, monkeypatch: MonkeyPatch) -> None:
 
 
 @time_machine.travel("2012-01-14", tick=False)
+@pytest.mark.flaky(max_runs=3, min_passes=1)
 def test_spinner_report(capfd: CaptureFixture, monkeypatch: MonkeyPatch) -> None:
     monkeypatch.setattr(sys.stdout, "isatty", lambda: False)
     with spinner.Spinner(refresh_rate=100) as spin: