Merge pull request #52 from canvas-medical/db-20260204-stage-before-commit

Ensure files are staged before the changes are committed

Author: andhines

canvas-plugin-assistant/scripts/git_commit_plugin.py

@@ -62,6 +62,9 @@ def run(cls, hook_info: HookInformation) -> None:
 
             print(f"Wrap-up report found: {latest_report.name}", file=sys.stderr)
 
+            # Stage all files in the plugin directory
+            cls._stage_files(plugin_dir)
+
             # Check if there are any changes in the plugin directory
             if not cls._has_changes(plugin_dir):
                 print("No changes detected in plugin directory, skipping commit", file=sys.stderr)
@@ -114,6 +117,35 @@ def _has_changes(cls, plugin_dir: Path) -> bool:
         finally:
             os.chdir(original_cwd)
 
+    @classmethod
+    def _stage_files(cls, plugin_dir: Path) -> None:
+        """
+        Stage all files in the plugin directory.
+
+        Uses `git add -A .` to stage all modified, added, and deleted files
+        within the plugin directory.
+
+        Args:
+            plugin_dir: Path to the plugin directory
+
+        Raises:
+            subprocess.CalledProcessError: If the git command fails
+        """
+        original_cwd = Path.cwd()
+        try:
+            os.chdir(plugin_dir)
+
+            # Stage all changes in plugin directory
+            subprocess.run(
+                ["git", "add", "-A", "."],
+                check=True,
+                capture_output=True,
+                text=True
+            )
+
+        finally:
+            os.chdir(original_cwd)
+
     @classmethod
     def _commit_and_push(cls, plugin_dir: Path) -> None:
         """

tests/canvas-plugin-assistant/scripts/test_git_commit_plugin.py

@@ -77,10 +77,11 @@ def test_run__no_wrap_up_reports(self, mock_exit, tmp_path):
         exp_exit_calls = [call(0)]
         assert mock_exit.mock_calls == exp_exit_calls
 
+    @patch("git_commit_plugin.GitCommitPlugin._stage_files")
     @patch("git_commit_plugin.GitCommitPlugin._has_changes")
     @patch("git_commit_plugin.sys.exit")
     def test_run__no_changes_detected(
-        self, mock_exit, mock_has_changes, tmp_path, capsys
+        self, mock_exit, mock_has_changes, mock_stage_files, tmp_path, capsys
     ):
         """Test run exits 0 when _has_changes returns False."""
         hook_info = make_hook_info(tmp_path)
@@ -89,6 +90,7 @@ def test_run__no_changes_detected(
         artifacts_dir.mkdir()
         (artifacts_dir / "wrap-up-report-20240101.md").write_text("report content")
 
+        mock_stage_files.side_effect = [None]
         mock_has_changes.side_effect = [False]
         mock_exit.side_effect = [SystemExit(0)]
 
@@ -97,8 +99,9 @@ def test_run__no_changes_detected(
         with pytest.raises(SystemExit):
             tested.run(hook_info)
 
-        exp_has_changes_calls = [call(hook_info.workspace_dir)]
-        assert mock_has_changes.mock_calls == exp_has_changes_calls
+        exp_calls = [call(hook_info.workspace_dir)]
+        assert mock_stage_files.mock_calls == exp_calls
+        assert mock_has_changes.mock_calls == exp_calls
 
         # Verify print calls for wrap-up found and no changes detected
         captured = capsys.readouterr()
@@ -108,11 +111,12 @@ def test_run__no_changes_detected(
         exp_exit_calls = [call(0)]
         assert mock_exit.mock_calls == exp_exit_calls
 
+    @patch("git_commit_plugin.GitCommitPlugin._stage_files")
     @patch("git_commit_plugin.GitCommitPlugin._commit_and_push")
     @patch("git_commit_plugin.GitCommitPlugin._has_changes")
     @patch("git_commit_plugin.sys.exit")
     def test_run__success(
-        self, mock_exit, mock_has_changes, mock_commit_and_push, tmp_path, capsys
+        self, mock_exit, mock_has_changes, mock_commit_and_push, mock_stage_files, tmp_path, capsys
     ):
         """Test run exits 0 on successful commit and push."""
         hook_info = make_hook_info(tmp_path)
@@ -121,6 +125,7 @@ def test_run__success(
         artifacts_dir.mkdir()
         (artifacts_dir / "wrap-up-report-20240101.md").write_text("report content")
 
+        mock_stage_files.side_effect = [None]
         mock_has_changes.side_effect = [True]
         mock_commit_and_push.side_effect = [None]
         mock_exit.side_effect = [SystemExit(0)]
@@ -130,11 +135,10 @@ def test_run__success(
         with pytest.raises(SystemExit):
             tested.run(hook_info)
 
-        exp_has_changes_calls = [call(hook_info.workspace_dir)]
-        assert mock_has_changes.mock_calls == exp_has_changes_calls
-
-        exp_commit_and_push_calls = [call(hook_info.workspace_dir)]
-        assert mock_commit_and_push.mock_calls == exp_commit_and_push_calls
+        exp_calls = [call(hook_info.workspace_dir)]
+        assert mock_stage_files.mock_calls == exp_calls
+        assert mock_has_changes.mock_calls == exp_calls
+        assert mock_commit_and_push.mock_calls == exp_calls
 
         # Verify print calls for wrap-up found and committing
         captured = capsys.readouterr()
@@ -144,11 +148,12 @@ def test_run__success(
         exp_exit_calls = [call(0)]
         assert mock_exit.mock_calls == exp_exit_calls
 
+    @patch("git_commit_plugin.GitCommitPlugin._stage_files")
     @patch("git_commit_plugin.GitCommitPlugin._commit_and_push")
     @patch("git_commit_plugin.GitCommitPlugin._has_changes")
     @patch("git_commit_plugin.sys.exit")
     def test_run__subprocess_error(
-        self, mock_exit, mock_has_changes, mock_commit_and_push, tmp_path, capsys
+        self, mock_exit, mock_has_changes, mock_commit_and_push, mock_stage_files, tmp_path, capsys
     ):
         """Test run exits 1 when subprocess.CalledProcessError is raised."""
         hook_info = make_hook_info(tmp_path)
@@ -157,6 +162,7 @@ def test_run__subprocess_error(
         artifacts_dir.mkdir()
         (artifacts_dir / "wrap-up-report-20240101.md").write_text("report content")
 
+        mock_stage_files.side_effect = [None]
         mock_has_changes.side_effect = [True]
         error = subprocess.CalledProcessError(1, "git push", stderr="push failed")
         mock_commit_and_push.side_effect = [error]
@@ -167,11 +173,10 @@ def test_run__subprocess_error(
         with pytest.raises(SystemExit):
             tested.run(hook_info)
 
-        exp_has_changes_calls = [call(hook_info.workspace_dir)]
-        assert mock_has_changes.mock_calls == exp_has_changes_calls
-
-        exp_commit_and_push_calls = [call(hook_info.workspace_dir)]
-        assert mock_commit_and_push.mock_calls == exp_commit_and_push_calls
+        exp_calls = [call(hook_info.workspace_dir)]
+        assert mock_stage_files.mock_calls == exp_calls
+        assert mock_has_changes.mock_calls == exp_calls
+        assert mock_commit_and_push.mock_calls == exp_calls
 
         # Verify print was called with error message to stderr
         captured = capsys.readouterr()
@@ -182,11 +187,12 @@ def test_run__subprocess_error(
         exp_exit_calls = [call(1)]
         assert mock_exit.mock_calls == exp_exit_calls
 
+    @patch("git_commit_plugin.GitCommitPlugin._stage_files")
     @patch("git_commit_plugin.GitCommitPlugin._commit_and_push")
     @patch("git_commit_plugin.GitCommitPlugin._has_changes")
     @patch("git_commit_plugin.sys.exit")
     def test_run__generic_error(
-        self, mock_exit, mock_has_changes, mock_commit_and_push, tmp_path, capsys
+        self, mock_exit, mock_has_changes, mock_commit_and_push, mock_stage_files, tmp_path, capsys
     ):
         """Test run exits 1 when a generic Exception is raised."""
         hook_info = make_hook_info(tmp_path)
@@ -195,6 +201,7 @@ def test_run__generic_error(
         artifacts_dir.mkdir()
         (artifacts_dir / "wrap-up-report-20240101.md").write_text("report content")
 
+        mock_stage_files.side_effect = [None]
         mock_has_changes.side_effect = [True]
         mock_commit_and_push.side_effect = [Exception("Unexpected error occurred")]
         mock_exit.side_effect = [SystemExit(1)]
@@ -204,11 +211,10 @@ def test_run__generic_error(
         with pytest.raises(SystemExit):
             tested.run(hook_info)
 
-        exp_has_changes_calls = [call(hook_info.workspace_dir)]
-        assert mock_has_changes.mock_calls == exp_has_changes_calls
-
-        exp_commit_and_push_calls = [call(hook_info.workspace_dir)]
-        assert mock_commit_and_push.mock_calls == exp_commit_and_push_calls
+        exp_calls = [call(hook_info.workspace_dir)]
+        assert mock_stage_files.mock_calls == exp_calls
+        assert mock_has_changes.mock_calls == exp_calls
+        assert mock_commit_and_push.mock_calls == exp_calls
 
         # Verify print was called with error message to stderr
         captured = capsys.readouterr()
@@ -219,10 +225,11 @@ def test_run__generic_error(
         exp_exit_calls = [call(1)]
         assert mock_exit.mock_calls == exp_exit_calls
 
+    @patch("git_commit_plugin.GitCommitPlugin._stage_files")
     @patch("git_commit_plugin.GitCommitPlugin._has_changes")
     @patch("git_commit_plugin.sys.exit")
     def test_run__multiple_reports_selects_most_recent(
-        self, mock_exit, mock_has_changes, tmp_path, capsys
+        self, mock_exit, mock_has_changes, mock_stage_files, tmp_path, capsys
     ):
         """Test run selects the most recent wrap-up report by mtime."""
         hook_info = make_hook_info(tmp_path)
@@ -238,6 +245,7 @@ def test_run__multiple_reports_selects_most_recent(
         report_newest = artifacts_dir / "wrap-up-report-newest.md"
         report_newest.write_text("newest report")
 
+        mock_stage_files.side_effect = [None]
         mock_has_changes.side_effect = [False]
         mock_exit.side_effect = [SystemExit(0)]
 
@@ -246,8 +254,9 @@ def test_run__multiple_reports_selects_most_recent(
         with pytest.raises(SystemExit):
             tested.run(hook_info)
 
-        exp_has_changes_calls = [call(hook_info.workspace_dir)]
-        assert mock_has_changes.mock_calls == exp_has_changes_calls
+        exp_calls = [call(hook_info.workspace_dir)]
+        assert mock_stage_files.mock_calls == exp_calls
+        assert mock_has_changes.mock_calls == exp_calls
 
         # Verify the print shows the most recent report
         captured = capsys.readouterr()