From: Alex Rousskov <rousskov@measurement-factory.com>
Date: Wed, 27 Mar 2024 18:41:41 +0000 (+0000)
Subject: CI: Require source-maintenance.sh application before merging PRs (#1760)
X-Git-Tag: SQUID_7_0_1~158
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e949a7d6c270c43552e8696edaac7557473d0bcc;p=thirdparty%2Fsquid.git

CI: Require source-maintenance.sh application before merging PRs (#1760)

By default, fixing PR-introduced code formatting problems should be that
PR responsibility. We did not enforced formatting because we did not
have CI automation to support that enforcement, and also because it was
tedious even for core developer to maintain the right astyle version.
Neither excuse remains valid these days.

In most development environments, it is not very difficult to install
Astyle v3.1 (and other Squid source maintenance tools). Our GitHub
Actions configuration file (.github/default.yaml) has a recipe. In
exceptional cases, including cases where a pull request was not
formatted because a different astyle version was installed, other
developers can (re)format PR sources (proactively or at author request).

Also fixed wrong error message when running source-maintenance.sh fails.
---

diff --git a/test-suite/test-sources.sh b/test-suite/test-sources.sh
index bad4cafe78..4da1fb80ed 100755
--- a/test-suite/test-sources.sh
+++ b/test-suite/test-sources.sh
@@ -131,20 +131,14 @@ check_source_maintenance() {
         return 0;
     fi
 
-    # The OS may not provide the right version of the astyle package, but
-    # source formatting (by developers) is not yet enforced, so we run with
-    # whatever astyle is provided, abusing the fact that $checker skips
-    # formatting iff it can execute a binary called astyle but does not like
-    # astyle's version.
-
     # Avoid distracting $checker warnings; TODO: Fix $checker instead.
     touch boilerplate_fix.sed
 
     if ! run $checker $copyrightOption no
     then
-        echo_error "Running $checker modified sources"
-        CHECK_OUTCOME_PHRASE="Ignored $checker failure" # maybe overwritten below
-        # TODO: Require source-maintenance.sh application instead of ignoring this error.
+        echo_error "Failure while running $checker"
+        CHECK_OUTCOME_PHRASE="$checker failure"
+        return 1
     fi
 
     if run git diff --exit-code
@@ -153,11 +147,11 @@ check_source_maintenance() {
     fi
 
     echo_error "Running $checker modified sources"
-    echo "The diff above details these modifications. Consider running $checker."
+    echo "The diff above details these modifications."
+    echo "advice: Run $checker. Review and commit correct modifications."
+    CHECK_OUTCOME_PHRASE="$checker modified sources"
     # TODO: Provide a downloadable patch that developers can apply.
-    CHECK_OUTCOME_PHRASE="Ignored the need to run $checker"
-    # TODO: Require source-maintenance.sh application instead of ignoring these changes.
-    return 0
+    return 1
 }
 
 run_one_check() {