feat(git): add API to modify repo configuration (#754)

Signed-off-by: Dariusz Duda <[email protected]>

Author: dariuszd21

craft_application/git/_git_repo.py

@@ -710,6 +710,21 @@ def clone_repository(
             ) from error
         return cls(path)
 
+    def get_config_value(self, key: str) -> str | None:
+        """Get value for the configuration key if available else return None."""
+        try:
+            return cast(str, self._repo.config[key])  # pyright: ignore[reportUnnecessaryCast]
+        except (KeyError, ValueError):
+            logger.debug("Config key %r not found in the repository", key)
+            return None
+
+    def set_config_value(self, key: str, value: str) -> None:
+        """Set new value for the configuration key.
+
+        :raises ValueError: if configuration is incorrect
+        """
+        self._repo.config[key] = value
+
     @classmethod
     @lru_cache(maxsize=1)
     def get_git_command(cls) -> str:

docs/reference/changelog.rst

@@ -18,13 +18,18 @@ Commands
 
 - Reduce spread verbosity level when running the ``test`` command.
 
+Git
+===
+
+- Add API to modify repository configuration.
+
 Fixes
 ======
 
 - Improve test result messages.
 - ``InitService`` no longer leaves empty files if rendering template fails.
 
-For a complete list of commits, check out the `5.2.1`_ release on GitHub.
+For a complete list of commits, check out the `5.3.0`_ release on GitHub.
 
 5.2.0 (2025-04-25)
 ------------------
@@ -772,4 +777,4 @@ For a complete list of commits, check out the `2.7.0`_ release on GitHub.
 .. _5.0.4: https://github.com/canonical/craft-application/releases/tag/5.0.4
 .. _5.1.0: https://github.com/canonical/craft-application/releases/tag/5.1.0
 .. _5.2.0: https://github.com/canonical/craft-application/releases/tag/5.2.0
-.. _5.2.1: https://github.com/canonical/craft-application/releases/tag/5.2.1
+.. _5.3.0: https://github.com/canonical/craft-application/releases/tag/5.3.0

tests/integration/git/test_git.py

@@ -16,12 +16,18 @@
 """Git module integration tests."""
 
 import pathlib
+import re
 
 import pytest
 
 from craft_application.git import NO_PUSH_URL, Commit, GitError, GitRepo
 
 
+@pytest.fixture
+def git_repo(empty_repository: pathlib.Path) -> GitRepo:
+    return GitRepo(empty_repository)
+
+
 @pytest.mark.slow
 def test_fetching_hello_repository(
     empty_repository: pathlib.Path,
@@ -97,3 +103,49 @@ def test_set_no_push(
     git_repo.set_no_push(test_remote)
     assert git_repo.get_remote_url(remote_name=test_remote) == hello_repository_lp_url
     assert git_repo.get_remote_push_url(remote_name=test_remote) == NO_PUSH_URL
+
+
+@pytest.mark.parametrize(
+    ("config_key", "expected_value"),
+    [("core.bare", "false"), ("non_existent.key", None)],
+)
+def test_get_repo_configuration(
+    git_repo: GitRepo, config_key: str, expected_value: str | None
+) -> None:
+    assert git_repo.get_config_value(config_key) == expected_value
+
+
+def test_set_repo_configuration(git_repo: GitRepo) -> None:
+    new_key = "test.craft"
+    new_value = "just-testing"
+    assert git_repo.get_config_value(new_key) is None
+    git_repo.set_config_value(new_key, new_value)
+    assert git_repo.get_config_value(new_key) == new_value
+
+
+def test_update_repo_configuration(git_repo: GitRepo) -> None:
+    key = "test.craft"
+    old_value = "just-old"
+    new_value = "just-new"
+    git_repo.set_config_value(key, old_value)
+    assert git_repo.get_config_value(key) == old_value
+    git_repo.set_config_value(key, new_value)
+    assert git_repo.get_config_value(key) == new_value
+
+
+def test_update_boolean_with_string_value(git_repo: GitRepo) -> None:
+    key = "core.bare"
+    new_value = "incorrect-boolean"
+    # this makes repository inaccessible via git CLI client
+    # fatal: bad boolean config value 'incorrect-boolean' for 'core.bare'
+    git_repo.set_config_value(key, new_value)
+    assert git_repo.get_config_value(key) == new_value
+
+
+def test_incorrect_config_key(git_repo: GitRepo) -> None:
+    key = "craft.incorrect&test*key"
+    new_value = "not-important"
+    with pytest.raises(
+        ValueError, match=re.escape(f"invalid config item name {key!r}")
+    ):
+        git_repo.set_config_value(key, new_value)

tests/unit/git/test_utils.py

@@ -64,8 +64,11 @@ def write_metadata(snap_path: pathlib.Path, content: str) -> None:
     snap_metadata.write_text(content)
 
 
-def test_import_fallback_in_non_snap_environment() -> None:
+def test_import_fallback_in_non_snap_environment(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
     """Fallback to previous one if not running as a snap."""
+    monkeypatch.delenv("SNAP", raising=False)
     assert find_ssl_cert_dir() == _FALLBACK_PATH, (
         "Use fallback if not installed as a snap."
     )