From a2ee304c0aa0613466a091349f38691ea425c54d Mon Sep 17 00:00:00 2001
From: Jim Huang <jserv@ccns.ncku.edu.tw>
Date: Fri, 23 Feb 2024 00:53:34 +0800
Subject: [PATCH] Enable GitHub Actions

The CI pipeline can automate the validation for Linux kernel module
builds along with coding style checks.
---
 .ci/build-n-run.sh          | 14 ++++++++++++++
 .ci/check-format.sh         | 21 +++++++++++++++++++++
 .ci/check-newline.sh        | 19 +++++++++++++++++++
 .github/workflows/main.yaml | 23 +++++++++++++++++++++++
 4 files changed, 77 insertions(+)
 create mode 100755 .ci/build-n-run.sh
 create mode 100755 .ci/check-format.sh
 create mode 100755 .ci/check-newline.sh
 create mode 100644 .github/workflows/main.yaml

diff --git a/.ci/build-n-run.sh b/.ci/build-n-run.sh
new file mode 100755
index 0000000..d6a4bdd
--- /dev/null
+++ b/.ci/build-n-run.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+function build_mod()
+{   
+    make all || exit 1
+}
+
+function run_tests()
+{
+    make check || exit 2
+}
+
+build_mod
+run_tests
diff --git a/.ci/check-format.sh b/.ci/check-format.sh
new file mode 100755
index 0000000..d97a3a8
--- /dev/null
+++ b/.ci/check-format.sh
@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+SOURCES=$(find $(git rev-parse --show-toplevel) | egrep "\.(cpp|cc|c|h)\$")
+
+CLANG_FORMAT=$(which clang-format-12)
+if [ $? -ne 0 ]; then
+    CLANG_FORMAT=$(which clang-format)
+    if [ $? -ne 0 ]; then
+        echo "[!] clang-format not installed. Unable to check source file format policy." >&2
+        exit 1
+    fi
+fi
+
+set -x
+
+for file in ${SOURCES};
+do
+    $CLANG_FORMAT ${file} > expected-format
+    diff -u -p --label="${file}" --label="expected coding style" ${file} expected-format
+done
+exit $($CLANG_FORMAT --output-replacements-xml ${SOURCES} | egrep -c "</replacement>")
diff --git a/.ci/check-newline.sh b/.ci/check-newline.sh
new file mode 100755
index 0000000..2e23cb5
--- /dev/null
+++ b/.ci/check-newline.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -e -u -o pipefail
+
+ret=0
+show=0
+# Reference: https://medium.com/@alexey.inkin/how-to-force-newline-at-end-of-files-and-why-you-should-do-it-fdf76d1d090e
+while IFS= read -rd '' f; do
+    if file --mime-encoding "$f" | grep -qv binary; then
+        tail -c1 < "$f" | read -r _ || show=1
+        if [ $show -eq 1 ]; then
+            echo "Warning: No newline at end of file $f"
+            ret=1
+            show=0
+        fi
+    fi
+done < <(git ls-files -z src tests/arch-test-target)
+
+exit $ret
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
new file mode 100644
index 0000000..01ec9c8
--- /dev/null
+++ b/.github/workflows/main.yaml
@@ -0,0 +1,23 @@
+name: main
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  workflow_dispatch:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v4
+      - name: validate coding style and functionality
+        run: |
+            sudo apt-get install -q -y clang-format-12
+            .ci/check-newline.sh
+            .ci/check-format.sh
+            .ci/build-n-run.sh
+        shell: bash