Introducing conda_cli, tmp_env, and path_factory fixtures

conda/cli/main_info.py

@@ -345,9 +345,7 @@ def execute(args, parser):
     if (
         args.all or all(not getattr(args, opt) for opt in options)
     ) and not context.json:
-        stdout_logger = getLogger("conda.stdoutlog")
-        stdout_logger.info(get_main_info_str(info_dict))
-        stdout_logger.info("\n")
+        print(get_main_info_str(info_dict) + "\n")
 
     if args.envs:
         from ..core.envs_manager import list_all_known_prefixes

conda/cli/main_remove.py

@@ -1,7 +1,6 @@
 # Copyright (C) 2012 Anaconda, Inc
 # SPDX-License-Identifier: BSD-3-Clause
 import logging
-import sys
 from os.path import isfile, join
 
 from ..base.context import context
@@ -55,12 +54,11 @@ def execute(args, parser):
     if args.all:
         if prefix == context.root_prefix:
             raise CondaEnvironmentError(
-                "cannot remove root environment,\n"
-                "       add -n NAME or -p PREFIX option"
+                "cannot remove root environment, add -n NAME or -p PREFIX option"
             )
         if not isfile(join(prefix, "conda-meta", "history")):
             raise DirectoryNotACondaEnvironmentError(prefix)
-        print("\nRemove all packages in environment %s:\n" % prefix, file=sys.stderr)
+        print(f"\nRemove all packages in environment {prefix}:\n")
 
         if "package_names" in args:
             stp = PrefixSetup(
@@ -75,9 +73,7 @@ def execute(args, parser):
             try:
                 handle_txn(txn, prefix, args, False, True)
             except PackagesNotFoundError:
-                print(
-                    "No packages found in %s. Continuing environment removal" % prefix
-                )
+                print(f"No packages found in {prefix}. Continuing environment removal")
         if not context.dry_run:
             rm_rf(prefix, clean_empty_parents=True)
             unregister_env(prefix)

conda/cli/main_run.py

@@ -55,4 +55,4 @@ def execute(args, parser):
         log = getLogger(__name__)
         log.warning(f"CONDA_TEST_SAVE_TEMPS :: retaining main_run script {script}")
 
-    return response
+    return response.rc

conda/testing/__init__.py

@@ -12,14 +12,23 @@
 # Ideally we'd have two modes, 'removed' and 'fixed'. I have seen
 # condabin come from an entirely different installation than
 # CONDA_PREFIX too in some instances and that really needs fixing.
+from __future__ import annotations
 
 import os
 import sys
+import uuid
 import warnings
+from contextlib import contextmanager
+from dataclasses import dataclass
 from os.path import dirname, isfile, join, normpath
 from pathlib import Path
 from subprocess import check_output
+from typing import Iterator
 
+import pytest
+
+from conda.base.context import context, reset_context
+from conda.cli.main import init_loggers
 from conda.common.compat import on_win
 
 from ..deprecations import deprecated
@@ -156,3 +165,94 @@ def conda_check_versions_aligned():
         )
         with open(version_file, "w") as fh:
             fh.write(version_from_git)
