Re: [PATCH v2 09/18] tests/qtest/migration: Add a test for HMP

["Dr. David Alan Gilbert" <dave@treblig.org>]

* Fabiano Rosas (farosas@suse.de) wrote:
> The following patches will change how parameters are set and shown in
> HMP, add a test for it.
> 
> The test issues HMP migrate_set_parameters for each of the existing
> migration parameters and queries them back with the info command. A
> list is kept with the expected strings. A substring match function
> inspired by glib's g_str_match_string is implemented for this test so
> the test can produce a decent error output instead of just assert
> failure. E.g:
> 
>  # HMP output mismatch for entry at line 55:
>  # expected vs. found:
>  #
>  # max-bandwidth: 10356305952768 bytes/hour
>  # ---
>  # max-bandwidth: 10356305952768 bytes/second
> 
> (note that line 55 above is the source line where the test case for
> max-bandwith is, which helps find the failing test in the list)
> 
> Usage:
> QTEST_QEMU_BINARY=./qemu-system-x86_64 \
> ./tests/qtest/migration-test --full -p /x86_64/migration/hmp/parameters
> 
> Signed-off-by: Fabiano Rosas <farosas@suse.de>

Acked-by: Dr. David Alan Gilbert <dave@treblig.org>

Two minor thoughts:
  a) You might try a numeric out of range test?
  b) 'input1' and 'input2' seem odd names for something that oculd be .name and .value ?
    (But only if you need to rework anyway).

Dave

