wip

Author: basak-qcom

.github/workflows/static-checks.yml

@@ -31,11 +31,8 @@ jobs:
 
       - name: Run Flake8 and dependencies
         run: |
-          # Run flake8 against all files outside .git/ that `file` reports
-          # as text/x-script.python
-          find . -path ./.git -prune -o -print0 | \
-            xargs -0n1 sh -c 'test "$(file --brief --mime-type "$1")" = "text/x-script.python" && printf "%s\000" "$1"' -- | \
-            xargs -0t flake8
+          . scripts/functions
+          scan_files text/x-script.python flake8
 
   pylint:
     name: Install and run Pylint on Python scripts
@@ -50,11 +47,8 @@ jobs:
 
       - name: Run Pylint (error mode)
         run: |
-          # Run pylint against all files outside .git/ that `file` reports
-          # as text/x-script.python
-          find . -path ./.git -prune -o -print0 | \
-            xargs -0n1 sh -c 'test "$(file --brief --mime-type "$1")" = "text/x-script.python" && printf "%s\000" "$1"' -- | \
-            xargs -0t pylint --errors-only
+          . scripts/functions
+          scan_files text/x-script.python pylint --errors-only
 
   shellcheck:
     name: Install and run ShellCheck on shell scripts
@@ -69,12 +63,12 @@ jobs:
 
       - name: Run ShellCheck
         run: |
-          # Run shellcheck against all files outside .git/ that `file` reports
-          # as text/x-shellscript
-          #
+          . scripts/functions
+
           # Ignore the double quoting warning, script authors have better
-          # knowledge of variable contents.
-          export SHELLCHECK_OPTS="-e SC2086"
-          find . -path ./.git -prune -o -print0 | \
-            xargs -0n1 sh -c 'test "$(file --brief --mime-type "$1")" = "text/x-shellscript" && printf "%s\000" "$1"' -- | \
-            xargs -0t shellcheck
+          # knowledge of variable contents, and we accept that in practice
+          # "local" is implemented everywhere so it's OK to use even though
+          # it's not strictly POSIX.
+          export SHELLCHECK_OPTS="-e SC2086,SC3043"
+
+          scan_files text/x-shellscript shellcheck

scripts/functions

@@ -0,0 +1,18 @@
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# shellcheck shell=sh
+
+scan_files() {
+    # For all files under $PWD except under .git that match $mime_type, run the
+    # scanner $cmd (expanded by shell word splitting). Return zero if all $cmd
+    # succeeded, non-zero otherwise.
+
+    local mime_type="$1"
+    local cmd="$2"
+
+    # shellcheck disable=SC2016
+    find . -path ./.git -prune -o -print0 | \
+      xargs -0n1 sh -c 'test "$(file --brief --mime-type "$1")" = "'"$mime_type"'" && printf "%s\000" "$1"' -- | \
+      xargs -0t -- $cmd
+}