Skip to contentSkip to conversation

lib/list_kunit: Follow new file name convention for KUnit tests

PATCH Superseded Andy Shevchenko 3 participants 12 messages Oct 15, 2020 – Oct 17, 2020

Subsystems (2)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/3 lib/list_kunit: Follow new file name convention for KUnit tests

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

---
v2: followed new convention

 MAINTAINERS                       | 2 +-
 lib/Makefile                      | 2 +-
 lib/{list-test.c => list_kunit.c} | 0
 3 files changed, 2 insertions(+), 2 deletions(-)
 rename lib/{list-test.c => list_kunit.c} (100%)
MAINTAINERS +1 -1
index 4538378de6f5..20facbca9388 100644
@@ -10188,7 +10188,7 @@ M:	David Gow <[email protected]>
 L:	[email protected]
 L:	[email protected]
 S:	Maintained
-F:	lib/list-test.c
+F:	lib/list_kunit.c
 
 LIVE PATCHING
 M:	Josh Poimboeuf <[email protected]>
lib/Makefile +1 -1
index 5ca03ba6ee45..1a5e6a6ebe8d 100644
@@ -350,6 +350,6 @@ obj-$(CONFIG_PLDMFW) += pldmfw/
 
 # KUnit tests
 obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o
-obj-$(CONFIG_LIST_KUNIT_TEST) += list-test.o
+obj-$(CONFIG_LIST_KUNIT_TEST) += list_kunit.o
 obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o
 obj-$(CONFIG_BITS_TEST) += test_bits.o
lib/list_kunit.c renamed from lib/list-test.c +0 -0
similarity index 100%
rename from lib/list-test.c
rename to lib/list_kunit.c
Signature · 1 line
2.28.0
#1 lore raw

PATCH v2 2/3 lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

Cc Mark Brown <[email protected]>
Cc Matti Vaittinen <[email protected]>

---
v2: new patch

 MAINTAINERS                                         | 3 +--
 lib/Makefile                                        | 2 +-
 lib/{test_linear_ranges.c => linear_ranges_kunit.c} | 0
 3 files changed, 2 insertions(+), 3 deletions(-)
 rename lib/{test_linear_ranges.c => linear_ranges_kunit.c} (100%)
MAINTAINERS +1 -2
index 20facbca9388..249417a036f9 100644
@@ -10069,8 +10069,7 @@ F:	include/uapi/linux/lightnvm.h
 LINEAR RANGES HELPERS
 M:	Mark Brown <[email protected]>
 R:	Matti Vaittinen <[email protected]>
-F:	lib/linear_ranges.c
-F:	lib/test_linear_ranges.c
+F:	lib/linear_ranges*.c
 F:	include/linux/linear_range.h
 
 LINUX FOR POWER MACINTOSH
lib/Makefile +1 -1
index 1a5e6a6ebe8d..5c18519d6733 100644
@@ -350,6 +350,6 @@ obj-$(CONFIG_PLDMFW) += pldmfw/
 
 # KUnit tests
 obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o
+obj-$(CONFIG_LINEAR_RANGES_TEST) += linear_ranges_kunit.o
 obj-$(CONFIG_LIST_KUNIT_TEST) += list_kunit.o
-obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o
 obj-$(CONFIG_BITS_TEST) += test_bits.o
lib/linear_ranges_kunit.c renamed from lib/test_linear_ranges.c +0 -0
similarity index 100%
rename from lib/test_linear_ranges.c
rename to lib/linear_ranges_kunit.c
Signature · 1 line
2.28.0
Reviewed-by on v2 2/3
#2 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Quoted 9 lines · Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

Cc Mark Brown <[email protected]>
Cc Matti Vaittinen <[email protected]>

Thanks. This looks good to me from an "I tested it and it worked" and a "matches the naming guidelines" point of view.

(Since the naming documentation isn't actually in Linus' branch yet, I'll drop a link to it here:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit
)

I'm not the test author though, and the naming doc does explicitly leave the possibility of keeping the old filenames for tests if there's a particularly good reason to (e.g., a lot depending on the module name). I'm not aware of any such thing, and so am in favour of the rename, but will defer to the test authors on that point if they object.

Either way,

Cheers,
-- David

#3 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Quoted 20 lines · David Gow
Quoted 9 lines · Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

Cc Mark Brown <[email protected]>
Cc Matti Vaittinen <[email protected]>

Thanks. This looks good to me from an "I tested it and it worked" and a "matches the naming guidelines" point of view.

(Since the naming documentation isn't actually in Linus' branch yet, I'll drop a link to it here:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit
)

