tests/drivers: move all driver tests into own folder #19435

Teufelchen1 · 2023-03-30T14:13:05Z

Hi! 🦅

Contribution description

This moves all tests/driver_*/ to tests/drivers/<driver name>/.
Reason for change is purely esthetic 🐮

Testing procedure

A passing CI should be enough - it should be (manually) checked that the new locations are still covered by it.
./dist/tools/compile_test/compile_like_murdock.py -b native -a tests/drivers/* can be helpful as well.

Teufelchen1 · 2023-03-30T14:14:08Z

tests/Makefile.tests_common

@@ -12,9 +12,6 @@ ifneq (,$(wildcard $(CURDIR)/tests*/.))
  endif
 endif

-ifneq (,$(filter tests_driver_%,$(APPLICATION)))


It is no longer needed to check if the given tests is a driver test. This is now done in the tests/drivers/Makefile.drivers_common

Teufelchen1 · 2023-03-30T14:15:06Z

tests/drivers/Makefile.drivers_common

@@ -0,0 +1,3 @@
+RIOTBASE ?= $(CURDIR)/../../..
+BOARD ?= samr21-xpro


According to the old tests/Makefile.tests_common; All driver tests are run on this board for some reason.

tests/drivers/xbee/main.c

aabadie · 2023-03-30T14:38:02Z

Maybe have a look at #15358 for the build system integration. Otherwise, I'm 👍 for this PR.

makefiles/app_dirs.inc.mk

aabadie · 2023-04-17T09:46:45Z

This needs a rebase

aabadie · 2023-04-17T14:25:57Z

Looks good but I don't know what the problem is with the header guards check...

aabadie · 2023-04-23T14:47:09Z

Sorry, this needs another rebase...

aabadie · 2023-04-23T15:00:43Z

The problem with the header guard check comes from missing updates of symlinks with mrf24j40 and kw2xrf drivers. The following diff fixes the problem locally:

diff --git a/tests/drivers/kw2xrf/common.h b/tests/drivers/kw2xrf/common.h
index e95bd2d8c6..618a21b4fc 120000
--- a/tests/drivers/kw2xrf/common.h
+++ b/tests/drivers/kw2xrf/common.h
@@ -1 +1 @@
-../ieee802154_hal/common.h
\ No newline at end of file
+../../ieee802154_hal/common.h
\ No newline at end of file
diff --git a/tests/drivers/kw2xrf/init_dev.c b/tests/drivers/kw2xrf/init_dev.c
index ddf5f5ff33..f4a4ab83e2 120000
--- a/tests/drivers/kw2xrf/init_dev.c
+++ b/tests/drivers/kw2xrf/init_dev.c
@@ -1 +1 @@
-../ieee802154_hal/init_devs.c
\ No newline at end of file
+../../ieee802154_hal/init_devs.c
\ No newline at end of file
diff --git a/tests/drivers/mrf24j40/common.h b/tests/drivers/mrf24j40/common.h
index e95bd2d8c6..618a21b4fc 120000
--- a/tests/drivers/mrf24j40/common.h
+++ b/tests/drivers/mrf24j40/common.h
@@ -1 +1 @@
-../ieee802154_hal/common.h
\ No newline at end of file
+../../ieee802154_hal/common.h
\ No newline at end of file
diff --git a/tests/drivers/mrf24j40/init_dev.c b/tests/drivers/mrf24j40/init_dev.c
index ddf5f5ff33..f4a4ab83e2 120000
--- a/tests/drivers/mrf24j40/init_dev.c
+++ b/tests/drivers/mrf24j40/init_dev.c
@@ -1 +1 @@
-../ieee802154_hal/init_devs.c
\ No newline at end of file
+../../ieee802154_hal/init_devs.c
\ No newline at end of file

riot-ci · 2023-04-25T09:47:31Z

Murdock results

✔️ PASSED

bb76f13 tests/drivers: move all driver tests into own folder

Success	Failures	Total	Runtime
6931	0	6931	10m:22s

Artifacts

Documentation preview

aabadie · 2023-04-25T10:02:04Z

Not sure what's wrong on Murdock. The error message is error: comsys-minion-0: get_supported_boards failed in tests/ieee802154_security

Teufelchen1 · 2023-04-25T12:34:22Z

