Fix list/depends cmd creates package env as run env

This happens if you declare configuration for a packaging environment.

Signed-off-by: Bernát Gábor <[email protected]>
Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.26.0
+    rev: v2.27.0
     hooks:
       - id: pyupgrade
         args: ["--py36-plus"]

docs/changelog/2234.bugfix.rst

@@ -0,0 +1,2 @@
+Fix list/depends commands can create tox package environment as runtime environment and display an error message
+- by :user:`gaborbernat`.

src/tox/execute/local_sub_process/__init__.py

@@ -63,7 +63,8 @@ def interrupt(self) -> None:
             msg = "requested interrupt of %d from %d, activate in %.2f"
             logging.warning(msg, to_pid, host_pid, self.options.suicide_timeout)
             if self.wait(self.options.suicide_timeout) is None:  # still alive -> INT
-                if sys.platform != "win32":  # on Windows everyone in the same process group, so they got the message
+                # on Windows everyone in the same process group, so they got the message
+                if sys.platform != "win32":  # pragma: win32 cover
                     msg = "send signal %s to %d from %d with timeout %.2f"
                     logging.warning(msg, f"SIGINT({SIG_INTERRUPT})", to_pid, host_pid, self.options.interrupt_timeout)
                     self._process.send_signal(SIG_INTERRUPT)

src/tox/session/cmd/depends.py

@@ -17,16 +17,14 @@ def tox_add_option(parser: ToxParser) -> None:
 
 
 def depends(state: State) -> int:
-    to_run_list = list(state.conf.env_list(everything=True))
+    to_run_list = list(state.all_run_envs(with_skip=False))
     order, todo = run_order(state, to_run_list)
     print(f"Execution order: {', '.join(order)}")
 
     deps: Dict[str, List[str]] = {k: [o for o in order if o in v] for k, v in todo.items()}
     deps["ALL"] = to_run_list
 
     def _handle(at: int, env: str) -> None:
-        if env not in order and env != "ALL":  # skipped envs
-            return
         print("   " * at, end="")
         print(env, end="")
         if env != "ALL":

src/tox/session/cmd/list_env.py

@@ -18,32 +18,33 @@ def list_env(state: State) -> int:
     option = state.options
 
     default = core["env_list"]  # this should be something not affected by env-vars :-|
-    ignore = {core["provision_tox_env"]}.union(default)
 
-    extra = [] if option.list_default_only else [e for e in state.conf.env_list(everything=True) if e not in ignore]
+    extra = [] if option.list_default_only else [e for e in state.all_run_envs(with_skip=True) if e not in default]
 
     if not option.list_no_description and default:
         print("default environments:")
     max_length = max((len(env) for env in (default.envs + extra)), default=0)
 
     def report_env(name: str) -> None:
         if not option.list_no_description:
-            text = state.tox_env(name).conf["description"]
+            tox_env = state.tox_env(name)
+            text = tox_env.conf["description"]
             if not text.strip():
                 text = "[no description]"
             text = text.replace("\n", " ")
-            msg = f"{e.ljust(max_length)} -> {text}".strip()
+            msg = f"{env.ljust(max_length)} -> {text}".strip()
         else:
-            msg = e
+            msg = env
         print(msg)
 
-    for e in default:
-        report_env(e)
+    for env in default:
+        report_env(env)
+
     if not option.list_default_only and extra:
         if not option.list_no_description:
             if default:
                 print("")
             print("additional environments:")
-        for e in extra:
-            report_env(e)
+        for env in extra:
+            report_env(env)
     return 0

src/tox/session/cmd/run/common.py

@@ -17,7 +17,6 @@
 from tox.session.cmd.run.single import ToxEnvRunResult, run_one
 from tox.session.state import State
 from tox.tox_env.api import ToxEnv
-from tox.tox_env.errors import Skip
 from tox.tox_env.runner import RunToxEnv
 from tox.util.graph import stable_topological_sort
 from tox.util.spinner import MISS_DURATION, Spinner
