GitHub Actions Lint: spellintian, codespell

.github/problem-matcher-lint-spellintian.json

@@ -0,0 +1,15 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "lint-spellintian",
+            "severity": "warning",
+            "pattern": [
+                {
+                    "regexp": "^([^:]+):(\\s+)(.+)$",
+                    "file": 1,
+                    "message": 3
+                }
+            ]
+        }
+    ]
+}

.github/workflows/lint.yaml

@@ -194,3 +194,63 @@ jobs:
             libusb-1.0-0-dev liblo-dev libavahi-client-dev python3-numpy
       - name: flake8
         run: make flake8 VERBOSE=1
+  spellintian:
+    name: spellintian
+    runs-on: ubuntu-latest
+    container: debian:stable
+    needs: build
+    steps:
+      - name: Download built source tree archive
+        uses: actions/download-artifact@v3
+        with:
+          name: ola-debian-stable-built-source-tree
+          path: .
+      - name: SHA256 artifact archive
+        run: sha256sum ola-debian-stable-built-source-tree.tar.gz
+      - name: Unarchive artifacts and delete archive
+        shell: bash
+        run: |
+          tar -xvzf ola-debian-stable-built-source-tree.tar.gz .
+          rm ola-debian-stable-built-source-tree.tar.gz
+      - name: Display structure of extracted files
+        if: env.ACTIONS_STEP_DEBUG == 'true'
+        run: ls -alR
+      - name: Update package database
+        run: apt-get update -y
+      - name: Install lint tools
+        run: apt-get -y install moreutils lintian
+      - name: Enable Problem Matcher for GitHub annotations
+        run: echo "::add-matcher::.github/problem-matcher-lint-spellintian.json"
+      - name: spellintian
+        run: ./scripts/spelling.sh spellintian
+  codespell:
+    name: codespell
+    runs-on: ubuntu-latest
+    container: debian:stable
+    needs: build
+    steps:
+      - name: Download built source tree archive
+        uses: actions/download-artifact@v3
+        with:
+          name: ola-debian-stable-built-source-tree
+          path: .
+      - name: SHA256 artifact archive
+        run: sha256sum ola-debian-stable-built-source-tree.tar.gz
+      - name: Unarchive artifacts and delete archive
+        shell: bash
+        run: |
+          tar -xvzf ola-debian-stable-built-source-tree.tar.gz .
+          rm ola-debian-stable-built-source-tree.tar.gz
+      - name: Display structure of extracted files
+        if: env.ACTIONS_STEP_DEBUG == 'true'
+        run: ls -alR
+      - name: Update package database
+        run: apt-get update -y
+      - name: Install lint tools
+        run: apt-get -y install python3-pip moreutils
+      - name: Install Python lint tools
+        run: python3 -m pip install --no-input codespell
+      - name: Setup codespell annotations
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: codespell
+        run: ./scripts/spelling.sh codespell

scripts/spelling.sh

@@ -0,0 +1,103 @@
+#!/usr/bin/env bash
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Library General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# spellintian.sh
+# Copyright (C) 2023 Perry Naseck, Peter Newman
+
+# This script is based on Travis CI tests by Peter Newman
+current_test=""
+# run_single_only=false
+if [ "$1" = "spellintian" ]; then
+  current_test="spellintian"
+  # run_single_only=true
+elif [ "$1" = "codespell" ]; then
+  current_test="codespell"
+else
+  echo "Unknown test specified in first argument. Options are spellintian and codespell."
+  exit 1;
+fi;
+
+if ! [ -x "$(command -v zrun)" ]; then
+  echo "error: Cannot find zrun. Do you need the moreutils package?"
+  exit 1;
+fi;
+if [ $current_test = "spellintian" ] && ! [ -x "$(command -v spellintian)" ]; then
+  echo "error: Cannot find spellintian. Do you need the lintian package?"
+  exit 1;
+fi;
+if [ $current_test = "codespell" ] && ! [ -x "$(command -v codespell)" ]; then
+  echo "error: Cannot find codespell. Install via pip."
+  exit 1;
+fi;
+
+SPELLINGBLACKLIST=$(cat <<-BLACKLIST
+      -wholename "./.codespellignorewords" -or \
+      -wholename "./.codespellignorelines" -or \
+      -wholename "./.git/*" -or \
+      -wholename "./aclocal.m4" -or \
+      -wholename "./config/config.guess" -or \
+      -wholename "./config/config.sub" -or \
+      -wholename "./config/depcomp" -or \
+      -wholename "./config/install-sh" -or \
+      -wholename "./config/libtool.m4" -or \
+      -wholename "./config/ltmain.sh" -or \
+      -wholename "./config/ltoptions.m4" -or \
+      -wholename "./config/ltsugar.m4" -or \
+      -wholename "./config/missing" -or \
+      -wholename "./libtool" -or \
+      -wholename "./config.log" -or \
+      -wholename "./config.status" -or \
+      -wholename "./Makefile" -or \
+      -wholename "./Makefile.in" -or \
+      -wholename "./autom4te.cache/*" -or \
+      -wholename "./java/Makefile" -or \
+      -wholename "./java/Makefile.in" -or \
+      -wholename "./olad/www/new/js/app.min.js" -or \
+      -wholename "./olad/www/new/js/app.min.js.map" -or \
+      -wholename "./olad/www/new/libs/angular/js/angular.min.js" -or \
+      -wholename "./olad/www/new/libs/marked/js/marked.min.js" -or \
+      -wholename "./olad/www/mobile.js" -or \
+      -wholename "./olad/www/ola.js" -or \
+      -wholename "./configure" -or \
+      -wholename "./common/protocol/Ola.pb.*" -or \
+      -wholename "./plugins/artnet/messages/ArtNetConfigMessages.pb.*" -or \
+      -wholename "./tools/ola_trigger/config.tab.*" -or \
+      -wholename "./tools/ola_trigger/lex.yy.cpp" -or \
+      -wholename "*.cc"
+BLACKLIST
+)
+
+spellingfiles=$(eval "find ./ -type f -and ! \( \
+    $SPELLINGBLACKLIST \
+    \) | xargs")
+
+if [ $current_test = "spellintian" ]; then
+  # count the number of spellintian errors, including duplicate words
+  # spellintian does not change the exit code, so the output must be checked
+  spellintian_issues="$(zrun spellintian $spellingfiles 2>&1)"
+
+  if [[ -n $spellintian_issues ]]; then
+    printf "%s\n" "$spellintian_issues"
+    # For now we always exit with success, as these errors are manually checked
+    # exit 1;
+    exit 0;
+  fi;
+fi;
+
+if [ $current_test = "codespell" ]; then
+  if ! zrun codespell --interactive 0 --check-filenames --check-hidden --quiet 2 --regex "[a-zA-Z0-9][\\-'a-zA-Z0-9]+[a-zA-Z0-9]" --exclude-file .codespellignorelines --ignore-words .codespellignorewords $spellingfiles 2>&1; then
+    exit 1;
+  fi;
+fi;