[BRE-831] Updating error wording for repos with custom default branches (#144)

Author: pixman20

src/bitwarden_workflow_linter/rules/check_pr_target.py

@@ -58,7 +58,8 @@ def fn(self, obj: Workflow) -> Tuple[bool, str]:
             result, check_job = self.has_check_run(obj)
             main_branch_only = self.targets_main_branch(obj)
             if not main_branch_only:
-                Errors.append("Workflows using pull_request_target can only target the main branch")
+                default_branch = self.settings.default_branch
+                Errors.append(f"Workflows using pull_request_target can only target the '{default_branch}' branch")
             if result:
                 missing_jobs = self.check_run_required(obj, check_job)
                 if missing_jobs:

tests/rules/test_check_pr_target.py

@@ -30,13 +30,13 @@ def fixture_correct_workflow():
   check-run:
     name: Check PR run
     uses: bitwarden/gh-actions/.github/workflows/check-run.yml@main
-  
+
   quality:
     name: Quality scan
     needs: check-run
     steps:
       - run: echo test
- 
+
   dependent-job:
      name: Another Dependent Job
      needs:
@@ -85,7 +85,7 @@ def fixture_no_needs_workflow():
     runs-on: ubuntu-22.04
     steps:
       - run: echo test
-  
+
   quality:
     name: Quality scan
     steps:
@@ -124,13 +124,13 @@ def dependent_missing_check_workflow():
   check-run:
     name: Check PR run
     uses: bitwarden/gh-actions/.github/workflows/check-run.yml@main
-  
+
   quality:
     name: Quality scan
     needs: check-run
     steps:
       - run: echo test
- 
+
   dependent-job:
      name: Another Dependent Job
      needs:
@@ -153,13 +153,13 @@ def fixture_no_branches_workflow():
   check-run:
     name: Check PR run
     uses: bitwarden/gh-actions/.github/workflows/check-run.yml@main
-  
+
   quality:
     name: Quality scan
     needs: check-run
     steps:
       - run: echo test
- 
+
   dependent-job:
      name: Another Dependent Job
      needs:
@@ -186,13 +186,13 @@ def fixture_bad_branches_workflow():
   check-run:
     name: Check PR run
     uses: bitwarden/gh-actions/.github/workflows/check-run.yml@main
-  
+
   quality:
     name: Quality scan
     needs: check-run
     steps:
       - run: echo test
- 
+
   dependent-job:
      name: Another Dependent Job
      needs:
@@ -216,13 +216,13 @@ def fixture_two_failures_workflow():
   check-run:
     name: Check PR run
     uses: bitwarden/some-other-repo/.github/workflows/check-run.yml@main
-  
+
   quality:
     name: Quality scan
     needs: check-run
     steps:
       - run: echo test
- 
+
   dependent-job:
      name: Another Dependent Job
      needs:
@@ -269,11 +269,11 @@ def test_targets_main_branch_no_default_branch(mock_workflow):
     with patch("src.bitwarden_workflow_linter.utils.Settings.factory") as mock_factory:
         # Simulate the default settings returned by the factory
         mock_factory.return_value = Settings(default_branch="main")
-        
+
         # Use the mocked factory to create the Settings instance
         settings = Settings.factory()
         rule = RuleCheckPrTarget(settings=settings)
-        
+
         # Assert that the workflow targets the main branch
         assert rule.targets_main_branch(mock_workflow) is True
 
@@ -317,14 +317,14 @@ def test_rule_on_dependencies_without_check(rule, dependent_missing_check_workfl
 def test_rule_on_no_branches_workflow(rule, no_branches_workflow):
     result, message = rule.fn(no_branches_workflow)
     assert result is False
-    assert message == "Workflows using pull_request_target can only target the main branch"
+    assert message == "Workflows using pull_request_target can only target the 'main' branch"
 
 def test_rule_on_only_target_main(rule, bad_branches_workflow):
     result, message = rule.fn(bad_branches_workflow)
     assert result is False
-    assert message == "Workflows using pull_request_target can only target the main branch"
+    assert message == "Workflows using pull_request_target can only target the 'main' branch"
 
 def test_rule_on_two_failures(rule, two_failures_workflow):
     result, message = rule.fn(two_failures_workflow)
     assert result is False
-    assert message == "Workflows using pull_request_target can only target the main branch\nA check-run job must be included as a direct job dependency when pull_request_target is used"
+    assert message == "Workflows using pull_request_target can only target the 'main' branch\nA check-run job must be included as a direct job dependency when pull_request_target is used"