fsfw/tests/user/CMakeLists.txt

################################################################################
# CMake support for the Flight Software Framework Tests
# Author: R. Mueller
################################################################################

################################################################################
# Pre-Project preparation
################################################################################
cmake_minimum_required(VERSION 3.13)

# set(CMAKE_VERBOSE TRUE)
# set(CODE_COVERAGE_VERBOSE TRUE)

set(CMAKE_SCRIPT_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")

option(TMTC_TEST "Build binary for manual or automatic TMTC tests" FALSE)
option(GENERATE_COVERAGE 
	"Specify whether coverage data is generated with GCOV" 
	TRUE
)

set(FSFW_ADD_UNITTESTS ON)

if(TMTC_TEST)
	set(LINK_CATCH2 FALSE)
else()
	set(LINK_CATCH2 TRUE)
endif()

# Tests can be built with the Host OSAL or with the Linux OSAL.
if(NOT FSFW_OSAL)
	set(FSFW_OSAL host CACHE STRING "OS for the FSFW.")
endif()

option(CUSTOM_UNITTEST_RUNNER 
	"Specify whether custom main or Catch2 main is used" TRUE
)

# Project Name
project(fsfw-tests C CXX)

################################################################################
# Pre-Sources preparation
################################################################################

# Specify the C++ standard
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

# Set names and variables
set(TARGET_NAME ${CMAKE_PROJECT_NAME}) 
if(CUSTOM_UNITTEST_RUNNER)
	set(CATCH2_TARGET Catch2)
else()
	set(CATCH2_TARGET Catch2WithMain)
endif()
set(LIB_FSFW_NAME fsfw)

# Set path names
set(FSFW_PATH fsfw)
set(CATCH2_PATH Catch2)
set(FSFW_TESTS_PATH fsfw/unittest)
set(TEST_SETUP_PATH unittest)
set(TMTC_TEST_PATH tests)

# Analyse different OS and architecture/target options and
# determine BSP_PATH

# FreeRTOS
if(FSFW_OSAL STREQUAL linux)
	add_definitions(-DUNIX -DLINUX)	
	find_package(Threads REQUIRED)
# Hosted
else()
	if(WIN32)
    	add_definitions(-DWIN32)
	elseif(UNIX)
		find_package(Threads REQUIRED)
		add_definitions(-DUNIX -DLINUX)	
	endif()
endif()

if(GENERATE_COVERAGE)
	list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/cmake-modules)
	if(CMAKE_COMPILER_IS_GNUCXX)
    	include(CodeCoverage)
    	# Add compile options on target base, we don't want coverage for Catch2
    	# append_coverage_compiler_flags()
   	endif()
endif()

set(FSFW_CONFIG_PATH testcfg)
set(FSFW_ADDITIONAL_INC_PATHS ${CMAKE_CURRENT_BINARY_DIR})

configure_file(${FSFW_CONFIG_PATH}/FSFWConfig.h.in FSFWConfig.h)
configure_file(${FSFW_CONFIG_PATH}/OBSWConfig.h.in OBSWConfig.h)
configure_file(${FSFW_CONFIG_PATH}/TestsConfig.h.in TestsConfig.h)

################################################################################
# Executable and Sources
################################################################################

# Add executable
add_executable(${TARGET_NAME})

# Add subdirectories
add_subdirectory(${FSFW_PATH})
add_subdirectory(${FSFW_CONFIG_PATH})

if(LINK_CATCH2)
	add_subdirectory(${CATCH2_PATH})
	add_subdirectory(${TEST_SETUP_PATH})
else()
	target_compile_definitions(${TARGET_NAME} PRIVATE
		FSFW_DISABLE_PRINTOUT=0
	)
	target_compile_definitions(${LIB_FSFW_NAME} PRIVATE	
		FSFW_DISABLE_PRINTOUT=0
	)
	add_subdirectory(${TMTC_TEST_PATH})
	add_subdirectory(${FSFW_TESTS_PATH})
endif()


################################################################################
# Post-Sources preparation
################################################################################

# Add libraries for all sources.
target_link_libraries(${TARGET_NAME} PRIVATE
	${LIB_FSFW_NAME} 
)

