tests/test-qmp-input-strict.c

   1 /*
   2  * QMP Input Visitor unit-tests (strict mode).
   3  *
   4  * Copyright (C) 2011-2012, 2015 Red Hat Inc.
   5  *
   6  * Authors:
   7  *  Luiz Capitulino <lcapitulino@redhat.com>
   8  *  Paolo Bonzini <pbonzini@redhat.com>
   9  *
  10  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  11  * See the COPYING file in the top-level directory.
  12  */
  13
  14 #include <glib.h>
  15 #include <stdarg.h>
  16
  17 #include "qemu-common.h"
  18 #include "qapi/qmp-input-visitor.h"
  19 #include "test-qapi-types.h"
  20 #include "test-qapi-visit.h"
  21 #include "qapi/qmp/types.h"
  22 #include "test-qmp-introspect.h"
  23 #include "qmp-introspect.h"
  24 #include "qapi-visit.h"
  25
  26 typedef struct TestInputVisitorData {
  27     QObject *obj;
  28     QmpInputVisitor *qiv;
  29 } TestInputVisitorData;
  30
  31 static void validate_teardown(TestInputVisitorData *data,
  32                                const void *unused)
  33 {
  34     qobject_decref(data->obj);
  35     data->obj = NULL;
  36
  37     if (data->qiv) {
  38         qmp_input_visitor_cleanup(data->qiv);
  39         data->qiv = NULL;
  40     }
  41 }
  42
  43 /* This is provided instead of a test setup function so that the JSON
  44    string used by the tests are kept in the test functions (and not
  45    int main()) */
  46 static GCC_FMT_ATTR(2, 3)
  47 Visitor *validate_test_init(TestInputVisitorData *data,
  48                              const char *json_string, ...)
  49 {
  50     Visitor *v;
  51     va_list ap;
  52
  53     va_start(ap, json_string);
  54     data->obj = qobject_from_jsonv(json_string, &ap);
  55     va_end(ap);
  56
  57     g_assert(data->obj != NULL);
  58
  59     data->qiv = qmp_input_visitor_new_strict(data->obj);
  60     g_assert(data->qiv != NULL);
  61
  62     v = qmp_input_get_visitor(data->qiv);
  63     g_assert(v != NULL);
  64
  65     return v;
  66 }
  67
  68 /* similar to validate_test_init(), but does not expect a string
  69  * literal/format json_string argument and so can be used for
  70  * programatically generated strings (and we can't pass in programatically
  71  * generated strings via %s format parameters since qobject_from_jsonv()
  72  * will wrap those in double-quotes and treat the entire object as a
  73  * string)
  74  */
  75 static Visitor *validate_test_init_raw(TestInputVisitorData *data,
  76                                        const char *json_string)
  77 {
  78     Visitor *v;
  79
  80     data->obj = qobject_from_json(json_string);
  81     g_assert(data->obj != NULL);
  82
  83     data->qiv = qmp_input_visitor_new_strict(data->obj);
  84     g_assert(data->qiv != NULL);
  85
  86     v = qmp_input_get_visitor(data->qiv);
  87     g_assert(v != NULL);
  88
  89     return v;
  90 }
  91
  92 typedef struct TestStruct
  93 {
  94     int64_t integer;
  95     bool boolean;
  96     char *string;
  97 } TestStruct;
  98
  99 static void visit_type_TestStruct(Visitor *v, TestStruct **obj,
 100                                   const char *name, Error **errp)
 101 {
 102     Error *err = NULL;
 103
 104     visit_start_struct(v, (void **)obj, "TestStruct", name, sizeof(TestStruct),
 105                        &err);
 106     if (err) {
 107         goto out;
 108     }
 109
 110     visit_type_int(v, &(*obj)->integer, "integer", &err);
 111     if (err) {
 112         goto out_end;
 113     }
 114     visit_type_bool(v, &(*obj)->boolean, "boolean", &err);
 115     if (err) {
 116         goto out_end;
 117     }
 118     visit_type_str(v, &(*obj)->string, "string", &err);
 119
 120 out_end:
 121     error_propagate(errp, err);
 122     err = NULL;
 123     visit_end_struct(v, &err);
 124 out:
 125     error_propagate(errp, err);
 126 }
 127
 128 static void test_validate_struct(TestInputVisitorData *data,
 129                                   const void *unused)
 130 {
 131     TestStruct *p = NULL;
 132     Error *err = NULL;
 133     Visitor *v;
 134
 135     v = validate_test_init(data, "{ 'integer': -42, 'boolean': true, 'string': 'foo' }");
 136
 137     visit_type_TestStruct(v, &p, NULL, &err);
 138     g_assert(!err);
 139     g_free(p->string);
 140     g_free(p);
 141 }
 142
 143 static void test_validate_struct_nested(TestInputVisitorData *data,
 144                                          const void *unused)
 145 {
 146     UserDefTwo *udp = NULL;
 147     Error *err = NULL;
 148     Visitor *v;
 149
 150     v = validate_test_init(data, "{ 'string0': 'string0', "
 151                            "'dict1': { 'string1': 'string1', "
 152                            "'dict2': { 'userdef': { 'integer': 42, "
 153                            "'string': 'string' }, 'string': 'string2'}}}");
 154
 155     visit_type_UserDefTwo(v, &udp, NULL, &err);
 156     g_assert(!err);
 157     qapi_free_UserDefTwo(udp);
 158 }
 159
 160 static void test_validate_list(TestInputVisitorData *data,
 161                                 const void *unused)
 162 {
 163     UserDefOneList *head = NULL;
 164     Error *err = NULL;
 165     Visitor *v;
 166
 167     v = validate_test_init(data, "[ { 'string': 'string0', 'integer': 42 }, { 'string': 'string1', 'integer': 43 }, { 'string': 'string2', 'integer': 44 } ]");
 168
 169     visit_type_UserDefOneList(v, &head, NULL, &err);
 170     g_assert(!err);
 171     qapi_free_UserDefOneList(head);
 172 }
 173
 174 static void test_validate_union_native_list(TestInputVisitorData *data,
 175                                             const void *unused)
 176 {
 177     UserDefNativeListUnion *tmp = NULL;
 178     Visitor *v;
 179     Error *err = NULL;
 180
 181     v = validate_test_init(data, "{ 'type': 'integer', 'data' : [ 1, 2 ] }");
 182
 183     visit_type_UserDefNativeListUnion(v, &tmp, NULL, &err);
 184     g_assert(!err);
 185     qapi_free_UserDefNativeListUnion(tmp);
 186 }
 187
 188 static void test_validate_union_flat(TestInputVisitorData *data,
 189                                      const void *unused)
 190 {
 191     UserDefFlatUnion *tmp = NULL;
 192     Visitor *v;
 193     Error *err = NULL;
 194
 195     v = validate_test_init(data,
 196                            "{ 'enum1': 'value1', "
 197                            "'integer': 41, "
 198                            "'string': 'str', "
 199                            "'boolean': true }");
 200
 201     visit_type_UserDefFlatUnion(v, &tmp, NULL, &err);
 202     g_assert(!err);
 203     qapi_free_UserDefFlatUnion(tmp);
 204 }
 205
 206 static void test_validate_alternate(TestInputVisitorData *data,
 207                                     const void *unused)
 208 {
 209     UserDefAlternate *tmp = NULL;
 210     Visitor *v;
 211     Error *err = NULL;
 212
 213     v = validate_test_init(data, "42");
 214
 215     visit_type_UserDefAlternate(v, &tmp, NULL, &err);
 216     g_assert(!err);
 217     qapi_free_UserDefAlternate(tmp);
 218 }
 219
 220 static void test_validate_fail_struct(TestInputVisitorData *data,
 221                                        const void *unused)
 222 {
 223     TestStruct *p = NULL;
 224     Error *err = NULL;
 225     Visitor *v;
 226
 227     v = validate_test_init(data, "{ 'integer': -42, 'boolean': true, 'string': 'foo', 'extra': 42 }");
 228
 229     visit_type_TestStruct(v, &p, NULL, &err);
 230     g_assert(err);
 231     if (p) {
 232         g_free(p->string);
 233     }
 234     g_free(p);
 235 }
 236
 237 static void test_validate_fail_struct_nested(TestInputVisitorData *data,
 238                                               const void *unused)
 239 {
 240     UserDefTwo *udp = NULL;
 241     Error *err = NULL;
 242     Visitor *v;
 243
 244     v = validate_test_init(data, "{ 'string0': 'string0', 'dict1': { 'string1': 'string1', 'dict2': { 'userdef1': { 'integer': 42, 'string': 'string', 'extra': [42, 23, {'foo':'bar'}] }, 'string2': 'string2'}}}");
 245
 246     visit_type_UserDefTwo(v, &udp, NULL, &err);
 247     g_assert(err);
 248     qapi_free_UserDefTwo(udp);
 249 }
 250
 251 static void test_validate_fail_list(TestInputVisitorData *data,
 252                                      const void *unused)
 253 {
 254     UserDefOneList *head = NULL;
 255     Error *err = NULL;
 256     Visitor *v;
 257
 258     v = validate_test_init(data, "[ { 'string': 'string0', 'integer': 42 }, { 'string': 'string1', 'integer': 43 }, { 'string': 'string2', 'integer': 44, 'extra': 'ggg' } ]");
 259
 260     visit_type_UserDefOneList(v, &head, NULL, &err);
 261     g_assert(err);
 262     qapi_free_UserDefOneList(head);
 263 }
 264
 265 static void test_validate_fail_union_native_list(TestInputVisitorData *data,
 266                                                  const void *unused)
 267 {
 268     UserDefNativeListUnion *tmp = NULL;
 269     Error *err = NULL;
 270     Visitor *v;
 271
 272     v = validate_test_init(data,
 273                            "{ 'type': 'integer', 'data' : [ 'string' ] }");
 274
 275     visit_type_UserDefNativeListUnion(v, &tmp, NULL, &err);
 276     g_assert(err);
 277     qapi_free_UserDefNativeListUnion(tmp);
 278 }
 279
 280 static void test_validate_fail_union_flat(TestInputVisitorData *data,
 281                                           const void *unused)
 282 {
 283     UserDefFlatUnion *tmp = NULL;
 284     Error *err = NULL;
 285     Visitor *v;
 286
 287     v = validate_test_init(data, "{ 'string': 'c', 'integer': 41, 'boolean': true }");
 288
 289     visit_type_UserDefFlatUnion(v, &tmp, NULL, &err);
 290     g_assert(err);
 291     qapi_free_UserDefFlatUnion(tmp);
 292 }
 293
 294 static void test_validate_fail_union_flat_no_discrim(TestInputVisitorData *data,
 295                                                      const void *unused)
 296 {
 297     UserDefFlatUnion2 *tmp = NULL;
 298     Error *err = NULL;
 299     Visitor *v;
 300
 301     /* test situation where discriminator field ('enum1' here) is missing */
 302     v = validate_test_init(data, "{ 'integer': 42, 'string': 'c', 'string1': 'd', 'string2': 'e' }");
 303
 304     visit_type_UserDefFlatUnion2(v, &tmp, NULL, &err);
 305     g_assert(err);
 306     qapi_free_UserDefFlatUnion2(tmp);
 307 }
 308
 309 static void test_validate_fail_alternate(TestInputVisitorData *data,
 310                                          const void *unused)
 311 {
 312     UserDefAlternate *tmp = NULL;
 313     Visitor *v;
 314     Error *err = NULL;
 315
 316     v = validate_test_init(data, "3.14");
 317
 318     visit_type_UserDefAlternate(v, &tmp, NULL, &err);
 319     g_assert(err);
 320     qapi_free_UserDefAlternate(tmp);
 321 }
 322
 323 static void do_test_validate_qmp_introspect(TestInputVisitorData *data,
 324                                             const char *schema_json)
 325 {
 326     SchemaInfoList *schema = NULL;
 327     Error *err = NULL;
 328     Visitor *v;
 329
 330     v = validate_test_init_raw(data, schema_json);
 331
 332     visit_type_SchemaInfoList(v, &schema, NULL, &err);
 333     if (err) {
 334         fprintf(stderr, "%s", error_get_pretty(err));
 335     }
 336     g_assert(!err);
 337     g_assert(schema);
 338
 339     qapi_free_SchemaInfoList(schema);
 340 }
 341
 342 static void test_validate_qmp_introspect(TestInputVisitorData *data,
 343                                            const void *unused)
 344 {
 345     do_test_validate_qmp_introspect(data, test_qmp_schema_json);
 346     do_test_validate_qmp_introspect(data, qmp_schema_json);
 347 }
 348
 349 static void validate_test_add(const char *testpath,
 350                                TestInputVisitorData *data,
 351                                void (*test_func)(TestInputVisitorData *data, const void *user_data))
 352 {
 353     g_test_add(testpath, TestInputVisitorData, data, NULL, test_func,
 354                validate_teardown);
 355 }
 356
 357 int main(int argc, char **argv)
 358 {
 359     TestInputVisitorData testdata;
 360
 361     g_test_init(&argc, &argv, NULL);
 362
 363     validate_test_add("/visitor/input-strict/pass/struct",
 364                       &testdata, test_validate_struct);
 365     validate_test_add("/visitor/input-strict/pass/struct-nested",
 366                       &testdata, test_validate_struct_nested);
 367     validate_test_add("/visitor/input-strict/pass/list",
 368                       &testdata, test_validate_list);
 369     validate_test_add("/visitor/input-strict/pass/union-flat",
 370                       &testdata, test_validate_union_flat);
 371     validate_test_add("/visitor/input-strict/pass/alternate",
 372                       &testdata, test_validate_alternate);
 373     validate_test_add("/visitor/input-strict/pass/union-native-list",
 374                       &testdata, test_validate_union_native_list);
 375     validate_test_add("/visitor/input-strict/fail/struct",
 376                       &testdata, test_validate_fail_struct);
 377     validate_test_add("/visitor/input-strict/fail/struct-nested",
 378                       &testdata, test_validate_fail_struct_nested);
 379     validate_test_add("/visitor/input-strict/fail/list",
 380                       &testdata, test_validate_fail_list);
 381     validate_test_add("/visitor/input-strict/fail/union-flat",
 382                       &testdata, test_validate_fail_union_flat);
 383     validate_test_add("/visitor/input-strict/fail/union-flat-no-discriminator",
 384                       &testdata, test_validate_fail_union_flat_no_discrim);
 385     validate_test_add("/visitor/input-strict/fail/alternate",
 386                       &testdata, test_validate_fail_alternate);
 387     validate_test_add("/visitor/input-strict/fail/union-native-list",
 388                       &testdata, test_validate_fail_union_native_list);
 389     validate_test_add("/visitor/input-strict/pass/qmp-introspect",
 390                       &testdata, test_validate_qmp_introspect);
 391
 392     g_test_run();
 393
 394     return 0;
 395 }