Add protected branches option

This is done to allow fixup pushes to all branches except
the protected ones. This way fixup and squash commits can
be pushed to feature branches but not to configured ones
like for example main or master branches.

Author: sebastianfeldmann

src/Hook/Branch/Action/BlockFixupAndSquashCommits.php

@@ -32,7 +32,8 @@
  *    "action": "\\CaptainHook\\App\\Hook\\Branch\\Action\\BlockFixupAndSquashCommits",
  *    "options": {
  *      "blockSquashCommits": true,
- *      "blockFixupCommits": true
+ *      "blockFixupCommits": true,
+ *      "protectedBranches": ["main", "master", "integration"]
  *    },
  *    "conditions": []
  *  }
@@ -49,14 +50,23 @@ class BlockFixupAndSquashCommits implements Action
      *
      * @var bool
      */
-    private $blockFixupCommits = true;
+    private bool $blockFixupCommits = true;
 
     /**
      * Should squash! commits be blocked
      *
      * @var bool
      */
-    private $blockSquashCommits = true;
+    private bool $blockSquashCommits = true;
+
+    /**
+     * List of protected branches
+     *
+     * If not specified all branches are protected
+     *
+     * @var array<string>
+     */
+    private array $protectedBranches;
 
     /**
      * Return hook restriction
@@ -90,6 +100,9 @@ public function execute(Config $config, IO $io, Repository $repository, Config\A
         $this->handleOptions($action->getOptions());
 
         foreach ($refsToPush as $range) {
+            if (!empty($this->protectedBranches) && !in_array($range->from()->branch(), $this->protectedBranches)) {
+                return;
+            }
             $commits = $this->getBlockedCommits($repository, $range->from()->id(), $range->to()->id());
 
             if (count($commits) > 0) {
@@ -108,6 +121,7 @@ private function handleOptions(Config\Options $options): void
     {
         $this->blockSquashCommits = (bool) $options->get('blockSquashCommits', true);
         $this->blockFixupCommits  = (bool) $options->get('blockFixupCommits', true);
+        $this->protectedBranches  = $options->get('protectedBranches', []);
     }
 
     /**

tests/unit/Hook/Branch/Action/BlockFixupAndSquashCommitsTest.php

@@ -57,6 +57,29 @@ public function testExecuteSuccess(): void
         $this->assertTrue(true);
     }
 
+    /**
+     * Tests BlockFixupAndSquashCommits::execute
+     */
+    public function testExecuteSuccessBecauseOfUnprotectedBranch(): void
+    {
+        $input    = ['refs/heads/foo 12345 refs/heads/foo 98765'];
+        $io       = $this->createIOMock();
+        $repo     = $this->createRepositoryMock();
+        $config   = $this->createConfigMock();
+        $action   = $this->createActionConfigMock();
+        $operator = $this->createGitLogOperator();
+        $options  = new Options(['protectedBranches' => ['main']]);
+        $action->expects($this->once())->method('getOptions')->willReturn($options);
+        $io->expects($this->once())->method('getStandardInput')->willReturn($input);
+        $operator->method('getCommitsBetween')->willReturn($this->getFakeCommits());
+        $repo->method('getLogOperator')->willReturn($operator);
+
+        $blocker = new BlockFixupAndSquashCommits();
+        $blocker->execute($config, $io, $repo, $action);
+
+        $this->assertTrue(true);
+    }
+
     /**
      * Tests BlockFixupAndSquashCommits::execute
      */
@@ -78,6 +101,7 @@ public function testExecuteSuccessWithNoChangesFromLocalAndRemote(): void
 
         $this->assertTrue(true);
     }
+
     /**
      * Tests BlockFixupAndSquashCommits::execute
      */
@@ -100,6 +124,29 @@ public function testExecuteBlockFixup(): void
         $blocker->execute($config, $io, $repo, $action);
     }
 
+    /**
+     * Tests BlockFixupAndSquashCommits::execute
+     */
+    public function testExecuteBlockFixupForProtectedBranch(): void
+    {
+        $this->expectException(Exception::class);
+
+        $input    = ['refs/heads/main 12345 refs/heads/main 98765'];
+        $io       = $this->createIOMock();
+        $repo     = $this->createRepositoryMock();
+        $config   = $this->createConfigMock();
+        $action   = $this->createActionConfigMock();
+        $operator = $this->createGitLogOperator();
+        $options  = new Options(['protectedBranches' => ['main']]);
+        $action->expects($this->once())->method('getOptions')->willReturn($options);
+        $io->expects($this->once())->method('getStandardInput')->willReturn($input);
+        $operator->method('getCommitsBetween')->willReturn($this->getFakeCommits('fixup! Foo'));
+        $repo->method('getLogOperator')->willReturn($operator);
+
+        $blocker = new BlockFixupAndSquashCommits();
+        $blocker->execute($config, $io, $repo, $action);
+    }
+
     /**
      * Tests BlockFixupAndSquashCommits::execute
      */