Skip to content

Suggested structure for library creation not compatible with unit testing #372

Open
@mattbaker-digital

Description

@mattbaker-digital

librarymanager/creating.rstsuggests placing library related source code in the src directory. In the example, HelloWorld.cpp would typically contain definitions for forward declarations in HelloWorld.h. If you attempt to run unit tests on any of the definitions in the separate source file, it will fail with linker errors (undefined reference to ... because files in the src directory are not compiled when running unit tests by default.

To overcome this issue, you would have to enable test_build_src which, according to advanced/unit-testing/structure/shared-code.rst, is not recommended.

It would seem that a better option is to place the files in the lib directory inside a module specific directory:

    ├── examples
    │   └── echo
    ├── lib
    │   └── HelloWorld
    │       ├── HelloWorld.h
    │       └── HelloWorld.cpp
    ├── library.json
    ├── src
    │   └── main.cpp
    └── test
        └── test_hello_world.cpp

Based on limited testing, the HelloWorld files must be in a sub-directory of lib, otherwise they wont be found by the Library Dependency Finder.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions