[libgweather/clang-format: 3/5] ci: Add a style check stage

[Emmanuele Bassi <ebassi src gnome org>]

commit 880b84139a481e5e2308dc41db57ecba0cd55cc0
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Sat Oct 16 23:55:11 2021 +0100

    ci: Add a style check stage
    
    Run clang-format-diff on the C sources, and fail if the coding style
    isn't respected.

 .gitlab-ci.yml                       | 15 +++++++++++++++
 .gitlab-ci/run-style-check.sh        | 18 ++++++++++++++++++
 .gitlab-ci/search-common-ancestor.sh | 36 ++++++++++++++++++++++++++++++++++++
 3 files changed, 69 insertions(+)
---
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index f0326abd..6624f9e9 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,11 +1,26 @@
 variables:
 
 stages:
+  - style-check
   - build
   - analysis
   - docs
   - deploy
 
+.only-default:
+  only:
+    - branches
+  except:
+    - tags
+
+style-check-diff:
+  extends: .only-default
+  image: fedora:latest
+  stage: style-check
+  before_script:
+    - dnf install -y clang-tools-extra
+    - sh -x ./.gitlab-ci/run-style-check.sh
+
 # Recipe for setting up the build
 # @PROJECT_DEPS: the dependencies of the project (on Fedora)
 # @MESON_VERSION: the version of Meson required by the project
diff --git a/.gitlab-ci/run-style-check.sh b/.gitlab-ci/run-style-check.sh
new file mode 100755
index 00000000..d3cf878b
--- /dev/null
+++ b/.gitlab-ci/run-style-check.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+ancestor_horizon=28  # days (4 weeks)
+
+# Wrap everything in a subshell so we can propagate the exit status.
+(
+
+source .gitlab-ci/search-common-ancestor.sh
+
+git diff -U0 --no-color "${newest_common_ancestor_sha}" libgweather/*.c libgweather/tests/*.c 
libgweather/tools/*.c | clang-format-diff -p1
+
+)
+)
+exit_status=$?
+
+exit ${exit_status}
diff --git a/.gitlab-ci/search-common-ancestor.sh b/.gitlab-ci/search-common-ancestor.sh
new file mode 100755
index 00000000..7f1fd0b7
--- /dev/null
+++ b/.gitlab-ci/search-common-ancestor.sh
@@ -0,0 +1,36 @@
+#!/bin/bash
+
+set -e
+
+ancestor_horizon=28  # days (4 weeks)
+
+# We need to add a new remote for the upstream target branch, since this script
+# could be running in a personal fork of the repository which has out of date
+# branches.
+#
+# Limit the fetch to a certain date horizon to limit the amount of data we get.
+# If the branch was forked from origin/main before this horizon, it should
+# probably be rebased.
+if ! git ls-remote --exit-code upstream >/dev/null 2>&1 ; then
+    git remote add upstream https://gitlab.gnome.org/GNOME/glib.git
+fi
+git fetch --shallow-since="$(date --date="${ancestor_horizon} days ago" +%Y-%m-%d)" upstream
+
+# Work out the newest common ancestor between the detached HEAD that this CI job
+# has checked out, and the upstream target branch (which will typically be
+# `upstream/main` or `upstream/gnome-40`).
+# `${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}` or `${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME}`
+# are only defined if we’re running in a merge request pipeline,
+# fall back to `${CI_DEFAULT_BRANCH}` or `${CI_COMMIT_BRANCH}` respectively
+# otherwise.
+
+source_branch="${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME:-${CI_COMMIT_BRANCH}}"
+git fetch --shallow-since="$(date --date="${ancestor_horizon} days ago" +%Y-%m-%d)" origin "${source_branch}"
+
+newest_common_ancestor_sha=$(diff --old-line-format='' --new-line-format='' <(git rev-list --first-parent 
"upstream/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-${CI_DEFAULT_BRANCH}}") <(git rev-list --first-parent 
"origin/${source_branch}") | head -1)
+if [ -z "${newest_common_ancestor_sha}" ]; then
+    echo "Couldn’t find common ancestor with upstream main branch. This typically"
+    echo "happens if you branched from main a long time ago. Please update"
+    echo "your clone, rebase, and re-push your branch."
+    exit 1
+fi