13afe7ab0SPaolo Bonzinitest_env = environment() 2654d6b04SPaolo Bonzinitest_env.set('PYTHONPATH', meson.project_source_root() / 'scripts') 33afe7ab0SPaolo Bonzinitest_env.set('PYTHONIOENCODING', 'utf-8') 43afe7ab0SPaolo Bonzini 53afe7ab0SPaolo Bonzinischemas = [ 63afe7ab0SPaolo Bonzini 'alternate-any.json', 73afe7ab0SPaolo Bonzini 'alternate-array.json', 83afe7ab0SPaolo Bonzini 'alternate-base.json', 93afe7ab0SPaolo Bonzini 'alternate-branch-if-invalid.json', 103afe7ab0SPaolo Bonzini 'alternate-clash.json', 113afe7ab0SPaolo Bonzini 'alternate-conflict-dict.json', 123afe7ab0SPaolo Bonzini 'alternate-conflict-enum-bool.json', 133afe7ab0SPaolo Bonzini 'alternate-conflict-enum-int.json', 14b36dc5c2SPaolo Bonzini 'alternate-conflict-lists.json', 153afe7ab0SPaolo Bonzini 'alternate-conflict-string.json', 163afe7ab0SPaolo Bonzini 'alternate-conflict-bool-string.json', 173afe7ab0SPaolo Bonzini 'alternate-conflict-num-string.json', 184918bb7dSJohn Snow 'alternate-data-invalid.json', 193afe7ab0SPaolo Bonzini 'alternate-empty.json', 203afe7ab0SPaolo Bonzini 'alternate-invalid-dict.json', 213afe7ab0SPaolo Bonzini 'alternate-nested.json', 223afe7ab0SPaolo Bonzini 'alternate-unknown.json', 233afe7ab0SPaolo Bonzini 'args-alternate.json', 243afe7ab0SPaolo Bonzini 'args-any.json', 253afe7ab0SPaolo Bonzini 'args-array-empty.json', 263afe7ab0SPaolo Bonzini 'args-array-unknown.json', 273afe7ab0SPaolo Bonzini 'args-bad-boxed.json', 283afe7ab0SPaolo Bonzini 'args-boxed-anon.json', 293afe7ab0SPaolo Bonzini 'args-boxed-string.json', 30de3b3f52SMarkus Armbruster 'args-if-implicit.json', 31de3b3f52SMarkus Armbruster 'args-if-unboxed.json', 323afe7ab0SPaolo Bonzini 'args-int.json', 333afe7ab0SPaolo Bonzini 'args-invalid.json', 343afe7ab0SPaolo Bonzini 'args-member-array-bad.json', 353afe7ab0SPaolo Bonzini 'args-member-case.json', 363afe7ab0SPaolo Bonzini 'args-member-unknown.json', 373afe7ab0SPaolo Bonzini 'args-union.json', 383afe7ab0SPaolo Bonzini 'args-unknown.json', 393afe7ab0SPaolo Bonzini 'bad-base.json', 403afe7ab0SPaolo Bonzini 'bad-data.json', 413afe7ab0SPaolo Bonzini 'bad-ident.json', 423afe7ab0SPaolo Bonzini 'bad-if.json', 435d83b9a1SMarc-André Lureau 'bad-if-all.json', 443afe7ab0SPaolo Bonzini 'bad-if-empty.json', 453afe7ab0SPaolo Bonzini 'bad-if-empty-list.json', 465d83b9a1SMarc-André Lureau 'bad-if-key.json', 475d83b9a1SMarc-André Lureau 'bad-if-keys.json', 483afe7ab0SPaolo Bonzini 'bad-if-list.json', 4971f03ef9SMarkus Armbruster 'bad-if-not.json', 503afe7ab0SPaolo Bonzini 'bad-type-bool.json', 513afe7ab0SPaolo Bonzini 'bad-type-dict.json', 523afe7ab0SPaolo Bonzini 'bad-type-int.json', 533afe7ab0SPaolo Bonzini 'base-cycle-direct.json', 543afe7ab0SPaolo Bonzini 'base-cycle-indirect.json', 553afe7ab0SPaolo Bonzini 'command-int.json', 563afe7ab0SPaolo Bonzini 'comments.json', 573afe7ab0SPaolo Bonzini 'doc-bad-alternate-member.json', 583afe7ab0SPaolo Bonzini 'doc-bad-boxed-command-arg.json', 593afe7ab0SPaolo Bonzini 'doc-bad-command-arg.json', 603afe7ab0SPaolo Bonzini 'doc-bad-enum-member.json', 613afe7ab0SPaolo Bonzini 'doc-bad-event-arg.json', 623afe7ab0SPaolo Bonzini 'doc-bad-feature.json', 63a69a6d4bSPeter Maydell 'doc-bad-indent.json', 643afe7ab0SPaolo Bonzini 'doc-bad-section.json', 653afe7ab0SPaolo Bonzini 'doc-bad-symbol.json', 663afe7ab0SPaolo Bonzini 'doc-bad-union-member.json', 673afe7ab0SPaolo Bonzini 'doc-before-include.json', 683afe7ab0SPaolo Bonzini 'doc-before-pragma.json', 69fc68b9ffSMarkus Armbruster 'doc-duplicate-features.json', 703afe7ab0SPaolo Bonzini 'doc-duplicated-arg.json', 713afe7ab0SPaolo Bonzini 'doc-duplicated-return.json', 723afe7ab0SPaolo Bonzini 'doc-duplicated-since.json', 733afe7ab0SPaolo Bonzini 'doc-empty-arg.json', 740ba2915bSMarkus Armbruster 'doc-empty-features.json', 753afe7ab0SPaolo Bonzini 'doc-empty-section.json', 763afe7ab0SPaolo Bonzini 'doc-empty-symbol.json', 773afe7ab0SPaolo Bonzini 'doc-good.json', 783afe7ab0SPaolo Bonzini 'doc-interleaved-section.json', 793afe7ab0SPaolo Bonzini 'doc-invalid-end.json', 803afe7ab0SPaolo Bonzini 'doc-invalid-end2.json', 813afe7ab0SPaolo Bonzini 'doc-invalid-return.json', 82e1f684eaSMarkus Armbruster 'doc-invalid-return2.json', 833afe7ab0SPaolo Bonzini 'doc-invalid-section.json', 843afe7ab0SPaolo Bonzini 'doc-invalid-start.json', 853afe7ab0SPaolo Bonzini 'doc-missing-colon.json', 863afe7ab0SPaolo Bonzini 'doc-missing-expr.json', 873afe7ab0SPaolo Bonzini 'doc-missing-space.json', 883afe7ab0SPaolo Bonzini 'doc-missing.json', 893afe7ab0SPaolo Bonzini 'doc-no-symbol.json', 903afe7ab0SPaolo Bonzini 'doc-undoc-feature.json', 913afe7ab0SPaolo Bonzini 'double-type.json', 923afe7ab0SPaolo Bonzini 'duplicate-key.json', 933afe7ab0SPaolo Bonzini 'empty.json', 943afe7ab0SPaolo Bonzini 'enum-bad-member.json', 953afe7ab0SPaolo Bonzini 'enum-bad-name.json', 963afe7ab0SPaolo Bonzini 'enum-bad-prefix.json', 973afe7ab0SPaolo Bonzini 'enum-clash-member.json', 983afe7ab0SPaolo Bonzini 'enum-dict-member-unknown.json', 993afe7ab0SPaolo Bonzini 'enum-if-invalid.json', 1003afe7ab0SPaolo Bonzini 'enum-int-member.json', 1013afe7ab0SPaolo Bonzini 'enum-member-case.json', 1023afe7ab0SPaolo Bonzini 'enum-missing-data.json', 1033afe7ab0SPaolo Bonzini 'enum-wrong-data.json', 1043afe7ab0SPaolo Bonzini 'event-boxed-empty.json', 1053afe7ab0SPaolo Bonzini 'event-case.json', 1063afe7ab0SPaolo Bonzini 'event-member-invalid-dict.json', 1073afe7ab0SPaolo Bonzini 'event-nest-struct.json', 1083afe7ab0SPaolo Bonzini 'features-bad-type.json', 1093afe7ab0SPaolo Bonzini 'features-deprecated-type.json', 1103afe7ab0SPaolo Bonzini 'features-duplicate-name.json', 1113afe7ab0SPaolo Bonzini 'features-if-invalid.json', 1123afe7ab0SPaolo Bonzini 'features-missing-name.json', 1133afe7ab0SPaolo Bonzini 'features-name-bad-type.json', 1143afe7ab0SPaolo Bonzini 'features-no-list.json', 1153afe7ab0SPaolo Bonzini 'features-unknown-key.json', 1163afe7ab0SPaolo Bonzini 'funny-char.json', 1173afe7ab0SPaolo Bonzini 'funny-word.json', 1183afe7ab0SPaolo Bonzini 'ident-with-escape.json', 1193afe7ab0SPaolo Bonzini 'include-before-err.json', 1203afe7ab0SPaolo Bonzini 'include-cycle.json', 1213afe7ab0SPaolo Bonzini 'include-extra-junk.json', 1223afe7ab0SPaolo Bonzini 'include-nested-err.json', 1233afe7ab0SPaolo Bonzini 'include-no-file.json', 1243afe7ab0SPaolo Bonzini 'include-non-file.json', 1253afe7ab0SPaolo Bonzini 'include-repetition.json', 1263afe7ab0SPaolo Bonzini 'include-self-cycle.json', 1273afe7ab0SPaolo Bonzini 'include-simple.json', 1283afe7ab0SPaolo Bonzini 'indented-expr.json', 1293afe7ab0SPaolo Bonzini 'leading-comma-list.json', 1303afe7ab0SPaolo Bonzini 'leading-comma-object.json', 131c256263fSJohn Snow 'missing-array-rsqb.json', 1323afe7ab0SPaolo Bonzini 'missing-colon.json', 1333afe7ab0SPaolo Bonzini 'missing-comma-list.json', 1343afe7ab0SPaolo Bonzini 'missing-comma-object.json', 135c256263fSJohn Snow 'missing-object-member-element.json', 1363afe7ab0SPaolo Bonzini 'missing-type.json', 1373afe7ab0SPaolo Bonzini 'nested-struct-data.json', 1383afe7ab0SPaolo Bonzini 'nested-struct-data-invalid-dict.json', 1393afe7ab0SPaolo Bonzini 'non-objects.json', 14004f22362SKevin Wolf 'oob-coroutine.json', 1413afe7ab0SPaolo Bonzini 'oob-test.json', 1423afe7ab0SPaolo Bonzini 'allow-preconfig-test.json', 1433afe7ab0SPaolo Bonzini 'pragma-extra-junk.json', 1443afe7ab0SPaolo Bonzini 'pragma-non-dict.json', 1453afe7ab0SPaolo Bonzini 'pragma-unknown.json', 146e90a61e3SMarkus Armbruster 'pragma-value-not-bool.json', 147e90a61e3SMarkus Armbruster 'pragma-value-not-list-of-str.json', 148e90a61e3SMarkus Armbruster 'pragma-value-not-list.json', 1493afe7ab0SPaolo Bonzini 'qapi-schema-test.json', 1503afe7ab0SPaolo Bonzini 'quoted-structural-chars.json', 1513afe7ab0SPaolo Bonzini 'redefined-command.json', 1523afe7ab0SPaolo Bonzini 'redefined-event.json', 153492db12eSMarkus Armbruster 'redefined-predefined.json', 1543afe7ab0SPaolo Bonzini 'redefined-type.json', 1553afe7ab0SPaolo Bonzini 'reserved-command-q.json', 1563afe7ab0SPaolo Bonzini 'reserved-enum-q.json', 1573afe7ab0SPaolo Bonzini 'reserved-member-has.json', 1583afe7ab0SPaolo Bonzini 'reserved-member-q.json', 1593afe7ab0SPaolo Bonzini 'reserved-member-u.json', 1603afe7ab0SPaolo Bonzini 'reserved-member-underscore.json', 1613afe7ab0SPaolo Bonzini 'reserved-type-list.json', 1623afe7ab0SPaolo Bonzini 'returns-alternate.json', 1633afe7ab0SPaolo Bonzini 'returns-array-bad.json', 164ef8b3829SMarkus Armbruster 'returns-bad-type.json', 1653afe7ab0SPaolo Bonzini 'returns-dict.json', 1663afe7ab0SPaolo Bonzini 'returns-unknown.json', 1673afe7ab0SPaolo Bonzini 'string-code-point-31.json', 1683afe7ab0SPaolo Bonzini 'string-code-point-127.json', 1693afe7ab0SPaolo Bonzini 'struct-base-clash-deep.json', 1703afe7ab0SPaolo Bonzini 'struct-base-clash.json', 1713afe7ab0SPaolo Bonzini 'struct-data-invalid.json', 172e2050ef6SMarkus Armbruster 'struct-data-typename.json', 1733afe7ab0SPaolo Bonzini 'struct-member-if-invalid.json', 1743afe7ab0SPaolo Bonzini 'struct-member-invalid-dict.json', 1753afe7ab0SPaolo Bonzini 'struct-member-invalid.json', 176e75d4225SMarkus Armbruster 'struct-member-name-clash.json', 1773afe7ab0SPaolo Bonzini 'trailing-comma-list.json', 1783afe7ab0SPaolo Bonzini 'trailing-comma-object.json', 1793afe7ab0SPaolo Bonzini 'type-bypass-bad-gen.json', 1803e6c8a63SMarkus Armbruster 'type-case.json', 1813afe7ab0SPaolo Bonzini 'unclosed-list.json', 1823afe7ab0SPaolo Bonzini 'unclosed-object.json', 1833afe7ab0SPaolo Bonzini 'unclosed-string.json', 1848b3b3a16SMarkus Armbruster 'union-array-branch.json', 1858b3b3a16SMarkus Armbruster 'union-bad-base.json', 1868b3b3a16SMarkus Armbruster 'union-bad-discriminator.json', 1878b3b3a16SMarkus Armbruster 'union-base-any.json', 1883afe7ab0SPaolo Bonzini 'union-base-empty.json', 1893afe7ab0SPaolo Bonzini 'union-base-no-discriminator.json', 1908b3b3a16SMarkus Armbruster 'union-base-union.json', 1913afe7ab0SPaolo Bonzini 'union-branch-if-invalid.json', 1923afe7ab0SPaolo Bonzini 'union-branch-invalid-dict.json', 1938b3b3a16SMarkus Armbruster 'union-clash-member.json', 1948b3b3a16SMarkus Armbruster 'union-discriminator-bad-name.json', 1958b3b3a16SMarkus Armbruster 'union-empty.json', 1968b3b3a16SMarkus Armbruster 'union-inline-invalid-dict.json', 1978b3b3a16SMarkus Armbruster 'union-int-branch.json', 1983afe7ab0SPaolo Bonzini 'union-invalid-base.json', 1998b3b3a16SMarkus Armbruster 'union-invalid-branch-key.json', 2004918bb7dSJohn Snow 'union-invalid-data.json', 2018b3b3a16SMarkus Armbruster 'union-invalid-discriminator.json', 2028b3b3a16SMarkus Armbruster 'union-invalid-if-discriminator.json', 203a17dbc4bSDaniel P. Berrangé 'union-invalid-union-subfield.json', 204a17dbc4bSDaniel P. Berrangé 'union-invalid-union-subtype.json', 2058b3b3a16SMarkus Armbruster 'union-no-base.json', 2068b3b3a16SMarkus Armbruster 'union-optional-discriminator.json', 2078b3b3a16SMarkus Armbruster 'union-string-discriminator.json', 2083afe7ab0SPaolo Bonzini 'union-unknown.json', 2093afe7ab0SPaolo Bonzini 'unknown-escape.json', 2103afe7ab0SPaolo Bonzini 'unknown-expr-key.json', 2113afe7ab0SPaolo Bonzini] 212334c3cd5SJohn Snowschemas = files(schemas) 213334c3cd5SJohn Snow 214334c3cd5SJohn Snow# Intentionally missing schema file test -- not passed through files(): 215334c3cd5SJohn Snowschemas += [meson.current_source_dir() / 'missing-schema.json'] 2163afe7ab0SPaolo Bonzini 2173afe7ab0SPaolo Bonzini# Because people may want to use test-qapi.py from the command line, we 2183afe7ab0SPaolo Bonzini# are not using the "#! /usr/bin/env python3" trick here. See 219551bdfa0SStefano Garzarella# docs/devel/build-system.rst 220334c3cd5SJohn Snowtest('QAPI schema regression tests', python, 221334c3cd5SJohn Snow args: files('test-qapi.py') + schemas, 2223afe7ab0SPaolo Bonzini env: test_env, suite: ['qapi-schema', 'qapi-frontend']) 2233afe7ab0SPaolo Bonzini 2243afe7ab0SPaolo Bonzinidiff = find_program('diff') 2253afe7ab0SPaolo Bonzini 226e3af71e9SPaolo Bonzinicustom_target('QAPI doc', 227a27ff0a2SPeter Maydell output: ['doc-good-qapi-commands.c', 'doc-good-qapi-commands.h', 2283afe7ab0SPaolo Bonzini 'doc-good-qapi-emit-events.c', 'doc-good-qapi-emit-events.h', 2293afe7ab0SPaolo Bonzini 'doc-good-qapi-events.c', 'doc-good-qapi-events.h', 2303afe7ab0SPaolo Bonzini 'doc-good-qapi-init-commands.c', 'doc-good-qapi-init-commands.h', 2313afe7ab0SPaolo Bonzini 'doc-good-qapi-introspect.c', 'doc-good-qapi-introspect.h', 2323afe7ab0SPaolo Bonzini 'doc-good-qapi-types.c', 'doc-good-qapi-types.h', 2333afe7ab0SPaolo Bonzini 'doc-good-qapi-visit.c', 'doc-good-qapi-visit.h' ], 2343afe7ab0SPaolo Bonzini input: files('doc-good.json'), 2353afe7ab0SPaolo Bonzini command: [ qapi_gen, '-o', meson.current_build_dir(), 2363afe7ab0SPaolo Bonzini '-p', 'doc-good-', '@INPUT0@' ], 2373afe7ab0SPaolo Bonzini depend_files: qapi_gen_depends) 2383afe7ab0SPaolo Bonzini 2399dc6ee3fSPaolo Bonziniif build_docs 240ca1145eeSPeter Maydell # Test the document-comment document generation code by running a test schema 241ca1145eeSPeter Maydell # file through Sphinx's plain-text builder and comparing the result against 242ca1145eeSPeter Maydell # a golden reference. This is in theory susceptible to failures if Sphinx 243ca1145eeSPeter Maydell # changes its output, but the text output has historically been very stable 244ca1145eeSPeter Maydell # (no changes between Sphinx 1.6 and 3.0), so it is a better bet than 245ca1145eeSPeter Maydell # texinfo or HTML generation, both of which have had changes. We might 246ca1145eeSPeter Maydell # need to add more sophisticated logic here in future for some sort of 247ca1145eeSPeter Maydell # fuzzy comparison if future Sphinx versions produce different text, 248ca1145eeSPeter Maydell # but for now the simple comparison suffices. 249ca1145eeSPeter Maydell qapi_doc_out = custom_target('QAPI rST doc', 250ca1145eeSPeter Maydell output: ['doc-good.txt'], 251ca1145eeSPeter Maydell input: files('doc-good.json', 'doc-good.rst'), 2529dc6ee3fSPaolo Bonzini build_by_default: true, 253706bbad2SMarc-André Lureau depfile: 'docs.d', 254ca1145eeSPeter Maydell # We use -E to suppress Sphinx's caching, because 255ca1145eeSPeter Maydell # we want it to always really run the QAPI doc 256ca1145eeSPeter Maydell # generation code. It also means we don't 257ca1145eeSPeter Maydell # clutter up the build dir with the cache. 258ca1145eeSPeter Maydell command: [SPHINX_ARGS, 259ca1145eeSPeter Maydell '-b', 'text', '-E', 260654d6b04SPaolo Bonzini '-c', meson.project_source_root() / 'docs', 261ca1145eeSPeter Maydell '-D', 'master_doc=doc-good', 262706bbad2SMarc-André Lureau '-Ddepfile=@DEPFILE@', 263706bbad2SMarc-André Lureau '-Ddepfile_stamp=doc-good.stamp', 264ca1145eeSPeter Maydell meson.current_source_dir(), 265ca1145eeSPeter Maydell meson.current_build_dir()]) 266ca1145eeSPeter Maydell 267ca1145eeSPeter Maydell # Fix possible inconsistency in line endings in generated output and 268ca1145eeSPeter Maydell # in the golden reference (which could otherwise cause test failures 269ca1145eeSPeter Maydell # on Windows hosts). Unfortunately diff --strip-trailing-cr 270ec91e923SMarc-André Lureau # is GNU-diff only. The odd-looking python is because we must avoid 271ca1145eeSPeter Maydell # using an explicit '\' character in the command arguments to 272ca1145eeSPeter Maydell # a custom_target(), as Meson will unhelpfully replace it with a '/' 273ca1145eeSPeter Maydell # (https://github.com/mesonbuild/meson/issues/1564) 274ec91e923SMarc-André Lureau remove_cr = [python, '-c', 'import sys;[sys.stdout.write(line.replace(chr(13), "")) for line in sys.stdin]'] 275ca1145eeSPeter Maydell qapi_doc_out_nocr = custom_target('QAPI rST doc newline-sanitized', 276ca1145eeSPeter Maydell output: ['doc-good.txt.nocr'], 277ca1145eeSPeter Maydell input: qapi_doc_out[0], 2789dc6ee3fSPaolo Bonzini build_by_default: true, 279976474fdSMarkus Armbruster command: [remove_cr], 280976474fdSMarkus Armbruster capture: true, 281976474fdSMarkus Armbruster feed: true) 282ca1145eeSPeter Maydell 283ca1145eeSPeter Maydell qapi_doc_ref_nocr = custom_target('QAPI rST doc reference newline-sanitized', 284ca1145eeSPeter Maydell output: ['doc-good.ref.nocr'], 285ca1145eeSPeter Maydell input: files('doc-good.txt'), 2869dc6ee3fSPaolo Bonzini build_by_default: true, 287976474fdSMarkus Armbruster command: [remove_cr], 288976474fdSMarkus Armbruster capture: true, 289976474fdSMarkus Armbruster feed: true) 290ca1145eeSPeter Maydell 2917bef93ffSPaolo Bonzini test('QAPI rST doc', diff, args: ['-u', qapi_doc_ref_nocr[0], qapi_doc_out_nocr[0]], 292ca1145eeSPeter Maydell suite: ['qapi-schema', 'qapi-doc']) 293ca1145eeSPeter Maydellendif 294