Skip to content

Latest commit

 

History

History

06_unit_tests

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
include
include
 
 
src
src
 
 
subprojects
subprojects
 
 
tests
tests
 
 
CMakeLists.txt
CMakeLists.txt
 
 
README.md
README.md
 
 
main.cc
main.cc
 
 
meson.build
meson.build
 
 

README.md

How to handle unit tests

In this example we make the first steps in the Test-driven Development (TDD). We use google tests to implement the unit tests. For the sake of simplicity, the code does not use boost program_options lib.

$ tree -I "*md" 
.
├── CMakeLists.txt
├── include
│   └── constants.h
├── main.cc
├── meson.build
├── README.md
├── src
│   ├── CMakeLists.txt
│   ├── mathematics
│   │   ├── CMakeLists.txt
│   │   ├── mathematics.cc
│   │   ├── mathematics.h
│   │   └── meson.build
│   ├── meson.build
│   └── physics
│       ├── CMakeLists.txt
│       ├── meson.build
│       ├── physics.cc
│       └── physics.h
├── subprojects <--------------------------------
│   ├── catch2.wrap 
│   └── gtest.wrap 
└── tests
    ├── CMakeLists.txt
    ├── integration_tests
    │   ├── 01.input
    │   ├── 01.output
    │   ├── 02.input
    │   ├── 02.output
    │   ├── CMakeLists.txt
    │   ├── compare.sh
    │   └── meson.build
    ├── meson.build
    └── unit_tests <-----------------------------
        ├── catch2
        │   ├── catch.cpp
        │   ├── CMakeLists.txt
        │   ├── mathematics_01_catch.cpp
        │   ├── meson.build
        │   └── physics_01_catch.cpp
        ├── CMakeLists.txt
        ├── gtest
        │   ├── CMakeLists.txt
        │   ├── mathematics_01.cc
        │   ├── meson.build
        │   └── physics_01.cc
        └── meson.build

gtest

You can find very nice documentation in the repo. A recap of the basic macros is reported here.

catch2

Take a look at the doc

How to use it in build system tools

  • There are different ways to use gtest with CMake (e.g. see here). I propose one that handles all the details by hand.

  • catch2 can be used with CMake, even though there is not an official way to do it. I'll propose mine :)

  • In meson, things are easier thanks to meson wrap.

CMake

  • Create a file CMakeLists.txt (case sensitive) with proper commands

  • Create a build directory and cd in it (e.g. mkdir build_cmake && cd build_cmake)

  • Run cmake /path/to/CMakeLists.txt -DVARIABLE_NAME=val (e.g.

    cmake -DGTEST_DIR=/path/to/gtest/ -DCATCH_DIR=/path/to/catch2 ..)

  • Compile with make

  • Run the tests with ctest

CMake useful commands
set(GTEST_DIR "" CACHE PATH "google test dir")

find_package(Threads REQUIRED) # gtest requires pthread

# remember to link the executable called by the test against the library ${CMAKE_THREAD_LIBS_INIT}

Meson

  • Create a file meson.build with proper commands

  • Populate the build directory and go there

    • you can ask to meson to create it

      meson build_meson && cd build_meson

    • or you create it and call meson from there mkdir build_meson && cd build_meson

      mkdir build_meson && cd build_meson && meson ..

  • Compile with ninja

  • Run the tests with meson test or ninja test

Meson useful commands
gtest = dependency('gtest',
                   fallback : ['gtest', 'gtest_main_dep'],  # magic of meson wrap
                   required: true)

# remember to add gtest to the depencies of the executable called in the test function

mutatis mutandis for catch2