Skip to content

Commit

Permalink
qapi: Improve reporting of invalid 'if' errors
Browse files Browse the repository at this point in the history
Move check_if() from check_keys() to check_exprs() and call it later,
so its error messages gain an "in definition" line.

Checking values in a function named check_keys() is unclean anyway.
The original sin was commit 0545f6b "qapi: Better error messages
for bad expressions", which checks the value of key 'name'.  More
sinning in commit 2cbf099 "qapi: More rigorous checking for type
safety bypass", commit c818408 "qapi: Implement boxed types for
commands/events", and commit 967c885 "qapi: add 'if' to top-level
expressions".  This commit does penance for the latter.  The next
commits will do penance for the others.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190927134639.4284-19-armbru@redhat.com>
  • Loading branch information
Markus Armbruster committed Sep 28, 2019
1 parent 4ebda5a commit 576f0b8
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 2 deletions.
4 changes: 2 additions & 2 deletions scripts/qapi/common.py
Expand Up @@ -925,8 +925,6 @@ def check_keys(expr, info, meta, required, optional=[]):
raise QAPISemError(info,
"'%s' of %s '%s' should only use true value"
% (key, meta, name))
if key == 'if':
check_if(expr, info)


def normalize_enum(expr):
Expand Down Expand Up @@ -1028,6 +1026,8 @@ def check_exprs(exprs):
else:
assert False, 'unexpected meta type'

check_if(expr, info)

if doc:
doc.check_expr(expr)

Expand Down
1 change: 1 addition & 0 deletions tests/qapi-schema/bad-if-empty-list.err
@@ -1 +1,2 @@
tests/qapi-schema/bad-if-empty-list.json: In struct 'TestIfStruct':
tests/qapi-schema/bad-if-empty-list.json:2: 'if' condition [] is useless
1 change: 1 addition & 0 deletions tests/qapi-schema/bad-if-empty.err
@@ -1 +1,2 @@
tests/qapi-schema/bad-if-empty.json: In struct 'TestIfStruct':
tests/qapi-schema/bad-if-empty.json:2: 'if' condition '' makes no sense
1 change: 1 addition & 0 deletions tests/qapi-schema/bad-if-list.err
@@ -1 +1,2 @@
tests/qapi-schema/bad-if-list.json: In struct 'TestIfStruct':
tests/qapi-schema/bad-if-list.json:2: 'if' condition ' ' makes no sense
1 change: 1 addition & 0 deletions tests/qapi-schema/bad-if.err
@@ -1 +1,2 @@
tests/qapi-schema/bad-if.json: In struct 'TestIfStruct':
tests/qapi-schema/bad-if.json:2: 'if' condition must be a string or a list of strings

0 comments on commit 576f0b8

Please sign in to comment.