Skip to content

Writing Unit Tests Part 5: Creating the Implementation Stub

In this Section

In this section of the tutorial, you will be repeating the steps you used to create an implementation stub for MathSender.

Create a Directory for the Unit Tests

In Components/MathReceiver, create a directory called test/ut 

# In: MathReceiver
mkdir -p test/ut

Add the unit test to the build. Absolutely make sure that this is BELOW the existing stuff in the CMakeLists.txt:

# In: MathReceiver/CMakeLists.txt
# Below: register_fprime_module()

set(UT_SOURCE_FILES
  "${CMAKE_CURRENT_LIST_DIR}/MathReceiver.fpp"
)
set(UT_AUTO_HELPERS ON)
register_fprime_ut()

Generate the unit test stub

Generate a stub implementation of the unit tests.

# In: MathReceiver
fprime-util impl --ut

These commands may take a while to run.

You haved just generate three new files MathReceiverTester.cpp MathReceiverTester.hpp MathReceiverTestMain.cpp. Move these files to the test/ut directory in MathReceiver using:

# In: MathReceiver
mv MathReceiverTester.* MathReceiverTestMain.cpp test/ut

Add MathReceiverTester.cpp and MathReceiverTestMain.cpp to the build. Do so by editing the CMakeLists.txt in MathReceiver: 

# In: MathReceiver/CMakeLists.txt 
set(UT_SOURCE_FILES
  "${CMAKE_CURRENT_LIST_DIR}/MathReceiver.fpp"
  "${CMAKE_CURRENT_LIST_DIR}/test/ut/MathReceiverTester.cpp"
  "${CMAKE_CURRENT_LIST_DIR}/test/ut/MathReceiverTestMain.cpp"
)
set(UT_AUTO_HELPERS ON)
register_fprime_ut()

Note: most of this is from a few steps ago, you will only be adding two lines in this step.

Build the unit test in MathReceiver:

# In: MathReceiver
fprime-util build --ut

Don't forget to add --ut or else you are just going to build the component again.

Preparing for Random Testing

Complete the following steps to prepare for random testing. 

// In: MathReceiverTester.cpp
#include "MathReceiverTester.hpp"
#include "STest/Pick/Pick.hpp"

// In: MathReceiverTestMain.cpp
#include "MathReceiverTester.hpp"
#include "STest/Random/Random.hpp"

// In: MathReceiverTestMain.cpp
// Within: int main(){
STest::Random::seed();

# In: /MathReceiver/CMakeLists.txt
# Above: register_fprime_ut()
set(UT_MOD_DEPS STest)

Summary

In this section you have setup implementation stubs to begin writing unit tests for MathReceiver.

Next: Writing Unit Tests 6