Small fixes and updates

Author: AAraKKe

ddev/src/ddev/cli/config/override.py

@@ -0,0 +1,104 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import click
+
+if TYPE_CHECKING:
+    from ddev.cli.application import Application
+
+
+def repo_to_override(app: Application) -> str:
+    from ddev.utils.metadata import (
+        InvalidMetadataError,
+        PyProjectNotFoundError,
+        RepoNotFoundError,
+        ValidRepo,
+        pyproject_metadata,
+    )
+
+    repos_map = {
+        ValidRepo.CORE: "core",
+        ValidRepo.EXTRAS: "extras",
+        ValidRepo.INTERNAL: "internal",
+        ValidRepo.AGENT: "agent",
+        ValidRepo.MARKETPLACE: "marketplace",
+        ValidRepo.INTEGRATIONS_INTERNAL_CORE: "integrations-internal-core",
+    }
+
+    try:
+        metadata = pyproject_metadata()
+        if metadata is None:
+            raise RepoNotFoundError()
+        repo = repos_map[metadata.repo]
+    except (PyProjectNotFoundError, RepoNotFoundError):
+        app.display_error(
+            "The current repo could not be inferred. Either this is not a repository or the root of "
+            "the repo is missing the ddev tool configuration in its pyproject.toml file."
+        )
+
+        repo = app.prompt(
+            "What repo are you trying to override? ",
+            type=click.Choice(list(repos_map.values())),
+            show_choices=True,
+        )
+    except InvalidMetadataError as e:
+        from rich.markup import escape
+
+        # Ensure escaping to avoid rich reading the table name as style markup
+        app.display_error(escape(str(e)))
+        app.abort()
+    except Exception as e:
+        app.display_error(f"An unexpected error occurred: {e}")
+        app.abort()
+
+    return repo
+
+
+@click.command()
+@click.pass_obj
+def override(app: Application):
+    """
+    Overrides the repo configuration with a `.ddev.toml` file in the current working directory.
+
+    The command tries to identify the repo you are in by reading the `repo` field in the `[tool.ddev]` table in
+    the `pyproject.toml` file located at the root of your git repository.
+
+    If the current directory is not part of a git repository, the repository root does not have a `pyproject.toml`
+    file, or the file exists but has no `[tool.ddev]` table, you will be prompted to specify which repo
+    configuration to override.
+    """
+    from rich.syntax import Syntax
+
+    from ddev.config.file import DDEV_TOML, RootConfig, deep_merge_with_list_handling
+    from ddev.config.utils import scrub_config
+    from ddev.utils.fs import Path
+    from ddev.utils.toml import dumps_toml_data
+
+    app.config_file.overrides_path = Path.cwd() / DDEV_TOML
+    repo = repo_to_override(app)
+
+    local_repo_config = {
+        "repo": repo,
+        "repos": {repo: str(app.config_file.overrides_path.resolve().parent)},
+    }
+
+    if app.config_file.overrides_path.exists():
+        app.display_info("Local config file already exists. Updating...")
+        local_config = app.config_file.overrides_model.raw_data
+        config = deep_merge_with_list_handling(local_config, local_repo_config)
+    else:
+        config = local_repo_config
+
+    app.config_file.overrides_model = RootConfig(config)
+    app.config_file.update()
+
+    app.display_success(f"Local repo configuration added in {app.config_file.pretty_overrides_path}\n")
+    app.display("Local config content:")
+    scrub_config(app.config_file.overrides_model.raw_data)
+    app.output(
+        Syntax(dumps_toml_data(app.config_file.overrides_model.raw_data).rstrip(), "toml", background_color="default")
+    )

ddev/src/ddev/config/file.py

@@ -281,7 +281,7 @@ def path(self, value: Path):
 
     @property
     def model(self) -> RootConfig:
-        return cast(RootConfig, self.global_model)
+        return self.global_model
 
     def save(self, content=None):
         import tomli_w

ddev/tests/cli/config/test_override.py

