From 8bb097fd1042f5847e381075240f5d3d7924e9e5 Mon Sep 17 00:00:00 2001
From: FranciscoPombal <FranciscoPombal@users.noreply.github.com>
Date: Mon, 26 Oct 2020 16:31:25 +0000
Subject: [PATCH] Add GitHub Actions file health workflow

---
 .github/workflows/file_health.sh   | 75 ++++++++++++++++++++++++++++++
 .github/workflows/file_health.yaml | 27 +++++++++++
 2 files changed, 102 insertions(+)
 create mode 100755 .github/workflows/file_health.sh
 create mode 100644 .github/workflows/file_health.yaml

diff --git a/.github/workflows/file_health.sh b/.github/workflows/file_health.sh
new file mode 100755
index 000000000..682a28b77
--- /dev/null
+++ b/.github/workflows/file_health.sh
@@ -0,0 +1,75 @@
+#!/usr/bin/env zsh
+
+set -o nounset
+
+# Assumption: file names don't contain `:` (for the `cut` invocation).
+# Safe to assume, as such a character in a filename would cause trouble on Windows, a platform we support
+
+# any regression turn this non-zero
+regressions=0
+
+# exclusions (these are just grep extended regular expressions to match against paths relative to the root of the repository)
+exclusions_nonutf8='(.*(7z|gif|ic(ns|o)|png|qm|zip))'
+exclusions_bom='src/base/unicodestrings.h'
+exclusions_tw='(*.ts)|src/webui/www/private/scripts/lib/mootools-1.2-more.js'
+exclusions_no_lf='(*.ts)|(.*svg)|compile_commands.json|src/webui/www/private/scripts/lib/mootools-1.2-(core-yc.js|more.js)'
+
+echo -e "*** Detect files not encoded in UTF-8 ***\n"
+
+find . -path ./build -prune -false -o -path ./.git -prune -false -o -type f -exec file --mime {} \; | sort \
+    | grep -v -e "charset=us-ascii" -e "charset=utf-8" | cut -d ":" -f 1 \
+    | grep -E -v -e "${exclusions_nonutf8}" \
+    | tee >(echo -e "\n--> Files not encoded in UTF-8: found" "$(wc -l < /dev/stdin)" "regression(s)") \
+    | xargs -I my_input -0 bash -c 'echo "my_input"; test "$(echo -n "my_input" | wc -l)" -eq 0'
+regressions=$((regressions+$?))
+
+echo -e "*** Detect files encoded in UTF-8 with BOM ***\n"
+
+grep --exclude-dir={.git,build} -rIl $'\xEF\xBB\xBF' | sort \
+    | grep -E -v -e "${exclusions_bom}" \
+    | tee >(echo -e "\n--> Files encoded in UTF-8 with BOM: found" "$(wc -l < /dev/stdin)" "regression(s)") \
+    | xargs -I my_input -0 bash -c 'echo "my_input"; test "$(echo -n "my_input" | wc -l)" -eq 0'
+regressions=$((regressions+$?))
+
+echo -e "*** Detect usage of CR byte ***\n"
+
+grep --exclude-dir={.git,build} -rIlU $'\x0D' | sort \
+    | tee >(echo -e "\n--> Usage of CR byte: found" "$(wc -l < /dev/stdin)" "regression(s)") \
+    | xargs -I my_input -0 bash -c 'echo "my_input"; test "$(echo -n "my_input" | wc -l)" -eq 0'
+regressions=$((regressions+$?))
+
+echo -e "*** Detect trailing whitespace in lines ***\n"
+
+grep --exclude-dir={.git,build} -rIl "[[:blank:]]$" | sort \
+    | grep -E -v -e "${exclusions_tw}" \
+    | tee >(echo -e "\n--> Trailing whitespace in lines: found" "$(wc -l < /dev/stdin)" "regression(s)") \
+    | xargs -I my_input -0 bash -c 'echo "my_input"; test "$(echo -n "my_input" | wc -l)" -eq 0';
+regressions=$((regressions+$?))
+
+echo -e "*** Detect too many trailing newlines ***\n"
+
+find . -path ./build -prune -false -o -path ./.git -prune -false -o -type f -exec file --mime {} \; | sort \
+    | grep -e "charset=us-ascii" -e "charset=utf-8" | cut -d ":" -f 1 \
+    | xargs -L1 -I my_input bash -c 'test "$(tail -q -c2 "my_input" | hexdump -C | grep "0a 0a")" && echo "my_input"' \
+    | tee >(echo -e "\n--> Too many trailing newlines: found" "$(wc -l < /dev/stdin)" "regression(s)") \
+    | xargs -I my_input -0 bash -c 'echo "my_input"; test "$(echo -n "my_input" | wc -l)" -eq 0'
+regressions=$((regressions+$?))
+
+echo -e "*** Detect no trailing newline ***\n"
+
+find . -path ./build -prune -false -o -path ./.git -prune -false -o -type f -exec file --mime {} \; | sort \
+    | grep -e "charset=us-ascii" -e "charset=utf-8" |  cut -d ":" -f 1 \
+    | grep -E -v -e "${exclusions_no_lf}" \
+    | xargs -L1 -I my_input bash -c 'test "$(tail -q -c1 "my_input" | hexdump -C | grep "0a")" || echo "my_input"' \
+    | tee >(echo -e "\n--> No trailing newline: found" "$(wc -l < /dev/stdin)" "regression(s)") \
+    | xargs -I my_input -0 bash -c 'echo "my_input"; test "$(echo -n "my_input" | wc -l)" -eq 0'
+regressions=$((regressions+$?))
+
+if [ "$regressions" -ne 0 ]; then
+    regressions=1
+    echo "File health regressions found. Please fix them (or add them as exclusions)."
+else
+    echo "All OK, no file health regressions found."
+fi
+
+exit $regressions;
diff --git a/.github/workflows/file_health.yaml b/.github/workflows/file_health.yaml
new file mode 100644
index 000000000..16c9813fb
--- /dev/null
+++ b/.github/workflows/file_health.yaml
@@ -0,0 +1,27 @@
+name: GitHub Actions file health check
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    types: [edited, opened, reopened, synchronize]
+    branches: [ '**' ]
+
+jobs:
+  check_file_health:
+    name: Check file health
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout repository
+      uses: actions/checkout@v2.3.3
+
+    - name: install zsh
+      run: |
+        sudo apt update
+        sudo apt install zsh
+
+    - name: run check file health script
+      run: |
+        ./.github/workflows/file_health.sh