xref: /openbmc/qemu/tests/qapi-schema/meson.build (revision e1f684ea)
1test_env = environment()
2test_env.set('PYTHONPATH', meson.project_source_root() / 'scripts')
3test_env.set('PYTHONIOENCODING', 'utf-8')
4
5schemas = [
6  'alternate-any.json',
7  'alternate-array.json',
8  'alternate-base.json',
9  'alternate-branch-if-invalid.json',
10  'alternate-clash.json',
11  'alternate-conflict-dict.json',
12  'alternate-conflict-enum-bool.json',
13  'alternate-conflict-enum-int.json',
14  'alternate-conflict-lists.json',
15  'alternate-conflict-string.json',
16  'alternate-conflict-bool-string.json',
17  'alternate-conflict-num-string.json',
18  'alternate-data-invalid.json',
19  'alternate-empty.json',
20  'alternate-invalid-dict.json',
21  'alternate-nested.json',
22  'alternate-unknown.json',
23  'args-alternate.json',
24  'args-any.json',
25  'args-array-empty.json',
26  'args-array-unknown.json',
27  'args-bad-boxed.json',
28  'args-boxed-anon.json',
29  'args-boxed-string.json',
30  'args-if-implicit.json',
31  'args-if-unboxed.json',
32  'args-int.json',
33  'args-invalid.json',
34  'args-member-array-bad.json',
35  'args-member-case.json',
36  'args-member-unknown.json',
37  'args-union.json',
38  'args-unknown.json',
39  'bad-base.json',
40  'bad-data.json',
41  'bad-ident.json',
42  'bad-if.json',
43  'bad-if-all.json',
44  'bad-if-empty.json',
45  'bad-if-empty-list.json',
46  'bad-if-key.json',
47  'bad-if-keys.json',
48  'bad-if-list.json',
49  'bad-if-not.json',
50  'bad-type-bool.json',
51  'bad-type-dict.json',
52  'bad-type-int.json',
53  'base-cycle-direct.json',
54  'base-cycle-indirect.json',
55  'command-int.json',
56  'comments.json',
57  'doc-bad-alternate-member.json',
58  'doc-bad-boxed-command-arg.json',
59  'doc-bad-command-arg.json',
60  'doc-bad-enum-member.json',
61  'doc-bad-event-arg.json',
62  'doc-bad-feature.json',
63  'doc-bad-indent.json',
64  'doc-bad-section.json',
65  'doc-bad-symbol.json',
66  'doc-bad-union-member.json',
67  'doc-before-include.json',
68  'doc-before-pragma.json',
69  'doc-duplicate-features.json',
70  'doc-duplicated-arg.json',
71  'doc-duplicated-return.json',
72  'doc-duplicated-since.json',
73  'doc-empty-arg.json',
74  'doc-empty-features.json',
75  'doc-empty-section.json',
76  'doc-empty-symbol.json',
77  'doc-good.json',
78  'doc-interleaved-section.json',
79  'doc-invalid-end.json',
80  'doc-invalid-end2.json',
81  'doc-invalid-return.json',
82  'doc-invalid-return2.json',
83  'doc-invalid-section.json',
84  'doc-invalid-start.json',
85  'doc-missing-colon.json',
86  'doc-missing-expr.json',
87  'doc-missing-space.json',
88  'doc-missing.json',
89  'doc-no-symbol.json',
90  'doc-undoc-feature.json',
91  'double-type.json',
92  'duplicate-key.json',
93  'empty.json',
94  'enum-bad-member.json',
95  'enum-bad-name.json',
96  'enum-bad-prefix.json',
97  'enum-clash-member.json',
98  'enum-dict-member-unknown.json',
99  'enum-if-invalid.json',
100  'enum-int-member.json',
101  'enum-member-case.json',
102  'enum-missing-data.json',
103  'enum-wrong-data.json',
104  'event-boxed-empty.json',
105  'event-case.json',
106  'event-member-invalid-dict.json',
107  'event-nest-struct.json',
108  'features-bad-type.json',
109  'features-deprecated-type.json',
110  'features-duplicate-name.json',
111  'features-if-invalid.json',
112  'features-missing-name.json',
113  'features-name-bad-type.json',
114  'features-no-list.json',
115  'features-unknown-key.json',
116  'funny-char.json',
117  'funny-word.json',
118  'ident-with-escape.json',
119  'include-before-err.json',
120  'include-cycle.json',
121  'include-extra-junk.json',
122  'include-nested-err.json',
123  'include-no-file.json',
124  'include-non-file.json',
125  'include-repetition.json',
126  'include-self-cycle.json',
127  'include-simple.json',
128  'indented-expr.json',
129  'leading-comma-list.json',
130  'leading-comma-object.json',
131  'missing-array-rsqb.json',
132  'missing-colon.json',
133  'missing-comma-list.json',
134  'missing-comma-object.json',
135  'missing-object-member-element.json',
136  'missing-type.json',
137  'nested-struct-data.json',
138  'nested-struct-data-invalid-dict.json',
139  'non-objects.json',
140  'oob-coroutine.json',
141  'oob-test.json',
142  'allow-preconfig-test.json',
143  'pragma-extra-junk.json',
144  'pragma-non-dict.json',
145  'pragma-unknown.json',
146  'pragma-value-not-bool.json',
147  'pragma-value-not-list-of-str.json',
148  'pragma-value-not-list.json',
149  'qapi-schema-test.json',
150  'quoted-structural-chars.json',
151  'redefined-command.json',
152  'redefined-event.json',
153  'redefined-predefined.json',
154  'redefined-type.json',
155  'reserved-command-q.json',
156  'reserved-enum-q.json',
157  'reserved-member-has.json',
158  'reserved-member-q.json',
159  'reserved-member-u.json',
160  'reserved-member-underscore.json',
161  'reserved-type-list.json',
162  'returns-alternate.json',
163  'returns-array-bad.json',
164  'returns-bad-type.json',
165  'returns-dict.json',
166  'returns-unknown.json',
167  'string-code-point-31.json',
168  'string-code-point-127.json',
169  'struct-base-clash-deep.json',
170  'struct-base-clash.json',
171  'struct-data-invalid.json',
172  'struct-data-typename.json',
173  'struct-member-if-invalid.json',
174  'struct-member-invalid-dict.json',
175  'struct-member-invalid.json',
176  'struct-member-name-clash.json',
177  'trailing-comma-list.json',
178  'trailing-comma-object.json',
179  'type-bypass-bad-gen.json',
180  'type-case.json',
181  'unclosed-list.json',
182  'unclosed-object.json',
183  'unclosed-string.json',
184  'union-array-branch.json',
185  'union-bad-base.json',
186  'union-bad-discriminator.json',
187  'union-base-any.json',
188  'union-base-empty.json',
189  'union-base-no-discriminator.json',
190  'union-base-union.json',
191  'union-branch-if-invalid.json',
192  'union-branch-invalid-dict.json',
193  'union-clash-member.json',
194  'union-discriminator-bad-name.json',
195  'union-empty.json',
196  'union-inline-invalid-dict.json',
197  'union-int-branch.json',
198  'union-invalid-base.json',
199  'union-invalid-branch-key.json',
200  'union-invalid-data.json',
201  'union-invalid-discriminator.json',
202  'union-invalid-if-discriminator.json',
203  'union-invalid-union-subfield.json',
204  'union-invalid-union-subtype.json',
205  'union-no-base.json',
206  'union-optional-discriminator.json',
207  'union-string-discriminator.json',
208  'union-unknown.json',
209  'unknown-escape.json',
210  'unknown-expr-key.json',
211]
212schemas = files(schemas)
213
214# Intentionally missing schema file test -- not passed through files():
215schemas += [meson.current_source_dir() / 'missing-schema.json']
216
217# Because people may want to use test-qapi.py from the command line, we
218# are not using the "#! /usr/bin/env python3" trick here.  See
219# docs/devel/build-system.rst
220test('QAPI schema regression tests', python,
221     args: files('test-qapi.py') + schemas,
222     env: test_env, suite: ['qapi-schema', 'qapi-frontend'])
223
224diff = find_program('diff')
225
226custom_target('QAPI doc',
227              output: ['doc-good-qapi-commands.c', 'doc-good-qapi-commands.h',
228                       'doc-good-qapi-emit-events.c', 'doc-good-qapi-emit-events.h',
229                       'doc-good-qapi-events.c', 'doc-good-qapi-events.h',
230                       'doc-good-qapi-init-commands.c', 'doc-good-qapi-init-commands.h',
231                       'doc-good-qapi-introspect.c', 'doc-good-qapi-introspect.h',
232                       'doc-good-qapi-types.c', 'doc-good-qapi-types.h',
233                       'doc-good-qapi-visit.c', 'doc-good-qapi-visit.h' ],
234              input: files('doc-good.json'),
235              command: [ qapi_gen, '-o', meson.current_build_dir(),
236                         '-p', 'doc-good-', '@INPUT0@' ],
237              depend_files: qapi_gen_depends)
238
239if build_docs
240  # Test the document-comment document generation code by running a test schema
241  # file through Sphinx's plain-text builder and comparing the result against
242  # a golden reference. This is in theory susceptible to failures if Sphinx
243  # changes its output, but the text output has historically been very stable
244  # (no changes between Sphinx 1.6 and 3.0), so it is a better bet than
245  # texinfo or HTML generation, both of which have had changes. We might
246  # need to add more sophisticated logic here in future for some sort of
247  # fuzzy comparison if future Sphinx versions produce different text,
248  # but for now the simple comparison suffices.
249  qapi_doc_out = custom_target('QAPI rST doc',
250                               output: ['doc-good.txt'],
251                               input: files('doc-good.json', 'doc-good.rst'),
252                               build_by_default: true,
253                               depfile: 'docs.d',
254                               # We use -E to suppress Sphinx's caching, because
255                               # we want it to always really run the QAPI doc
256                               # generation code. It also means we don't
257                               # clutter up the build dir with the cache.
258                               command: [SPHINX_ARGS,
259                                         '-b', 'text', '-E',
260                                         '-c', meson.project_source_root() / 'docs',
261                                         '-D', 'master_doc=doc-good',
262                                         '-Ddepfile=@DEPFILE@',
263                                         '-Ddepfile_stamp=doc-good.stamp',
264                                         meson.current_source_dir(),
265                                         meson.current_build_dir()])
266
267  # Fix possible inconsistency in line endings in generated output and
268  # in the golden reference (which could otherwise cause test failures
269  # on Windows hosts). Unfortunately diff --strip-trailing-cr
270  # is GNU-diff only. The odd-looking python is because we must avoid
271  # using an explicit '\' character in the command arguments to
272  # a custom_target(), as Meson will unhelpfully replace it with a '/'
273  # (https://github.com/mesonbuild/meson/issues/1564)
274  remove_cr = [python, '-c', 'import sys;[sys.stdout.write(line.replace(chr(13), "")) for line in sys.stdin]']
275  qapi_doc_out_nocr = custom_target('QAPI rST doc newline-sanitized',
276                                    output: ['doc-good.txt.nocr'],
277                                    input: qapi_doc_out[0],
278                                    build_by_default: true,
279                                    command: [remove_cr],
280                                    capture: true,
281                                    feed: true)
282
283  qapi_doc_ref_nocr = custom_target('QAPI rST doc reference newline-sanitized',
284                                    output: ['doc-good.ref.nocr'],
285                                    input: files('doc-good.txt'),
286                                    build_by_default: true,
287                                    command: [remove_cr],
288                                    capture: true,
289                                    feed: true)
290
291  test('QAPI rST doc', diff, args: ['-u', qapi_doc_ref_nocr[0], qapi_doc_out_nocr[0]],
292       suite: ['qapi-schema', 'qapi-doc'])
293endif
294