From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-17.5 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,NICE_REPLY_A, SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 967D0C433E0 for ; Thu, 25 Mar 2021 17:53:21 +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 2EB6A61A2D for ; Thu, 25 Mar 2021 17:53:21 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 2EB6A61A2D 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+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:41402 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lPUAa-00078l-78 for qemu-devel@archiver.kernel.org; Thu, 25 Mar 2021 13:53:20 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58248) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lPU80-0005hl-2Z for qemu-devel@nongnu.org; Thu, 25 Mar 2021 13:50:40 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:29007) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lPU7v-0004tC-ME for qemu-devel@nongnu.org; Thu, 25 Mar 2021 13:50:39 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1616694635; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=weJAjU7ki/Q7dk0wTFvV6G5Hgu/psBxs9zsHJ4Qzg2s=; b=azrOcDTwnxngwNSz9IRvHF+HmnC79/ify+wnXLFvo12cbBNLblY7CL78NlXvyCMudfCeLG fJcR2hOYNfxa/C9jpJ+V95fz5Lb1wremd0eEu0wBeCpHk+R6xf9g5VE853ugATi8Aueryx THzgeLkDHPZDZMGFJxY4fJdNWWq2Zws= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-267-M2AaMRyHNiy_AehfT7PjZA-1; Thu, 25 Mar 2021 13:50:33 -0400 X-MC-Unique: M2AaMRyHNiy_AehfT7PjZA-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 106F36B9CF; Thu, 25 Mar 2021 17:50:32 +0000 (UTC) Received: from [10.10.117.181] (ovpn-117-181.rdu2.redhat.com [10.10.117.181]) by smtp.corp.redhat.com (Postfix) with ESMTP id 57E7C5D9D0; Thu, 25 Mar 2021 17:50:25 +0000 (UTC) Subject: Re: [PATCH 13/28] qapi: Enforce event naming rules To: Markus Armbruster References: <20210323094025.3569441-1-armbru@redhat.com> <20210323094025.3569441-14-armbru@redhat.com> <87r1k5f4u7.fsf@dusky.pond.sub.org> <799ad08b-3b45-f511-7717-f366eb2c0404@redhat.com> <87blb7ah1t.fsf@dusky.pond.sub.org> From: John Snow Message-ID: <8e89a84f-8fc8-13e1-5840-fbba018f84e9@redhat.com> Date: Thu, 25 Mar 2021 13:50:24 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.8.1 MIME-Version: 1.0 In-Reply-To: <87blb7ah1t.fsf@dusky.pond.sub.org> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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: michael.roth@amd.com, qemu-devel@nongnu.org, marcandre.lureau@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 3/25/21 2:22 AM, Markus Armbruster wrote: > John Snow writes: > >> On 3/24/21 2:22 AM, Markus Armbruster wrote: >>> John Snow writes: >>> >>>> On 3/23/21 5:40 AM, Markus Armbruster wrote: >>>>> Event names should be ALL_CAPS with words separated by underscore. >>>>> Enforce this. The only offenders are in tests/. Fix them. Existing >>>>> test event-case covers the new error. >>>>> Signed-off-by: Markus Armbruster >>>>> --- >>>>> tests/unit/test-qmp-event.c | 6 +++--- >>>>> scripts/qapi/expr.py | 4 +++- >>>>> tests/qapi-schema/doc-good.json | 4 ++-- >>>>> tests/qapi-schema/doc-good.out | 4 ++-- >>>>> tests/qapi-schema/doc-good.txt | 2 +- >>>>> tests/qapi-schema/doc-invalid-return.json | 4 ++-- >>>>> tests/qapi-schema/event-case.err | 2 ++ >>>>> tests/qapi-schema/event-case.json | 2 -- >>>>> tests/qapi-schema/event-case.out | 14 -------------- >>>>> tests/qapi-schema/qapi-schema-test.json | 6 +++--- >>>>> tests/qapi-schema/qapi-schema-test.out | 8 ++++---- >>>>> 11 files changed, 22 insertions(+), 34 deletions(-) >>>>> diff --git a/tests/unit/test-qmp-event.c >>>>> b/tests/unit/test-qmp-event.c >>>>> index 047f44ff9a..d58c3b78f2 100644 >>>>> --- a/tests/unit/test-qmp-event.c >>>>> +++ b/tests/unit/test-qmp-event.c >>>>> @@ -143,7 +143,7 @@ static void test_event_d(TestEventData *data, >>>>> static void test_event_deprecated(TestEventData *data, const >>>>> void *unused) >>>>> { >>>>> - data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST-EVENT-FEATURES1' }"); >>>>> + data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST_EVENT_FEATURES1' }"); >>>>> memset(&compat_policy, 0, sizeof(compat_policy)); >>>>> @@ -163,7 +163,7 @@ static void >>>>> test_event_deprecated_data(TestEventData *data, const void *unused) >>>>> { >>>>> memset(&compat_policy, 0, sizeof(compat_policy)); >>>>> - data->expect = qdict_from_jsonf_nofail("{ 'event': >>>>> 'TEST-EVENT-FEATURES0'," >>>>> + data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST_EVENT_FEATURES0'," >>>>> " 'data': { 'foo': 42 } }"); >>>>> qapi_event_send_test_event_features0(42); >>>>> g_assert(data->emitted); >>>>> @@ -172,7 +172,7 @@ static void test_event_deprecated_data(TestEventData *data, const void *unused) >>>>> compat_policy.has_deprecated_output = true; >>>>> compat_policy.deprecated_output = COMPAT_POLICY_OUTPUT_HIDE; >>>>> - data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST-EVENT-FEATURES0' }"); >>>>> + data->expect = qdict_from_jsonf_nofail("{ 'event': 'TEST_EVENT_FEATURES0' }"); >>>>> qapi_event_send_test_event_features0(42); >>>>> g_assert(data->emitted); >>>>> diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py >>>>> index b5fb0be48b..c065505b27 100644 >>>>> --- a/scripts/qapi/expr.py >>>>> +++ b/scripts/qapi/expr.py >>>>> @@ -45,7 +45,9 @@ def check_name_str(name, info, source): >>>>> def check_name_upper(name, info, source): >>>>> stem = check_name_str(name, info, source) >>>>> - # TODO reject '[a-z-]' in @stem >>>>> + if re.search(r'[a-z-]', stem): >>>>> + raise QAPISemError( >>>>> + info, "name of %s must not use lowercase or '-'" % source) >>>>> >>>> >>>> Does a little bit more than check_name_upper. Is this only used for >>>> event names? I guess so. Should it be inlined into check_defn_name_str >>>> instead in this case, or nah? >>> >>> I'd prefer not to inline. I'm open to better function names. >>> >>> We have three name styles. qapi-code-gen.txt: >>> >>> [Type] definitions should always use CamelCase for >>> user-defined type names, while built-in types are lowercase. >>> >>> [...] >>> >>> Command names, and member names within a type, should be all lower >>> case with words separated by a hyphen. [...] >>> >>> Event names should be ALL_CAPS with words separated by underscore. >>> >>> I define three functions for them: check_name_camel(), >>> check_name_lower(), and check_name_upper(). >>> >>> The functions factor out the naming rule aspect, and they let us keep >>> the naming rule aspect together. That's why I'd prefer not to inline. >>> >>> We could name them after their purpose instead: >>> check_name_user_defined_type(), check_name_command_or_member(), >>> check_name_event(). The first two are rather long. Shorter: >>> check_name_type(), check_name_other(), check_name_event(). >>> >>> Thoughts? >>> >> >> The long names are nice and descriptive. > > Then I should give them a try to see whether the result feels neat or > ugly. > I tried my hand at documenting them in my respin; I am not entirely confident I got the names and purposes and semantics exactly right. I didn't try to rename them, but it would be easy to do. You'll have to let me know your preferences. --js