The Project Structure

Organizing Your Project for Success

To streamline integration and maintainability, Erbsland UnitTest is designed to be included as a Git submodule within your project. We recommend the following directory structure for a sample project called erbsland-unittest-example:

erbsland-unittest-example
    ├── <libraries>         # All dependent libraries for the `Example` project (submodules)
    ├── erbsland-unittest   # The Erbsland UnitTest library added as a submodule
    ├── example-lib         # The "Example" project being tested (also added as a submodule)
    │   ├── src (...)
    │   └── CMakeLists.txt
    ├── unittest            # The actual unit tests, containing one or more test binaries
    │   ├── src             # Source files for the unit tests
    │   │   ├── main.cpp           # Main entry point for the unit test executable
    │   │   ├── BasicTest.hpp      # Each test set resides in a file ending with ...Test.hpp
    │   │   ├── ContextTest.hpp    # Each file contains a test class matching the file name
    │   │   └── LongTest.hpp
    │   ├── data            # Supporting data for unit tests
    │   └── CMakeLists.txt
    └── CMakeLists.txt      # The root project's CMake configuration file

This structure ensures your project is:

  • Well-Organized: Clear separation of libraries, application code, and tests.

  • Easy to Navigate: Simplifies locating files and understanding dependencies.

  • Straightforward to Manage: Facilitates efficient integration and testing of libraries and applications.

Create the Structure

To get started, create the recommended directory structure and initialize the necessary submodules:

cd ~
mkdir erbsland-unittest-example
cd erbsland-unittest-example
git init
git submodule add https://github.com/erbsland-dev/erbsland-unittest.git erbsland-unittest
git submodule init erbsland-unittest

Next, add the application or library you wish to test, along with any dependencies, as submodules to the project:

git submodule add https://github.com/erbsland-dev/erbsland-unittest-example-lib.git example-lib
git submodule init example-lib

By including each component as a submodule, you ensure that everything is version-controlled, organized, and manageable within a single repository.

Why Use This Structure?

  • Modularity: Each part of your project is modular, promoting clean and scalable development.

  • Version Control: Submodules allow you to track specific versions of dependencies, ensuring consistency.

  • Ease of Maintenance: Makes it easy to update libraries and track changes over time.

Proceed to the CMake Configuration →

About the Command-Line Examples

Throughout this guide, command-line examples demonstrate essential setup tasks such as:

  • Adding submodules using the git command.

  • Creating directories with mkdir.

  • Editing files using a text editor like nano.

While these examples use the command-line interface for accessibility and clarity, you are free to use your preferred tools and workflows to achieve the same results.