Merge pull request ARMmbed#14426 from ARMmbed/feature_unittest_refactor

CMake: Refactor UNITTESTS CMake

Author: adbridge

.gitignore

@@ -102,3 +102,5 @@ DELIVERY/
 CMakeCache.txt
 cmake_install.cmake
 CMakeFiles/
+cmake_build/
+Testing/

.travis.yml

@@ -39,9 +39,11 @@ addons:
       - sourceline: 'deb https://apt.kitware.com/ubuntu/ focal main'
         key_url: 'https://apt.kitware.com/keys/kitware-archive-latest.asc'
     packages:
-    - cmake
-    - ninja-build
-    - libncursesw5
+      - cmake
+      - ninja-build
+      - gcovr
+      - libncursesw5
+      - g++-7
 
 matrix:
   include:
@@ -321,3 +323,23 @@ matrix:
         - mbedtools configure -p ${ROOT} -t ${TOOLCHAIN} -m ${TARGET_NAME} --mbed-os-path .
         - cmake -S ${ROOT} -B ${ROOT}/cmake_build/${TARGET_NAME}/${PROFILE}/${TOOLCHAIN}/ -GNinja -DCMAKE_BUILD_TYPE=${PROFILE}
         - cmake --build ${ROOT}/cmake_build/${TARGET_NAME}/${PROFILE}/${TOOLCHAIN}/
+
+    ### Mbed OS unittest ###
+    - &cmake-build-run-unittest
+      stage: "CMake"
+      name: "CMake unittest build"
+      env: NAME=cmake_unittest 
+      install:        
+        # Hide Travis-preinstalled CMake
+        # The Travis-preinstalled CMake is unfortunately not installed via apt, so we
+        # can't replace it with an apt-supplied version very easily. Additionally, we
+        # can't permit the Travis-preinstalled copy to survive, as the Travis default
+        # path lists the Travis CMake install location ahead of any place where apt
+        # would install CMake to. Instead of apt removing or upgrading to a new CMake
+        # version, we must instead delete the Travis copy of CMake.
+        - sudo rm -rf /usr/local/cmake*
+      script:
+        - echo ctest --build-and-test . build --build-generator Ninja --build-options -DBUILD_TESTING=ON -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE=ON -DCMAKE_CXX_COMPILER=g++-7 -DCMAKE_C_COMPILER=gcc-7 --test-command ctest        
+        - ctest --build-and-test . build --build-generator Ninja --build-options -DBUILD_TESTING=ON -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE=ON -DCMAKE_CXX_COMPILER=g++-7 -DCMAKE_C_COMPILER=gcc-7 --test-command ctest        
+        - gcovr --gcov-executable gcov-7 -r . ./build -s -e ".*\.h" --exclude-directories=$TRAVIS_BUILD_DIR/build/UNITTESTS --exclude-directories=$TRAVIS_BUILD_DIR/build/_deps
+        - ccache -s

CMakeLists.txt

@@ -5,8 +5,10 @@
 
 cmake_minimum_required(VERSION 3.19.0 FATAL_ERROR)
 
-include(${MBED_CONFIG_PATH}/mbed_config.cmake)
-include(mbed_set_linker_script)
+if(${CMAKE_CROSSCOMPILING})
+    include(${MBED_CONFIG_PATH}/mbed_config.cmake)
+    include(mbed_set_linker_script)
+endif()
 
 project(mbed-os)
 
@@ -15,6 +17,13 @@ list(APPEND CMAKE_MODULE_PATH
     "${mbed-os_SOURCE_DIR}/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/scripts;${mbed-os_SOURCE_DIR}/targets/TARGET_Cypress/scripts;${mbed-os_SOURCE_DIR}/targets/TARGET_NXP/scripts"
 )
 
+option(BUILD_TESTING "Run unit tests only." OFF)
+
+if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND BUILD_TESTING)
+    include(CTest)   
+    add_subdirectory(UNITTESTS)
+endif()
+
 add_library(mbed-core INTERFACE)
 
 add_library(mbed-os INTERFACE)
@@ -33,88 +42,91 @@ target_link_libraries(mbed-baremetal
 )
 # Validate selected C library type
 # The C library type selected has to match the library that the target can support
