JSON uses "name":value, but many of our visitor interfaces were
called with visit_type_FOO(v, &value, name, errp).  This can be
a bit confusing to have to mentally swap the parameter order to
match JSON order.  It's particularly bad for visit_start_struct(),
where the 'name' parameter is smack in the middle of the
otherwise-related group of 'obj, kind, size' parameters! It's
time to do a global swap of the parameter ordering, so that the
'name' parameter is always immediately after the Visitor argument.
Additional reason in favor of the swap: the existing include/qjson.h
prefers listing 'name' first in json_prop_*(), and I have plans to
unify that file with the qapi visitors; listing 'name' first in
qapi will minimize churn to the (admittedly few) qjson.h clients.
Later patches will then fix docs, object.h, visitor-impl.h, and
those clients to match.
Done by first patching scripts/qapi*.py by hand to make generated
files do what I want, then by running the following Coccinelle
script to affect the rest of the code base:
 $ spatch --sp-file script `git grep -l '\bvisit_' -- '**/*.[ch]'`
I then had to apply some touchups (Coccinelle insisted on TAB
indentation in visitor.h, and botched the signature of
visit_type_enum() by rewriting 'const char *const strings[]' to
the syntactically invalid 'const char*const[] strings').  The
movement of parameters is sufficient to provoke compiler errors
if any callers were missed.
    // Part 1: Swap declaration order
    @@
    type TV, TErr, TObj, T1, T2;
    identifier OBJ, ARG1, ARG2;
    @@
     void visit_start_struct
    -(TV v, TObj OBJ, T1 ARG1, const char *name, T2 ARG2, TErr errp)
    +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp)
     { ... }
    @@
    type bool, TV, T1;
    identifier ARG1;
    @@
     bool visit_optional
    -(TV v, T1 ARG1, const char *name)
    +(TV v, const char *name, T1 ARG1)
     { ... }
    @@
    type TV, TErr, TObj, T1;
    identifier OBJ, ARG1;
    @@
     void visit_get_next_type
    -(TV v, TObj OBJ, T1 ARG1, const char *name, TErr errp)
    +(TV v, const char *name, TObj OBJ, T1 ARG1, TErr errp)
     { ... }
    @@
    type TV, TErr, TObj, T1, T2;
    identifier OBJ, ARG1, ARG2;
    @@
     void visit_type_enum
    -(TV v, TObj OBJ, T1 ARG1, T2 ARG2, const char *name, TErr errp)
    +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp)
     { ... }
    @@
    type TV, TErr, TObj;
    identifier OBJ;
    identifier VISIT_TYPE =~ "^visit_type_";
    @@
     void VISIT_TYPE
    -(TV v, TObj OBJ, const char *name, TErr errp)
    +(TV v, const char *name, TObj OBJ, TErr errp)
     { ... }
    // Part 2: swap caller order
    @@
    expression V, NAME, OBJ, ARG1, ARG2, ERR;
    identifier VISIT_TYPE =~ "^visit_type_";
    @@
    (
    -visit_start_struct(V, OBJ, ARG1, NAME, ARG2, ERR)
    +visit_start_struct(V, NAME, OBJ, ARG1, ARG2, ERR)
    |
    -visit_optional(V, ARG1, NAME)
    +visit_optional(V, NAME, ARG1)
    |
    -visit_get_next_type(V, OBJ, ARG1, NAME, ERR)
    +visit_get_next_type(V, NAME, OBJ, ARG1, ERR)
    |
    -visit_type_enum(V, OBJ, ARG1, ARG2, NAME, ERR)
    +visit_type_enum(V, NAME, OBJ, ARG1, ARG2, ERR)
    |
    -VISIT_TYPE(V, OBJ, NAME, ERR)
    +VISIT_TYPE(V, NAME, OBJ, ERR)
    )
Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1454075341-13658-19-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
		
	
			
		
			
				
	
	
		
			283 lines
		
	
	
		
			7.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			283 lines
		
	
	
		
			7.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * String Input Visitor unit-tests.
 | 
						|
 *
 | 
						|
 * Copyright (C) 2012 Red Hat Inc.
 | 
						|
 *
 | 
						|
 * Authors:
 | 
						|
 *  Paolo Bonzini <pbonzini@redhat.com> (based on test-qmp-input-visitor)
 | 
						|
 *
 | 
						|
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 | 
						|
 * See the COPYING file in the top-level directory.
 | 
						|
 */
 | 
						|
 | 
						|
#include <glib.h>
 | 
						|
#include <stdarg.h>
 | 
						|
 | 
						|
#include "qemu-common.h"
 | 
						|
#include "qapi/string-input-visitor.h"
 | 
						|
#include "test-qapi-types.h"
 | 
						|
#include "test-qapi-visit.h"
 | 
						|
