feat(core): preserve staged files when editing renku config (#2871)

Author: mohammad-alisafaee

renku/command/command_builder/command.py

@@ -414,6 +414,7 @@ def with_commit(
         commit_if_empty: bool = False,
         raise_if_empty: bool = False,
         commit_only: Optional[bool] = None,
+        skip_staging: bool = False,
     ) -> "Command":
         """Create a commit.
 
@@ -426,7 +427,7 @@ def with_commit(
         """
         from renku.command.command_builder.repo import Commit
 
-        return Commit(self, message, commit_if_empty, raise_if_empty, commit_only)
+        return Commit(self, message, commit_if_empty, raise_if_empty, commit_only, skip_staging)
 
     @check_finalized
     def lock_project(self) -> "Command":

renku/command/command_builder/repo.py

@@ -35,6 +35,7 @@ def __init__(
         commit_if_empty: Optional[bool] = False,
         raise_if_empty: Optional[bool] = False,
         commit_only: Optional[bool] = None,
+        skip_staging: bool = False,
     ) -> None:
         """__init__ of Commit.
 
@@ -49,6 +50,7 @@ def __init__(
         self._commit_if_empty = commit_if_empty
         self._raise_if_empty = raise_if_empty
         self._commit_filter_paths = commit_only
+        self._skip_staging: bool = skip_staging
 
     def _pre_hook(self, builder: Command, context: dict, *args, **kwargs) -> None:
         """Hook to create a commit transaction.
@@ -65,7 +67,9 @@ def _pre_hook(self, builder: Command, context: dict, *args, **kwargs) -> None:
         from renku.core.management.git import prepare_commit
 
         self.diff_before = prepare_commit(
-            context["client_dispatcher"].current_client, commit_only=self._commit_filter_paths
+            context["client_dispatcher"].current_client,
+            commit_only=self._commit_filter_paths,
+            skip_staging=self._skip_staging,
         )
 
     def _post_hook(self, builder: Command, context: dict, result: CommandResult, *args, **kwargs):
@@ -90,6 +94,7 @@ def _post_hook(self, builder: Command, context: dict, result: CommandResult, *ar
                 commit_empty=self._commit_if_empty,
                 raise_if_empty=self._raise_if_empty,
                 commit_message=self._message,
+                skip_staging=self._skip_staging,
             )
         except errors.RenkuException as e:
             result.error = e

renku/command/config.py

@@ -100,7 +100,7 @@ def update_config():
         Command()
         .command(_update_config)
         .require_migration()
-        .with_commit(commit_if_empty=False, commit_only=CONFIG_LOCAL_PATH)
+        .with_commit(commit_if_empty=False, commit_only=CONFIG_LOCAL_PATH, skip_staging=True)
         .with_database()
     )
 

renku/core/management/git.py

@@ -38,14 +38,14 @@
 STARTED_AT = int(time.time() * 1e3)
 
 
-def prepare_commit(
-    client,
-    commit_only=None,
-    skip_dirty_checks=False,
-):
+def prepare_commit(client, commit_only=None, skip_dirty_checks=False, skip_staging: bool = False):
     """Gather information about repo needed for committing later on."""
     diff_before = set()
 
+    if skip_staging:
+        if not isinstance(commit_only, list) or len(commit_only) == 0:
+            raise errors.OperationError("Cannot use ``skip_staging`` without specifying files to commit.")
+
     if commit_only == COMMIT_DIFF_STRATEGY:
         if len(client.repository.staged_changes) > 0 or len(client.repository.unstaged_changes) > 0:
             client.repository.reset()
@@ -73,6 +73,7 @@ def finalize_commit(
     raise_if_empty=False,
     commit_message=None,
     abbreviate_message=True,
+    skip_staging: bool = False,
 ):
     """Commit modified/added paths."""
     from renku.infrastructure.repository import Actor
@@ -127,8 +128,10 @@ def finalize_commit(
     if abbreviate_message:
         commit_message = shorten_message(commit_message)
 
+    # NOTE: Only commit specified paths when skipping staging area
+    paths = commit_only if skip_staging else []
     # Ignore pre-commit hooks since we have already done everything.
-    client.repository.commit(commit_message + client.transaction_id, committer=committer, no_verify=True)
+    client.repository.commit(commit_message + client.transaction_id, committer=committer, no_verify=True, paths=paths)
 
 
 def prepare_worktree(

renku/infrastructure/repository.py

@@ -207,6 +207,7 @@ def commit(
         committer: "Actor" = None,
         no_verify: bool = False,
         no_edit: bool = False,
+        paths: Optional[List[Union[Path, str]]] = None,
     ) -> "Commit":
         """Commit added files to the VCS."""
         if self._repository is None:
@@ -217,7 +218,12 @@ def commit(
         if committer:
             env.update({"GIT_COMMITTER_NAME": committer.name, "GIT_COMMITTER_EMAIL": committer.email})
 
-        self.run_git_command("commit", message=message, no_verify=no_verify, amend=amend, no_edit=no_edit, env=env)
+        # NOTE: Only commit specified paths
+        args = ["--"] + [str(p) for p in paths] if paths else []
+
+        self.run_git_command(
+            "commit", *args, message=message, no_verify=no_verify, amend=amend, no_edit=no_edit, env=env
+        )
 
         return Commit.from_commit(self._repository, self._repository.head.commit)
 

tests/cli/test_config.py

@@ -16,6 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Test ``config`` command."""
+import os
 import subprocess
 import sys
 from threading import Thread
@@ -272,3 +273,22 @@ def test_config_interpolation_is_disabled(client, runner, value):
 
     assert 0 == result.exit_code, format_result_exception(result)
     assert f"{value}\n" == result.output
+
+
+def test_config_commit(client, runner, data_repository, global_config_dir):
+    """Test config changes only commits the renku config file."""
+    commit_sha_before = client.repository.head.commit.hexsha
+
+    (client.path / "untracked").write_text("untracked")
+    (client.path / "staged").write_text("staged")
+    client.repository.add("staged")
+
+    result = runner.invoke(cli, ["config", "set", "key", "value"])
+
+    assert 0 == result.exit_code, format_result_exception(result)
+    assert {os.path.join(".renku", "renku.ini")} == {f.a_path for f in client.repository.head.commit.get_changes()}
+    assert {"untracked"} == set(client.repository.untracked_files)
+    assert {"staged"} == {f.a_path for f in client.repository.staged_changes}
+
+    commit_sha_after = client.repository.head.commit.hexsha
+    assert commit_sha_after != commit_sha_before