Ah! It's probably failing because I overlooked tests/ieee802154_security/Makefile.

[...]
include ../driver_netdev_common/Makefile.netdev.mk

Since drivers/netdev_common is the correct location now, this fails.

I'm no sure how to fix it. Simply correcting the location does not work as the Makefiles in tests/driver/ expect $(curdir) to be there and not in tests/ieee82154_security/.
One option would be to move this test into the drivers folder but that feels wrong, as it is testing a module and not a driver (for a piece of hardware).
Alternatively, netdev_common could be moved back, out of the drivers folder, into tests/. But then it would be used by two* drivers and two** module test. Feels unclean as well.
Lastly, I could just bodge these two and make it "work". But I would rather not.

* atwinc15x0, xbee
** netstats_neighbor, ieee82154_security

aabadie · 2023-04-25T12:37:41Z

Alternatively, netdev_common could be moved back, out of the drivers folder, into tests/. But then it would be used by two* drivers and two** module test. Feels unclean as well.

That option is the least worst IMHO. I'd do that.

Teufelchen1 · 2023-04-25T13:09:44Z

I think it turned out cleaner than anticipated. For ease of review, it's in separate commit. I will squash after review. :)

aabadie · 2023-04-25T13:25:11Z

Murdock is still complaining: error: mobi3: get_supported_boards failed in tests/netdev_common. You might have to keep the "include ../Makefile.tests_common" in its Makefile for some reason.

aabadie

Murdock is green and changes are good IMHO. Please squash!

ACK

aabadie · 2023-04-28T09:15:34Z

bors merge

19435: tests/drivers: move all driver tests into own folder r=aabadie a=Teufelchen1 Hi! 🦅 ### Contribution description This moves all `tests/driver_*/` to `tests/drivers/<driver name>/`. Reason for change is purely esthetic 🐮 ### Testing procedure A passing CI should be enough - it should be (manually) checked that the new locations are still covered by it. `./dist/tools/compile_test/compile_like_murdock.py -b native -a tests/drivers/*` can be helpful as well. Co-authored-by: Teufelchen1 <bennet.blischke@haw-hamburg.de>

bors · 2023-04-28T11:31:48Z

Build failed:

Murdock

aabadie · 2023-05-03T07:45:46Z

Murdock failed and now this needs another rebase...

aabadie · 2023-05-04T15:37:34Z

bors merge

bors · 2023-05-04T17:37:39Z

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

gschorcht · 2023-05-05T06:59:59Z

Why are there still some driver_xxx test applications in tests and have not been moved to tests/drivers?

$~> ls -1d tests/driver_*
tests/driver_htu21d 
tests/driver_sdcard_spi 
tests/driver_vl53l1x
tests/driver_vl53l1x_st_api
tests/driver_ws281x

aabadie · 2023-05-05T07:34:14Z

Why are there still some driver_xxx test applications in tests and have not been moved to tests/drivers?

They were simply missed I think, even by the reviewer :)

gschorcht · 2023-05-05T07:48:05Z

These are pretty old test applications. Therefore, I was wondering whether there was a special reason for not moving them to tests/drivers.

aabadie · 2023-05-05T07:49:43Z

I'll open a PR in a moment to fix the problem

gschorcht · 2023-05-05T07:52:54Z

BTW, it is a very nice cleanup that makes the navigation in test applications much easier. I wished we had such a change for tests/pkg_*, tests/gnrc_*, tests/periph_*, tests/zimer_* ...

aabadie · 2023-05-05T07:58:36Z

Actually, all driver applications in tests were moved. It's just that the directories remains if they contain artifacts. Use git clean -fxx tests/driver_* and you'll see that all driver applications are now in tests/drivers/

Teufelchen1 requested review from leandrolanzieri, jia200x, MrKevinWeiss, miri64, jeandudey, smlng, aabadie, MichelRottleuthner and fjmolinas as code owners March 30, 2023 14:13

github-actions bot added Area: build system Area: Build system Area: doc Area: Documentation Area: Kconfig Area: Kconfig integration Area: tests Area: tests and testing framework labels Mar 30, 2023

Teufelchen1 commented Mar 30, 2023

View reviewed changes

tests/drivers/xbee/main.c Outdated Show resolved Hide resolved