-if(${MBED_C_LIB} STREQUAL "small")
-    if(NOT "small" IN_LIST MBED_TARGET_SUPPORTED_C_LIBS)
-        if("std" IN_LIST MBED_TARGET_SUPPORTED_C_LIBS)
-            message(WARNING
-                "We noticed that target.c_lib is set to `${MBED_C_LIB}`."
-                " As the ${MBED_TARGET} target does not support a small C library for the ${MBED_TOOLCHAIN} toolchain,"
-                " we are using the standard C library instead."
-            )
-            set(MBED_C_LIB "std" CACHE STRING "")
+if(${CMAKE_CROSSCOMPILING})
+    if(${MBED_C_LIB} STREQUAL "small")
+        if(NOT "small" IN_LIST MBED_TARGET_SUPPORTED_C_LIBS)
+            if("std" IN_LIST MBED_TARGET_SUPPORTED_C_LIBS)
+                message(WARNING
+                    "We noticed that target.c_lib is set to `${MBED_C_LIB}`."
+                    " As the ${MBED_TARGET} target does not support a small C library for the ${MBED_TOOLCHAIN} toolchain,"
+                    " we are using the standard C library instead."
+                )
+                set(MBED_C_LIB "std" CACHE STRING "")
+            endif()
         endif()
+    elseif(NOT ${MBED_C_LIB} IN_LIST MBED_TARGET_SUPPORTED_C_LIBS)
+        message(FATAL_ERROR
+            "Invalid `target.c_lib` ('${MBED_C_LIB}') for '${MBED_TARGET}' target."
+            "\nPossible value(s): ${MBED_TARGET_SUPPORTED_C_LIBS}"
+        )
     endif()
-elseif(NOT ${MBED_C_LIB} IN_LIST MBED_TARGET_SUPPORTED_C_LIBS)
-    message(FATAL_ERROR
-        "Invalid `target.c_lib` ('${MBED_C_LIB}') for '${MBED_TARGET}' target."
-        "\nPossible value(s): ${MBED_TARGET_SUPPORTED_C_LIBS}"
-    )
-endif()
 
-# Validate selected printf library
-set(MBED_PRINTF_LIB_TYPES std minimal-printf)
-if(NOT ${MBED_PRINTF_LIB} IN_LIST MBED_PRINTF_LIB_TYPES)
-    message(FATAL_ERROR
-        "Invalid printf library type '${MBED_PRINTF_LIB}'. Possible values:\n ${MBED_PRINTF_LIB_TYPES}"
-    )
-endif()
-
-mbed_set_cpu_core_definitions(mbed-core)
-if(${MBED_TOOLCHAIN_FILE_USED})
-    mbed_set_profile_options(mbed-core ${MBED_TOOLCHAIN})
-    mbed_set_c_lib(mbed-core ${MBED_C_LIB})
-    mbed_set_printf_lib(mbed-core ${MBED_PRINTF_LIB})
+    # Validate selected printf library
+    set(MBED_PRINTF_LIB_TYPES std minimal-printf)
+    if(NOT ${MBED_PRINTF_LIB} IN_LIST MBED_PRINTF_LIB_TYPES)
+        message(FATAL_ERROR
+            "Invalid printf library type '${MBED_PRINTF_LIB}'. Possible values:\n ${MBED_PRINTF_LIB_TYPES}"
+        )
+    endif()
+    
+    mbed_set_cpu_core_definitions(mbed-core)
+    if(${MBED_TOOLCHAIN_FILE_USED})
+        message(STATUS ${MBED_TOOLCHAIN})
+        mbed_set_profile_options(mbed-core ${MBED_TOOLCHAIN})
+        mbed_set_c_lib(mbed-core ${MBED_C_LIB})
+        mbed_set_printf_lib(mbed-core ${MBED_PRINTF_LIB})
+    
+        target_compile_features(mbed-core
+            INTERFACE
+                c_std_11
+                cxx_std_14
+        )
+    
+    endif()
 
-    target_compile_features(mbed-core
+    target_compile_definitions(mbed-core
         INTERFACE
-            c_std_11
-            cxx_std_14
+            ${MBED_TARGET_DEFINITIONS}
+            ${MBED_CONFIG_DEFINITIONS}
     )
 
-endif()
-
-target_compile_definitions(mbed-core
-    INTERFACE
-        ${MBED_TARGET_DEFINITIONS}
-        ${MBED_CONFIG_DEFINITIONS}
-)
-
-# Add MBED_TEST_MODE for backward compatibility with Greentea tests written for use with Mbed CLI 1
-if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND BUILD_TESTING)
-    target_compile_definitions(${PROJECT_NAME}
-        PUBLIC
-            MBED_TEST_MODE
-    )
-endif()
+    # Add MBED_TEST_MODE for backward compatibility with Greentea tests written for use with Mbed CLI 1
+    if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND BUILD_TESTING)
+        target_compile_definitions(${PROJECT_NAME}
+            PUBLIC
+                MBED_TEST_MODE
+        )
+    endif()
 