@@ -213,9 +212,9 @@ def execute(state: State, max_workers: Optional[int], has_spinner: bool, live: b
             done.wait()
             # workaround for https://bugs.python.org/issue45274
             lock = getattr(thread, "_tstate_lock", None)
-            if lock is not None and lock.locked():
-                lock.release()
-                thread._stop()  # type: ignore # we must call this private method to fix the thread state
+            if lock is not None and lock.locked():  # pragma: no branch
+                lock.release()  # pragma: no cover
+                thread._stop()  # type: ignore  # pragma: no cover # calling private method to fix thread state
             thread.join()
     finally:
         ordered_results: List[ToxEnvRunResult] = []
@@ -319,7 +318,7 @@ def _run(tox_env: RunToxEnv) -> ToxEnvRunResult:
     finally:
         try:
             # call teardown - configuration only environments for example could not be finished
-            for _, tox_env in state.run_envs():
+            for _, tox_env in state.created_run_envs():
                 tox_env.teardown()
         finally:
             done.set()
@@ -368,10 +367,7 @@ def run_order(state: State, to_run: List[str]) -> Tuple[List[str], Dict[str, Set
     to_run_set = set(to_run)
     todo: Dict[str, Set[str]] = {}
     for env in to_run:
-        try:
-            run_env = state.tox_env(env)
-        except Skip:
-            continue
+        run_env = state.tox_env(env)
         depends = set(cast(EnvList, run_env.conf["depends"]).envs)
         todo[env] = to_run_set & depends
     order = stable_topological_sort(todo)

src/tox/session/state.py

@@ -1,3 +1,4 @@
+from itertools import chain
 from typing import TYPE_CHECKING, Dict, Iterator, Sequence, Set, Tuple, cast
 
 from tox.config.main import Config
@@ -6,6 +7,7 @@
 from tox.plugin import impl
 from tox.report import HandledError, ToxHandler
 from tox.tox_env.api import ToxEnvCreateArgs
+from tox.tox_env.errors import Skip
 from tox.tox_env.package import PackageToxEnv
 from tox.tox_env.runner import RunToxEnv
 
@@ -102,9 +104,26 @@ def _get_package_env(self, packager: str, name: str) -> PackageToxEnv:
             self._pkg_env[name] = packager, pkg_tox_env
         return pkg_tox_env
 
-    def run_envs(self) -> Iterator[Tuple[str, RunToxEnv]]:
+    def created_run_envs(self) -> Iterator[Tuple[str, RunToxEnv]]:
         yield from self._run_env.items()
 
+    def all_run_envs(self, *, with_skip: bool = True) -> Iterator[str]:
+        default_env_list = self.conf.core["env_list"]
+        ignore = {self.conf.core["provision_tox_env"]}
+        for env in chain(default_env_list.envs, self.conf.env_list(everything=True)):
+            if env in ignore:
+                continue
+            ignore.add(env)  # ignore self
+            skip = False
+            try:
+                tox_env = self.tox_env(env)
+            except Skip:
+                skip = True
+                tox_env = self.tox_env(env)
+            ignore.update(i.name for i in tox_env.package_envs)  # ignore package environments
+            if not skip or with_skip:
+                yield env
+
 
 @impl
 def tox_add_option(parser: "ToxParser") -> None:
@@ -114,6 +133,6 @@ def tox_add_option(parser: "ToxParser") -> None:
         "--runner",
         dest="default_runner",
         help="the tox run engine to use when not explicitly stated in tox env configuration",
-        default=REGISTER.default_run_env,
-        choices=list(REGISTER.run_envs),
+        default=REGISTER.default_env_runner,
+        choices=list(REGISTER.env_runners),
     )

src/tox/tox_env/python/runner.py

@@ -66,7 +66,7 @@ def _register_package_conf(self) -> bool:
         if develop_mode:
             self.conf.add_constant(["package"], desc, "dev-legacy")
         else:
-            self.conf.add_config(keys="package", of_type=str, default="sdist", desc=desc)
+            self.conf.add_config(keys="package", of_type=str, default=self.default_pkg_type, desc=desc)
         pkg_type = self.pkg_type
 
         if pkg_type == "skip":
@@ -109,6 +109,10 @@ def default_wheel_tag(conf: "Config", env_name: Optional[str]) -> str:
         )
         return True
 
+    @property
+    def default_pkg_type(self) -> str:
+        return "sdist"
+
     @property
     def pkg_type(self) -> str:
         pkg_type: str = self.conf["package"]

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

@@ -22,13 +22,14 @@ def _default_package_tox_env_type(self) -> str:
         return "virtualenv-pep-517"
 
     @property
-    def has_package_by_default(self) -> bool:
+    def default_pkg_type(self) -> str:
         tox_root: Path = self.core["tox_root"]
-        return (
-            getattr(self.options, "install_pkg", None) is not None
-            or (tox_root / "pyproject.toml").exists()
-            or (tox_root / "setup.py").exists()
-        )
+        if not (
+            any((tox_root / i).exists() for i in ("pyproject.toml", "setup.py", "setup.cfg"))
+            or getattr(self.options, "install_pkg", None) is not None
+        ):
+            return "skip"
+        return super().default_pkg_type
 
 
 @impl

src/tox/tox_env/register.py

@@ -40,17 +40,17 @@ def add_package_env(self, of_type: Type[PackageToxEnv]) -> None:
         self._package_envs[of_type.id()] = of_type
 
     @property
-    def run_envs(self) -> Iterable[str]:
+    def env_runners(self) -> Iterable[str]:
         """:returns: run environment types currently defined"""
         return self._run_envs.keys()
 
     @property
-    def default_run_env(self) -> str:
+    def default_env_runner(self) -> str:
         """:returns: the default run environment type"""
         return self._default_run_env
 
-    @default_run_env.setter
-    def default_run_env(self, value: str) -> None:
+    @default_env_runner.setter
+    def default_env_runner(self, value: str) -> None:
         """
         Change the default run environment type.