Commit 576f0b8a authored by Markus Armbruster's avatar Markus Armbruster
Browse files

qapi: Improve reporting of invalid 'if' errors 



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 0545f6b8 "qapi: Better error messages
for bad expressions", which checks the value of key 'name'.  More
sinning in commit 2cbf0992 "qapi: More rigorous checking for type
safety bypass", commit c818408e "qapi: Implement boxed types for
commands/events", and commit 967c8851 "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: default avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Message-Id: <20190927134639.4284-19-armbru@redhat.com>
parent 4ebda5ab

scripts/qapi/common.py

+2 −2
Original line number Diff line number Diff line
@@ -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):
@@ -1028,6 +1026,8 @@ def check_exprs(exprs): 
        else:

            assert False, 'unexpected meta type'



        check_if(expr, info)



        if doc:

            doc.check_expr(expr)

tests/qapi-schema/bad-if-empty-list.err

+1 −0
Original line number Diff line number Diff line 
tests/qapi-schema/bad-if-empty-list.json: In struct 'TestIfStruct':

tests/qapi-schema/bad-if-empty-list.json:2: 'if' condition [] is useless

tests/qapi-schema/bad-if-empty.err

+1 −0
Original line number Diff line number Diff line 
tests/qapi-schema/bad-if-empty.json: In struct 'TestIfStruct':

tests/qapi-schema/bad-if-empty.json:2: 'if' condition '' makes no sense

tests/qapi-schema/bad-if-list.err

+1 −0
Original line number Diff line number Diff line 
tests/qapi-schema/bad-if-list.json: In struct 'TestIfStruct':

tests/qapi-schema/bad-if-list.json:2: 'if' condition ' ' makes no sense

tests/qapi-schema/bad-if.err

+1 −0
Original line number Diff line number Diff line 
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