+
+
+@dataclass
+class CondaCLIFixture:
+    capsys: CaptureFixture
+
+    def __call__(self, *argv: str, no_capture: bool = False) -> tuple[str, str, int]:
+        """Mimic what is done in `conda.cli.main.main`"""
+        # drop the conda argument if provided
+        if argv[0] == "conda":
+            argv = argv[1:]
+
+        # extra checks to handle legacy subcommands
+        if argv[0] == "env":
+            from conda_env.cli.main import create_parser as generate_parser
+            from conda_env.cli.main import do_call
+
+            argv = argv[1:]
+        else:
+            from conda.cli.conda_argparse import do_call, generate_parser
+
+        # ensure arguments are string
+        argv = tuple(map(str, argv))
+
+        # parse arguments
+        parser = generate_parser()
+        args = parser.parse_args(argv)
+
+        # initialize context and loggers
+        context.__init__(argparse_args=args)
+        init_loggers(context)
+
+        # run command
+        result = do_call(args, parser)
+        out, err = self.capsys.readouterr()
+
+        # restore to prior state
+        reset_context()
+
+        return out, err, result
+
+
+@pytest.fixture
+def conda_cli(capsys: CaptureFixture) -> CondaCLIFixture:
+    yield CondaCLIFixture(capsys)
+
+
+@dataclass
+class PathFactoryFixture:
+    tmp_path: Path
+
+    def __call__(
+        self,
+        name: str | None = None,
+        prefix: str | None = None,
+        suffix: str | None = None,
+    ) -> Path:
+        prefix = prefix or ""
+        name = name or uuid.uuid4().hex
+        suffix = suffix or ""
+        return self.tmp_path / (prefix + name + suffix)
+
+
+@pytest.fixture
+def path_factory(tmp_path: Path) -> PathFactoryFixture:
+    yield PathFactoryFixture(tmp_path)
+
+
+@dataclass
+class TmpEnvFixture:
+    path_factory: PathFactoryFixture
+    conda_cli: CondaCLIFixture
+
+    @contextmanager
+    def __call__(
+        self,
+        *packages: str,
+        prefix: str | os.PathLike | None = None,
+    ) -> Iterator[Path]:
+        prefix = Path(prefix or self.path_factory())
+
+        reset_context([prefix / "condarc"])
+        self.conda_cli("create", "--prefix", prefix, *packages, "--yes", "--quiet")
+        yield prefix
+
+
+@pytest.fixture
+def tmp_env(
+    path_factory: PathFactoryFixture, conda_cli: CondaCLIFixture
+) -> TmpEnvFixture:
+    yield TmpEnvFixture(path_factory, conda_cli)

conda/testing/helpers.py

@@ -19,6 +19,7 @@
 import pytest
 
 from conda.auxlib.compat import shlex_split_unicode
+from conda.deprecations import deprecated
 from conda_env.cli import main as conda_env_cli
 
 from .. import cli
@@ -124,6 +125,7 @@ def assert_in(a, b, output=""):
     )
 
 
+@deprecated("23.9", "24.3", addendum="Use `conda.testing.run` instead.")
 def run_inprocess_conda_command(command, disallow_stderr: bool = True):
     # anything that uses this function is an integration test
     reset_context(())

conda/testing/integration.py

@@ -39,6 +39,7 @@
 from conda.common.url import escape_channel_url, path_to_url
 from conda.core.package_cache_data import PackageCacheData
 from conda.core.prefix_data import PrefixData
+from conda.deprecations import deprecated
 from conda.exceptions import conda_exception_handler
 from conda.gateways.disk.create import mkdir_p
 from conda.gateways.disk.delete import rm_rf
@@ -210,6 +211,7 @@ def temp_chdir(target_dir):
         os.chdir(curdir)
 
 
+@deprecated("23.9", "24.3", addendum="Use `conda.testing.run` instead.")
 def run_command(command, prefix, *arguments, **kwargs):
     assert isinstance(arguments, tuple), "run_command() arguments must be tuples"
     arguments = massage_arguments(arguments)
@@ -278,21 +280,13 @@ def run_command(command, prefix, *arguments, **kwargs):
         TEST_LOG_LEVEL, "requests"
     ):
         arguments = encode_arguments(arguments)
-        is_run = arguments[0] == "run"
-        if is_run:
-            cap_args = (None, None)
         with argv(["python_api"] + arguments), captured(*cap_args) as c:
             if use_exception_handler:
                 result = conda_exception_handler(do_call, args, p)
             else:
                 result = do_call(args, p)
-        if is_run:
-            stdout = result.stdout
-            stderr = result.stderr
-            result = result.rc
-        else:
-            stdout = c.stdout
-            stderr = c.stderr
+        stdout = c.stdout
+        stderr = c.stderr
         print(stdout, file=sys.stdout)
         print(stderr, file=sys.stderr)
 

news/12592-conda_cli-fixture

@@ -0,0 +1,21 @@
+### Enhancements
+
+* Add `conda_cli` fixture to replace `conda.testing.helpers.run_inprocess_conda_command` and `conda.testing.integration.run_command`. (#12592)
+* Add `tmp_env` fixture to replace `conda.testing.integration.make_temp_env`. (#12592)
+* Add `path_factory` fixture to replace custom prefix logic like `conda.testing.integration._get_temp_prefix` and `conda.testing.integration.make_temp_prefix`. (#12592)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>