> ---
>  tests/qtest/migration/misc-tests.c | 201 +++++++++++++++++++++++++++++
>  1 file changed, 201 insertions(+)
> 
> diff --git a/tests/qtest/migration/misc-tests.c b/tests/qtest/migration/misc-tests.c
> index 4e0deb7f18..533cf3d55d 100644
> --- a/tests/qtest/migration/misc-tests.c
> +++ b/tests/qtest/migration/misc-tests.c
> @@ -22,6 +22,203 @@
>  
>  static char *tmpfs;
>  
> +#ifdef CONFIG_HMP
> +static int test_case_line;
> +
> +#define TEST(i1, i2, e) { i1, i2, e , .line = __LINE__, }
> +#define SKIP(i1, i2, e) { i1, i2, e , .skip = true, }
> +#define BG_SNAP_MSG ("Error: Background-snapshot is not compatible with " \
> +                     "currently set capabilities")
> +
> +typedef struct HMPTestData {
> +    const char *input1;
> +    const char *input2;
> +    const char *output1;
> +    bool skip;
> +    int line;
> +} HMPTestData;
> +
> +/*
> + * .input1: string to be used as parameter name
> + * .input2: string to be used as parameter value
> + * .output1: expected output of migrate_set_parameters
> + * E.g:
> + * (qemu) migrate_set_parameters .input1 .input2
> + * .output1
> + */
> +HMPTestData test_cases[] = {
> +    TEST("", "", "migrate_set_parameter: string expected"),
> +    TEST("foo", "", "migrate_set_parameter: string expected"),
> +    TEST("foo", "on", "Error: invalid parameter value: foo"),
> +
> +    /* bool */
> +    TEST("cpu-throttle-tailslow", "on", "on"),
> +    TEST("direct-io", "on", "on"),
> +
> +    /* uint64_t */
> +    TEST("announce-initial", "60", "60 ms"),
> +    TEST("announce-max", "600", "600 ms"),
> +    TEST("announce-rounds", "6", "6"),
> +    TEST("announce-step", "15", "15 ms"),
> +    TEST("downtime-limit", "400", "400 ms"),
> +    TEST("avail-switchover-bandwidth", "2097152", "2199023255552 bytes/second"),
> +    TEST("max-bandwidth", "9876543", "10356305952768 bytes/second"),
> +    TEST("max-postcopy-bandwidth", "1048576", "1048576 bytes/second"),
> +    TEST("vcpu-dirty-limit", "20", "20 MB/s"),
> +    TEST("x-rdma-chunk-size", "1048576", "1048576 bytes"),
> +    TEST("x-vcpu-dirty-limit-period", "750", "750 ms"),
> +    TEST("xbzrle-cache-size", "67108864", "67108864 bytes"),
> +
> +    /* uint32_t */
> +    TEST("x-checkpoint-delay", "5000", "5000 ms"),
> +
> +    /* uint8_t */
> +    TEST("cpu-throttle-increment", "15", "15"),
> +    TEST("cpu-throttle-initial", "25", "25"),
> +    TEST("max-cpu-throttle", "85", "85"),
> +    TEST("multifd-channels", "8", "8"),
> +    TEST("throttle-trigger-threshold", "65", "65"),
> +
> +    /* complex types */
> +    TEST("mode", "cpr-exec", "cpr-exec"),
> +    TEST("multifd-compression", "zlib", "zlib"),
> +    TEST("zero-page-detection", "none", "none"),
> +    TEST("tls-authz", "my_authz", "'my_authz'"),
> +    TEST("tls-creds", "null", "'null'"),
> +    TEST("tls-hostname", "localhost", "'localhost'"),
> +    TEST("cpr-exec-command", "/bin/true foobar", "/bin/true foobar"),
> +
> +    /* can be set but are currently missing in the query output */
> +    SKIP("multifd-qatzip-level", "5", "5"),
> +    SKIP("multifd-zlib-level", "4", "4"),
> +    SKIP("multifd-zstd-level", "6", "6"),
> +
> +    /* cannot be set */
> +    TEST("block-bitmap-mapping", "[]",
> +         "Error: The block-bitmap-mapping parameter "
> +         "can only be set through QMP"),
> +};
> +
> +/*
> + * Find a contiguous run of tokens in @larger that match the sequence
> + * of tokens in @smaller, ignoring mismatches due to sequences of
> + * empty tokens.
> + *
> + * Returns whether a match was found. @last is set if at least one
> + * token has matched.
> + */
> +static bool token_list_is_substr(char **smaller, char **larger, int *last)
> +{
> +    int i, j, k = 0;
> +    bool match = false;
> +
> +    for (i = 0; smaller[i]; i++) {
> +        for (j = k; larger[j]; j++) {
> +            if (!*larger[j]) {
> +                continue;
> +            }
> +
> +            /* readline adds several escape sequences */
> +            if (*larger[j] == '\033') {
> +                continue;
> +            }
> +
> +            if (g_str_equal(larger[j], smaller[i])) {
> +                match = true;
> +                *last = j;
> +                k = j + 1;
> +                break;
> +            }
> +
> +            if (match) {
> +                return false;
> +            } else {
> +                match = false;
> +            }
> +        }
> +    }
> +
> +    return match;
> +}
> +
> +static void assert_hmp_match_line(const char *str, const char *text)
> +{
> +    g_auto(GStrv) tok_str = g_strsplit_set(str, " ", -1);
> +    g_auto(GStrv) lines = g_strsplit_set(text, " \r\n", -1);
> +    int i, idx = -1;
> +
> +    /*
> +     * Note that the reason the 'str' above is split is to allow
> +     * token_list_is_substr() to first match on the parameter name so
> +     * matching can stop immediately after a mismatched value is
> +     * found. This provides a better output for failing test cases
> +     * than simply "str != line".
> +     */
> +
> +    for (i = 0; lines[i]; i++) {
> +        if (token_list_is_substr(tok_str, (char **)&lines[i], &idx)) {
> +            return;
> +        }
> +
> +        if (idx >= 0) {
> +            break;
> +        }
> +    }
> +
> +    g_test_message("HMP output mismatch for entry at line %d:", test_case_line);
> +    g_test_message("expected vs. found:\n\n%s\n---\n%s %s", str, lines[idx],
> +                   lines[idx + 1]);
> +    g_assert_not_reached();
> +}
> +
> +static void assert_hmp_success(const char *str)
> +{
> +    if (!g_str_equal(str, "")) {
> +        g_test_message("HMP command failed:\n\n%s", str);
> +        g_assert_not_reached();
> +    }
> +}
> +
> +static void test_hmp_migration_parameters(char *name, MigrateCommon *args)
> +{
> +    QTestState *qts;
> +
> +    /* force TCG so it can run in all targets */
> +    qts = qtest_init("-accel tcg -nodefaults -S");
> +
> +    for (int i = 0; i < G_N_ELEMENTS(test_cases); i++) {
> +        g_autofree char *resp = NULL;
> +        g_autofree char *line = NULL;
> +        struct HMPTestData *t = &test_cases[i];
> +
> +        if (t->skip) {
> +            continue;
> +        }
> +
> +        test_case_line = t->line;
> +
> +        resp = qtest_hmp(qts, "migrate_set_parameter %s %s", t->input1,
> +                         t->input2);
> +
> +        if (g_str_has_prefix(t->output1, "Error:") ||
> +            g_str_has_prefix(resp, "migrate_set_parameter:")) {
> +
> +            assert_hmp_match_line(t->output1, resp);
> +            continue;
> +        }
> +        assert_hmp_success(resp);
> +        g_free(resp);
> +
> +        resp = qtest_hmp(qts, "info migrate_parameters");
> +
> +        line = g_strconcat(t->input1, ": ", t->output1, NULL);
> +        assert_hmp_match_line(line, resp);
> +    }
> +
> +    qtest_quit(qts);
> +}
> +#endif /* CONFIG_HMP */
> +
>  static void test_baddest(char *name, MigrateCommon *args)
>  {
>      QTestState *from, *to;
> @@ -260,4 +457,8 @@ void migration_test_add_misc(MigrationTestEnv *env)
>                         test_validate_uri_channels_both_set);
>      migration_test_add("/migration/validate_uri/channels/none_set",
>                         test_validate_uri_channels_none_set);
> +#ifdef CONFIG_HMP
> +    migration_test_add("/migration/hmp/parameters",
> +                       test_hmp_migration_parameters);
> +#endif
>  }
> -- 
> 2.53.0
> 
-- 
 -----Open up your eyes, open up your mind, open up your code -------   
/ Dr. David Alan Gilbert    |       Running GNU/Linux       | Happy  \ 
\        dave @ treblig.org |                               | In Hex /
 \ _________________________|_____ http://www.treblig.org   |_______/