Merge pull request #10526 from gitbutlerapp/hook-errors

Tests around commit hooks

Author: Caleb-T-Owens

apps/desktop/src/components/NewCommitView.svelte

@@ -84,6 +84,18 @@
 				throw new Error('No branch selected!');
 			}
 
+			// Run commit-msg hook if hooks are enabled
+			let finalMessage = message;
+			if ($runCommitHooks) {
+				const messageHookResult = await hooksService.message(projectId, message);
+				if (messageHookResult?.status === 'failure') {
+					showError('Commit message hook failed', messageHookResult.error);
+					return;
+				} else if (messageHookResult?.status === 'message') {
+					finalMessage = messageHookResult.message;
+				}
+			}
+
 			const worktreeChanges = await uncommittedService.worktreeChanges(projectId, stackId);
 
 			// Get current editor mode from the component instance
@@ -94,7 +106,7 @@
 				projectId,
 				stackId: finalStackId,
 				selectedBranchName: finalBranchName,
-				message,
+				message: finalMessage,
 				parentId,
 				isRichTextMode
 			});
@@ -108,7 +120,7 @@
 					projectId,
 					parentId,
 					stackId: finalStackId,
-					message: message,
+					message: finalMessage,
 					stackBranchName: finalBranchName,
 					worktreeChanges
 				},

e2e/playwright/scripts/create-allowed-file.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+# Create a file with allowed content
+
+pushd local-with-hooks
+echo "This is allowed content" > allowed.txt
+popd

e2e/playwright/scripts/create-forbidden-file.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+# Create a file with forbidden content
+
+pushd local-with-hooks
+echo "This contains FORBIDDEN content" > forbidden.txt
+popd

e2e/playwright/scripts/create-postcommit-fail-marker.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+# Create a marker file to trigger post-commit failure
+
+pushd local-with-hooks
+touch FAIL_POST_COMMIT
+popd

e2e/playwright/scripts/project-with-commit-hooks.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+
+echo "GIT CONFIG $GIT_CONFIG_GLOBAL"
+echo "DATA DIR $GITBUTLER_CLI_DATA_DIR"
+echo "BUT_TESTING $BUT_TESTING"
+
+# Setup a remote project
+mkdir remote-with-hooks
+pushd remote-with-hooks
+git init -b master --object-format=sha1
+echo "Initial content" >> initial_file.txt
+git add initial_file.txt
+git commit -am "Initial commit"
+popd
+
+# Clone the remote into a folder
+git clone remote-with-hooks local-with-hooks
+pushd local-with-hooks
+  git checkout master
+
+  # Create a commit-msg hook that modifies the message
+  mkdir -p .git/hooks
+  cat > .git/hooks/commit-msg << 'HOOK_EOF'
+#!/bin/sh
+# This hook modifies commit messages by adding a prefix
+MESSAGE_FILE="$1"
+ORIGINAL_MESSAGE=$(cat "$MESSAGE_FILE")
+
+# If message contains "REJECT", reject it
+if echo "$ORIGINAL_MESSAGE" | grep -q "REJECT"; then
+  echo "Error: Commit message contains forbidden word REJECT"
+  exit 1
+fi
+
+# If message contains "MODIFY", add a prefix
+if echo "$ORIGINAL_MESSAGE" | grep -q "MODIFY"; then
+  echo "[MODIFIED] $ORIGINAL_MESSAGE" > "$MESSAGE_FILE"
+fi
+HOOK_EOF
+
+  chmod +x .git/hooks/commit-msg
+
+  # Create a pre-commit hook that checks for forbidden content
+  cat > .git/hooks/pre-commit << 'HOOK_EOF'
+#!/bin/sh
+# This hook checks staged files for forbidden content
+
+# Get the list of staged files
+STAGED_FILES=$(git diff --cached --name-only)
+
+# Check each staged file for FORBIDDEN content
+for file in $STAGED_FILES; do
+  if [ -f "$file" ]; then
+    if grep -q "FORBIDDEN" "$file"; then
+      echo "Error: File $file contains FORBIDDEN content"
+      exit 1
+    fi
+  fi
+done
+
+exit 0
+HOOK_EOF
+
+  chmod +x .git/hooks/pre-commit
+
+  # Create a post-commit hook that can be triggered to fail
+  cat > .git/hooks/post-commit << 'HOOK_EOF'
+#!/bin/sh
+# This hook checks if a marker file exists to trigger failure
+
+if [ -f "FAIL_POST_COMMIT" ]; then
+  echo "Error: Post-commit hook failed due to FAIL_POST_COMMIT marker"
+  exit 1
+fi
+
+exit 0
+HOOK_EOF
+
+  chmod +x .git/hooks/post-commit
+
+  # Add some uncommitted changes for testing
+  echo "Uncommitted changes" >> uncommitted.txt
+
+  # Add the project to GitButler
+  $BUT_TESTING add-project --switch-to-workspace "$(git rev-parse --symbolic-full-name @{u})"
+popd