if(LINK_CATCH2)
	target_link_libraries(${TARGET_NAME} PRIVATE
		${CATCH2_TARGET}
	)
endif()

if(GENERATE_COVERAGE)
	if(CMAKE_COMPILER_IS_GNUCXX)
		# set(CODE_COVERAGE_VERBOSE TRUE)
    	include(CodeCoverage)
    	
    	# Remove quotes.
    	separate_arguments(COVERAGE_COMPILER_FLAGS 
    		NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}"
    	)
    	
    	# Add compile options manually, we don't want coverage for Catch2
    	target_compile_options(${TARGET_NAME} PRIVATE
    		"${COVERAGE_COMPILER_FLAGS}"
    	)
    	target_compile_options(${LIB_FSFW_NAME} PRIVATE
    		"${COVERAGE_COMPILER_FLAGS}"
    	)
    	
		# Exclude internal unittest from coverage for now.
    	if(WIN32)
			set(GCOVR_ADDITIONAL_ARGS 
				"--exclude-throw-branches"
				"--exclude-unreachable-branches"
			)
			set(COVERAGE_EXCLUDES
				"/c/msys64/mingw64/*" "Catch2"
				"${CMAKE_CURRENT_SOURCE_DIR}/fsfw/unittest/internal"
			)
		elseif(UNIX)
			set(COVERAGE_EXCLUDES
				"/usr/include/*" "/usr/bin/*" "Catch2/*"
				"fsfw/unittest/internal/*"
			)
		endif()
    	
		target_link_options(${TARGET_NAME} PRIVATE
			-fprofile-arcs
			-ftest-coverage
    	)
    	target_link_options(${LIB_FSFW_NAME} PRIVATE
			-fprofile-arcs
			-ftest-coverage
    	)
    	
		if(WIN32)
			setup_target_for_coverage_gcovr_html(
				NAME ${TARGET_NAME}_coverage
				EXECUTABLE ${TARGET_NAME}
				DEPENDENCIES ${TARGET_NAME}
			)
    	else()
			setup_target_for_coverage_lcov(
				NAME ${TARGET_NAME}_coverage
				EXECUTABLE ${TARGET_NAME}
				DEPENDENCIES ${TARGET_NAME}
			)
		endif()
	endif()
endif()

# Add include paths for all sources.
target_include_directories(${TARGET_NAME} PRIVATE
	${CMAKE_CURRENT_SOURCE_DIR}
	${FSFW_CONFIG_PATH}
	${CMAKE_CURRENT_BINARY_DIR}
)	

if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
	set(WARNING_FLAGS
		-Wall
		-Wextra
		-Wshadow=local
		-Wimplicit-fallthrough=1
		-Wno-unused-parameter
		-Wno-psabi
	)
	
	# Remove unused sections.
	target_compile_options(${TARGET_NAME} PRIVATE
		"-ffunction-sections"
		"-fdata-sections"
	)

	# Removed unused sections.
	target_link_options(${TARGET_NAME} PRIVATE
		"-Wl,--gc-sections"
	)
	
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
	set(COMPILER_FLAGS "/permissive-")
endif()

if(CMAKE_VERBOSE)
	message(STATUS "Warning flags: ${WARNING_FLAGS}")
endif()
		 
# Compile options for all sources.
target_compile_options(${TARGET_NAME} PRIVATE
	${WARNING_FLAGS}
)

if(NOT CMAKE_SIZE)
	set(CMAKE_SIZE size)
	if(WIN32)
		set(FILE_SUFFIX ".exe")
	endif()
endif()

string(CONCAT POST_BUILD_COMMENT
    "Build directory: ${CMAKE_BINARY_DIR}\n"
    "Target OSAL: ${FSFW_OSAL}\n"
    "Target Build Type: ${CMAKE_BUILD_TYPE}"
)

add_custom_command(TARGET ${TARGET_NAME}
    POST_BUILD
    COMMAND ${CMAKE_SIZE} ${TARGET_NAME}${FILE_SUFFIX}
    COMMENT ${POST_BUILD_COMMENT}
)

include (${CMAKE_SCRIPT_PATH}/BuildType.cmake)
set_build_type()