#include "qapi/qmp/types.h"
 | 
						|
 | 
						|
typedef struct TestInputVisitorData {
 | 
						|
    StringInputVisitor *siv;
 | 
						|
} TestInputVisitorData;
 | 
						|
 | 
						|
static void visitor_input_teardown(TestInputVisitorData *data,
 | 
						|
                                   const void *unused)
 | 
						|
{
 | 
						|
    if (data->siv) {
 | 
						|
        string_input_visitor_cleanup(data->siv);
 | 
						|
        data->siv = NULL;
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
/* This is provided instead of a test setup function so that the JSON
 | 
						|
   string used by the tests are kept in the test functions (and not
 | 
						|
   int main()) */
 | 
						|
static
 | 
						|
Visitor *visitor_input_test_init(TestInputVisitorData *data,
 | 
						|
                                 const char *string)
 | 
						|
{
 | 
						|
    Visitor *v;
 | 
						|
 | 
						|
    data->siv = string_input_visitor_new(string);
 | 
						|
    g_assert(data->siv != NULL);
 | 
						|
 | 
						|
    v = string_input_get_visitor(data->siv);
 | 
						|
    g_assert(v != NULL);
 | 
						|
 | 
						|
    return v;
 | 
						|
}
 | 
						|
 | 
						|
static void test_visitor_in_int(TestInputVisitorData *data,
 | 
						|
                                const void *unused)
 | 
						|
{
 | 
						|
    int64_t res = 0, value = -42;
 | 
						|
    Error *err = NULL;
 | 
						|
    Visitor *v;
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "-42");
 | 
						|
 | 
						|
    visit_type_int(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, value);
 | 
						|
}
 | 
						|
 | 
						|
static void test_visitor_in_intList(TestInputVisitorData *data,
 | 
						|
                                    const void *unused)
 | 
						|
{
 | 
						|
    int64_t value[] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 20};
 | 
						|
    int16List *res = NULL, *tmp;
 | 
						|
    Visitor *v;
 | 
						|
    int i = 0;
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "1,2,0,2-4,20,5-9,1-8");
 | 
						|
 | 
						|
    visit_type_int16List(v, NULL, &res, &error_abort);
 | 
						|
    tmp = res;
 | 
						|
    while (i < sizeof(value) / sizeof(value[0])) {
 | 
						|
        g_assert(tmp);
 | 
						|
        g_assert_cmpint(tmp->value, ==, value[i++]);
 | 
						|
        tmp = tmp->next;
 | 
						|
    }
 | 
						|
    g_assert(!tmp);
 | 
						|
 | 
						|
    tmp = res;
 | 
						|
    while (tmp) {
 | 
						|
        res = res->next;
 | 
						|
        g_free(tmp);
 | 
						|
        tmp = res;
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
static void test_visitor_in_bool(TestInputVisitorData *data,
 | 
						|
                                 const void *unused)
 | 
						|
{
 | 
						|
    Error *err = NULL;
 | 
						|
    bool res = false;
 | 
						|
    Visitor *v;
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "true");
 | 
						|
 | 
						|
    visit_type_bool(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, true);
 | 
						|
    visitor_input_teardown(data, unused);
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "yes");
 | 
						|
 | 
						|
    visit_type_bool(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, true);
 | 
						|
    visitor_input_teardown(data, unused);
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "on");
 | 
						|
 | 
						|
    visit_type_bool(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, true);
 | 
						|
    visitor_input_teardown(data, unused);
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "false");
 | 
						|
 | 
						|
    visit_type_bool(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, false);
 | 
						|
    visitor_input_teardown(data, unused);
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "no");
 | 
						|
 | 
						|
    visit_type_bool(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, false);
 | 
						|
    visitor_input_teardown(data, unused);
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "off");
 | 
						|
 | 
						|
    visit_type_bool(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpint(res, ==, false);
 | 
						|
}
 | 
						|
 | 
						|
static void test_visitor_in_number(TestInputVisitorData *data,
 | 
						|
                                   const void *unused)
 | 
						|
{
 | 
						|
    double res = 0, value = 3.14;
 | 
						|
    Error *err = NULL;
 | 
						|
    Visitor *v;
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, "3.14");
 | 
						|
 | 
						|
    visit_type_number(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpfloat(res, ==, value);
 | 
						|
}
 | 
						|
 | 
						|
static void test_visitor_in_string(TestInputVisitorData *data,
 | 
						|
                                   const void *unused)
 | 
						|
{
 | 
						|
    char *res = NULL, *value = (char *) "Q E M U";
 | 
						|
    Error *err = NULL;
 | 
						|
    Visitor *v;
 | 
						|
 | 
						|
    v = visitor_input_test_init(data, value);
 | 
						|
 | 
						|
    visit_type_str(v, NULL, &res, &err);
 | 
						|
    g_assert(!err);
 | 
						|
    g_assert_cmpstr(res, ==, value);
 | 
						|
 | 
						|
    g_free(res);
 | 
						|
}
 | 
						|
 | 
						|
