linux-kernel - Re: [PATCH 1/4] selftests/nolibc: add a test-report target

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <ZIB792FtG6ibOudp@1wt.eu>
Date:   Wed, 7 Jun 2023 14:45:43 +0200
From:   Willy Tarreau <w@....eu>
To:     Zhangjin Wu <falcon@...ylab.org>
Cc:     arnd@...db.de, linux-kernel@...r.kernel.org,
        linux-kselftest@...r.kernel.org, linux-riscv@...ts.infradead.org,
        thomas@...ch.de
Subject: Re: [PATCH 1/4] selftests/nolibc: add a test-report target

Hi Zhangjin,

On Wed, Jun 07, 2023 at 01:52:00PM +0800, Zhangjin Wu wrote:
> Hi, Willy
> 
> > > On Mon, Jun 05, 2023 at 11:48:52AM +0800, Zhangjin Wu wrote:
> > > > A standalone test-report target is added to let the run, run-user and
> > > > rerun targets share them.
> > > > 
> > > > Signed-off-by: Zhangjin Wu <falcon@...ylab.org>
> > > > ---
> > > >  tools/testing/selftests/nolibc/Makefile | 26 ++++++++++++-------------
> > > >  1 file changed, 13 insertions(+), 13 deletions(-)
> > > > 
> > > > diff --git a/tools/testing/selftests/nolibc/Makefile b/tools/testing/selftests/nolibc/Makefile
> > > > index be4159837494..8149ace2938a 100644
> > > > --- a/tools/testing/selftests/nolibc/Makefile
> > > > +++ b/tools/testing/selftests/nolibc/Makefile
> > > > @@ -127,14 +127,18 @@ nolibc-test: nolibc-test.c sysroot/$(ARCH)/include
> > > >  libc-test: nolibc-test.c
> > > >  	$(QUIET_CC)$(CC) -o $@ $<
> > > >  
> > > > -# qemu user-land test
> > > > -run-user: nolibc-test
> > > > -	$(Q)qemu-$(QEMU_ARCH) ./nolibc-test > "$(CURDIR)/run.out" || :
> > > > +test-report:
> > > >  	$(Q)awk '/\[OK\]$$/{p++} /\[FAIL\]$$/{f++} /\[SKIPPED\]$$/{s++} \
> > > >  	         END{ printf("%d test(s) passed, %d skipped, %d failed.", p, s, f); \
> > > >  	         if (s+f > 0) printf(" See all results in %s\n", ARGV[1]); else print; }' \
> > > >  	         $(CURDIR)/run.out
> > > >  
> > > > +# qemu user-land test
> > > > +_run-user: nolibc-test
> > > > +	$(Q)qemu-$(QEMU_ARCH) ./nolibc-test > "$(CURDIR)/run.out" || :
> > > > +
> > > > +run-user: _run-user test-report
> > > > +
> > > 
> > > This will not reliably work, there's no ordering here, nothing guarantees
> > > that test-report will run *after* _run-user (e.g. make -j). Another
> > > approach is needed if you want to factor this, but in general creating
> > > sequences in makefiles is difficult and often more painful than having
> > > 3 times the same 3 lines.
> > >
> > 
> > Ok, thanks, what about this?
> > 
> >     # LOG_REPORT: report the test results
> >     LOG_REPORT   := awk '/\[OK\][\r]*$$/{p++} /\[FAIL\][\r]*$$/{f++} /\[SKIPPED\][\r]*$$/{s++} \
> > 	                 END{ printf("%d test(s) passed, %d skipped, %d failed.", p, s, f); \
> > 	                 printf(" See all results in %s\n", ARGV[1]); }'
> > 
> >     run-user: nolibc-test
> > 	$(Q)qemu-$(QEMU_ARCH) ./nolibc-test > "$(CURDIR)/run.out" || :
> > 	$(Q)$(LOG_REPORT) $(CURDIR)/run.out
> > 
> >     run: kernel
> > 	$(Q)qemu-system-$(QEMU_ARCH) -display none -no-reboot -kernel "$(srctree)/$(IMAGE)" -serial stdio $(QEMU_ARGS) > "$(CURDIR)/run.out"
> > 	$(Q)$(LOG_REPORT) $(CURDIR)/run.out
> > 
> >     rerun:
> > 	$(Q)qemu-system-$(QEMU_ARCH) -display none -no-reboot -kernel "$(srctree)/$(IMAGE)" -serial stdio $(QEMU_ARGS) > "$(CURDIR)/run.out"
> > 	$(Q)$(LOG_REPORT) $(CURDIR)/run.out
> > 
> > Or we directly add a standalone test report script? something like
> > tools/testing/selftests/nolibc/report.sh
> > 
> >     #!/bin/sh
> >     #
> >     # report.sh -- report the test results of nolibc-test
> >     #
> >     
> >     LOG_FILE=$1
> >     [ ! -f "$LOG_FILE" ] && echo "Usage: $0 /path/to/run.out"
> >     
> >     awk '
> >         /\[OK\][\r]*$$/{ p++ }
> >         /\[FAIL\][\r]*$$/{ f++ }
> >         /\[SKIPPED\][\r]*$$/{ s++ }
> >     
> >         END {
> >             printf("%d test(s) passed, %d skipped, %d failed.", p, s, f);
> >             printf(" See all results in %s\n", ARGV[1]);
> >         }' $LOG_FILE
> > 
> > And use it like this:
> > 
> >     LOG_REPORT           = $(CURDIR)/report.sh
> >
> 
> I plan to renew this patchset, which one of the above methods do you
> prefer?

IFF it needs to be done I prefer the macro in the Makefile to avoid
depending on external scripts that are useless outside of the makefile.
BUT, my point remains that I adopted this so that I could quickly and
visually check that everything was OK. I'm fine with any other method
but I do not want to have to carefully read all these lines to make
sure I'm not mixing a "8" with a "0" (I'm mentioning this one because
it's exactly the one I had when I decided to add the extra values).
For example if you prepend "FAILURE: ", "WARNING: ", "SUCCESS: " in
front of these lines to summarize them depending on the highest level
encountered (success, skipped, failed), then I'm fine because it's
easy to check that all lines show the same word.

> For the always print statement:
> 
>     printf(" See all results in %s\n", ARGV[1]); }'

Then please put it on its own line without the leading space, this
will be even more readable.

> I will paste the reason why I need it, as mentioned in [1], if you still
> need a clean test report, I will give up this change ;-)

No worries, I don't want to be annoying if you need something, but I
don't want to be annoyed by changes either :-)

thanks,
Willy