-# We need to generate a "response file" to pass to the C preprocessor when we preprocess the linker
-# script, because of path length limitations on Windows. We set the response file and bind the path
-# to a global property here. The MBED_TARGET being built queries this global property when it sets
-# the linker script.
-#
-# We must set this global property before the targets subdirectory is added to the project. This is
-# required because the MBED_TARGET depends on the response file. If the path to the response file
-# is not defined when the target requests it the config definitions will not be passed to CPP.
-#
-# TODO: Remove this and find a more idiomatic way of passing compile definitions to CPP without
-# using response files or global properties.
-mbed_generate_options_for_linker(mbed-core RESPONSE_FILE_PATH)
-set_property(GLOBAL PROPERTY COMPILE_DEFS_RESPONSE_FILE ${RESPONSE_FILE_PATH})
-
-# Add compile definitions for backward compatibility with the toolchain
-# supported. New source files should instead check for __GNUC__ and __clang__
-# for the GCC_ARM and ARM toolchains respectively.
-if(${MBED_TOOLCHAIN} STREQUAL "GCC_ARM")
-    target_compile_definitions(mbed-core
-        INTERFACE
-            TOOLCHAIN_GCC_ARM
-            TOOLCHAIN_GCC
-    )
-elseif(${MBED_TOOLCHAIN} STREQUAL "ARM")
-    target_compile_definitions(mbed-core
-        INTERFACE
-            TOOLCHAIN_ARM
-    )
+    # We need to generate a "response file" to pass to the C preprocessor when we preprocess the linker
+    # script, because of path le    ngth limitations on Windows. We set the response file and bind the path
+    # to a global property here. The MBED_TARGET being built queries this global property when it sets
+    # the linker script.
+    #
+    # We must set this global property before the targets subdirectory is added to the project. This is
+    # required because the MBED_TARGET depends on the response file. If the path to the response file
+    # is not defined when the target requests it the config definitions will not be passed to CPP.
+    #
+    # TODO: Remove this and find a more idiomatic way of passing compile definitions to CPP without
+    # using response files or global properties.
+    mbed_generate_options_for_linker(mbed-core RESPONSE_FILE_PATH)
+    set_property(GLOBAL PROPERTY COMPILE_DEFS_RESPONSE_FILE ${RESPONSE_FILE_PATH})
+    
+    # Add compile definitions for backward compatibility with the toolchain
+    # supported. New source files should instead check for __GNUC__ and __clang__
+    # for the GCC_ARM and ARM toolchains respectively.
+    if(${MBED_TOOLCHAIN} STREQUAL "GCC_ARM")
+        target_compile_definitions(mbed-core
+            INTERFACE
+                TOOLCHAIN_GCC_ARM
+                TOOLCHAIN_GCC
+        )
+    elseif(${MBED_TOOLCHAIN} STREQUAL "ARM")
+        target_compile_definitions(mbed-core
+            INTERFACE
+                TOOLCHAIN_ARM
+        )
+    endif()
 endif()
 
 # Include mbed.h and config from generate folder
@@ -136,23 +148,26 @@ add_subdirectory(hal)
 add_subdirectory(platform)
 add_subdirectory(rtos)
 add_subdirectory(targets)
+add_subdirectory(storage)
+add_subdirectory(events)
+add_subdirectory(connectivity)
 
 # The directories below contain optional target libraries
-add_subdirectory(events EXCLUDE_FROM_ALL)
-add_subdirectory(connectivity EXCLUDE_FROM_ALL)
-add_subdirectory(storage EXCLUDE_FROM_ALL)
 add_subdirectory(drivers/device_key EXCLUDE_FROM_ALL)
 add_subdirectory(drivers/usb EXCLUDE_FROM_ALL)
 add_subdirectory(features EXCLUDE_FROM_ALL)
 add_subdirectory(cmsis/CMSIS_5/CMSIS/RTOS2 EXCLUDE_FROM_ALL)
 add_subdirectory(cmsis/device/rtos EXCLUDE_FROM_ALL)
 
-# Ensure the words that make up the Mbed target name are separated with a hyphen, lowercase, and with the `mbed-` prefix.
-string(TOLOWER ${MBED_TARGET} MBED_TARGET_CONVERTED)
-string(REPLACE "_" "-" MBED_TARGET_CONVERTED ${MBED_TARGET_CONVERTED})
-string(PREPEND MBED_TARGET_CONVERTED "mbed-")
 
-target_link_libraries(mbed-core INTERFACE ${MBED_TARGET_CONVERTED})
+if(${CMAKE_CROSSCOMPILING})
+    # Ensure the words that make up the Mbed target name are separated with a hyphen, lowercase, and with the `mbed-` prefix.
+    string(TOLOWER ${MBED_TARGET} MBED_TARGET_CONVERTED)
+    string(REPLACE "_" "-" MBED_TARGET_CONVERTED ${MBED_TARGET_CONVERTED})
+    string(PREPEND MBED_TARGET_CONVERTED "mbed-")
+    
+    target_link_libraries(mbed-core INTERFACE ${MBED_TARGET_CONVERTED})
+endif()
 
 #
 # Converts output file of `target` to binary file and to Intel HEX file.