Hey folks,
I am working a little bit on fixing `scons check` on develop. During that I found out how we test the different devices (the code is in `release/tests`). Unfortunately the files in `release/tests` only cover a small subset of what should be supported on the different devices. Also since almost no one knows of the existence of these files (or at least I did not until tonight) it is difficult to keep them up to date with a changing API.
Thus I want to propose including small snippets of code with the peripheral drivers. We could add a new tag to the `driver.xml` files, something like <compile-test></compile-test> that point to a file that contains something like e.g.:
GpioOutputA0::setOutput(); GpioOutputA0::setOutput(xpcc::Gpio::High); GpioOutputA0::set(); GpioOutputA0::reset(); GpioOutputA0::toggle();
GpioInputA1::setInput(); GpioInputA1::read();
GpioA2::setOutput(); GpioA2::set(); GpioA2::setInput(); GpioA2::read();
for the stm32/gpio driver.
Then `scons check` can go ahead and build a compile test program by looking at the drivers that a available for a specific device. Also we could add a flag to tell `scons check` only to check a certain driver, i.d. only build files for devices that require said driver and only include the tests of said driver in the test files.
Doing this will make the tests more complete and easier to keep up to date. However there might be some things that I overlooked since the idea just popped into my head. So I would be happy to hear your comments on this issue.
Kevin
Zeige Antworten nach Diskussionsstrang
Hello Kevin,
[...] Also since almost no one knows of the existence of these files (or at least I did not until tonight) [...]
Which picks up on my point of our last meeting about documentation. We must document what we are doing otherwise this will happen all the time! And it will only get worse if we don't do it at least for the new stuff!
Thus I want to propose including small snippets of code with the peripheral drivers. We could add a new tag to the `driver.xml` files, something like <compile-test></compile-test> that point to a file that contains something like e.g.:
GpioOutputA0::setOutput(); GpioOutputA0::setOutput(xpcc::Gpio::High); GpioOutputA0::set(); GpioOutputA0::reset(); GpioOutputA0::toggle(); GpioInputA1::setInput(); GpioInputA1::read(); GpioA2::setOutput(); GpioA2::set(); GpioA2::setInput(); GpioA2::read();for the stm32/gpio driver.
I don't think this will work very well. Often you will need something more, for example some include files etc. which would not fit in this scheme.
Cheers, Fabian
-
Fabian Greif -
Kevin Laeufer