diff mbox series

[net-next,2/4] selftests: tc-testing: check if 'jq' is available in taprio script

Message ID 20240123122736.9915-3-pctammela@mojatatu.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series selftests: tc-testing: misc changes for tdc | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/build_tools success Errors and warnings before: 2 this patch: 0
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success net selftest script(s) already in Makefile
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 11 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Pedro Tammela Jan. 23, 2024, 12:27 p.m. UTC
If 'jq' is not available the taprio tests that use this script will
run forever. Check if it exists before entering the while loop.

Signed-off-by: Pedro Tammela <pctammela@mojatatu.com>
---
 .../selftests/tc-testing/scripts/taprio_wait_for_admin.sh    | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Davide Caratti Jan. 23, 2024, 1:17 p.m. UTC | #1
hi Pedro,

On Tue, Jan 23, 2024 at 1:28 PM Pedro Tammela <pctammela@mojatatu.com> wrote:
>
> If 'jq' is not available the taprio tests that use this script will
> run forever. Check if it exists before entering the while loop.
>
> Signed-off-by: Pedro Tammela <pctammela@mojatatu.com>
> ---
>  .../selftests/tc-testing/scripts/taprio_wait_for_admin.sh    | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh b/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
> index f5335e8ad6b4..68f2c6eaa802 100755
> --- a/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
> +++ b/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
> @@ -3,6 +3,11 @@
>  TC="$1"; shift
>  ETH="$1"; shift
>
> +if ! command -v jq &> /dev/null; then
> +    echo "Please install jq"
> +    exit 1
> +fi
> +

nit: what about returning $KSFT_SKIP (that is 4) if jq is not there?
so the test does not fail.
thanks!
Pedro Tammela Jan. 23, 2024, 4:47 p.m. UTC | #2
On 23/01/2024 10:17, Davide Caratti wrote:
> hi Pedro,
> 
> On Tue, Jan 23, 2024 at 1:28 PM Pedro Tammela <pctammela@mojatatu.com> wrote:
>>
>> If 'jq' is not available the taprio tests that use this script will
>> run forever. Check if it exists before entering the while loop.
>>
>> Signed-off-by: Pedro Tammela <pctammela@mojatatu.com>
>> ---
>>   .../selftests/tc-testing/scripts/taprio_wait_for_admin.sh    | 5 +++++
>>   1 file changed, 5 insertions(+)
>>
>> diff --git a/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh b/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
>> index f5335e8ad6b4..68f2c6eaa802 100755
>> --- a/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
>> +++ b/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
>> @@ -3,6 +3,11 @@
>>   TC="$1"; shift
>>   ETH="$1"; shift
>>
>> +if ! command -v jq &> /dev/null; then
>> +    echo "Please install jq"
>> +    exit 1
>> +fi
>> +
> 
> nit: what about returning $KSFT_SKIP (that is 4) if jq is not there?
> so the test does not fail.
> thanks!

Since these scripts are run in the setup phase, it has a special treatment.

Take for example this run:
ok 1 ba39 - Add taprio Qdisc to multi-queue device (8 queues)
ok 2 9462 - Add taprio Qdisc with multiple sched-entry
ok 3 8d92 - Add taprio Qdisc with txtime-delay
ok 4 d092 - Delete taprio Qdisc with valid handle
ok 5 8471 - Show taprio class
ok 6 0a85 - Add taprio Qdisc to single-queue device
ok 7 3e1e - Add taprio Qdisc with an invalid cycle-time
ok 8 39b4 - Reject grafting taprio as child qdisc of software taprio # 
skipped - "-----> prepare stage" did not complete successfully

ok 9 e8a1 - Reject grafting taprio as child qdisc of offloaded taprio # 
skipped - skipped - previous setup failed 9 39b4

ok 10 a7bf - Graft cbs as child of software taprio # skipped - skipped - 
previous setup failed 9 39b4

ok 11 6a83 - Graft cbs as child of offloaded taprio # skipped - skipped 
- previous setup failed 9 39b4

As of today it returns 0, success in ksft, even though it clearly 
wasn't. Looking at the code any failures in the setup/teardown phase 
will stop the run, skip all the remaining tests but still return success.

About returning skip from the script, aside from marking it as skip and 
continuing the suite, we would need to run a silent teardown, one that 
executes all commands in the specified teardown but
ignores errors. In this case we are assuming all setup steps follow KSFT 
return codes. Not sure if it it's reasonable or not...

As your suggestion is not a blocker, I would rather address the above 
problems in a follow up series since they will require some refactoring.
WDYT?
Davide Caratti Jan. 24, 2024, 10:31 a.m. UTC | #3
hello Pedro, thanks for your answer!

On Tue, Jan 23, 2024 at 5:47 PM Pedro Tammela <pctammela@mojatatu.com> wrote:
>
> On 23/01/2024 10:17, Davide Caratti wrote:
> > hi Pedro,
> >
> > On Tue, Jan 23, 2024 at 1:28 PM Pedro Tammela <pctammela@mojatatu.com> wrote:
> >>
> >> If 'jq' is not available the taprio tests that use this script will
> >> run forever. Check if it exists before entering the while loop.

[...]

