diff mbox series

[13/21] initscript fkt: ignore blank lines in readhash

Message ID	20240520090611.10406-14-jonatan.schlag@ipfire.org
State	New
Headers	From: Jonatan Schlag <jonatan.schlag@ipfire.org> To: development@lists.ipfire.org Subject: [PATCH 13/21] initscript fkt: ignore blank lines in readhash Date: Mon, 20 May 2024 11:06:03 +0200 Message-Id: <20240520090611.10406-14-jonatan.schlag@ipfire.org> In-Reply-To: <20240520090611.10406-1-jonatan.schlag@ipfire.org> References: <20240520090611.10406-1-jonatan.schlag@ipfire.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID-Hash: EIG65NEJFURIB22DSFD6CHORST7NPUHK Precedence: list Archived-At: <https://lists.ipfire.org/hyperkitty/list/development@lists.ipfire.org/message/EIG65NEJFURIB22DSFD6CHORST7NPUHK/>
Series	[01/21] test: Add bash lib for colors \| [01/21] test: Add bash lib for colors [02/21] tests: Add bash lib [03/21] tests/lib.sh: Add function test_that_key_in_arry_has_value [04/21] tests/lib.sh: Add check if variable exists to test_that_key_in_arry_has_value [05/21] tests/lib.sh: Add logging functions [06/21] tests/lib.sh: adjust to pytest logging style [07/21] tests/lib.sh: Fix check if array is defined [08/21] test_that_key_in_arry_has_value: Check if the key is defined [09/21] tests/lib.sh: Use namref to access an array [10/21] test_that_key_in_arry_has_value: Check if a key in an array exists [11/21] tests: Add function to test the ouput of a bash function [12/21] initscript functions: add readhash [13/21] initscript fkt: ignore blank lines in readhash [14/21] test: Add functions test_that_array_is_defined [15/21] tests: Add functions test_that_array_doesnt_have_key [16/21] initscripts fkt: Ignore comments in readhash [17/21] initscripts fkt: ignore invalid keys in readhash [18/21] initscripts fkt: readhash should only parse lines with a = [19/21] initscripts fkt: Check for invalid values in readhash [20/21] initscripts fkt: keep readhash compatible with older implementation [21/21] initscripts fkt: Fix shebang

Commit Message

Jonatan Schlag May 20, 2024, 9:06 a.m. UTC

  Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
---
 src/initscripts/system/functions                            | 6 ++++++
 tests/src/initscripts/system/functions/data/1_output_stderr | 0
 tests/src/initscripts/system/functions/data/1_output_stdout | 0
 tests/src/initscripts/system/functions/test.sh              | 3 +++
 4 files changed, 9 insertions(+)
 create mode 100644 tests/src/initscripts/system/functions/data/1_output_stderr
 create mode 100644 tests/src/initscripts/system/functions/data/1_output_stdout

Comments

Michael Tremer May 31, 2024, 9:55 a.m. UTC | #1

