From 9820735b9ecc0e442d99a58b96e4309da4edeff6 Mon Sep 17 00:00:00 2001
From: Michael Tremer <michael.tremer@ipfire.org>
Date: Fri, 15 Mar 2024 10:49:12 +0000
Subject: [PATCH] tools: Rewrite checkrootfiles

This is a clean rewrite that makes the script a little bit more modular
and easier to use. It should also show clearer error messages.

Finally, it removes the exclusion of various files that are no longer a
hit any more. The only legitimate exception is qemu.

Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
---
 tools/checkrootfiles | 139 +++++++++++++++++++++++++++++--------------
 1 file changed, 93 insertions(+), 46 deletions(-)

diff --git a/tools/checkrootfiles b/tools/checkrootfiles
index 5036ce2d0f..9437de6f14 100755
--- a/tools/checkrootfiles
+++ b/tools/checkrootfiles
@@ -19,49 +19,96 @@
 #                                                                             #
 ###############################################################################
 
-grep -r "^etc/init.d//*" ./config/rootfiles/ >/dev/null 2>&1
-if [ "${?}" == "0" ]; then
-	echo "Error! 'etc/init.d/...' in rootfiles files found!"
-	grep -r "^etc/init.d//*" ./config/rootfiles/
-	echo "Change this to 'etc/rc.d/init.d/...' !"
-fi
-
-grep -r "^var/run//*" ./config/rootfiles/ >/dev/null 2>&1
-if [ "${?}" == "0" ]; then
-	echo "Error! 'var/run/...' in rootfiles files found!"
-	grep -r "^var/run//*" ./config/rootfiles/
-	echo "Comment this and create it at initskript if needed !"
-fi
-
-grep -r 'x86_64' ./config/rootfiles/ --exclude gcc --exclude rust-libc \
-    --exclude rust-ppv-lite86 --exclude rust-memchr --exclude-dir aarch64 --exclude-dir riscv64 --exclude-dir x86_64 \
-    --exclude update.sh --exclude qemu --exclude cmake --exclude xfsprogs \
-    --exclude-dir oldcore --exclude-dir x86_64 >/dev/null 2>&1
-if [ "${?}" == "0" ]; then
-	echo "Error! '/x86_64' in rootfiles files found!"
-	grep -r 'x86_64' ./config/rootfiles/ --exclude gcc --exclude rust-libc \
-    --exclude rust-ppv-lite86 --exclude rust-memchr --exclude-dir aarch64 --exclude-dir riscv64 --exclude-dir x86_64  \
-    --exclude update.sh  --exclude qemu --exclude cmake --exclude xfsprogs \
-    --exclude-dir oldcore --exclude-dir x86_64
-	echo "Replace by xxxMACHINExxx !"
-fi
-
-grep -r 'aarch64' ./config/rootfiles/ --exclude gcc --exclude rust-libc --exclude gdb --exclude liburcu --exclude gdb \
-     --exclude qemu --exclude liburcu --exclude abseil-cpp \
-     --exclude-dir oldcore --exclude-dir aarch64 --exclude-dir riscv64 --exclude-dir x86_64 >/dev/null 2>&1
-if [ "${?}" == "0" ]; then
-	echo "Error! 'aarch64' in rootfiles files found!"
-	grep -r 'aarch64' ./config/rootfiles/ --exclude gcc --exclude rust-libc --exclude gdb \
-    --exclude qemu --exclude liburcu --exclude abseil-cpp \
-    --exclude-dir oldcore --exclude-dir aarch64 --exclude-dir riscv64 --exclude-dir x86_64
-	echo "Replace by xxxMACHINExxx !"
-fi
-
-grep -r 'riscv64' ./config/rootfiles/ --exclude gcc --exclude rust-libc --exclude gdb --exclude liburcu --exclude go --exclude qemu \
-     --exclude-dir oldcore --exclude-dir aarch64 --exclude-dir riscv64 --exclude-dir x86_64  >/dev/null 2>&1
-if [ "${?}" == "0" ]; then
-	echo "Error! 'riscv64' in rootfiles files found!"
-	grep -r 'riscv64' ./config/rootfiles/ --exclude gcc --exclude rust-libc --exclude go --exclude qemu \
-    --exclude-dir oldcore --exclude-dir aarch64 --exclude-dir riscv64 --exclude-dir x86_64
-	echo "Replace by xxxMACHINExxx !"
-fi
+# All supported architectures
+ARCHES=(
+	aarch64
+	riscv64
+	x86_64
+)
+
+# A list of files that are not scanned
+# because they probably cause some false positives.
+EXCLUDED_FILES=(
+	qemu
+)
+
+ARGS=(
+	# Search path
+	"config/rootfiles"
+
+	# Exclude old core updates
+	"--exclude-dir" "oldcore"
+
+	# Ignore the update scripts
+	"--exclude" "update.sh"
+)
+
+check_for_arch() {
+	local arch="${1}"
+
+	local args=(
+		"${ARGS[@]}"
+	)
+
+	# Exclude any architecture-specific directories
+	local a
+	for a in ${ARCHES[@]}; do
+		args+=( "--exclude-dir" "${a}" )
+	done
+
+	# Exclude all excluded files
+	local x
+	for x in ${EXCLUDED_FILES[@]}; do
+		args+=( "--exclude" "${x}" )
+	done
+
+	# Search for all lines that contain the architecture, but exclude commented lines
+	grep -r "^[^#].*${arch}" "${args[@]}"
+}
+
+check_for_pattern() {
+	local pattern="${1}"
+	local message="${2}"
+
+	local args=(
+		"${ARGS[@]}"
+	)
+
+	if grep -r "${pattern}" "${args[@]}"; then
+		if [ -n "${message}" ]; then
+			echo "ERROR: ${message}"
+		else
+			echo "ERROR: Files matching '${pattern}' have been found in the rootfiles"
+		fi
+		return 1
+	fi
+
+	return 0
+}
+
+main() {
+	local failed=0
+
+	# Check for /etc/init.d
+	if ! check_for_pattern "^etc/init\.d/" \
+			"/etc/init.d/* has been found. Please replace by /etc/rc.d/init.d"; then
+		failed=1
+	fi
+
+	# Check for /var/run
+	if ! check_for_pattern "^var/run/.*" \
+			"You cannot ship files in /var/run as it is a ramdisk"; then
+		failed=1
+	fi
+
+	# Check architectures
+	local arch
+	for arch in ${ARCHES[@]}; do
+		check_for_arch "${arch}" || failed=$?
+	done
+
+	# Return the error
+	return ${failed}
+}
+
+main "$@" || exit $?
-- 
2.39.2