conda list: Exit with return code 1 if the queried packages can't be found (conda#15075)

* conda list: Exit with return code 1 if the queried packages can't be found

* add test

* add news

* Remove --check, just raise

* adjust tests

* pre-commit

* amend news

* Apply suggestions from code review

* Don't search for full name if there is no regex provided.

* Fix test_list_package.

* Refactor tests for conda list command; consolidate argument variations and improve error handling for invalid prefixes.

---------

Co-authored-by: Ken Odegard <kodegard@anaconda.com>
Co-authored-by: Jannis Leidel <jannis@leidel.info>

Author: 3 people

conda/cli/main_list.py

@@ -245,6 +245,9 @@ def list_packages(
 
         packages.append(row)
 
+    if regex and not packages:
+        raise CondaValueError(f"No packages match '{regex}'.")
+
     if reverse:
         packages = reversed(packages)
 
@@ -349,7 +352,7 @@ def execute(args: Namespace, parser: ArgumentParser) -> int:
         )
 
     regex = args.regex
-    if args.full_name:
+    if regex and args.full_name:
         regex = rf"^{regex}$"
 
     if args.revisions:

news/15075-list-exit-code

@@ -0,0 +1,19 @@
+### Enhancements
+
+* `conda list pattern` will raise an exception with exit code 1 if the query did not match any packages in the target environment. (#15074 via #15075)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

tests/cli/test_conda_argparse.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import importlib
-import re
 import sys
 from inspect import isclass, isfunction
 from logging import getLogger
@@ -16,7 +15,6 @@
     _GreedySubParsersAction,
     generate_parser,
 )
-from conda.exceptions import EnvironmentLocationNotFound
 
 if TYPE_CHECKING:
     from typing import Any, Callable
@@ -26,26 +24,6 @@
 log = getLogger(__name__)
 
 
-def test_list_through_python_api(conda_cli: CondaCLIFixture):
-    with pytest.raises(EnvironmentLocationNotFound, match="Not a conda environment"):
-        conda_cli("list", "--prefix", "not-a-real-path")
-
-    # cover argument variations
-    # mutually exclusive: --canonical, --export, --explicit, (default human readable)
-    for args1 in [[], ["--json"]]:
-        for args2 in [[], ["--revisions"]]:
-            for args3 in [
-                ["--canonical"],
-                ["--export"],
-                ["--explicit", "--md5"],
-                ["--full-name"],
-            ]:
-                args = (*args1, *args2, *args3)
-                stdout, _, _ = conda_cli("list", *args)
-                if "--md5" in args and "--revisions" not in args:
-                    assert re.search(r"#[0-9a-f]{32}", stdout)
-
-
 def test_parser_basics():
     p = generate_parser()
     with pytest.raises(SystemExit, match="2"):

tests/cli/test_main_list.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import json
+import re
 import sys
 from typing import TYPE_CHECKING
 
@@ -11,7 +12,7 @@
 from conda.base.constants import CONDA_LIST_FIELDS
 from conda.common.configuration import CustomValidationError
 from conda.core.prefix_data import PrefixData
-from conda.exceptions import EnvironmentLocationNotFound
+from conda.exceptions import CondaValueError, EnvironmentLocationNotFound
 from conda.testing.integration import package_is_installed
 
 if TYPE_CHECKING:
@@ -26,6 +27,10 @@
     )
 
 
+# Precompile for reuse in parameterized cases
+MD5_HEX_RE = re.compile(r"#[0-9a-f]{32}")
+
+
 @pytest.fixture
 def tmp_envs_dirs(mocker: MockerFixture, tmp_path: Path) -> Path:
     mocker.patch(
@@ -47,6 +52,40 @@ def test_list(
         assert any(item["name"] == pkg for item in json.loads(stdout))
 
 
+@pytest.mark.parametrize(
+    "args",
+    [
+        ["--canonical"],
+        ["--export"],
+        ["--explicit", "--md5"],
+        ["--full-name"],
+        ["--revisions", "--canonical"],
+        ["--revisions", "--export"],
+        ["--revisions", "--explicit", "--md5"],
+        ["--revisions", "--full-name"],
+        ["--json", "--canonical"],
+        ["--json", "--export"],
+        ["--json", "--explicit", "--md5"],
+        ["--json", "--full-name"],
+        ["--json", "--revisions", "--canonical"],
+        ["--json", "--revisions", "--export"],
+        ["--json", "--revisions", "--explicit", "--md5"],
+        ["--json", "--revisions", "--full-name"],
+    ],
+)
+def test_list_argument_variations(conda_cli: CondaCLIFixture, args: list[str]):
+    # cover argument variations
+    # mutually exclusive: --canonical, --export, --explicit, (default human readable)
+    stdout, _, _ = conda_cli("list", *args)
+    if "--md5" in args and "--revisions" not in args:
+        assert MD5_HEX_RE.search(stdout)
+
+
+def test_list_with_bad_prefix_raises(conda_cli: CondaCLIFixture):
+    with pytest.raises(EnvironmentLocationNotFound, match="Not a conda environment"):
+        conda_cli("list", "--prefix", "not-a-real-path")
+
+
 # conda list --reverse
 def test_list_reverse(
     tmp_env: TmpEnvFixture,
@@ -111,9 +150,10 @@ def test_list_revisions(tmp_envs_dirs: Path, conda_cli: CondaCLIFixture) -> None
 
 # conda list PACKAGE
 def test_list_package(tmp_envs_dirs: Path, conda_cli: CondaCLIFixture) -> None:
-    stdout, _, _ = conda_cli("list", "ipython", "--json")
+    stdout, _, _ = conda_cli("list", "python", "--json")
     parsed = json.loads(stdout.strip())
     assert isinstance(parsed, list)
+    assert "python" in [package["name"] for package in parsed]
 
 
 def test_list_explicit(
@@ -249,3 +289,16 @@ def test_fields_invalid(conda_cli):
     )
     assert "list_fields" in str(exc)
     assert "invalid-field" in str(exc)
+
+
+def test_exit_codes(conda_cli):
+    # If the package is installed, with or without --check, the exit code must be 0
+    out, err, rc = conda_cli("list", f"--prefix={sys.prefix}", "conda")
+    assert rc == 0
+
+    conda_cli(
+        "list",
+        f"--prefix={sys.prefix}",
+        "does-not-exist",
+        raises=CondaValueError,
+    )