> > nit: what about returning $KSFT_SKIP (that is 4) if jq is not there?
> > so the test does not fail.
> > thanks!
>
> Since these scripts are run in the setup phase, it has a special treatment.
>
> Take for example this run:
> ok 1 ba39 - Add taprio Qdisc to multi-queue device (8 queues)
> ok 2 9462 - Add taprio Qdisc with multiple sched-entry
> ok 3 8d92 - Add taprio Qdisc with txtime-delay
> ok 4 d092 - Delete taprio Qdisc with valid handle
> ok 5 8471 - Show taprio class
> ok 6 0a85 - Add taprio Qdisc to single-queue device
> ok 7 3e1e - Add taprio Qdisc with an invalid cycle-time
> ok 8 39b4 - Reject grafting taprio as child qdisc of software taprio #
> skipped - "-----> prepare stage" did not complete successfully
>
> ok 9 e8a1 - Reject grafting taprio as child qdisc of offloaded taprio #
> skipped - skipped - previous setup failed 9 39b4

[...]

> As of today it returns 0, success in ksft, even though it clearly
> wasn't. Looking at the code any failures in the setup/teardown phase
> will stop the run, skip all the remaining tests but still return success.
>
> About returning skip from the script, aside from marking it as skip and
> continuing the suite, we would need to run a silent teardown, one that
> executes all commands in the specified teardown but
> ignores errors. In this case we are assuming all setup steps follow KSFT
> return codes. Not sure if it it's reasonable or not...

wouldn't this be fixed by adding this line:

"dependsOn" : "command -v jq >/dev/null"

to test scenarios 39b4 and e8a1 ? I'm asking this because jq is used
also in verifyCmd after the script, to parse results.
Background for this question: I see tdc skipping both setup and
teardown stages for each test case in taprio.json where this line:

     "dependsOn": "command -v ciao >/dev/null",

is present. Rather than doing a setup +  silent teardown, just do
nothing and go to the next test.

> As your suggestion is not a blocker, I would rather address the above
> problems in a follow up series since they will require some refactoring.
> WDYT?

no objections, but I'm curious to see if "dependsOn" would fix this case :)
thanks!
Pedro Tammela Jan. 24, 2024, 5:26 p.m. UTC | #4
On 24/01/2024 07:31, Davide Caratti wrote:
> hello Pedro, thanks for your answer!
> 
> On Tue, Jan 23, 2024 at 5:47 PM Pedro Tammela <pctammela@mojatatu.com> wrote:
>>
>> On 23/01/2024 10:17, Davide Caratti wrote:
>>> hi Pedro,
>>>
>>> On Tue, Jan 23, 2024 at 1:28 PM Pedro Tammela <pctammela@mojatatu.com> wrote:
>>>>
>>>> If 'jq' is not available the taprio tests that use this script will
>>>> run forever. Check if it exists before entering the while loop.
> 
> [...]
> 
>>> nit: what about returning $KSFT_SKIP (that is 4) if jq is not there?
>>> so the test does not fail.
>>> thanks!
>>
>> Since these scripts are run in the setup phase, it has a special treatment.
>>
>> Take for example this run:
>> ok 1 ba39 - Add taprio Qdisc to multi-queue device (8 queues)
>> ok 2 9462 - Add taprio Qdisc with multiple sched-entry
>> ok 3 8d92 - Add taprio Qdisc with txtime-delay
>> ok 4 d092 - Delete taprio Qdisc with valid handle
>> ok 5 8471 - Show taprio class
>> ok 6 0a85 - Add taprio Qdisc to single-queue device
>> ok 7 3e1e - Add taprio Qdisc with an invalid cycle-time
>> ok 8 39b4 - Reject grafting taprio as child qdisc of software taprio #
>> skipped - "-----> prepare stage" did not complete successfully
>>
>> ok 9 e8a1 - Reject grafting taprio as child qdisc of offloaded taprio #
>> skipped - skipped - previous setup failed 9 39b4
> 
> [...]
> 
>> As of today it returns 0, success in ksft, even though it clearly
>> wasn't. Looking at the code any failures in the setup/teardown phase
>> will stop the run, skip all the remaining tests but still return success.
>>
>> About returning skip from the script, aside from marking it as skip and
>> continuing the suite, we would need to run a silent teardown, one that
>> executes all commands in the specified teardown but
>> ignores errors. In this case we are assuming all setup steps follow KSFT
>> return codes. Not sure if it it's reasonable or not...
> 
> wouldn't this be fixed by adding this line:
> 
> "dependsOn" : "command -v jq >/dev/null"
> 
> to test scenarios 39b4 and e8a1 ? I'm asking this because jq is used
> also in verifyCmd after the script, to parse results.
> Background for this question: I see tdc skipping both setup and
> teardown stages for each test case in taprio.json where this line:
> 
>       "dependsOn": "command -v ciao >/dev/null",
> 
> is present. Rather than doing a setup +  silent teardown, just do
> nothing and go to the next test.

Oh indeed! Thanks for the suggestion this is much nicer.
I will send a v2!

> 
>> As your suggestion is not a blocker, I would rather address the above
>> problems in a follow up series since they will require some refactoring.
>> WDYT?
> 
> no objections, but I'm curious to see if "dependsOn" would fix this case :)
> thanks!
diff mbox series

Patch

diff --git a/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh b/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
index f5335e8ad6b4..68f2c6eaa802 100755
--- a/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
+++ b/tools/testing/selftests/tc-testing/scripts/taprio_wait_for_admin.sh
@@ -3,6 +3,11 @@ 
 TC="$1"; shift
 ETH="$1"; shift
 
+if ! command -v jq &> /dev/null; then
+    echo "Please install jq"
+    exit 1
+fi
+
 # The taprio architecture changes the admin schedule from a hrtimer and not
 # from process context, so we need to wait in order to make sure that any
 # schedule change actually took place.