[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 01/19] tests/qapi-schema: Demonstrate feature and enum doc comment
From: |
Markus Armbruster |
Subject: |
[PULL 01/19] tests/qapi-schema: Demonstrate feature and enum doc comment bugs |
Date: |
Tue, 29 Oct 2019 11:22:10 +0100 |
Add negative tests doc-bad-enum-member and doc-bad-feature to cover
documentation for nonexistent enum members and features, and test
doc-undoc-feature to cover features lacking documentation. None of
them works. To be fixed later in this series.
Signed-off-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
---
tests/Makefile.include | 3 +++
tests/qapi-schema/doc-bad-enum-member.err | 0
tests/qapi-schema/doc-bad-enum-member.json | 9 +++++++++
tests/qapi-schema/doc-bad-enum-member.out | 21 +++++++++++++++++++++
tests/qapi-schema/doc-bad-feature.err | 0
tests/qapi-schema/doc-bad-feature.json | 10 ++++++++++
tests/qapi-schema/doc-bad-feature.out | 17 +++++++++++++++++
tests/qapi-schema/doc-undoc-feature.err | 0
tests/qapi-schema/doc-undoc-feature.json | 10 ++++++++++
tests/qapi-schema/doc-undoc-feature.out | 19 +++++++++++++++++++
10 files changed, 89 insertions(+)
create mode 100644 tests/qapi-schema/doc-bad-enum-member.err
create mode 100644 tests/qapi-schema/doc-bad-enum-member.json
create mode 100644 tests/qapi-schema/doc-bad-enum-member.out
create mode 100644 tests/qapi-schema/doc-bad-feature.err
create mode 100644 tests/qapi-schema/doc-bad-feature.json
create mode 100644 tests/qapi-schema/doc-bad-feature.out
create mode 100644 tests/qapi-schema/doc-undoc-feature.err
create mode 100644 tests/qapi-schema/doc-undoc-feature.json
create mode 100644 tests/qapi-schema/doc-undoc-feature.out
diff --git a/tests/Makefile.include b/tests/Makefile.include
index fde8a0c5ef..ca2a0cb84f 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -342,6 +342,8 @@ 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-enum-member.json
+qapi-schema += doc-bad-feature.json
qapi-schema += doc-bad-section.json
qapi-schema += doc-bad-symbol.json
qapi-schema += doc-bad-union-member.json
@@ -365,6 +367,7 @@ qapi-schema += doc-missing-expr.json
qapi-schema += doc-missing-space.json
qapi-schema += doc-missing.json
qapi-schema += doc-no-symbol.json
+qapi-schema += doc-undoc-feature.json
qapi-schema += double-type.json
qapi-schema += duplicate-key.json
qapi-schema += empty.json
diff --git a/tests/qapi-schema/doc-bad-enum-member.err
b/tests/qapi-schema/doc-bad-enum-member.err
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/qapi-schema/doc-bad-enum-member.json
b/tests/qapi-schema/doc-bad-enum-member.json
new file mode 100644
index 0000000000..9f32fe64b4
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-enum-member.json
@@ -0,0 +1,9 @@
+# Members listed in the doc comment must exist in the actual schema
+# BUG: nonexistent @a is not rejected
+
+##
+# @Foo:
+# @a: a
+# @b: b
+##
+{ 'enum': 'Foo', 'data': [ 'b' ] }
diff --git a/tests/qapi-schema/doc-bad-enum-member.out
b/tests/qapi-schema/doc-bad-enum-member.out
new file mode 100644
index 0000000000..6ca31c1e9b
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-enum-member.out
@@ -0,0 +1,21 @@
+module None
+object q_empty
+enum QType
+ prefix QTYPE
+ member none
+ member qnull
+ member qnum
+ member qstring
+ member qdict
+ member qlist
+ member qbool
+module doc-bad-enum-member.json
+enum Foo
+ member b
+doc symbol=Foo
+ body=
+
+ arg=a
+a
+ arg=b
+b
diff --git a/tests/qapi-schema/doc-bad-feature.err
b/tests/qapi-schema/doc-bad-feature.err
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/qapi-schema/doc-bad-feature.json
b/tests/qapi-schema/doc-bad-feature.json
new file mode 100644
index 0000000000..2a78e3b1db
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-feature.json
@@ -0,0 +1,10 @@
+# Features listed in the doc comment must exist in the actual schema
+# BUG: nonexistent @a is not rejected
+
+##
+# @foo:
+#
+# Features:
+# @a: a
+##
+{ 'command': 'foo' }
diff --git a/tests/qapi-schema/doc-bad-feature.out
b/tests/qapi-schema/doc-bad-feature.out
new file mode 100644
index 0000000000..4670be3a72
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-feature.out
@@ -0,0 +1,17 @@
+module None
+object q_empty
+enum QType
+ prefix QTYPE
+ member none
+ member qnull
+ member qnum
+ member qstring
+ member qdict
+ member qlist
+ member qbool
+module doc-bad-feature.json
+command foo None -> None
+ gen=True success_response=True boxed=False oob=False preconfig=False
+doc symbol=foo
+ body=
+
diff --git a/tests/qapi-schema/doc-undoc-feature.err
b/tests/qapi-schema/doc-undoc-feature.err
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/qapi-schema/doc-undoc-feature.json
b/tests/qapi-schema/doc-undoc-feature.json
new file mode 100644
index 0000000000..c7650d9974
--- /dev/null
+++ b/tests/qapi-schema/doc-undoc-feature.json
@@ -0,0 +1,10 @@
+# Doc comment must cover all features
+# BUG: missing documentation for @undoc not caught
+
+##
+# @foo:
+#
+# Features:
+# @doc: documented feature
+##
+{ 'command': 'foo', 'features': ['undoc', 'doc'] }
diff --git a/tests/qapi-schema/doc-undoc-feature.out
b/tests/qapi-schema/doc-undoc-feature.out
new file mode 100644
index 0000000000..faae777f0d
--- /dev/null
+++ b/tests/qapi-schema/doc-undoc-feature.out
@@ -0,0 +1,19 @@
+module None
+object q_empty
+enum QType
+ prefix QTYPE
+ member none
+ member qnull
+ member qnum
+ member qstring
+ member qdict
+ member qlist
+ member qbool
+module doc-undoc-feature.json
+command foo None -> None
+ gen=True success_response=True boxed=False oob=False preconfig=False
+ feature undoc
+ feature doc
+doc symbol=foo
+ body=
+
--
2.21.0
- [PULL 00/19] QAPI patches for 2019-10-29, Markus Armbruster, 2019/10/29
- [PULL 12/19] qapi: Simplify ._make_implicit_object_type(), Markus Armbruster, 2019/10/29
- [PULL 03/19] tests/qapi-schema: Cover alternate documentation comments, Markus Armbruster, 2019/10/29
- [PULL 02/19] tests/qapi-schema: Demonstrate command and event doc comment bugs, Markus Armbruster, 2019/10/29
- [PULL 07/19] qapi: De-duplicate entity documentation generation code, Markus Armbruster, 2019/10/29
- [PULL 04/19] tests/qapi-schema: Fix feature documentation testing, Markus Armbruster, 2019/10/29
- [PULL 01/19] tests/qapi-schema: Demonstrate feature and enum doc comment bugs,
Markus Armbruster <=
- [PULL 09/19] qapi: Fix enum doc comment checking, Markus Armbruster, 2019/10/29
- [PULL 13/19] qapi: Eliminate .check_doc() overrides, Markus Armbruster, 2019/10/29
- [PULL 05/19] qemu-doc: Belatedly document QMP command deprecation, Markus Armbruster, 2019/10/29
- [PULL 10/19] qapi: Clean up doc comment checking for implicit union base, Markus Armbruster, 2019/10/29
- [PULL 14/19] qapi: Fold normalize_if() into check_if(), Markus Armbruster, 2019/10/29
- [PULL 06/19] qapi: Implement boxed event argument documentation, Markus Armbruster, 2019/10/29
- [PULL 15/19] qapi: Fold normalize_features() into check_features(), Markus Armbruster, 2019/10/29
- [PULL 11/19] qapi: Fix doc comment checking for commands and events, Markus Armbruster, 2019/10/29
- [PULL 16/19] qapi: Fold normalize_enum() into check_enum(), Markus Armbruster, 2019/10/29
- [PULL 18/19] qapi: Polish reporting of bogus member documentation, Markus Armbruster, 2019/10/29