From 0c9f7c77350acad907882b3dd4e2ea5a7d1f3293 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonas=20=C3=85dahl?= <jadahl@gmail.com>
Date: Wed, 4 Nov 2020 18:35:04 +0100
Subject: [PATCH] ci/check-commit-log: Generate JUnit report

This will make it less horrible when commit message doesn't pass the
compliance checks.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1549>
---
 .gitlab-ci.yml                 |  6 +++
 .gitlab-ci/check-commit-log.sh | 88 ++++++++++++++++++++++++++--------
 2 files changed, 73 insertions(+), 21 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 4f029c16d..98eb667d3 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -12,6 +12,12 @@ check-commit-log:
     GIT_DEPTH: "100"
   script:
     - ./.gitlab-ci/check-commit-log.sh
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - commit-message-junit-report.xml
+    reports:
+      junit: commit-message-junit-report.xml
   only:
     - merge_requests
 
diff --git a/.gitlab-ci/check-commit-log.sh b/.gitlab-ci/check-commit-log.sh
index 754a7bca4..c309ff225 100755
--- a/.gitlab-ci/check-commit-log.sh
+++ b/.gitlab-ci/check-commit-log.sh
@@ -23,33 +23,80 @@ function commit_message_has_mr_url() {
   return $?
 }
 
-function commit_message_subject_is_compliant() {
+JUNIT_REPORT_TESTS_FILE=$(mktemp)
+
+function append_failed_test_case() {
+  test_name="$1"
+  commit="$2"
+  test_message="$3"
+  commit_short=${commit:0:8}
+
+  echo "<testcase name=\"$test_name: $commit_short\"><failure message=\"$commit_short: $test_message\"/></testcase>" >> $JUNIT_REPORT_TESTS_FILE
+  echo &>2 "Commit check failed: $commit_short: $test_message"
+}
+
+function append_passed_test_case() {
+  test_name="$1"
+  commit="$2"
+  commit_short=${commit:0:8}
+
+  echo "<testcase name=\"$test_name: $commit_short\"></testcase>" >> $JUNIT_REPORT_TESTS_FILE
+}
+
+function generate_junit_report() {
+  junit_report_file="$1"
+  num_tests=$(cat "$JUNIT_REPORT_TESTS_FILE" | wc -l)
+  num_failures=$(grep '<failure />' "$JUNIT_REPORT_TESTS_FILE" | wc -l )
+
+  echo Generating JUnit report \"$(pwd)/$junit_report_file\" with $num_tests tests and $num_failures failures.
+
+  cat > $junit_report_file << __EOF__
+<?xml version="1.0" encoding="utf-8"?>
+<testsuites tests="$num_tests" errors="0" failures="$num_failures">
+<testsuite name="commit-review" tests="$num_tests" errors="0" failures="$num_failures" skipped="0">
+$(< $JUNIT_REPORT_TESTS_FILE)
+</testsuite>
+</testsuites>
+__EOF__
+}
+
+function check_commit_message_subject() {
   commit=$1
   commit_message_subject=$(git show -s --format='format:%s' $commit)
 
   if echo "$commit_message_subject" | grep -qe "\(^meta-\|^Meta\)"; then
-    echo " - message subject should not be prefixed with 'meta-' or 'Meta'"
-    return 1
+    append_failed_test_case meta-prefix $commit \
+      "Commit message subject should not be prefixed with 'meta-' or 'Meta'"
+  else
+    append_passed_test_case meta-prefix $commit
   fi
 
   if echo "$commit_message_subject" | grep -qe "\(^clutter-\|^Clutter\)"; then
-    echo " - message subject should not be prefixed with 'clutter-' or 'Clutter', use 'clutter/' instead"
-    return 1
+    append_failed_test_case clutter-prefix $commit \
+      "Commit message subject should not be prefixed with 'clutter-' or 'Clutter', use 'clutter/' instead"
+  else
+    append_passed_test_case clutter-prefix $commit
   fi
 
   if echo "$commit_message_subject" | grep -qe "\(^cogl-\|^Cogl\)"; then
-    echo " - message subject should not be prefixed with 'cogl-' or 'Cogl', use 'cogl/' instead"
-    return 1
+    append_failed_test_case cogl-prefix $commit \
+      "Commit message subject should not be prefixed with 'cogl-' or 'Cogl', use 'cogl/' instead"
+  else
+    append_passed_test_case cogl-prefix $commit
   fi
 
   if echo "$commit_message_subject" | sed -e 's/^[^:]\+: //' | grep -qe '^[[:lower:]]'; then
-    echo " - message subject should be properly Capitalized. E.g. 'window: Marginalize extradicity'"
-    return 1
+    append_failed_test_case capitalization $commit \
+      "Commit message subject should be properly Capitalized. E.g. 'window: Marginalize extradicity'"
+  else
+    append_passed_test_case capitalization $commit
   fi
 
   if echo "$commit_message_subject" | grep -qe "\.[ch]:"; then
-    echo " - message subject prefix should not include .c, .h, etc."
-    return 1
+    append_failed_test_case not-file-suffix $commit \
+      "Commit message subject prefix should not include .c, .h, etc."
+  else
+    append_passed_test_case not-file-suffix $commit
   fi
 
   return 0
@@ -57,19 +104,18 @@ function commit_message_subject_is_compliant() {
 
 RET=0
 for commit in $commits; do
-  commit_short=$(echo $commit | cut -c -8)
 
   if commit_message_has_mr_url $commit; then
-    echo "Commit $commit_short must not contain a link to its own merge request"
-    exit 1
+    append_failed_test_case superfluous_url $commit \
+      "Commit message must not contain a link to its own merge request"
+  else
+    append_passed_test_case superfluous_url $commit
   fi
 
-  errors=$(commit_message_subject_is_compliant $commit)
-  if [ $? != 0 ]; then
-    echo "Commit message for $commit_short is not compliant:"
-    echo "$errors"
-    RET=1
-  fi
+  check_commit_message_subject $commit
 done
 
-exit $RET
+generate_junit_report commit-message-junit-report.xml
+
+! grep -q '<failure' commit-message-junit-report.xml
+exit $?