From patchwork Tue Sep 24 13:28:25 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 11159045 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id B4C83112B for ; Tue, 24 Sep 2019 14:53:16 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 92ED9207FD for ; Tue, 24 Sep 2019 14:53:16 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 92ED9207FD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Received: from localhost ([::1]:46612 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iCmBm-0005G0-Ca for patchwork-qemu-devel@patchwork.kernel.org; Tue, 24 Sep 2019 10:53:14 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58813) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iCks3-0000HE-4J for qemu-devel@nongnu.org; Tue, 24 Sep 2019 09:28:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iCkrw-0001Tj-B8 for qemu-devel@nongnu.org; Tue, 24 Sep 2019 09:28:46 -0400 Received: from mx1.redhat.com ([209.132.183.28]:38484) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iCkrv-0001SH-Kg for qemu-devel@nongnu.org; Tue, 24 Sep 2019 09:28:40 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 44453A26685; Tue, 24 Sep 2019 13:28:38 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-117-142.ams2.redhat.com [10.36.117.142]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DC5C960C5E; Tue, 24 Sep 2019 13:28:37 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id A439D1136420; Tue, 24 Sep 2019 15:28:30 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Subject: [PATCH 20/25] qapi: Improve reporting of missing / unknown definition keys Date: Tue, 24 Sep 2019 15:28:25 +0200 Message-Id: <20190924132830.15835-21-armbru@redhat.com> In-Reply-To: <20190924132830.15835-1-armbru@redhat.com> References: <20190924132830.15835-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.68]); Tue, 24 Sep 2019 13:28:38 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: marcandre.lureau@redhat.com, mdroth@linux.vnet.ibm.com Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" 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 Reviewed-by: Eric Blake --- scripts/qapi/common.py | 40 ++++++++++++------------- tests/qapi-schema/alternate-base.err | 1 + tests/qapi-schema/bad-type-bool.err | 2 +- tests/qapi-schema/bad-type-dict.err | 2 +- tests/qapi-schema/double-type.err | 1 + tests/qapi-schema/enum-missing-data.err | 1 + tests/qapi-schema/unknown-expr-key.err | 1 + 7 files changed, 25 insertions(+), 23 deletions(-) diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py index 4bfc007833..297b82db4c 100644 --- a/scripts/qapi/common.py +++ b/scripts/qapi/common.py @@ -905,8 +905,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) @@ -964,37 +962,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) @@ -1008,20 +987,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) diff --git a/tests/qapi-schema/alternate-base.err b/tests/qapi-schema/alternate-base.err index 4c9158db02..6290665ac2 100644 --- a/tests/qapi-schema/alternate-base.err +++ b/tests/qapi-schema/alternate-base.err @@ -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'. diff --git a/tests/qapi-schema/bad-type-bool.err b/tests/qapi-schema/bad-type-bool.err index 62fd70baaf..984a77c4e3 100644 --- a/tests/qapi-schema/bad-type-bool.err +++ b/tests/qapi-schema/bad-type-bool.err @@ -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 diff --git a/tests/qapi-schema/bad-type-dict.err b/tests/qapi-schema/bad-type-dict.err index 0b2a2aeac4..e83b8cfb41 100644 --- a/tests/qapi-schema/bad-type-dict.err +++ b/tests/qapi-schema/bad-type-dict.err @@ -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 diff --git a/tests/qapi-schema/double-type.err b/tests/qapi-schema/double-type.err index 44a9dfdd55..ddb22af638 100644 --- a/tests/qapi-schema/double-type.err +++ b/tests/qapi-schema/double-type.err @@ -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'. diff --git a/tests/qapi-schema/enum-missing-data.err b/tests/qapi-schema/enum-missing-data.err index 3c3c52d037..ffde1082c3 100644 --- a/tests/qapi-schema/enum-missing-data.err +++ b/tests/qapi-schema/enum-missing-data.err @@ -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' diff --git a/tests/qapi-schema/unknown-expr-key.err b/tests/qapi-schema/unknown-expr-key.err index 07558edb78..e401efe148 100644 --- a/tests/qapi-schema/unknown-expr-key.err +++ b/tests/qapi-schema/unknown-expr-key.err @@ -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'.