> On 20 May 2024, at 10:06, Jonatan Schlag <jonatan.schlag@ipfire.org> wrote:
> 
> Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
> ---
> src/initscripts/system/functions                            | 6 ++++++
> tests/src/initscripts/system/functions/data/1_output_stderr | 0
> tests/src/initscripts/system/functions/data/1_output_stdout | 0
> tests/src/initscripts/system/functions/test.sh              | 3 +++
> 4 files changed, 9 insertions(+)
> create mode 100644 tests/src/initscripts/system/functions/data/1_output_stderr
> create mode 100644 tests/src/initscripts/system/functions/data/1_output_stdout
> 
> diff --git a/src/initscripts/system/functions b/src/initscripts/system/functions
> index 44ce999d3..3f01be9e0 100644
> --- a/src/initscripts/system/functions
> +++ b/src/initscripts/system/functions
> @@ -900,6 +900,12 @@ readhash() {
> 
> local line
> while read -r line; do
> +
> + # Skip Blank Lines
> + if [[ ${line} =~ ^[[:space:]]*$ ]]; then
> + continue
> + fi
> +
> local key="${line%=*}"
> local val="${line#*=}"

I don’t think this is quite sufficient.

You might have other lines that are invalid. For example “=VALUE”. I think we should check that key isn’t empty, and we should limit what characters can be used in keys and values as it used to be before in the script.

https://git.ipfire.org/?p=ipfire-2.x.git;a=blob;f=src/scripts/readhash;h=bffc93fbd00c31a76e9c96fc17dabf0a87c3c9ef;hb=HEAD

> 
> diff --git a/tests/src/initscripts/system/functions/data/1_output_stderr b/tests/src/initscripts/system/functions/data/1_output_stderr
> new file mode 100644
> index 000000000..e69de29bb
> diff --git a/tests/src/initscripts/system/functions/data/1_output_stdout b/tests/src/initscripts/system/functions/data/1_output_stdout
> new file mode 100644
> index 000000000..e69de29bb
> diff --git a/tests/src/initscripts/system/functions/test.sh b/tests/src/initscripts/system/functions/test.sh
> index ec502e199..8d644b8cd 100755
> --- a/tests/src/initscripts/system/functions/test.sh
> +++ b/tests/src/initscripts/system/functions/test.sh
> @@ -14,3 +14,6 @@ readhash "CONFIG" "${SCRIPT_PATH}/data/1"
> # test if we read the correct data
> test_that_key_in_arry_has_value "CONFIG" "RED_DHCP_HOSTNAME" "ipfire"
> test_that_key_in_arry_has_value "CONFIG" "BLUE_MACADDR" "bc:30:7d:58:6b:e3"
> +
> +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"
> -- 
> 2.39.2
>

Jonatan Schlag June 2, 2024, 6:07 p.m. UTC | #2

Hi,


Am Freitag, dem 31.05.2024 um 10:55 +0100 schrieb Michael Tremer:
> 
> 
> > On 20 May 2024, at 10:06, Jonatan Schlag
> > <jonatan.schlag@ipfire.org> wrote:
> > 
> > Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
> > ---
> > src/initscripts/system/functions                            | 6
> > ++++++
> > tests/src/initscripts/system/functions/data/1_output_stderr | 0
> > tests/src/initscripts/system/functions/data/1_output_stdout | 0
> > tests/src/initscripts/system/functions/test.sh              | 3 +++
> > 4 files changed, 9 insertions(+)
> > create mode 100644
> > tests/src/initscripts/system/functions/data/1_output_stderr
> > create mode 100644
> > tests/src/initscripts/system/functions/data/1_output_stdout
> > 
> > diff --git a/src/initscripts/system/functions
> > b/src/initscripts/system/functions
> > index 44ce999d3..3f01be9e0 100644
> > --- a/src/initscripts/system/functions
> > +++ b/src/initscripts/system/functions
> > @@ -900,6 +900,12 @@ readhash() {
> > 
> > local line
> > while read -r line; do
> > +
> > + # Skip Blank Lines
> > + if [[ ${line} =~ ^[[:space:]]*$ ]]; then
> > + continue
> > + fi
> > +
> > local key="${line%=*}"
> > local val="${line#*=}"
> 
> I don’t think this is quite sufficient.
> 
> You might have other lines that are invalid. For example “=VALUE”. I
> think we should check that key isn’t empty, and we should limit what
> characters can be used in keys and values as it used to be before in
> the script.
> 
> https://git.ipfire.org/?p=ipfire-2.x.git;a=blob;f=src/scripts/readhash;h=bffc93fbd00c31a76e9c96fc17dabf0a87c3c9ef;hb=HEAD
> 
Hi,

I will merge all commits for checks in the next series. There are more
checks to come. In a later commit, I check for correct values and keys.

Jonatan
> > 
> > diff --git
> > a/tests/src/initscripts/system/functions/data/1_output_stderr
> > b/tests/src/initscripts/system/functions/data/1_output_stderr
> > new file mode 100644
> > index 000000000..e69de29bb
> > diff --git
> > a/tests/src/initscripts/system/functions/data/1_output_stdout
> > b/tests/src/initscripts/system/functions/data/1_output_stdout
> > new file mode 100644
> > index 000000000..e69de29bb
> > diff --git a/tests/src/initscripts/system/functions/test.sh
> > b/tests/src/initscripts/system/functions/test.sh
> > index ec502e199..8d644b8cd 100755
> > --- a/tests/src/initscripts/system/functions/test.sh
> > +++ b/tests/src/initscripts/system/functions/test.sh
> > @@ -14,3 +14,6 @@ readhash "CONFIG" "${SCRIPT_PATH}/data/1"
> > # test if we read the correct data
> > test_that_key_in_arry_has_value "CONFIG" "RED_DHCP_HOSTNAME"
> > "ipfire"
> > test_that_key_in_arry_has_value "CONFIG" "BLUE_MACADDR"
> > "bc:30:7d:58:6b:e3"
> > +
> > +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"
> > -- 
> > 2.39.2
> > 
>

Michael Tremer June 3, 2024, 9:21 a.m. UTC | #3

Your tests I didn’t understand at all. You need to structure those in a more simple way.

> On 2 Jun 2024, at 19:07, Jonatan Schlag <jonatan.schlag@ipfire.org> wrote:
> 
> Hi,
> 
> 
> Am Freitag, dem 31.05.2024 um 10:55 +0100 schrieb Michael Tremer:
>> 
>> 
>>> On 20 May 2024, at 10:06, Jonatan Schlag
>>> <jonatan.schlag@ipfire.org> wrote:
>>> 
>>> Signed-off-by: Jonatan Schlag <jonatan.schlag@ipfire.org>
>>> ---
>>> src/initscripts/system/functions                            | 6
>>> ++++++
>>> tests/src/initscripts/system/functions/data/1_output_stderr | 0
>>> tests/src/initscripts/system/functions/data/1_output_stdout | 0
>>> tests/src/initscripts/system/functions/test.sh              | 3 +++
>>> 4 files changed, 9 insertions(+)
>>> create mode 100644
>>> tests/src/initscripts/system/functions/data/1_output_stderr
>>> create mode 100644
>>> tests/src/initscripts/system/functions/data/1_output_stdout
>>> 
>>> diff --git a/src/initscripts/system/functions
>>> b/src/initscripts/system/functions
>>> index 44ce999d3..3f01be9e0 100644
>>> --- a/src/initscripts/system/functions
>>> +++ b/src/initscripts/system/functions
>>> @@ -900,6 +900,12 @@ readhash() {
>>> 
>>> local line
>>> while read -r line; do
>>> +
>>> + # Skip Blank Lines
>>> + if [[ ${line} =~ ^[[:space:]]*$ ]]; then
>>> + continue
>>> + fi
>>> +
>>> local key="${line%=*}"
>>> local val="${line#*=}"
>> 
>> I don’t think this is quite sufficient.
>> 
>> You might have other lines that are invalid. For example “=VALUE”. I
>> think we should check that key isn’t empty, and we should limit what
>> characters can be used in keys and values as it used to be before in
>> the script.
>> 
>> https://git.ipfire.org/?p=ipfire-2.x.git;a=blob;f=src/scripts/readhash;h=bffc93fbd00c31a76e9c96fc17dabf0a87c3c9ef;hb=HEAD
>> 
> Hi,
> 
> I will merge all commits for checks in the next series. There are more
> checks to come. In a later commit, I check for correct values and keys.
> 
> Jonatan
>>> 
>>> diff --git
>>> a/tests/src/initscripts/system/functions/data/1_output_stderr
>>> b/tests/src/initscripts/system/functions/data/1_output_stderr
>>> new file mode 100644
>>> index 000000000..e69de29bb
>>> diff --git
>>> a/tests/src/initscripts/system/functions/data/1_output_stdout
>>> b/tests/src/initscripts/system/functions/data/1_output_stdout
>>> new file mode 100644
>>> index 000000000..e69de29bb
>>> diff --git a/tests/src/initscripts/system/functions/test.sh
>>> b/tests/src/initscripts/system/functions/test.sh
>>> index ec502e199..8d644b8cd 100755
>>> --- a/tests/src/initscripts/system/functions/test.sh
>>> +++ b/tests/src/initscripts/system/functions/test.sh
>>> @@ -14,3 +14,6 @@ readhash "CONFIG" "${SCRIPT_PATH}/data/1"
>>> # test if we read the correct data
>>> test_that_key_in_arry_has_value "CONFIG" "RED_DHCP_HOSTNAME"
>>> "ipfire"
>>> test_that_key_in_arry_has_value "CONFIG" "BLUE_MACADDR"
>>> "bc:30:7d:58:6b:e3"
>>> +
>>> +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"
>>> -- 
>>> 2.39.2

diff mbox series

Patch

diff --git a/src/initscripts/system/functions b/src/initscripts/system/functions
index 44ce999d3..3f01be9e0 100644
--- a/src/initscripts/system/functions
+++ b/src/initscripts/system/functions
@@ -900,6 +900,12 @@  readhash() {
 
 	local line
 	while read -r line; do
+
+		# Skip Blank Lines
+		if [[ ${line} =~ ^[[:space:]]*$ ]]; then
+			continue
+		fi
+
 		local key="${line%=*}"
 		local val="${line#*=}"
 
diff --git a/tests/src/initscripts/system/functions/data/1_output_stderr b/tests/src/initscripts/system/functions/data/1_output_stderr
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/src/initscripts/system/functions/data/1_output_stdout b/tests/src/initscripts/system/functions/data/1_output_stdout
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/src/initscripts/system/functions/test.sh b/tests/src/initscripts/system/functions/test.sh
index ec502e199..8d644b8cd 100755
--- a/tests/src/initscripts/system/functions/test.sh
+++ b/tests/src/initscripts/system/functions/test.sh
@@ -14,3 +14,6 @@  readhash "CONFIG" "${SCRIPT_PATH}/data/1"
 # test if we read the correct data
 test_that_key_in_arry_has_value "CONFIG" "RED_DHCP_HOSTNAME" "ipfire"
 test_that_key_in_arry_has_value "CONFIG" "BLUE_MACADDR" "bc:30:7d:58:6b:e3"
+
+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"