[Libguestfs] [PATCH v2 nbdkit] tests: Add generic ‘requires’ function for test prerequisites.

[Eric Blake]

On 1/23/19 9:36 AM, Richard W.M. Jones wrote:

> +++ b/tests/functions.sh.in
> @@ -1,7 +1,7 @@
>  # nbdkit
>  # Common functions used by the tests.
>  # @configure_input@
> -# Copyright (C) 2017-2018 Red Hat Inc.
> +# Copyright (C) 2017-2019 Red Hat Inc.
>  # All rights reserved.
>  #
>  # Redistribution and use in source and binary forms, with or without
> @@ -57,6 +57,21 @@ _run_cleanup_hooks ()
>  }
>  trap _run_cleanup_hooks INT QUIT TERM EXIT ERR
>  
> +# requires program [args]
> +#
> +# Check that ‘program [args]’ works.  If not, skip the test.
> +# For example to check that qemu-img is available, do:
> +#
> +# requires qemu-img --version
> +requires ()
> +{
> +    ( "$@" ) </dev/null >/dev/null 2>&1 || {
> +        echo "$0: ‘$*’ failed with error code $?"
> +        echo "$0: test prerequisite is missing or not working"
> +        exit 77
> +    }
> +}

Updated function looks good.

> +++ b/tests/test-ip.sh
> @@ -37,26 +37,17 @@
>  source ./functions.sh
>  set -e
>  
> -rm -f ip.pid ipv4.out ipv6.out
> -cleanup_fn rm -f ip.pid ipv4.out ipv6.out
> +requires ss --version
> +requires ip -V
> +requires qemu-img --version
>  
> -# Don't fail if certain commands aren't available.
> -if ! ss --version; then
> -    echo "$0: 'ss' command not available"
> -    exit 77
> -fi
> -if ! command -v qemu-img; then
> -    echo "$0: 'qemu-img' command not available"
> -    exit 77
> -fi
>  if ! qemu-img --help | grep -- --image-opts; then
>      echo "$0: 'qemu-img' command does not have the --image-opts option"
>      exit 77

The old test insists on --image-opts,

>  fi
> -if ! ip -V; then
> -    echo "$0: 'ip' command not available"
> -    exit 77
> -fi
> +
> +rm -f ip.pid ipv4.out ipv6.out
> +cleanup_fn rm -f ip.pid ipv4.out ipv6.out

...but the rewrite does not.  Could be solved with:

requires qemu-img info --image-opts driver=file,filename=functions.sh

> +++ b/tests/test-partitioning2.sh
> @@ -40,16 +40,12 @@ source ./functions.sh
>  set -e
>  set -x
>  
> +requires mke2fs -V
> +
>  files="partitioning2.pid partitioning2.sock partitioning2.fs partitioning2.p1 partitioning2.p3"
>  rm -f $files
>  cleanup_fn rm -f $files
>  
> -# Test that mke2fs works
> -if ! mke2fs -V; then
> -    echo "$0: missing or broken mke2fs"
> -    exit 77
> -fi
> -
>  # Create partitions before and after.
>  truncate -s 1 partitioning2.p1

'truncate' is not universally available; that may be something for a
future patch to add a requires line for (but not this patch, which
should be just the mechanical rewrites).

> +++ b/tests/test-tls-psk.sh
> @@ -35,15 +35,9 @@ source ./functions.sh
>  set -e
>  set -x
>  
> -# Don't fail if certain commands aren't available.
> -if ! ss --version; then
> -    echo "$0: 'ss' command not available"
> -    exit 77
> -fi
> -if ! command -v qemu-img > /dev/null; then
> -    echo "$0: 'qemu-img' command not available"
> -    exit 77
> -fi
> +requires ss --version
> +requires qemu-img --version
> +
>  if ! qemu-img --help | grep -- --object; then

There might be a way to express this via requires (similar to the way I
checked for --image-opts support above), via a harmless probe of a
known-existing file. But I didn't spend time coming up with such a
working command line probe (I got distracted by the fact that 'qemu-img
info --object nosuch file' has status 1 but no error message on stderr,
oops).

Looks like you're ready to go.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libguestfs/attachments/20190123/732452e8/attachment.sig>