Teufelchen1 commented Apr 13, 2023

View reviewed changes

makefiles/app_dirs.inc.mk Show resolved Hide resolved

aabadie reviewed Apr 14, 2023

View reviewed changes

makefiles/app_dirs.inc.mk Show resolved Hide resolved

Teufelchen1 force-pushed the feat/driver_dir branch from 367cd3a to fb6a582 Compare April 17, 2023 08:14

Teufelchen1 force-pushed the feat/driver_dir branch from fb6a582 to 7117c96 Compare April 17, 2023 13:10

Teufelchen1 force-pushed the feat/driver_dir branch from 7117c96 to 08c707b Compare April 24, 2023 14:49

aabadie added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Apr 25, 2023

Teufelchen1 force-pushed the feat/driver_dir branch from 1c2ae4a to c68b1e6 Compare April 25, 2023 13:08

Teufelchen1 force-pushed the feat/driver_dir branch from c68b1e6 to 14efca8 Compare April 25, 2023 13:48

aabadie approved these changes Apr 26, 2023

View reviewed changes

Teufelchen1 force-pushed the feat/driver_dir branch from 14efca8 to 09a7b74 Compare April 27, 2023 10:50

tests/drivers: move all driver tests into own folder

bb76f13

Teufelchen1 force-pushed the feat/driver_dir branch from 09a7b74 to bb76f13 Compare May 4, 2023 14:35

bors bot merged commit 77bd7d0 into RIOT-OS:master May 4, 2023

benpicco added this to the Release 2023.07 milestone Aug 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tests/drivers: move all driver tests into own folder #19435

tests/drivers: move all driver tests into own folder #19435

Teufelchen1 commented Mar 30, 2023

Teufelchen1 Mar 30, 2023

Teufelchen1 Mar 30, 2023

aabadie commented Mar 30, 2023

aabadie commented Apr 17, 2023

aabadie commented Apr 17, 2023

aabadie commented Apr 23, 2023

aabadie commented Apr 23, 2023

riot-ci commented Apr 25, 2023 •

edited

Loading

aabadie commented Apr 25, 2023

Teufelchen1 commented Apr 25, 2023

aabadie commented Apr 25, 2023

Teufelchen1 commented Apr 25, 2023

aabadie commented Apr 25, 2023

aabadie left a comment

aabadie commented Apr 28, 2023

bors bot commented Apr 28, 2023

aabadie commented May 3, 2023

aabadie commented May 4, 2023

bors bot commented May 4, 2023

gschorcht commented May 5, 2023

aabadie commented May 5, 2023

gschorcht commented May 5, 2023

aabadie commented May 5, 2023

gschorcht commented May 5, 2023

aabadie commented May 5, 2023

		@@ -0,0 +1,3 @@
		RIOTBASE ?= $(CURDIR)/../../..
		BOARD ?= samr21-xpro

tests/drivers: move all driver tests into own folder #19435

tests/drivers: move all driver tests into own folder #19435

Conversation

Teufelchen1 commented Mar 30, 2023

Contribution description

Testing procedure

Teufelchen1 Mar 30, 2023

Choose a reason for hiding this comment

Teufelchen1 Mar 30, 2023

Choose a reason for hiding this comment

aabadie commented Mar 30, 2023

aabadie commented Apr 17, 2023

aabadie commented Apr 17, 2023

aabadie commented Apr 23, 2023

aabadie commented Apr 23, 2023

riot-ci commented Apr 25, 2023 • edited Loading

Murdock results

Artifacts

aabadie commented Apr 25, 2023

Teufelchen1 commented Apr 25, 2023

aabadie commented Apr 25, 2023

Teufelchen1 commented Apr 25, 2023

aabadie commented Apr 25, 2023

aabadie left a comment

Choose a reason for hiding this comment

aabadie commented Apr 28, 2023

bors bot commented Apr 28, 2023

aabadie commented May 3, 2023

aabadie commented May 4, 2023

bors bot commented May 4, 2023

gschorcht commented May 5, 2023

aabadie commented May 5, 2023

gschorcht commented May 5, 2023

aabadie commented May 5, 2023

gschorcht commented May 5, 2023

aabadie commented May 5, 2023

riot-ci commented Apr 25, 2023 •

edited

Loading