@@ -0,0 +1,165 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from collections.abc import Generator
+
+import pytest
+
+from ddev.config.file import DDEV_TOML, ConfigFileWithOverrides
+from ddev.utils.fs import Path
+from ddev.utils.toml import dump_toml_data, load_toml_file
+from tests.helpers.git import ClonedRepo
+from tests.helpers.runner import CliRunner, Result
+
+
+@pytest.fixture
+def repo_with_ddev_tool_config(repository_as_cwd: ClonedRepo) -> Generator[ClonedRepo, None, None]:
+    pyproject_path = repository_as_cwd.path / "pyproject.toml"
+    pyproject = load_toml_file(pyproject_path)
+    pyproject["tool"]["ddev"] = {"repo": "integrations-core"}
+    dump_toml_data(pyproject, pyproject_path)
+
+    yield repository_as_cwd
+
+
+def test_create_new_overrides_config(
+    ddev: CliRunner, config_file: ConfigFileWithOverrides, helpers, repo_with_ddev_tool_config: ClonedRepo
+):
+    temp_dir = repo_with_ddev_tool_config.path
+
+    result = ddev("config", "override")
+    local_path = str(temp_dir).replace("\\", "\\\\")
+
+    expected_output = helpers.dedent(
+        f"""
+        Local repo configuration added in {config_file.pretty_overrides_path}
+
+        Local config content:
+        repo = "core"
+
+        [repos]
+        core = "{local_path}"
+        """
+    )
+    # Reload new values
+    config_file.load()
+
+    assert result.exit_code == 0, result.output
+    assert result.output == expected_output
+
+    # Verify the config was actually created
+    assert config_file.overrides_path.exists()
+    assert config_file.overrides_model.raw_data["repos"]["core"] == str(config_file.overrides_path.parent)
+    assert config_file.overrides_model.raw_data["repo"] == "core"
+
+
+def test_update_existing_local_config(
+    ddev: CliRunner, config_file: ConfigFileWithOverrides, helpers, repo_with_ddev_tool_config: ClonedRepo
+):
+    ddev_path = repo_with_ddev_tool_config.path / DDEV_TOML
+    existing_config = helpers.dedent(
+        """
+        [orgs.default]
+        api_key = "test_key"
+
+        [repos]
+        core = "/old/path"
+        """
+    )
+    ddev_path.write_text(existing_config)
+
+    result = ddev("config", "override")
+    local_path = str(ddev_path.parent).replace("\\", "\\\\")
+
+    assert result.exit_code == 0, result.output
+    assert result.output == helpers.dedent(
+        f"""
+        Local config file already exists. Updating...
+        Local repo configuration added in {config_file.pretty_overrides_path}
+
+        Local config content:
+        repo = "core"
+
+        [orgs.default]
+        api_key = "*****"
+
+        [repos]
+        core = "{local_path}"
+        """
+    )
+
+    # Verify the config was updated correctly
+    config_file.load()
+    assert config_file.overrides_model.raw_data["repos"]["core"] == str(repo_with_ddev_tool_config.path)
+    assert config_file.overrides_model.raw_data["repo"] == "core"
+    assert config_file.overrides_model.raw_data["orgs"]["default"]["api_key"] == "test_key"
+
+
+def assert_valid_local_config(
+    config_file: ConfigFileWithOverrides, repo_path: Path, result: Result, expected_output: str
+):
+    assert result.exit_code == 0
+    assert "The current repo could not be inferred" in result.output
+    assert "What repo are you trying to override?" in result.output
+    assert expected_output in result.output
+    assert config_file.overrides_model.raw_data["repos"]["extras"] == str(repo_path)
+    assert config_file.overrides_model.raw_data["repo"] == "extras"
+
+
+def test_not_in_repo_ask_user(ddev: CliRunner, config_file: ConfigFileWithOverrides, helpers, overrides_config: Path):
+    result = ddev("config", "override", input="extras")
+    extras_path = str(config_file.overrides_path.parent).replace("\\", "\\\\")
+
+    expected_output = helpers.dedent(
+        f"""
+        Local config file already exists. Updating...
+        Local repo configuration added in {config_file.pretty_overrides_path}
+
+        Local config content:
+        repo = "extras"
+
+        [repos]
+        extras = "{extras_path}"
+        """
+    )
+    # Reload new values
+    config_file.load()
+    assert_valid_local_config(config_file, overrides_config.parent, result, expected_output)
+
+
+def test_pyproject_not_found_ask_user(
+    ddev: CliRunner, config_file: ConfigFileWithOverrides, helpers, repository_as_cwd: ClonedRepo
+):
+    (repository_as_cwd.path / "pyproject.toml").unlink()
+    result = ddev("config", "override", input="extras")
+    extras_path = str(config_file.overrides_path.parent).replace("\\", "\\\\")
+
+    expected_output = helpers.dedent(
+        f"""
+        Local repo configuration added in {config_file.pretty_overrides_path}
+
+        Local config content:
+        repo = "extras"
+
+        [repos]
+        extras = "{extras_path}"
+        """
+    )
+    # Reload new values
+    config_file.load()
+    assert_valid_local_config(config_file, config_file.overrides_path.parent, result, expected_output)
+
+
+def test_misconfigured_pyproject_fails(
+    ddev: CliRunner, config_file: ConfigFileWithOverrides, helpers, repository_as_cwd: ClonedRepo
+):
+    # Setup wrongly configured pyproject.toml
+    pyproject_path = repository_as_cwd.path / "pyproject.toml"
+    pyproject = load_toml_file(pyproject_path)
+    pyproject["tool"]["ddev"] = {"repo": "wrong-repo"}
+    dump_toml_data(pyproject, pyproject_path)
+
+    result = ddev("config", "override")
+    assert result.exit_code == 1
+    assert "Invalid ddev metadata found in pyproject.toml" in result.output
+    assert "[tool.ddev.repo] is 'wrong-repo': Input should be 'integrations-core'" in result.output

ddev/tests/test__utils.py

@@ -6,17 +6,15 @@
 
 
 def test_cloned_repo(repository, local_repo):
-    integrations = sorted(
+    integrations = {
         entry.name for entry in repository.path.iterdir() if (repository.path / entry.name / 'manifest.json').is_file()
-    )
-    expected_integrations = sorted(
+    }
+    expected_integrations = {
         entry.name for entry in local_repo.iterdir() if (local_repo / entry.name / 'manifest.json').is_file()
-    )
+    }
 
     # Note: We are checking that the number of integrations is +- 1 from the `master`
     # branch as a workaround for scenarios where the current branch adds/removes
     # an integration and there has a different integration count than master.
-    if len(integrations) != len(expected_integrations):
-        assert abs(len(integrations) - len(expected_integrations)) == 1
-    else:
+    if abs(len(integrations) - len(expected_integrations)) > 1:
         assert integrations == expected_integrations