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

   1 # *-*- Mode: Python -*-*
   2
   3 # for testing enums
   4 { 'enum': 'EnumOne',
   5   'data': [ 'value1', 'value2', 'value3' ] }
   6 { 'struct': 'NestedEnumsOne',
   7   'data': { 'enum1': 'EnumOne', '*enum2': 'EnumOne', 'enum3': 'EnumOne', '*enum4': 'EnumOne' } }
   8
   9 # for testing override of default naming heuristic
  10 { 'enum': 'QEnumTwo',
  11   'prefix': 'QENUM_TWO',
  12   'data': [ 'value1', 'value2' ] }
  13
  14 # for testing nested structs
  15 { 'struct': 'UserDefOne',
  16   'base': 'UserDefZero',        # intentional forward reference
  17   'data': { 'string': 'str', '*enum1': 'EnumOne' } }
  18
  19 { 'struct': 'UserDefZero',
  20   'data': { 'integer': 'int' } }
  21
  22 { 'struct': 'UserDefTwoDictDict',
  23   'data': { 'userdef': 'UserDefOne', 'string': 'str' } }
  24
  25 { 'struct': 'UserDefTwoDict',
  26   'data': { 'string1': 'str',
  27             'dict2': 'UserDefTwoDictDict',
  28             '*dict3': 'UserDefTwoDictDict' } }
  29
  30 { 'struct': 'UserDefTwo',
  31   'data': { 'string0': 'str',
  32             'dict1': 'UserDefTwoDict' } }
  33
  34 # for testing unions
  35 # Among other things, test that a name collision between branches does
  36 # not cause any problems (since only one branch can be in use at a time),
  37 # by intentionally using two branches that both have a C member 'a_b'
  38 { 'struct': 'UserDefA',
  39   'data': { 'boolean': 'bool', '*a_b': 'int' } }
  40
  41 { 'struct': 'UserDefB',
  42   'data': { 'intb': 'int', '*a-b': 'bool' } }
  43
  44 { 'union': 'UserDefFlatUnion',
  45   'base': 'UserDefUnionBase',   # intentional forward reference
  46   'discriminator': 'enum1',
  47   'data': { 'value1' : 'UserDefA',
  48             'value2' : 'UserDefB',
  49             'value3' : 'UserDefB' } }
  50
  51 { 'struct': 'UserDefUnionBase',
  52   'base': 'UserDefZero',
  53   'data': { 'string': 'str', 'enum1': 'EnumOne' } }
  54
  55 # this variant of UserDefFlatUnion defaults to a union that uses fields with
  56 # allocated types to test corner cases in the cleanup/dealloc visitor
  57 { 'union': 'UserDefFlatUnion2',
  58   'base': 'UserDefUnionBase',
  59   'discriminator': 'enum1',
  60   'data': { 'value1' : 'UserDefC', # intentional forward reference
  61             'value2' : 'UserDefB',
  62             'value3' : 'UserDefA' } }
  63
  64 { 'alternate': 'UserDefAlternate',
  65   'data': { 'uda': 'UserDefA', 's': 'str', 'i': 'int' } }
  66
  67 { 'struct': 'UserDefC',
  68   'data': { 'string1': 'str', 'string2': 'str' } }
  69
  70 # for testing native lists
  71 { 'union': 'UserDefNativeListUnion',
  72   'data': { 'integer': ['int'],
  73             's8': ['int8'],
  74             's16': ['int16'],
  75             's32': ['int32'],
  76             's64': ['int64'],
  77             'u8': ['uint8'],
  78             'u16': ['uint16'],
  79             'u32': ['uint32'],
  80             'u64': ['uint64'],
  81             'number': ['number'],
  82             'boolean': ['bool'],
  83             'string': ['str'],
  84             'sizes': ['size'],
  85             'any': ['any'] } }
  86
  87 # testing commands
  88 { 'command': 'user_def_cmd', 'data': {} }
  89 { 'command': 'user_def_cmd1', 'data': {'ud1a': 'UserDefOne'} }
  90 { 'command': 'user_def_cmd2',
  91   'data': {'ud1a': 'UserDefOne', '*ud1b': 'UserDefOne'},
  92   'returns': 'UserDefTwo' }
  93 { 'command': 'user_def_cmd3', 'data': {'a': 'int', '*b': 'int' },
  94   'returns': 'int' }
  95 # note: command name 'guest-sync' chosen to avoid "cannot use built-in" error
  96 { 'command': 'guest-sync', 'data': { 'arg': 'any' }, 'returns': 'any' }
  97
  98 # For testing integer range flattening in opts-visitor. The following schema
  99 # corresponds to the option format:
 100 #
 101 # -userdef i64=3-6,i64=-5--1,u64=2,u16=1,u16=7-12
 102 #
 103 # For simplicity, this example doesn't use [type=]discriminator nor optargs
 104 # specific to discriminator values.
 105 { 'struct': 'UserDefOptions',
 106   'data': {
 107     '*i64' : [ 'int'    ],
 108     '*u64' : [ 'uint64' ],
 109     '*u16' : [ 'uint16' ],
 110     '*i64x':   'int'     ,
 111     '*u64x':   'uint64'  } }
 112
 113 # testing event
 114 { 'struct': 'EventStructOne',
 115   'data': { 'struct1': 'UserDefOne', 'string': 'str', '*enum2': 'EnumOne' } }
 116
 117 { 'event': 'EVENT_A' }
 118 { 'event': 'EVENT_B',
 119   'data': { } }
 120 { 'event': 'EVENT_C',
 121   'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } }
 122 { 'event': 'EVENT_D',
 123   'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } }
 124
 125 # test that we correctly compile downstream extensions
 126 { 'enum': '__org.qemu_x-Enum', 'data': [ '__org.qemu_x-value' ] }
 127 { 'struct': '__org.qemu_x-Base',
 128   'data': { '__org.qemu_x-member1': '__org.qemu_x-Enum' } }
 129 { 'struct': '__org.qemu_x-Struct', 'base': '__org.qemu_x-Base',
 130   'data': { '__org.qemu_x-member2': 'str' } }
 131 { 'union': '__org.qemu_x-Union1', 'data': { '__org.qemu_x-branch': 'str' } }
 132 { 'struct': '__org.qemu_x-Struct2',
 133   'data': { 'array': ['__org.qemu_x-Union1'] } }
 134 { 'union': '__org.qemu_x-Union2', 'base': '__org.qemu_x-Base',
 135   'discriminator': '__org.qemu_x-member1',
 136   'data': { '__org.qemu_x-value': '__org.qemu_x-Struct2' } }
 137 { 'alternate': '__org.qemu_x-Alt',
 138   'data': { '__org.qemu_x-branch': 'str', 'b': '__org.qemu_x-Base' } }
 139 { 'event': '__ORG.QEMU_X-EVENT', 'data': '__org.qemu_x-Struct' }
 140 { 'command': '__org.qemu_x-command',
 141   'data': { 'a': ['__org.qemu_x-Enum'], 'b': ['__org.qemu_x-Struct'],
 142             'c': '__org.qemu_x-Union2', 'd': '__org.qemu_x-Alt' },
 143   'returns': '__org.qemu_x-Union1' }