* Re: [PATCH 13/21] initscript fkt: ignore blank lines in readhash
[not found] <2F5DC8C8-DA61-4C2B-9F04-9A6DA689DBF5@ipfire.org>
@ 2024-06-02 18:07 ` Jonatan Schlag
2024-06-03 9:21 ` Michael Tremer
0 siblings, 1 reply; 3+ messages in thread
From: Jonatan Schlag @ 2024-06-02 18:07 UTC (permalink / raw)
To: development
[-- Attachment #1: Type: text/plain, Size: 3106 bytes --]
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(a)ipfire.org> wrote:
> >
> > Signed-off-by: Jonatan Schlag <jonatan.schlag(a)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
> >
>
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH 13/21] initscript fkt: ignore blank lines in readhash
2024-06-02 18:07 ` [PATCH 13/21] initscript fkt: ignore blank lines in readhash Jonatan Schlag
@ 2024-06-03 9:21 ` Michael Tremer
0 siblings, 0 replies; 3+ messages in thread
From: Michael Tremer @ 2024-06-03 9:21 UTC (permalink / raw)
To: development
[-- Attachment #1: Type: text/plain, Size: 3268 bytes --]
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(a)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(a)ipfire.org> wrote:
>>>
>>> Signed-off-by: Jonatan Schlag <jonatan.schlag(a)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
^ permalink raw reply [flat|nested] 3+ messages in thread
* First patch series for the roadmap item "Get rid of CONFIG_TYPE in the network config"
@ 2024-05-20 9:05 Jonatan Schlag
2024-05-20 9:06 ` [PATCH 13/21] initscript fkt: ignore blank lines in readhash Jonatan Schlag
0 siblings, 1 reply; 3+ messages in thread
From: Jonatan Schlag @ 2024-05-20 9:05 UTC (permalink / raw)
To: development
[-- Attachment #1: Type: text/plain, Size: 1953 bytes --]
Hi list,
This is the first patch series for the roadmap item: https://www.ipfire.org/docs/roadmap/get-rid-of-configtype-in-network-config . This patch series introduces a bash testing library and a function readhash, which we will use in every bash script which needs to read our config files. As this patch set is already massive, I thought it might be better to discuss the function first before I introduce it in every script. Otherwise, we would talk about 50 patches and not 21. This amount would be somehow not reviewable. If this patch series get merged, fine. If you want to wait for all the patches also fine, but as told, this will get a huge patch set.
Patches in this series are:
[PATCH 01/21] test: Add bash lib for colors
[PATCH 02/21] tests: Add bash lib
[PATCH 03/21] tests/lib.sh: Add function
[PATCH 04/21] tests/lib.sh: Add check if variable exists to
[PATCH 05/21] tests/lib.sh: Add logging functions
[PATCH 06/21] tests/lib.sh: adjust to pytest logging style
[PATCH 07/21] tests/lib.sh: Fix check if array is defined
[PATCH 08/21] test_that_key_in_arry_has_value: Check if the key is
[PATCH 09/21] tests/lib.sh: Use namref to access an array
[PATCH 10/21] test_that_key_in_arry_has_value: Check if a key in an
[PATCH 11/21] tests: Add function to test the ouput of a bash
[PATCH 12/21] initscript functions: add readhash
[PATCH 13/21] initscript fkt: ignore blank lines in readhash
[PATCH 14/21] test: Add functions test_that_array_is_defined
[PATCH 15/21] tests: Add functions test_that_array_doesnt_have_key
[PATCH 16/21] initscripts fkt: Ignore comments in readhash
[PATCH 17/21] initscripts fkt: ignore invalid keys in readhash
[PATCH 18/21] initscripts fkt: readhash should only parse lines with
[PATCH 19/21] initscripts fkt: Check for invalid values in readhash
[PATCH 20/21] initscripts fkt: keep readhash compatible with older
[PATCH 21/21] initscripts fkt: Fix shebang
Greetings Jonatan
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH 13/21] initscript fkt: ignore blank lines in readhash
2024-05-20 9:05 First patch series for the roadmap item "Get rid of CONFIG_TYPE in the network config" Jonatan Schlag
@ 2024-05-20 9:06 ` Jonatan Schlag
0 siblings, 0 replies; 3+ messages in thread
From: Jonatan Schlag @ 2024-05-20 9:06 UTC (permalink / raw)
To: development
[-- Attachment #1: Type: text/plain, Size: 2070 bytes --]
Signed-off-by: Jonatan Schlag <jonatan.schlag(a)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#*=}"
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-06-03 9:21 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <2F5DC8C8-DA61-4C2B-9F04-9A6DA689DBF5@ipfire.org>
2024-06-02 18:07 ` [PATCH 13/21] initscript fkt: ignore blank lines in readhash Jonatan Schlag
2024-06-03 9:21 ` Michael Tremer
2024-05-20 9:05 First patch series for the roadmap item "Get rid of CONFIG_TYPE in the network config" Jonatan Schlag
2024-05-20 9:06 ` [PATCH 13/21] initscript fkt: ignore blank lines in readhash Jonatan Schlag
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox