virtualization.lists.linux-foundation.org archive mirror
 help / color / mirror / Atom feed
From: Simon Horman <horms@kernel.org>
To: Bobby Eshleman <bobbyeshleman@gmail.com>
Cc: Stefano Garzarella <sgarzare@redhat.com>,
	Shuah Khan <shuah@kernel.org>, Jakub Kicinski <kuba@kernel.org>,
	virtualization@lists.linux.dev, netdev@vger.kernel.org,
	linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
	Bobby Eshleman <bobbyeshleman@meta.com>
Subject: Re: [PATCH net-next 01/12] selftests/vsock: improve logging in vmtest.sh
Date: Mon, 27 Oct 2025 16:45:27 +0000	[thread overview]
Message-ID: <aP-hpxMgB5tN7KJ3@horms.kernel.org> (raw)
In-Reply-To: <20251022-vsock-selftests-fixes-and-improvements-v1-1-edeb179d6463@meta.com>

On Wed, Oct 22, 2025 at 06:00:05PM -0700, Bobby Eshleman wrote:
> From: Bobby Eshleman <bobbyeshleman@meta.com>
> 
> Improve usability of logging functions. Remove the test name prefix from
> logging functions so that logging calls can be made deeper into the call
> stack without passing down the test name or setting some global. Teach
> log function to accept a LOG_PREFIX variable to avoid unnecessary
> argument shifting.
> 
> Remove log_setup() and instead use log_host(). The host/guest prefixes
> are useful to show whether a failure happened on the guest or host side,
> but "setup" doesn't really give additional useful information. Since all
> log_setup() calls happen on the host, lets just use log_host() instead.
> 
> Signed-off-by: Bobby Eshleman <bobbyeshleman@meta.com>

...

>  log() {
> -	local prefix="$1"
> +	local redirect
> +	local prefix
>  
> -	shift
> -	local redirect=
>  	if [[ ${VERBOSE} -eq 0 ]]; then
>  		redirect=/dev/null
>  	else
>  		redirect=/dev/stdout
>  	fi
>  
> +	prefix="${LOG_PREFIX:-}"
> +
>  	if [[ "$#" -eq 0 ]]; then
> -		__log_stdin | tee -a "${LOG}" > ${redirect}
> +		if [[ -n "${prefix}" ]]; then
> +			cat | awk -v prefix="${prefix}" '{printf "%s: %s\n", prefix, $0}'

FIWIIW, I would drop cat from this line.

> +		else
> +			cat
> +		fi
>  	else
> -		__log_args "$@" | tee -a "${LOG}" > ${redirect}
> -	fi
> -}
> -
> -log_setup() {
> -	log "setup" "$@"
> +		if [[ -n "${prefix}" ]]; then
> +			echo "${prefix}: " "$@"
> +		else
> +			echo "$@"
> +		fi
> +	fi | tee -a "${LOG}" > ${redirect}
>  }
>  
>  log_host() {
> -	local testname=$1
> -
> -	shift
> -	log "test:${testname}:host" "$@"
> +	LOG_PREFIX=host log $@

shellcheck suggests keeping the quoting of $@.
This seems reasonable to me. Although in practice I don't think
it will change the behaviour of this script.

>  }
>  log_host
>  log_guest() {
> -	local testname=$1
> -
> -	shift
> -	log "test:${testname}:guest" "$@"
> +	LOG_PREFIX=guest log $@

shellcheck also points out that log_guest is never passed
arguments, so $@ can be dropped. If you prefer to keep
it then, as per log_host, it seems reasonable for it to be quoted.

>  }

...

  reply	other threads:[~2025-10-27 16:45 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-23  1:00 [PATCH net-next 00/12] selftests/vsock: refactor and improve vmtest infrastructure Bobby Eshleman
2025-10-23  1:00 ` [PATCH net-next 01/12] selftests/vsock: improve logging in vmtest.sh Bobby Eshleman
2025-10-27 16:45   ` Simon Horman [this message]
2025-10-27 17:28     ` Bobby Eshleman
2025-10-23  1:00 ` [PATCH net-next 02/12] selftests/vsock: make wait_for_listener() work even if pipefail is on Bobby Eshleman
2025-10-27 16:48   ` Simon Horman
2025-10-27 17:55     ` Bobby Eshleman
2025-10-29 16:56       ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 03/12] selftests/vsock: reuse logic for vsock_test through wrapper functions Bobby Eshleman
2025-10-27 16:58   ` Simon Horman
2025-10-27 18:01     ` Bobby Eshleman
2025-10-27 19:08       ` Bobby Eshleman
2025-10-27 23:22         ` Jakub Kicinski
2025-10-28 18:20           ` Bobby Eshleman
2025-10-29 16:58         ` Simon Horman
2025-10-29 17:00           ` Bobby Eshleman
2025-10-23  1:00 ` [PATCH net-next 04/12] selftests/vsock: avoid multi-VM pidfile collisions with QEMU Bobby Eshleman
2025-10-27 16:57   ` Simon Horman
2025-10-27 18:01     ` Bobby Eshleman
2025-10-23  1:00 ` [PATCH net-next 05/12] selftests/vsock: do not unconditionally die if qemu fails Bobby Eshleman
2025-10-29 16:58   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 06/12] selftests/vsock: speed up tests by reducing the QEMU pidfile timeout Bobby Eshleman
2025-10-29 16:59   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 07/12] selftests/vsock: add check_result() for pass/fail counting Bobby Eshleman
2025-10-29 16:59   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 08/12] selftests/vsock: identify and execute tests that can re-use VM Bobby Eshleman
2025-10-29 16:59   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 09/12] selftests/vsock: add BUILD=0 definition Bobby Eshleman
2025-10-27 17:45   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 10/12] selftests/vsock: avoid false-positives when checking dmesg Bobby Eshleman
2025-10-29 17:00   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 11/12] selftests/vsock: add 1.37 to tested virtme-ng versions Bobby Eshleman
2025-10-29 17:01   ` Simon Horman
2025-10-23  1:00 ` [PATCH net-next 12/12] selftests/vsock: add vsock_loopback module loading Bobby Eshleman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aP-hpxMgB5tN7KJ3@horms.kernel.org \
    --to=horms@kernel.org \
    --cc=bobbyeshleman@gmail.com \
    --cc=bobbyeshleman@meta.com \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=sgarzare@redhat.com \
    --cc=shuah@kernel.org \
    --cc=virtualization@lists.linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).