From: Jonatan Schlag <jonatan.schlag@ipfire.org>
Date: Sun, 16 Jun 2024 16:02:39 +0000 (+0200)
Subject: initscripts fkt: Ignore comments in readhash
X-Git-Tag: v2.29-core189~65^2~82
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d289bc28beb65a937aba335501a86102d0455cec;p=ipfire-2.x.git

initscripts fkt: Ignore comments in readhash

As '#Another Comment' is a valid key we test this change by checking if
the comments do not end up as keys in our array.

Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
---

diff --git a/src/initscripts/system/functions b/src/initscripts/system/functions
index 507ebb7c5d..d1a1f5b042 100644
--- a/src/initscripts/system/functions
+++ b/src/initscripts/system/functions
@@ -905,6 +905,11 @@ readhash() {
 			continue
 		fi
 
+		# Skip Comments
+		if [[ ${line} =~ ^#.*$ ]]; then
+			continue
+		fi
+
 		local key="${line%=*}"
 		local val="${line#*=}"
 
diff --git a/tests/src/initscripts/system/functions/data/1 b/tests/src/initscripts/system/functions/data/1
index 8aca9422bb..c75620b6b0 100644
--- a/tests/src/initscripts/system/functions/data/1
+++ b/tests/src/initscripts/system/functions/data/1
@@ -5,6 +5,7 @@ GREEN_DRIVER=r8175
 RED_DEV=red0
 RED_MACADDR=00:c0:08:8a:a0:56
 RED_DRIVER=r8283
+# Another Comment
 BLUE_DEV='blue0 net0'
 BLUE_MACADDR=bc:30:7d:58:6b:e3
 BLUE_DRIVER=rt2800
@@ -15,3 +16,5 @@ RED_NETMASK=0.0.0.0
 RED_TYPE=PPPOE
 RED_NETADDRESS=0.0.0.0
 
+# Comment for testing  
+    # Comment for testing Comments with spaces before
diff --git a/tests/src/initscripts/system/functions/test.sh b/tests/src/initscripts/system/functions/test.sh
index 751be68844..915f098a06 100755
--- a/tests/src/initscripts/system/functions/test.sh
+++ b/tests/src/initscripts/system/functions/test.sh
@@ -15,5 +15,11 @@ readhash "CONFIG" "${SCRIPT_PATH}/data/1"
 test_value_in_array "CONFIG" "RED_DHCP_HOSTNAME" "ipfire"
 test_value_in_array "CONFIG" "BLUE_MACADDR" "bc:30:7d:58:6b:e3"
 
+# Test that comments are skipped
+# apparently the way we read the file strips the whitespace, so the key does not contain any whitespace either
+test_that_array_doesnt_have_key "CONFIG" "# Another Comment"
+test_that_array_doesnt_have_key "CONFIG" "# Comment for testing"
+test_that_array_doesnt_have_key "CONFIG" "# Comment for testing Comments with spaces before"
+
 test_that_output_is "${SCRIPT_PATH}/data/1_output_stdout" "1" readhash "CONFIG" "${SCRIPT_PATH}/data/1"
 test_that_output_is "${SCRIPT_PATH}/data/1_output_stderr" "2" readhash "CONFIG" "${SCRIPT_PATH}/data/1"