OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

qapi: Improve reporting of missing / unknown definition keys

Browse Source 
Have check_exprs() call check_keys() later, so its error messages gain
an "in definition" line.

Both check_keys() and check_name_is_str() check the definition's name
is a string.  Since check_keys() now runs after check_name_is_str()
rather than before, its check is dead.  Bury it.  Checking values in
check_keys() is unclean anyway.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190927134639.4284-21-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2019-09-27 15:46:33 +02:00
parent a6735a5743
commit 3f58cc29a8
7 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
scripts/qapi/common.py
View File

@ -910,8 +910,6 @@ def check_known_keys(value, info, source, required, optional):
def check_keys(expr, info, meta, required, optional=[]):
name = expr[meta]
if not isinstance(name, str):
raise QAPISemError(info, "'%s' key must have a string value" % meta)
required = required + [meta]
source = "%s '%s'" % (meta, name)
check_known_keys(expr, info, source, required, optional)
@ -969,37 +967,18 @@ def check_exprs(exprs):
if 'enum' in expr:
meta = 'enum'
check_keys(expr, info, 'enum', ['data'], ['if', 'prefix'])
normalize_enum(expr)
elif 'union' in expr:
meta = 'union'
check_keys(expr, info, 'union', ['data'],
['base', 'discriminator', 'if'])
normalize_members(expr.get('base'))
normalize_members(expr['data'])
elif 'alternate' in expr:
meta = 'alternate'
check_keys(expr, info, 'alternate', ['data'], ['if'])
normalize_members(expr['data'])
elif 'struct' in expr:
meta = 'struct'
check_keys(expr, info, 'struct', ['data'],
['base', 'if', 'features'])
normalize_members(expr['data'])
normalize_features(expr.get('features'))
elif 'command' in expr:
meta = 'command'
check_keys(expr, info, 'command', [],
['data', 'returns', 'gen', 'success-response',
'boxed', 'allow-oob', 'allow-preconfig', 'if'])
normalize_members(expr.get('data'))
elif 'event' in expr:
meta = 'event'
check_keys(expr, info, 'event', [], ['data', 'boxed', 'if'])
normalize_members(expr.get('data'))
else:
raise QAPISemError(info, "expression is missing metatype")
normalize_if(expr)
name = expr[meta]
check_name_is_str(name, info, "'%s'" % meta)
@ -1013,20 +992,39 @@ def check_exprs(exprs):
% (name, doc.symbol))
if meta == 'enum':
check_keys(expr, info, 'enum', ['data'], ['if', 'prefix'])
normalize_enum(expr)
check_enum(expr, info)
elif meta == 'union':
check_keys(expr, info, 'union', ['data'],
['base', 'discriminator', 'if'])
normalize_members(expr.get('base'))
normalize_members(expr['data'])
check_union(expr, info)
elif meta == 'alternate':
check_keys(expr, info, 'alternate', ['data'], ['if'])
normalize_members(expr['data'])
check_alternate(expr, info)
elif meta == 'struct':
check_keys(expr, info, 'struct', ['data'],
['base', 'if', 'features'])
normalize_members(expr['data'])
normalize_features(expr.get('features'))
check_struct(expr, info)
elif meta == 'command':
check_keys(expr, info, 'command', [],
['data', 'returns', 'gen', 'success-response',
'boxed', 'allow-oob', 'allow-preconfig', 'if'])
normalize_members(expr.get('data'))
check_command(expr, info)
elif meta == 'event':
check_keys(expr, info, 'event', [], ['data', 'boxed', 'if'])
normalize_members(expr.get('data'))
check_event(expr, info)
else:
assert False, 'unexpected meta type'
normalize_if(expr)
check_if(expr, info)
check_flags(expr, info)

1
tests/qapi-schema/alternate-base.err
View File

@ -1,2 +1,3 @@
tests/qapi-schema/alternate-base.json: In alternate 'Alt':
tests/qapi-schema/alternate-base.json:4: unknown key 'base' in alternate 'Alt'
Valid keys are 'alternate', 'data', 'if'.

2
tests/qapi-schema/bad-type-bool.err
View File

@ -1 +1 @@
tests/qapi-schema/bad-type-bool.json:2: 'struct' key must have a string value
tests/qapi-schema/bad-type-bool.json:2: 'struct' requires a string name

2
tests/qapi-schema/bad-type-dict.err
View File

@ -1 +1 @@
tests/qapi-schema/bad-type-dict.json:2: 'command' key must have a string value
tests/qapi-schema/bad-type-dict.json:2: 'command' requires a string name

1
tests/qapi-schema/double-type.err
View File

@ -1,2 +1,3 @@
tests/qapi-schema/double-type.json: In struct 'bar':
tests/qapi-schema/double-type.json:2: unknown key 'command' in struct 'bar'
Valid keys are 'base', 'data', 'features', 'if', 'struct'.

1
tests/qapi-schema/enum-missing-data.err
View File

@ -1 +1,2 @@
tests/qapi-schema/enum-missing-data.json: In enum 'MyEnum':
tests/qapi-schema/enum-missing-data.json:2: key 'data' is missing from enum 'MyEnum'

1
tests/qapi-schema/unknown-expr-key.err
View File

@ -1,2 +1,3 @@
tests/qapi-schema/unknown-expr-key.json: In struct 'bar':
tests/qapi-schema/unknown-expr-key.json:2: unknown keys 'bogus', 'phony' in struct 'bar'
Valid keys are 'base', 'data', 'features', 'if', 'struct'.