linux-kernel - Re: [PATCH 1/7] HID: uclogic: KUnit best practices and naming conventions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20220711161646.GA10528@elementary>
Date:   Mon, 11 Jul 2022 18:16:46 +0200
From:   José Expósito <jose.exposito89@...il.com>
To:     Daniel Latypov <dlatypov@...gle.com>
Cc:     jikos@...nel.org, benjamin.tissoires@...hat.com, spbnick@...il.com,
        j.witteveen@...il.com, stefanberzl@...il.com,
        linux-input@...r.kernel.org, linux-kernel@...r.kernel.org,
        kunit-dev@...glegroups.com
Subject: Re: [PATCH 1/7] HID: uclogic: KUnit best practices and naming
 conventions

Hi Daniel,

On Mon, Jul 11, 2022 at 07:41:53AM -0700, Daniel Latypov wrote:
> On Sun, Jul 10, 2022 at 10:51 AM José Expósito
> <jose.exposito89@...il.com> wrote:
> >
> > The KUnit documentation [1] suggests allowing build tests as a module.
> >
> > In addition, it is recommended [2] to use snake case names for
> > kunit_suite and test cases.
> 
> Test parameters don't fall under "test cases", though I see how that
> can be construed as such.
> I don't think anyone has stated any preference to standardize the naming there.
> 
> We currently have parameterized tests using spaces and punctuation, e.g.
> ok 7 - binfmt_elf
>     # Subtest: ext4_inode_test
>     1..1
>         # Subtest: inode_test_xtimestamp_decoding
>         ok 1 - 1901-12-13 Lower bound of 32bit < 0 timestamp, no extra bits
>         ok 2 - 1969-12-31 Upper bound of 32bit < 0 timestamp, no extra bits
> ...
>     ok 1 - mctp_test_fragment
>         # Subtest: mctp_test_rx_input
>         ok 1 - {1,a,8,0}
>         ok 2 - {1,a,9,0}
>         ok 3 - {2,a,8,0}
> 
> So I think the old names were more conventional.

I changed the names to be consistent with other tests I'm working on
present in "gpu/drm/tests/drm_format_helper_test.c".

My first version there used full sentences for the test cases, but, if
I remember correctly, it was suggested to use snake case.

I don't have a strong preference about using one approach or the other.
If there is not a rule, I'd prefer to be consistent with the work I'm
doing in the DRM subsystem to avoid mixing notation or refactoring
there, but I'm open to change it.

> > Change the Kconfig entry from bool to tristate and stick to the naming
> > conventions to avoid style issues with future tests.
> >
> > Link: https://docs.kernel.org/dev-tools/kunit/style.html#test-kconfig-entries  [1]
> > Link: https://www.kernel.org/doc/html/latest/dev-tools/kunit/style.html  [2]
> > Signed-off-by: José Expósito <jose.exposito89@...il.com>
> 
> Everything else (renaming the suite and switching to tristate) sounds
> good to me though.
> 
> Acked-by: Daniel Latypov <dlatypov@...gle.com>

Thanks a lot for your review! I'll wait a couple of days before
sending v2 with the Acked-by tag just in case you or somebody else
wants to add more comments.

Best wishes,
Jose