Is there a way to compile only partial (private) libraries (here: components) for specific (testing) environments? For example using subdirectories?
I would like to structure the source files of my project with two levels:
- on a “component” level
- on a “unit” level
Any similarities to terms used in PIO documentation is not intentional.
And I would like to test those units using dedicated environments (using
platform = native).
The PlatformIO documentation explains:
By default, PlatformIO does not build the main source code from the
src_dirfolder in pair with a test source code. […] We recommend splitting the source code into multiple components and placing them into the
lib_dir(project’s private libraries and components).
Thus I put my components into the
The component level shall represent architectural boundaries. Different directories shall represent different parts of the software. These parts may change for different reasons. The Dependency Rule is checked for those components. The component directories shall be within one common directory (
The units shall be software parts which are tested individually. Unity is used for unit tests. Units shall be tested isolated. A test for one unit shall not require to compile separate source files which are not under test. Units are part of components. Testing a single unit shall not require to compile the the whole component. This shall simplify mocking. Also this shall simplify to avoid dependencies to code which does not compile with the test environment. For example when I test a unit on the native platform I do not want that neighboring units from the same component are also compiled which may not be compatible to that platform.
My problem is, that:
- When I try to test a unit, the other source files outside of the unit directory (
lib/comp1/unit1), which are in the same component directory (
lib/comp1) are also compiled (using
lib_ldf_mode = chain). This is bad, as those may have other requirements for building, in particular other dependencies which may not compile for the test environment.
- If I set
lib_ldf_mode = offthe source for the UUT is not found. But I can not add the source explicitly to the LDF, as subdirectories can not be specified using for example
lib_deps = comp1/unit1. Or is there a way to specifiy a subdirectory
lib_ldf_mode = offand
lib_deps = comp1does attempt to build every source file in that directory (which may fail, see above).