xref: /qemu/tests/qapi-schema/test-qapi.py (revision ab9056ff) 
1#!/usr/bin/env python
2#
3# QAPI parser test harness
4#
5# Copyright (c) 2013 Red Hat Inc.
6#
7# Authors:
8#  Markus Armbruster <armbru@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
14from __future__ import print_function
15
16import argparse
17import difflib
18import os
19import sys
20
21from qapi.error import QAPIError
22from qapi.schema import QAPISchema, QAPISchemaVisitor
23
24if sys.version_info[0] < 3:
25    from cStringIO import StringIO
26else:
27    from io import StringIO
28
29
30class QAPISchemaTestVisitor(QAPISchemaVisitor):
31
32    def visit_module(self, name):
33        print('module %s' % name)
34
35    def visit_include(self, name, info):
36        print('include %s' % name)
37
38    def visit_enum_type(self, name, info, ifcond, members, prefix):
39        print('enum %s' % name)
40        if prefix:
41            print('    prefix %s' % prefix)
42        for m in members:
43            print('    member %s' % m.name)
44            self._print_if(m.ifcond, indent=8)
45        self._print_if(ifcond)
46
47    def visit_array_type(self, name, info, ifcond, element_type):
48        if not info:
49            return              # suppress built-in arrays
50        print('array %s %s' % (name, element_type.name))
51        self._print_if(ifcond)
52
53    def visit_object_type(self, name, info, ifcond, base, members, variants,
54                          features):
55        print('object %s' % name)
56        if base:
57            print('    base %s' % base.name)
58        for m in members:
59            print('    member %s: %s optional=%s'
60                  % (m.name, m.type.name, m.optional))
61            self._print_if(m.ifcond, 8)
62        self._print_variants(variants)
63        self._print_if(ifcond)
64        self._print_features(features)
65
66    def visit_alternate_type(self, name, info, ifcond, variants):
67        print('alternate %s' % name)
68        self._print_variants(variants)
69        self._print_if(ifcond)
70
71    def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
72                      success_response, boxed, allow_oob, allow_preconfig,
73                      features):
74        print('command %s %s -> %s'
75              % (name, arg_type and arg_type.name,
76                 ret_type and ret_type.name))
77        print('    gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
78              % (gen, success_response, boxed, allow_oob, allow_preconfig))
79        self._print_if(ifcond)
80        self._print_features(features)
81
82    def visit_event(self, name, info, ifcond, arg_type, boxed):
83        print('event %s %s' % (name, arg_type and arg_type.name))
84        print('    boxed=%s' % boxed)
85        self._print_if(ifcond)
86
87    @staticmethod
88    def _print_variants(variants):
89        if variants:
90            print('    tag %s' % variants.tag_member.name)
91            for v in variants.variants:
92                print('    case %s: %s' % (v.name, v.type.name))
93                QAPISchemaTestVisitor._print_if(v.ifcond, indent=8)
94
95    @staticmethod
96    def _print_if(ifcond, indent=4):
97        if ifcond:
98            print('%sif %s' % (' ' * indent, ifcond))
99
100    @classmethod
101    def _print_features(cls, features):
102        if features:
103            for f in features:
104                print('    feature %s' % f.name)
105                cls._print_if(f.ifcond, 8)
106
107
108def test_frontend(fname):
109    schema = QAPISchema(fname)
110    schema.visit(QAPISchemaTestVisitor())
111
112    for doc in schema.docs:
113        if doc.symbol:
114            print('doc symbol=%s' % doc.symbol)
115        else:
116            print('doc freeform')
117        print('    body=\n%s' % doc.body.text)
118        for arg, section in doc.args.items():
119            print('    arg=%s\n%s' % (arg, section.text))
120        for section in doc.sections:
121            print('    section=%s\n%s' % (section.name, section.text))
122
123
124def test_and_diff(test_name, dir_name, update):
125    sys.stdout = StringIO()
126    try:
127        test_frontend(os.path.join(dir_name, test_name + '.json'))
128    except QAPIError as err:
129        if err.info.fname is None:
130            print("%s" % err, file=sys.stderr)
131            return 2
132        errstr = str(err) + '\n'
133        if dir_name:
134            errstr = errstr.replace(dir_name + '/', '')
135        actual_err = errstr.splitlines(True)
136    else:
137        actual_err = []
138    finally:
139        actual_out = sys.stdout.getvalue().splitlines(True)
140        sys.stdout.close()
141        sys.stdout = sys.__stdout__
142
143    mode = 'r+' if update else 'r'
144    try:
145        outfp = open(os.path.join(dir_name, test_name + '.out'), mode)
146        errfp = open(os.path.join(dir_name, test_name + '.err'), mode)
147        expected_out = outfp.readlines()
148        expected_err = errfp.readlines()
149    except IOError as err:
150        print("%s: can't open '%s': %s"
151              % (sys.argv[0], err.filename, err.strerror),
152              file=sys.stderr)
153        return 2
154
155    if actual_out == expected_out and actual_err == expected_err:
156        return 0
157
158    print("%s %s" % (test_name, 'UPDATE' if update else 'FAIL'),
159          file=sys.stderr)
160    out_diff = difflib.unified_diff(expected_out, actual_out, outfp.name)
161    err_diff = difflib.unified_diff(expected_err, actual_err, errfp.name)
162    sys.stdout.writelines(out_diff)
163    sys.stdout.writelines(err_diff)
164
165    if not update:
166        return 1
167
168    try:
169        outfp.truncate(0)
170        outfp.seek(0)
171        outfp.writelines(actual_out)
172        errfp.truncate(0)
173        errfp.seek(0)
174        errfp.writelines(actual_err)
175    except IOError as err:
176        print("%s: can't write '%s': %s"
177              % (sys.argv[0], err.filename, err.strerror),
178              file=sys.stderr)
179        return 2
180
181    return 0
182
183
184def main(argv):
185    parser = argparse.ArgumentParser(
186        description='QAPI schema tester')
187    parser.add_argument('-d', '--dir', action='store', default='',
188                        help="directory containing tests")
189    parser.add_argument('-u', '--update', action='store_true',
190                        help="update expected test results")
191    parser.add_argument('tests', nargs='*', metavar='TEST', action='store')
192    args = parser.parse_args()
193
194    status = 0
195    for t in args.tests:
196        (dir_name, base_name) = os.path.split(t)
197        dir_name = dir_name or args.dir
198        test_name = os.path.splitext(base_name)[0]
199        status |= test_and_diff(test_name, dir_name, args.update)
200
201    exit(status)
202
203
204if __name__ == '__main__':
205    main(sys.argv)
206    exit(0)
207