Quoted 4 lines

I'm not the test author though, and the naming doc does explicitly leave the possibility of keeping the old filenames for tests if there's a particularly good reason to (e.g., a lot depending on the module name).

Can you point out to this? Briefly looking into I haven't found that.

Quoted 6 lines

I'm not aware of any such thing, and so am in favour of the rename, but will defer to the test authors on that point if they object.

Either way,

Thanks!

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#4 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Quoted 22 lines · Andy Shevchenko
Quoted 20 lines · David Gow
Quoted 9 lines · Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

Cc Mark Brown <[email protected]>
Cc Matti Vaittinen <[email protected]>

Thanks. This looks good to me from an "I tested it and it worked" and a "matches the naming guidelines" point of view.

(Since the naming documentation isn't actually in Linus' branch yet, I'll drop a link to it here:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit
)

Quoted 6 lines
Quoted 4 lines

I'm not the test author though, and the naming doc does explicitly leave the possibility of keeping the old filenames for tests if there's a particularly good reason to (e.g., a lot depending on the module name).

Can you point out to this? Briefly looking into I haven't found that.

This was what was intended by the first "exemption" listed[1] at the beginning of the document:
"It's recommended that you only deviate from these guidelines when:
[...] Porting tests to KUnit which are already known with an existing name"

Admittedly, this test was originally a KUnit test, rather than a port of another test, so the exact wording probably doesn't apply here, but that's more an artefact of the naming guidelines landing after this test did.

The goal here is really just to make sure that existing test modules can be ported to KUnit without breaking existing users which may depend on the name. It doesn't look like that applies for this test, though.

Cheers,
-- David

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit#n13

#5 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

In reply to Andy Shevchenko
Quoted 4 lines · Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

I'm missing the rest of this series - what's the story with dependencies here?

#6 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Quoted 8 lines · Mark Brown
Quoted 4 lines · Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

I'm missing the rest of this series - what's the story with dependencies here?

There is a dependency in Makefile. Do you want me to send a new version with Cc'ing you all?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#7 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Quoted 8 lines · Andy Shevchenko
Quoted 4 lines · Mark Brown

On Thu, Oct 15, 2020 at 09:44:15PM +0300, Andy Shevchenko wrote:

I'm missing the rest of this series - what's the story with dependencies here?

There is a dependency in Makefile. Do you want me to send a new version with Cc'ing you all?

v3 has been sent.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#8 lore raw

Re: [PATCH v2 2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

In reply to Andy Shevchenko
Quoted 7 lines · Andy Shevchenko
Quoted 2 lines · Mark Brown

I'm missing the rest of this series - what's the story with dependencies here?

There is a dependency in Makefile. Do you want me to send a new version with Cc'ing you all?

It's fine this time but please don't do this in future, people need at least a cover letter so they know how things rae related to each other.

#9 lore raw

PATCH v2 3/3 lib/bits_kunit: Follow new file name convention for KUnit tests

In reply to Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

---
v2: new patch

 lib/Makefile                      | 2 +-
 lib/{test_bits.c => bits_kunit.c} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename lib/{test_bits.c => bits_kunit.c} (100%)
lib/Makefile +1 -1
index 5c18519d6733..70a4a21ff5d6 100644
@@ -350,6 +350,6 @@ obj-$(CONFIG_PLDMFW) += pldmfw/
 
 # KUnit tests
 obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o
+obj-$(CONFIG_BITS_TEST) += bits_kunit.o
 obj-$(CONFIG_LINEAR_RANGES_TEST) += linear_ranges_kunit.o
 obj-$(CONFIG_LIST_KUNIT_TEST) += list_kunit.o
-obj-$(CONFIG_BITS_TEST) += test_bits.o
lib/bits_kunit.c renamed from lib/test_bits.c +0 -0
similarity index 100%
rename from lib/test_bits.c
rename to lib/bits_kunit.c
Signature · 1 line
2.28.0
Reviewed-by on v2 3/3
#10 lore raw

Re: [PATCH v2 3/3] lib/bits_kunit: Follow new file name convention for KUnit tests

Quoted 7 lines · Andy Shevchenko

Follow new file name convention for the KUnit tests. Since we have lib/*test*.c in a few variations, use 'kunit' suffix to distinguish usual test cases with KUnit-based ones.

Again, this worked and looks good to me. Apart from noting that the module name will change (so if people are depending on that, it'll break things), I'm all in favour of this.

For the record (since it's not quite upstream yet), the naming documentation referenced is currently available here:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit

Anyway,

Thanks,
-- David