Re: [Qemu-devel] [PATCH 2/2] tests: Check serial output of firmware boot of some machines

[David Gibson]

On Thu, Jul 14, 2016 at 11:57:46AM +0200, Thomas Huth wrote:
> Some of the machines that we have got a firmware image for write
> some output to the serial console while booting up. We can use
> this output to make sure that the machine is basically working,
> so this adds a test that checks the output of these machines
> for some well-known "magic" strings.
> 
> Signed-off-by: Thomas Huth <address@hidden>

I love this idea.  A couple of queries about the implemntation.

> ---
>  tests/Makefile.include   |   8 ++++
>  tests/boot-serial-test.c | 110 
> +++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 118 insertions(+)
>  create mode 100644 tests/boot-serial-test.c
> 
> diff --git a/tests/Makefile.include b/tests/Makefile.include
> index b7784d3..ba1cc8d 100644
> --- a/tests/Makefile.include
> +++ b/tests/Makefile.include
> @@ -194,6 +194,7 @@ check-qtest-i386-y += tests/hd-geo-test$(EXESUF)
>  gcov-files-i386-y += hw/block/hd-geometry.c
>  check-qtest-i386-y += tests/boot-order-test$(EXESUF)
>  check-qtest-i386-y += tests/bios-tables-test$(EXESUF)
> +check-qtest-i386-y += tests/boot-serial-test$(EXESUF)
>  check-qtest-i386-y += tests/pxe-test$(EXESUF)
>  check-qtest-i386-y += tests/rtc-test$(EXESUF)
>  check-qtest-i386-y += tests/ipmi-kcs-test$(EXESUF)
> @@ -241,6 +242,8 @@ check-qtest-x86_64-y += $(check-qtest-i386-y)
>  gcov-files-i386-y += i386-softmmu/hw/timer/mc146818rtc.c
>  gcov-files-x86_64-y = $(subst 
> i386-softmmu/,x86_64-softmmu/,$(gcov-files-i386-y))
>  
> +check-qtest-alpha-y = tests/boot-serial-test$(EXESUF)
> +
>  check-qtest-mips-y = tests/endianness-test$(EXESUF)
>  check-qtest-mips64-y = tests/endianness-test$(EXESUF)
>  check-qtest-mips64el-y = tests/endianness-test$(EXESUF)
> @@ -248,12 +251,14 @@ check-qtest-mips64el-y = tests/endianness-test$(EXESUF)
>  check-qtest-ppc-y = tests/endianness-test$(EXESUF)
>  check-qtest-ppc-y += tests/boot-order-test$(EXESUF)
>  check-qtest-ppc-y += tests/prom-env-test$(EXESUF)
> +check-qtest-ppc-y += tests/boot-serial-test$(EXESUF)
>  
>  check-qtest-ppc64-y = tests/endianness-test$(EXESUF)
>  check-qtest-ppc64-y += tests/boot-order-test$(EXESUF)
>  check-qtest-ppc64-y += tests/spapr-phb-test$(EXESUF)
>  gcov-files-ppc64-y += ppc64-softmmu/hw/ppc/spapr_pci.c
>  check-qtest-ppc64-y += tests/prom-env-test$(EXESUF)
> +check-qtest-ppc64-y += tests/boot-serial-test$(EXESUF)
>  
>  check-qtest-sh4-y = tests/endianness-test$(EXESUF)
>  check-qtest-sh4eb-y = tests/endianness-test$(EXESUF)
> @@ -277,6 +282,8 @@ gcov-files-arm-y += arm-softmmu/hw/block/virtio-blk.c
>  check-qtest-microblazeel-y = $(check-qtest-microblaze-y)
>  check-qtest-xtensaeb-y = $(check-qtest-xtensa-y)
>  
> +check-qtest-s390x-y = tests/boot-serial-test$(EXESUF)
> +
>  check-qtest-generic-y += tests/qom-test$(EXESUF)
>  
>  qapi-schema += alternate-any.json
> @@ -575,6 +582,7 @@ tests/ipmi-kcs-test$(EXESUF): tests/ipmi-kcs-test.o
>  tests/ipmi-bt-test$(EXESUF): tests/ipmi-bt-test.o
>  tests/hd-geo-test$(EXESUF): tests/hd-geo-test.o
>  tests/boot-order-test$(EXESUF): tests/boot-order-test.o $(libqos-obj-y)
> +tests/boot-serial-test$(EXESUF): tests/boot-serial-test.o $(libqos-obj-y)
>  tests/bios-tables-test$(EXESUF): tests/bios-tables-test.o \
>       tests/boot-sector.o $(libqos-obj-y)
>  tests/pxe-test$(EXESUF): tests/pxe-test.o tests/boot-sector.o $(libqos-obj-y)
> diff --git a/tests/boot-serial-test.c b/tests/boot-serial-test.c
> new file mode 100644
> index 0000000..3263dcd
> --- /dev/null
> +++ b/tests/boot-serial-test.c
> @@ -0,0 +1,110 @@
> +/*
> + * Test serial output of some machines.
> + *
> + * Copyright 2016 Thomas Huth, Red Hat Inc.
> + *
> + * This work is licensed under the terms of the GNU GPL, version 2
> + * or later. See the COPYING file in the top-level directory.
> + *
> + * This test is used to check that the serial output of the firmware
> + * (that we provide for some machines) contains an expected string.
> + * Thus we check that the firmware still boots at least to a certain
> + * point and so we know that the machine is not completely broken.
> + */
> +
> +#include "qemu/osdep.h"
> +#include "libqtest.h"
> +
> +typedef struct testdef {
> +    const char *arch;       /* Target architecture */
> +    const char *machine;    /* Name of the machine */
> +    const char *extra;      /* Additional parameters */
> +    const char *expect;     /* Expected string in the serial output */
> +} testdef_t;
> +
> +static testdef_t tests[] = {
> +    { "alpha", "clipper", "", "PCI:" },
> +    { "ppc", "ppce500", "", "U-Boot" },
> +    { "ppc", "prep", "", "Open Hack'Ware BIOS" },
> +    { "ppc64", "ppce500", "", "U-Boot" },
> +    { "ppc64", "prep", "", "Open Hack'Ware BIOS" },
> +    { "ppc64", "pseries", "", "Open Firmware" },
> +    { "i386", "isapc", "-device sga", "SGABIOS" },
> +    { "i386", "pc", "-device sga", "SGABIOS" },
> +    { "i386", "q35", "-device sga", "SGABIOS" },
> +    { "x86_64", "isapc", "-device sga", "SGABIOS" },
> +    { "x86_64", "pc", "-device sga", "SGABIOS" },
> +    { "x86_64", "q35", "-device sga", "SGABIOS" },
> +    { "s390x", "s390-ccw-virtio",
> +      "-nodefaults -device sclpconsole,chardev=serial0", "virtio device" },
> +    { NULL }
> +};
> +
> +static void check_guest_output(const testdef_t *test, int fd)
> +{
> +    bool output_ok = false;
> +    int i, pos = 0;
> +    char ch;
> +
> +    /* Poll serial output... Wait at most 30 seconds */
> +    for (i = 0; i < 3000; ++i) {
> +        while (read(fd, &ch, 1) == 1) {

It might be a good idea to check for actual errors from read() here.

> +            if (ch == test->expect[pos]) {
> +                pos += 1;
> +                if (test->expect[pos] == '\0') {
> +                    /* We've reached the end of the expected string! */
> +                    output_ok = true;
> +                    goto done;
> +                }
> +            } else {
> +                pos = 0;
> +            }
> +        }
> +        g_usleep(10000);
> +    }
> +
> +done:
> +    g_assert(output_ok);
> +}
> +
> +static void test_machine(const void *data)
> +{
> +    const testdef_t *test = data;
> +    char *args;
> +    char tmpname[] = "/tmp/qtest-boot-serial-XXXXXX";
> +    int fd;
> +
> +    fd = mkstemp(tmpname);
> +    g_assert(fd != -1);
> +
> +    args = g_strdup_printf("-M %s,accel=tcg -chardev file,id=serial0,path=%s"
> +                           " -serial chardev:serial0 %s", test->machine,
> +                           tmpname, test->extra);
> +
> +    qtest_start(args);
> +    unlink(tmpname);
> +
> +    check_guest_output(test, fd);
> +    qtest_quit(global_qtest);
> +
> +    g_free(args);
> +    close(fd);
> +}
> +
> +int main(int argc, char *argv[])
> +{
> +    const char *arch = qtest_get_arch();
> +    int i;
> +
> +    g_test_init(&argc, &argv, NULL);
> +
> +    for (i = 0; tests[i].arch != NULL; i++) {
> +        if (strcmp(arch, tests[i].arch) == 0) {
> +            char *name = g_strdup_printf("boot-serial/%s", tests[i].machine);
> +            qtest_add_data_func(name, &tests[i], test_machine);

Do we need some conditionals in case certain machine types are
configured out?

> +            g_free(name);
> +        }
> +    }
> +
> +    return g_test_run();
> +}

-- 
David Gibson                    | I'll have my music baroque, and my code
david AT gibson.dropbear.id.au  | minimalist, thank you.  NOT _the_ _other_
                                | _way_ _around_!
http://www.ozlabs.org/~dgibson

signature.asc
Description: PGP signature