[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v6 11/27] qapi: improve reporting of unknown or miss
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH v6 11/27] qapi: improve reporting of unknown or missing keys |
Date: |
Fri, 6 Jul 2018 12:57:37 +0200 |
Report the set of missing or unknown keys. And give a hint about the
accepted keys.
Signed-off-by: Marc-André Lureau <address@hidden>
---
scripts/qapi/common.py | 23 +++++++++++++++--------
tests/qapi-schema/alternate-base.err | 1 +
tests/qapi-schema/double-type.err | 1 +
tests/qapi-schema/unknown-expr-key.err | 3 ++-
tests/qapi-schema/unknown-expr-key.json | 2 +-
5 files changed, 20 insertions(+), 10 deletions(-)
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index 8313c478c4..cf8dab2866 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -874,14 +874,21 @@ def check_struct(expr, info):
def check_known_keys(info, source, keys, required, optional):
- for key in keys:
- if key not in required and key not in optional:
- raise QAPISemError(info, "Unknown key '%s' in %s" % (key, source))
-
- for key in required:
- if key not in keys:
- raise QAPISemError(info, "Key '%s' is missing from %s"
- % (key, source))
+
+ def pprint(elems):
+ return ', '.join("'" + e + "'" for e in sorted(elems))
+
+ missing = set(required) - set(keys)
+ if missing:
+ raise QAPISemError(info, "Key%s %s %s missing from %s"
+ % ('s' if len(missing) > 1 else '', pprint(missing),
+ 'are' if len(missing) > 1 else 'is', source))
+ allowed = set(required + optional)
+ unknown = set(keys) - allowed
+ if unknown:
+ raise QAPISemError(info, "Unknown key%s %s in %s\nValid keys are %s."
+ % ('s' if len(unknown) > 1 else '', pprint(unknown),
+ source, pprint(allowed)))
def check_keys(expr_elem, meta, required, optional=[]):
diff --git a/tests/qapi-schema/alternate-base.err
b/tests/qapi-schema/alternate-base.err
index 30d8a34373..ebe05bc898 100644
--- a/tests/qapi-schema/alternate-base.err
+++ b/tests/qapi-schema/alternate-base.err
@@ -1 +1,2 @@
tests/qapi-schema/alternate-base.json:4: Unknown key 'base' in alternate 'Alt'
+Valid keys are 'alternate', 'data', 'if'.
diff --git a/tests/qapi-schema/double-type.err
b/tests/qapi-schema/double-type.err
index f9613c6d6b..799193dba1 100644
--- a/tests/qapi-schema/double-type.err
+++ b/tests/qapi-schema/double-type.err
@@ -1 +1,2 @@
tests/qapi-schema/double-type.json:2: Unknown key 'command' in struct 'bar'
+Valid keys are 'base', 'data', 'if', 'struct'.
diff --git a/tests/qapi-schema/unknown-expr-key.err
b/tests/qapi-schema/unknown-expr-key.err
index 12f5ed5b43..83b83121e0 100644
--- a/tests/qapi-schema/unknown-expr-key.err
+++ b/tests/qapi-schema/unknown-expr-key.err
@@ -1 +1,2 @@
-tests/qapi-schema/unknown-expr-key.json:2: Unknown key 'bogus' in struct 'bar'
+tests/qapi-schema/unknown-expr-key.json:2: Unknown keys 'bogus', 'foo' in
struct 'bar'
+Valid keys are 'base', 'data', 'if', 'struct'.
diff --git a/tests/qapi-schema/unknown-expr-key.json
b/tests/qapi-schema/unknown-expr-key.json
index 3b2be00cc4..5bcb8efd1d 100644
--- a/tests/qapi-schema/unknown-expr-key.json
+++ b/tests/qapi-schema/unknown-expr-key.json
@@ -1,2 +1,2 @@
# we reject an expression with unknown top-level keys
-{ 'struct': 'bar', 'data': { 'string': 'str'}, 'bogus': { } }
+{ 'struct': 'bar', 'data': { 'string': 'str'}, 'bogus': { }, 'foo': { } }
--
2.18.0.rc1
- [Qemu-devel] [PATCH v6 01/27] qmp-shell: learn to send commands with quoted arguments, (continued)
- [Qemu-devel] [PATCH v6 01/27] qmp-shell: learn to send commands with quoted arguments, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 03/27] tests: change /0.15/* tests to /qmp/*, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 02/27] json: remove useless return value from lexer/parser, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 04/27] qapi: Fix some pycodestyle-3 complaints, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 06/27] qapi: do not define enumeration value explicitly, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 07/27] qapi: rename QAPISchemaEnumType.values to .members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 05/27] qapi: include osdep.h in type headers, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 08/27] qapi: change enum visitor and gen_enum* to take QAPISchemaMember, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 10/27] qapi: factor out checking for keys, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 09/27] tests: print enum type members more like object type members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 11/27] qapi: improve reporting of unknown or missing keys,
Marc-André Lureau <=
- [Qemu-devel] [PATCH v6 12/27] qapi: add a dictionnary form with 'name' key for enum members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 14/27] qapi-event: add 'if' condition to implicit event enum, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 13/27] qapi: add 'if' to enum members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 15/27] qapi: rename allow_dict to allow_implicit, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 16/27] qapi: add a dictionary form with 'type' key for members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 18/27] qapi: add an error in case a discriminator is conditionnal, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 17/27] qapi: add 'if' to implicit struct members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 19/27] qapi: add 'if' on union members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 20/27] qapi: add 'if' to alternate members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 21/27] qapi: add #if conditions to generated code members, Marc-André Lureau, 2018/07/06