tests/qapi-schema/qapi-schema-test.json

   1 # *-*- Mode: Python -*-*
   2
   3 # This file is a stress test of supported qapi constructs that must
   4 # parse and compile correctly.
   5
   6 # Whitelists to permit QAPI rule violations
   7 { 'pragma': {
   8     # Commands allowed to return a non-dictionary:
   9     'returns-whitelist': [
  10         'guest-get-time',
  11         'guest-sync' ] } }
  12
  13 { 'struct': 'TestStruct',
  14   'data': { 'integer': {'type': 'int'}, 'boolean': 'bool', 'string': 'str' } }
  15
  16 # for testing enums
  17 { 'struct': 'NestedEnumsOne',
  18   'data': { 'enum1': 'EnumOne',   # Intentional forward reference
  19             '*enum2': 'EnumOne', 'enum3': 'EnumOne', '*enum4': 'EnumOne' } }
  20
  21 # An empty enum, although unusual, is currently acceptable
  22 { 'enum': 'MyEnum', 'data': [ ] }
  23
  24 # Likewise for an empty struct, including an empty base
  25 { 'struct': 'Empty1', 'data': { } }
  26 { 'struct': 'Empty2', 'base': 'Empty1', 'data': { } }
  27
  28 { 'command': 'user_def_cmd0', 'data': 'Empty2', 'returns': 'Empty2' }
  29
  30 # for testing override of default naming heuristic
  31 { 'enum': 'QEnumTwo',
  32   'prefix': 'QENUM_TWO',
  33   'data': [ 'value1', 'value2' ] }
  34
  35 # for testing nested structs
  36 { 'struct': 'UserDefOne',
  37   'base': 'UserDefZero',        # intentional forward reference
  38   'data': { 'string': 'str',
  39             '*enum1': 'EnumOne' } }   # intentional forward reference
  40
  41 { 'enum': 'EnumOne',
  42   'data': [ 'value1', 'value2', 'value3', 'value4' ] }
  43
  44 { 'struct': 'UserDefZero',
  45   'data': { 'integer': 'int' } }
  46
  47 { 'struct': 'UserDefTwoDictDict',
  48   'data': { 'userdef': 'UserDefOne', 'string': 'str' } }
  49
  50 { 'struct': 'UserDefTwoDict',
  51   'data': { 'string1': 'str',
  52             'dict2': 'UserDefTwoDictDict',
  53             '*dict3': 'UserDefTwoDictDict' } }
  54
  55 { 'struct': 'UserDefTwo',
  56   'data': { 'string0': 'str',
  57             'dict1': 'UserDefTwoDict' } }
  58
  59 { 'struct': 'UserDefThree',
  60   'data': { 'string0': 'str' } }
  61
  62 # dummy struct to force generation of array types not otherwise mentioned
  63 { 'struct': 'ForceArrays',
  64   'data': { 'unused1':['UserDefOne'], 'unused2':['UserDefTwo'],
  65             'unused3':['TestStruct'] } }
  66
  67 # for testing unions
  68 # Among other things, test that a name collision between branches does
  69 # not cause any problems (since only one branch can be in use at a time),
  70 # by intentionally using two branches that both have a C member 'a_b'
  71 { 'struct': 'UserDefA',
  72   'data': { 'boolean': 'bool', '*a_b': 'int' } }
  73
  74 { 'struct': 'UserDefB',
  75   'data': { 'intb': 'int', '*a-b': 'bool' } }
  76
  77 { 'union': 'UserDefFlatUnion',
  78   'base': 'UserDefUnionBase',   # intentional forward reference
  79   'discriminator': 'enum1',
  80   'data': { 'value1' : {'type': 'UserDefA'},
  81             'value2' : 'UserDefB',
  82             'value3' : 'UserDefB'
  83             # 'value4' defaults to empty
  84   } }
  85
  86 { 'struct': 'UserDefUnionBase',
  87   'base': 'UserDefZero',
  88   'data': { 'string': 'str', 'enum1': 'EnumOne' } }
  89
  90 # this variant of UserDefFlatUnion defaults to a union that uses members with
  91 # allocated types to test corner cases in the cleanup/dealloc visitor
  92 { 'union': 'UserDefFlatUnion2',
  93   'base': { '*integer': 'int', 'string': 'str', 'enum1': 'QEnumTwo' },
  94   'discriminator': 'enum1',
  95   'data': { 'value1' : 'UserDefC', # intentional forward reference
  96             'value2' : 'UserDefB' } }
  97
  98 { 'struct': 'WrapAlternate',
  99   'data': { 'alt': 'UserDefAlternate' } }
 100 { 'alternate': 'UserDefAlternate',
 101   'data': { 'udfu': {'type': 'UserDefFlatUnion'}, 'e': 'EnumOne', 'i': 'int',
 102             'n': 'null' } }
 103
 104 { 'struct': 'UserDefC',
 105   'data': { 'string1': 'str', 'string2': 'str' } }
 106
 107 # for testing use of 'number' within alternates
 108 { 'alternate': 'AltEnumBool', 'data': { 'e': 'EnumOne', 'b': 'bool' } }
 109 { 'alternate': 'AltEnumNum', 'data': { 'e': 'EnumOne', 'n': 'number' } }
 110 { 'alternate': 'AltNumEnum', 'data': { 'n': 'number', 'e': 'EnumOne' } }
 111 { 'alternate': 'AltEnumInt', 'data': { 'e': 'EnumOne', 'i': 'int' } }
 112
 113 # for testing use of 'str' within alternates
 114 { 'alternate': 'AltStrObj', 'data': { 's': 'str', 'o': 'TestStruct' } }
 115
 116 # for testing lists
 117 { 'union': 'UserDefListUnion',
 118   'data': { 'integer': ['int'],
 119             's8': ['int8'],
 120             's16': ['int16'],
 121             's32': ['int32'],
 122             's64': ['int64'],
 123             'u8': ['uint8'],
 124             'u16': ['uint16'],
 125             'u32': ['uint32'],
 126             'u64': ['uint64'],
 127             'number': ['number'],
 128             'boolean': ['bool'],
 129             'string': ['str'],
 130             'sizes': ['size'],
 131             'any': ['any'],
 132             'user': ['Status'] } } # intentional forward ref. to sub-module
 133
 134 # for testing sub-modules
 135 { 'include': 'include/sub-module.json' }
 136
 137 # testing commands
 138 { 'command': 'user_def_cmd', 'data': {} }
 139 { 'command': 'user_def_cmd1', 'data': {'ud1a': 'UserDefOne'} }
 140 { 'command': 'user_def_cmd2',
 141   'data': {'ud1a': {'type': 'UserDefOne'}, '*ud1b': 'UserDefOne'},
 142   'returns': 'UserDefTwo' }
 143
 144 { 'command': 'cmd-success-response', 'data': {}, 'success-response': false }
 145
 146 # Returning a non-dictionary requires a name from the whitelist
 147 { 'command': 'guest-get-time', 'data': {'a': 'int', '*b': 'int' },
 148   'returns': 'int' }
 149 { 'command': 'guest-sync', 'data': { 'arg': 'any' }, 'returns': 'any' }
 150 { 'command': 'boxed-struct', 'boxed': true, 'data': 'UserDefZero' }
 151 { 'command': 'boxed-union', 'data': 'UserDefListUnion', 'boxed': true }
 152
 153 # Smoke test on out-of-band and allow-preconfig-test
 154 { 'command': 'test-flags-command', 'allow-oob': true, 'allow-preconfig': true }
 155
 156 # For testing integer range flattening in opts-visitor. The following schema
 157 # corresponds to the option format:
 158 #
 159 # -userdef i64=3-6,i64=-5--1,u64=2,u16=1,u16=7-12
 160 #
 161 # For simplicity, this example doesn't use [type=]discriminator nor optargs
 162 # specific to discriminator values.
 163 { 'struct': 'UserDefOptions',
 164   'data': {
 165     '*i64' : [ 'int'    ],
 166     '*u64' : [ 'uint64' ],
 167     '*u16' : [ 'uint16' ],
 168     '*i64x':   'int'     ,
 169     '*u64x':   'uint64'  } }
 170
 171 # testing event
 172 { 'struct': 'EventStructOne',
 173   'data': { 'struct1': {'type': 'UserDefOne'}, 'string': 'str', '*enum2': 'EnumOne' } }
 174
 175 { 'event': 'EVENT_A' }
 176 { 'event': 'EVENT_B',
 177   'data': { } }
 178 { 'event': 'EVENT_C',
 179   'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } }
 180 { 'event': 'EVENT_D',
 181   'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } }
 182 { 'event': 'EVENT_E', 'boxed': true, 'data': 'UserDefZero' }
 183 { 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefAlternate' }
 184
 185 # test that we correctly compile downstream extensions, as well as munge
 186 # ticklish names
 187 { 'enum': '__org.qemu_x-Enum', 'data': [ '__org.qemu_x-value' ] }
 188 { 'struct': '__org.qemu_x-Base',
 189   'data': { '__org.qemu_x-member1': '__org.qemu_x-Enum' } }
 190 { 'struct': '__org.qemu_x-Struct', 'base': '__org.qemu_x-Base',
 191   'data': { '__org.qemu_x-member2': 'str', '*wchar-t': 'int' } }
 192 { 'union': '__org.qemu_x-Union1', 'data': { '__org.qemu_x-branch': 'str' } }
 193 { 'struct': '__org.qemu_x-Struct2',
 194   'data': { 'array': ['__org.qemu_x-Union1'] } }
 195 { 'union': '__org.qemu_x-Union2', 'base': '__org.qemu_x-Base',
 196   'discriminator': '__org.qemu_x-member1',
 197   'data': { '__org.qemu_x-value': '__org.qemu_x-Struct2' } }
 198 { 'alternate': '__org.qemu_x-Alt',
 199   'data': { '__org.qemu_x-branch': 'str', 'b': '__org.qemu_x-Base' } }
 200 { 'event': '__ORG.QEMU_X-EVENT', 'data': '__org.qemu_x-Struct' }
 201 { 'command': '__org.qemu_x-command',
 202   'data': { 'a': ['__org.qemu_x-Enum'], 'b': ['__org.qemu_x-Struct'],
 203             'c': '__org.qemu_x-Union2', 'd': '__org.qemu_x-Alt' },
 204   'returns': '__org.qemu_x-Union1' }
 205
 206 # test 'if' condition handling
 207
 208 { 'struct': 'TestIfStruct', 'data':
 209   { 'foo': 'int',
 210     'bar': { 'type': 'int', 'if': 'defined(TEST_IF_STRUCT_BAR)'} },
 211   'if': 'defined(TEST_IF_STRUCT)' }
 212
 213 { 'enum': 'TestIfEnum', 'data':
 214   [ 'foo', { 'name' : 'bar', 'if': 'defined(TEST_IF_ENUM_BAR)' } ],
 215   'if': 'defined(TEST_IF_ENUM)' }
 216
 217 { 'union': 'TestIfUnion', 'data':
 218   { 'foo': 'TestStruct',
 219     'union_bar': { 'type': 'str', 'if': 'defined(TEST_IF_UNION_BAR)'} },
 220   'if': 'defined(TEST_IF_UNION) && defined(TEST_IF_STRUCT)' }
 221
 222 { 'command': 'TestIfUnionCmd', 'data': { 'union_cmd_arg': 'TestIfUnion' },
 223   'if': 'defined(TEST_IF_UNION)' }
 224
 225 { 'alternate': 'TestIfAlternate', 'data':
 226   { 'foo': 'int',
 227     'bar': { 'type': 'TestStruct', 'if': 'defined(TEST_IF_ALT_BAR)'} },
 228   'if': 'defined(TEST_IF_ALT) && defined(TEST_IF_STRUCT)' }
 229
 230 { 'command': 'TestIfAlternateCmd', 'data': { 'alt_cmd_arg': 'TestIfAlternate' },
 231   'if': 'defined(TEST_IF_ALT)' }
 232
 233 { 'command': 'TestIfCmd', 'data':
 234   { 'foo': 'TestIfStruct',
 235     'bar': { 'type': 'TestIfEnum', 'if': 'defined(TEST_IF_CMD_BAR)' } },
 236   'returns': 'UserDefThree',
 237   'if': ['defined(TEST_IF_CMD)', 'defined(TEST_IF_STRUCT)'] }
 238
 239 { 'command': 'TestCmdReturnDefThree', 'returns': 'UserDefThree' }
 240
 241 { 'event': 'TestIfEvent', 'data':
 242   { 'foo': 'TestIfStruct',
 243     'bar': { 'type': ['TestIfEnum'], 'if': 'defined(TEST_IF_EVT_BAR)' } },
 244   'if': 'defined(TEST_IF_EVT) && defined(TEST_IF_STRUCT)' }
 245
 246 # test 'features' for structs
 247
 248 { 'struct': 'FeatureStruct0',
 249   'data': { 'foo': 'int' },
 250   'features': [] }
 251 { 'struct': 'FeatureStruct1',
 252   'data': { 'foo': 'int' },
 253   'features': [ 'feature1' ] }
 254 { 'struct': 'FeatureStruct2',
 255   'data': { 'foo': 'int' },
 256   'features': [ { 'name': 'feature1' } ] }
 257 { 'struct': 'FeatureStruct3',
 258   'data': { 'foo': 'int' },
 259   'features': [ 'feature1', 'feature2' ] }
 260 { 'struct': 'FeatureStruct4',
 261   'data': { 'namespace-test': 'int' },
 262   'features': [ 'namespace-test', 'int', 'name', 'if' ] }
 263
 264 { 'struct': 'CondFeatureStruct1',
 265   'data': { 'foo': 'int' },
 266   'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'} ] }
 267 { 'struct': 'CondFeatureStruct2',
 268   'data': { 'foo': 'int' },
 269   'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'},
 270                 { 'name': 'feature2', 'if': 'defined(TEST_IF_FEATURE_2)'} ] }
 271 { 'struct': 'CondFeatureStruct3',
 272   'data': { 'foo': 'int' },
 273   'features': [ { 'name': 'feature1', 'if': [ 'defined(TEST_IF_COND_1)',
 274                                               'defined(TEST_IF_COND_2)'] } ] }
 275 { 'command': 'test-features',
 276   'data': { 'fs0': 'FeatureStruct0',
 277             'fs1': 'FeatureStruct1',
 278             'fs2': 'FeatureStruct2',
 279             'fs3': 'FeatureStruct3',
 280             'fs4': 'FeatureStruct4',
 281             'cfs1': 'CondFeatureStruct1',
 282             'cfs2': 'CondFeatureStruct2',
 283             'cfs3': 'CondFeatureStruct3' } }