From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Subject: [Qemu-devel] [PULL for 2.9 38/49] tests/qapi-schema: Improve coverage of bogus member docs
Date: Thu, 16 Mar 2017 07:27:54 +0100 [thread overview]
Message-ID: <1489645685-4750-39-git-send-email-armbru@redhat.com> (raw)
In-Reply-To: <1489645685-4750-1-git-send-email-armbru@redhat.com>
New test doc-bad-union-member.json shows we can fail to reject
documentation for nonexistent members.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-37-git-send-email-armbru@redhat.com>
---
tests/Makefile.include | 2 ++
tests/qapi-schema/doc-bad-alternate-member.err | 1 +
tests/qapi-schema/doc-bad-alternate-member.exit | 1 +
tests/qapi-schema/doc-bad-alternate-member.json | 9 +++++++++
tests/qapi-schema/doc-bad-alternate-member.out | 0
tests/qapi-schema/doc-bad-union-member.err | 0
tests/qapi-schema/doc-bad-union-member.exit | 1 +
tests/qapi-schema/doc-bad-union-member.json | 19 +++++++++++++++++++
tests/qapi-schema/doc-bad-union-member.out | 11 +++++++++++
9 files changed, 44 insertions(+)
create mode 100644 tests/qapi-schema/doc-bad-alternate-member.err
create mode 100644 tests/qapi-schema/doc-bad-alternate-member.exit
create mode 100644 tests/qapi-schema/doc-bad-alternate-member.json
create mode 100644 tests/qapi-schema/doc-bad-alternate-member.out
create mode 100644 tests/qapi-schema/doc-bad-union-member.err
create mode 100644 tests/qapi-schema/doc-bad-union-member.exit
create mode 100644 tests/qapi-schema/doc-bad-union-member.json
create mode 100644 tests/qapi-schema/doc-bad-union-member.out
diff --git a/tests/Makefile.include b/tests/Makefile.include
index 734c7ff..e6e00b4 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -367,8 +367,10 @@ qapi-schema += base-cycle-direct.json
qapi-schema += base-cycle-indirect.json
qapi-schema += command-int.json
qapi-schema += comments.json
+qapi-schema += doc-bad-alternate-member.json
qapi-schema += doc-bad-command-arg.json
qapi-schema += doc-bad-symbol.json
+qapi-schema += doc-bad-union-member.json
qapi-schema += doc-before-include.json
qapi-schema += doc-before-pragma.json
qapi-schema += doc-duplicated-arg.json
diff --git a/tests/qapi-schema/doc-bad-alternate-member.err b/tests/qapi-schema/doc-bad-alternate-member.err
new file mode 100644
index 0000000..387f782
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-alternate-member.err
@@ -0,0 +1 @@
+tests/qapi-schema/doc-bad-alternate-member.json:3: The following documented members are not in the declaration: aa, bb
diff --git a/tests/qapi-schema/doc-bad-alternate-member.exit b/tests/qapi-schema/doc-bad-alternate-member.exit
new file mode 100644
index 0000000..d00491f
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-alternate-member.exit
@@ -0,0 +1 @@
+1
diff --git a/tests/qapi-schema/doc-bad-alternate-member.json b/tests/qapi-schema/doc-bad-alternate-member.json
new file mode 100644
index 0000000..738635c
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-alternate-member.json
@@ -0,0 +1,9 @@
+# Arguments listed in the doc comment must exist in the actual schema
+
+##
+# @AorB:
+# @aa: a
+# @bb: b
+##
+{ 'alternate': 'AorB',
+ 'data': { 'a': 'str', 'b': 'int' } }
diff --git a/tests/qapi-schema/doc-bad-alternate-member.out b/tests/qapi-schema/doc-bad-alternate-member.out
new file mode 100644
index 0000000..e69de29
diff --git a/tests/qapi-schema/doc-bad-union-member.err b/tests/qapi-schema/doc-bad-union-member.err
new file mode 100644
index 0000000..e69de29
diff --git a/tests/qapi-schema/doc-bad-union-member.exit b/tests/qapi-schema/doc-bad-union-member.exit
new file mode 100644
index 0000000..573541a
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-union-member.exit
@@ -0,0 +1 @@
+0
diff --git a/tests/qapi-schema/doc-bad-union-member.json b/tests/qapi-schema/doc-bad-union-member.json
new file mode 100644
index 0000000..d611435
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-union-member.json
@@ -0,0 +1,19 @@
+# Arguments listed in the doc comment must exist in the actual schema
+
+##
+# @Frob:
+# @a: a
+# @b: b
+##
+{ 'union': 'Frob',
+ 'base': 'Base',
+ 'discriminator': 'type',
+ 'data': { 'nothing': 'Empty' } }
+
+{ 'struct': 'Base',
+ 'data': { 'type': 'T' } }
+
+{ 'struct': 'Empty',
+ 'data': { } }
+
+{ 'enum': 'T', 'data': ['nothing'] }
diff --git a/tests/qapi-schema/doc-bad-union-member.out b/tests/qapi-schema/doc-bad-union-member.out
new file mode 100644
index 0000000..2576ecd
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-union-member.out
@@ -0,0 +1,11 @@
+object Base
+ member type: T optional=False
+object Empty
+object Frob
+ base Base
+ tag type
+ case nothing: Empty
+enum QType ['none', 'qnull', 'qint', 'qstring', 'qdict', 'qlist', 'qfloat', 'qbool']
+ prefix QTYPE
+enum T ['nothing']
+object q_empty
--
2.7.4
next prev parent reply other threads:[~2017-03-16 6:28 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-16 6:27 [Qemu-devel] [PULL for 2.9 00/49] QAPI patches for 2017-03-16 Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 01/49] qapi2texi: change texi formatters Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 02/49] qmp: allow setting properties to empty string in qmp-shell Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 03/49] qapi: Factor QAPISchemaParser._include() out of .__init__() Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 04/49] qapi: Make doc comments optional where we don't need them Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 05/49] qapi: Back out doc comments added just to please qapi.py Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 06/49] docs/qapi-code-gen.txt: Drop confusing reference to 'gen' Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 07/49] qapi: Have each QAPI schema declare its returns white-list Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 08/49] qapi: Have each QAPI schema declare its name rule violations Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 09/49] qapi: Clean up build of generated documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 10/49] tests/qapi-schema: Cover empty union base Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 11/49] qapi: Fix to reject empty union base gracefully Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 12/49] qapi2texi: Fix up output around #optional Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 14/49] qapi/rocker: Fix up doc comment notes on optional members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType' Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 16/49] qapi: Prepare for requiring more complete documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 17/49] qapi: Conjure up QAPIDoc.ArgSection for undocumented members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 19/49] qapi: The #optional tag is redundant, drop Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 20/49] qapi: Use raw strings for regular expressions consistently Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 23/49] qapi2texi: Present the table of members more clearly Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 24/49] qapi2texi: Explain enum value undocumentedness " Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 27/49] qapi2texi: Include member type in generated documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 28/49] qapi2texi: Generate reference to base type members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 33/49] qapi: Fix detection of doc / expression mismatch Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 34/49] qapi: Move detection of doc / expression name mismatch Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 35/49] qapi: Improve error message on @NAME: in free-form doc Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 36/49] qapi: Move empty doc section checking to doc parser Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 37/49] tests/qapi-schema: Rename doc-bad-args to doc-bad-command-arg Markus Armbruster
2017-03-16 6:27 ` Markus Armbruster [this message]
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 39/49] qapi: Fix detection of bogus member documentation Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop QAPIDoc.expr Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 41/49] qapi: Drop unused variable events Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 42/49] qapi: Simplify what gets stored in enum_types Markus Armbruster
2017-03-16 6:27 ` [Qemu-devel] [PULL for 2.9 43/49] qapi: Factor add_name() calls out of the meta conditional Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 44/49] qapi: enum_types is a list used like a dict, make it one Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 45/49] qapi: struct_types " Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 46/49] qapi: union_types " Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 47/49] qapi: Drop unused .check_clash() parameter schema Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier Markus Armbruster
2017-03-16 6:28 ` [Qemu-devel] [PULL for 2.9 49/49] qapi: Fix a misleading parser error message Markus Armbruster
2017-03-16 14:22 ` [Qemu-devel] [PULL for 2.9 00/49] QAPI patches for 2017-03-16 Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1489645685-4750-39-git-send-email-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).