Use .condarc file to configure conda-standalone (#99)

* Add .condarc file to bundle to set channels

* Add test to test that config in conda-standalone is captured correctly

* Change name of test function

* Add news file

* Add .condarc file to recipe

* Add fallback value for when CONDA_ROOT is set externally

* Allow restricting of condarc search paths

* Make assertions less restrictive

* Update build scripts to include patched file

* Update patch

* Change file order for config file loading

* Use single-letter variable name in batch for loop

* Revert using for-loop in bld.bat

* Fix typo

* Add --no-rcs CLI option

* Add environment variable and CLI option to news file

* Use custom environment variable to designate .condarc directory

* Convert remaining RECIPE_DIR variable to PYINSTALLER_CONDARC_DIR

* Generalize variable names in tests

* Copy configuration dictionaries

news/99-configure-conda-standalone

@@ -0,0 +1,20 @@
+### Enhancements
+
+* Configure conda-standalone binaries with .condarc files. (#97 via #99)
+* Add environment variable `CONDA_RESTRICT_RC_SEARCH_PATH` and CLI option `--no-rc` to only load `.condarc` file delivered by `conda-standalone` bundle or `CONDARC` environment variable. (#99)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

recipe/.condarc

@@ -0,0 +1,2 @@
+channels:
+  - conda-forge

recipe/bld.bat

@@ -6,6 +6,8 @@ RENAME "%SP_DIR%\conda\utils.py" utils.py.bak || goto :error
 COPY conda_src\conda\utils.py "%SP_DIR%\conda\utils.py" || goto :error
 RENAME "%SP_DIR%\conda\deprecations.py" deprecations.py.bak || goto :error
 COPY conda_src\conda\deprecations.py "%SP_DIR%\conda\deprecations.py" || goto :error
+RENAME "%SP_DIR%\conda\base\constants.py" constants.py.bak || goto :error
+COPY conda_src\conda\base\constants.py "%SP_DIR%\conda\base\constants.py" || goto :error
 
 :: we need these for noarch packages with entry points to work on windows
 COPY "conda_src\conda\shell\cli-%ARCH%.exe" entry_point_base.exe || goto :error

recipe/build.sh

@@ -2,7 +2,7 @@ set -euxo pipefail
 
 # patched conda files
 # new files in patches need to be added here
-for fname in "core/path_actions.py" "utils.py" "deprecations.py"; do
+for fname in "core/path_actions.py" "utils.py" "deprecations.py" "base/constants.py"; do
   mv "$SP_DIR/conda/${fname}" "$SP_DIR/conda/${fname}.bak"
   cp "conda_src/conda/${fname}" "$SP_DIR/conda/${fname}"
 done

recipe/meta.yaml

@@ -19,6 +19,7 @@ source:
     patches:
       - ../src/conda_patches/0001-Rename-and-replace-entrypoint-stub-exe.patch
       - ../src/conda_patches/0002-Manipulate-PATH-directly-instead-of-_call_ing-conda.patch
+      - ../src/conda_patches/0003-Restrict-search-paths.patch
 
   - url: https://github.com/conda/constructor/archive/{{ constructor_version }}.tar.gz  # [win]
     sha256: 0ea4f6d563a53ebb03475dc6d2d88d3ab01be4e9d291fd276c79315aa92e5114  # [win]
@@ -29,6 +30,8 @@ build:
   string: "g{{ GIT_FULL_HASH[:7] }}_py{{ pyver }}_{{ PKG_BUILDNUM }}"
   ignore_run_exports:
     - '*'
+  script_env:
+    - PYINSTALLER_CONDARC_DIR={{ RECIPE_DIR }}
 
 requirements:
   build:
@@ -48,6 +51,7 @@ test:
   requires:
     - pytest
     - menuinst >={{ menuinst_lower_bound }}
+    - ruamel.yaml
   source_files:
     - tests
   commands:

src/conda.exe.spec

@@ -62,6 +62,13 @@ elif sys.platform == "darwin":
     ]
     extra_exe_kwargs["entitlements_file"] = os.path.join(HERE, "entitlements.plist")
 
+# Add .condarc file to bundle to configure channels
+# during the package building stage
+if "PYINSTALLER_CONDARC_DIR" in os.environ:
+    condarc = os.path.join(os.environ["PYINSTALLER_CONDARC_DIR"], ".condarc")
+    if os.path.exists(condarc):
+        datas.append((condarc, "."))
+
 a = Analysis(['entry_point.py', 'imports.py'],
              pathex=['.'],
              binaries=binaries,

src/conda_patches/0003-Restrict-search-paths.patch

@@ -0,0 +1,91 @@
+diff --git a/conda/base/constants.py b/conda/base/constants.py
+index d38502a48..b56724933 100644
+--- a/conda/base/constants.py
++++ b/conda/base/constants.py
+@@ -10,6 +10,7 @@ Another important source of "static" configuration is conda/models/enums.py.
+
+ import struct
+ from enum import Enum, EnumMeta
++from os import environ
+ from os.path import join
+
+ from ..common.compat import on_win
+@@ -25,42 +26,47 @@ machine_bits = 8 * struct.calcsize("P")
+
+ APP_NAME = "conda"
+
+-if on_win:  # pragma: no cover
++if "CONDA_RESTRICT_RC_SEARCH_PATH" in environ:
+     SEARCH_PATH = (
+-        "C:/ProgramData/conda/.condarc",
+-        "C:/ProgramData/conda/condarc",
+-        "C:/ProgramData/conda/condarc.d",
++        "$CONDARC",
+     )
+ else:
+-    SEARCH_PATH = (
+-        "/etc/conda/.condarc",
+-        "/etc/conda/condarc",
+-        "/etc/conda/condarc.d/",
+-        "/var/lib/conda/.condarc",
+-        "/var/lib/conda/condarc",
+-        "/var/lib/conda/condarc.d/",
++    if on_win:  # pragma: no cover
++        SEARCH_PATH = (
++            "C:/ProgramData/conda/.condarc",
++            "C:/ProgramData/conda/condarc",
++            "C:/ProgramData/conda/condarc.d",
++        )
++    else:
++        SEARCH_PATH = (
++            "/etc/conda/.condarc",
++            "/etc/conda/condarc",
++            "/etc/conda/condarc.d/",
++            "/var/lib/conda/.condarc",
++            "/var/lib/conda/condarc",
++            "/var/lib/conda/condarc.d/",
++        )
++
++    SEARCH_PATH += (
++        "$CONDA_ROOT/.condarc",
++        "$CONDA_ROOT/condarc",
++        "$CONDA_ROOT/condarc.d/",
++        "$XDG_CONFIG_HOME/conda/.condarc",
++        "$XDG_CONFIG_HOME/conda/condarc",
++        "$XDG_CONFIG_HOME/conda/condarc.d/",
++        "~/.config/conda/.condarc",
++        "~/.config/conda/condarc",
++        "~/.config/conda/condarc.d/",
++        "~/.conda/.condarc",
++        "~/.conda/condarc",
++        "~/.conda/condarc.d/",
++        "~/.condarc",
++        "$CONDA_PREFIX/.condarc",
++        "$CONDA_PREFIX/condarc",
++        "$CONDA_PREFIX/condarc.d/",
++        "$CONDARC",
+     )
+
+-SEARCH_PATH += (
+-    "$CONDA_ROOT/.condarc",
+-    "$CONDA_ROOT/condarc",
+-    "$CONDA_ROOT/condarc.d/",
+-    "$XDG_CONFIG_HOME/conda/.condarc",
+-    "$XDG_CONFIG_HOME/conda/condarc",
+-    "$XDG_CONFIG_HOME/conda/condarc.d/",
+-    "~/.config/conda/.condarc",
+-    "~/.config/conda/condarc",
+-    "~/.config/conda/condarc.d/",
+-    "~/.conda/.condarc",
+-    "~/.conda/condarc",
+-    "~/.conda/condarc.d/",
+-    "~/.condarc",
+-    "$CONDA_PREFIX/.condarc",
+-    "$CONDA_PREFIX/condarc",
+-    "$CONDA_PREFIX/condarc.d/",
+-    "$CONDARC",
+-)
+-
+ DEFAULT_CHANNEL_ALIAS = "https://conda.anaconda.org"
+ CONDA_HOMEPAGE_URL = "https://conda.io"
+ ERROR_UPLOAD_URL = "https://conda.io/conda-post/unexpected-error"

src/entry_point.py

@@ -18,6 +18,9 @@
     # See https://github.com/conda/conda-standalone/issues/86
     del os.environ["SSLKEYLOGFILE"]
 
+if "CONDARC" not in os.environ:
+    os.environ["CONDARC"] = os.path.join(sys.prefix, ".condarc")
+
 
 def _create_dummy_executor(*args, **kwargs):
     "use this for debugging, because ProcessPoolExecutor isn't pdb/ipdb friendly"
@@ -295,6 +298,12 @@ def _conda_main():
     from conda.cli import main
 
     _fix_sys_path()
+    try:
+        no_rc = sys.argv.index("--no-rc")
+        os.environ["CONDA_RESTRICT_RC_SEARCH_PATH"] = "1"
+        del sys.argv[no_rc]
+    except ValueError:
+        pass
     return main()
 
 

tests/requirements.txt

@@ -1,2 +1,3 @@
 pytest
 menuinst>=2
+ruamel.yaml

tests/test_main.py

@@ -1,4 +1,5 @@
 import io
+import json
 import os
 import shutil
 import stat
@@ -8,6 +9,7 @@
 from pathlib import Path
 
 import pytest
+from ruamel.yaml import YAML
 
 # TIP: You can debug the tests with this setup:
 # CONDA_STANDALONE=src/entry_point.py pytest ...
@@ -67,6 +69,75 @@ def test_constructor():
     run_conda("constructor", "--help", check=True)
 
 
+@pytest.mark.parametrize("search_paths", ("all_rcs", "--no-rc", "env_var"))
+def test_conda_standalone_config(search_paths, tmp_path, monkeypatch):
+    expected_configs = {}
+    if rc_dir := os.environ.get("PYINSTALLER_CONDARC_DIR"):
+        condarc = Path(rc_dir, ".condarc")
+        if condarc.exists():
+            yaml = YAML()
+            with open(condarc) as crc:
+                config = YAML().load(crc)
+                expected_configs["standalone"] = config.copy()
+
+    config_args = ["--show-sources", "--json"]
+    if search_paths == "env_var":
+        monkeypatch.setenv("CONDA_RESTRICT_RC_SEARCH_PATH", "1")
+    elif search_paths == "--no-rc":
+        config_args.append("--no-rc")
+    else:
+        config_path = str(tmp_path / ".condarc")
+        expected_configs[config_path] = {
+            "channels": [
+                "defaults",
+            ]
+        }
+        with open(config_path, "w") as crc:
+            yaml.dump(expected_configs[config_path], crc)
+        monkeypatch.setenv("CONDA_ROOT", str(tmp_path))
+    env = os.environ.copy()
+
+    proc = run_conda(
+        "config",
+        *config_args,
+        check=True,
+        capture_output=True,
+        text=True,
+        env=env,
+    )
+    condarcs = json.loads(proc.stdout)
+
+    tmp_root = None
+    if rc_dir:
+        # Quick way to get the location conda-standalone is extracted into
+        proc = run_conda(
+            "python",
+            "-c",
+            "import sys; print(sys.prefix)",
+            check=True,
+            capture_output=True,
+            text=True,
+            env=env,
+        )
+        tmp_root = str(Path(proc.stdout).parent)
+
+    conda_configs = {}
+    for filepath, config in condarcs.items():
+        if Path(filepath).exists():
+            conda_configs[filepath] = config.copy()
+        elif rc_dir and filepath.startswith(tmp_root):
+            conda_configs["standalone"] = config.copy()
+    if search_paths == "all_rcs":
+        # If the search path is restricted, there may be other .condarc
+        # files in the final config, so be less strict with assertions
+        for filepath, config in expected_configs.items():
+            assert (
+                conda_configs.get(filepath) == config
+            ), f"Incorrect config for {filepath}"
+    else:
+        assert expected_configs == conda_configs
+
+
 def test_extract_conda_pkgs(tmp_path: Path):
     shutil.copytree(HERE / "data", tmp_path / "pkgs")
     run_conda("constructor", "--prefix", tmp_path, "--extract-conda-pkgs", check=True)