static void test_visitor_in_enum(TestInputVisitorData *data,
 | 
						|
                                 const void *unused)
 | 
						|
{
 | 
						|
    Error *err = NULL;
 | 
						|
    Visitor *v;
 | 
						|
    EnumOne i;
 | 
						|
 | 
						|
    for (i = 0; EnumOne_lookup[i]; i++) {
 | 
						|
        EnumOne res = -1;
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, EnumOne_lookup[i]);
 | 
						|
 | 
						|
        visit_type_EnumOne(v, NULL, &res, &err);
 | 
						|
        g_assert(!err);
 | 
						|
        g_assert_cmpint(i, ==, res);
 | 
						|
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
    }
 | 
						|
 | 
						|
    data->siv = NULL;
 | 
						|
}
 | 
						|
 | 
						|
/* Try to crash the visitors */
 | 
						|
static void test_visitor_in_fuzz(TestInputVisitorData *data,
 | 
						|
                                 const void *unused)
 | 
						|
{
 | 
						|
    int64_t ires;
 | 
						|
    intList *ilres;
 | 
						|
    bool bres;
 | 
						|
    double nres;
 | 
						|
    char *sres;
 | 
						|
    EnumOne eres;
 | 
						|
    Visitor *v;
 | 
						|
    unsigned int i;
 | 
						|
    char buf[10000];
 | 
						|
 | 
						|
    for (i = 0; i < 100; i++) {
 | 
						|
        unsigned int j;
 | 
						|
 | 
						|
        j = g_test_rand_int_range(0, sizeof(buf) - 1);
 | 
						|
 | 
						|
        buf[j] = '\0';
 | 
						|
 | 
						|
        if (j != 0) {
 | 
						|
            for (j--; j != 0; j--) {
 | 
						|
                buf[j - 1] = (char)g_test_rand_int_range(0, 256);
 | 
						|
            }
 | 
						|
        }
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, buf);
 | 
						|
        visit_type_int(v, NULL, &ires, NULL);
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, buf);
 | 
						|
        visit_type_intList(v, NULL, &ilres, NULL);
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, buf);
 | 
						|
        visit_type_bool(v, NULL, &bres, NULL);
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, buf);
 | 
						|
        visit_type_number(v, NULL, &nres, NULL);
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, buf);
 | 
						|
        sres = NULL;
 | 
						|
        visit_type_str(v, NULL, &sres, NULL);
 | 
						|
        g_free(sres);
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
 | 
						|
        v = visitor_input_test_init(data, buf);
 | 
						|
        visit_type_EnumOne(v, NULL, &eres, NULL);
 | 
						|
        visitor_input_teardown(data, NULL);
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
static void input_visitor_test_add(const char *testpath,
 | 
						|
                                   TestInputVisitorData *data,
 | 
						|
                                   void (*test_func)(TestInputVisitorData *data, const void *user_data))
 | 
						|
{
 | 
						|
    g_test_add(testpath, TestInputVisitorData, data, NULL, test_func,
 | 
						|
               visitor_input_teardown);
 | 
						|
}
 | 
						|
 | 
						|
int main(int argc, char **argv)
 | 
						|
{
 | 
						|
    TestInputVisitorData in_visitor_data;
 | 
						|
 | 
						|
    g_test_init(&argc, &argv, NULL);
 | 
						|
 | 
						|
    input_visitor_test_add("/string-visitor/input/int",
 | 
						|
                           &in_visitor_data, test_visitor_in_int);
 | 
						|
    input_visitor_test_add("/string-visitor/input/intList",
 | 
						|
                           &in_visitor_data, test_visitor_in_intList);
 | 
						|
    input_visitor_test_add("/string-visitor/input/bool",
 | 
						|
                           &in_visitor_data, test_visitor_in_bool);
 | 
						|
    input_visitor_test_add("/string-visitor/input/number",
 | 
						|
                           &in_visitor_data, test_visitor_in_number);
 | 
						|
    input_visitor_test_add("/string-visitor/input/string",
 | 
						|
                            &in_visitor_data, test_visitor_in_string);
 | 
						|
    input_visitor_test_add("/string-visitor/input/enum",
 | 
						|
                            &in_visitor_data, test_visitor_in_enum);
 | 
						|
    input_visitor_test_add("/string-visitor/input/fuzz",
 | 
						|
                            &in_visitor_data, test_visitor_in_fuzz);
 | 
						|
 | 
						|
    g_test_run();
 | 
						|
 | 
						|
    return 0;
 | 
						|
}
 |