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