CMake: greentea: Port mbed-drivers-ticker to CTest

Call add_test in mbed_greentea_add_test and specify mbedhtrun as the
command to run. To allow mbedhtrun to communicate with the DUT, the user
is required to pass in -DMBED_TARGET_SERIAL_PORT,
-DMBED_TARGET_SERIAL_NUM and -DMBED_TARGET_MOUNT_POINT so mbedhtrun can
find the device.

Also add an MBED_HTRUN_OPTIONAL_ARGUMENTS variable which takes a
semicolon separated list of optional arguments to forward to htrun. When
we refine the argument list to htrun, we can make use of this mechanism
to provide optional flags and reduce the number of variables the user is
forced to define to make the tests run.

Temporary checks have been added to mbed_greentea_add_test to keep the
old flow working until we port all of the greentea tests to CTest.

Author: rwalton-arm

drivers/CMakeLists.txt

@@ -1,8 +1,12 @@
 # Copyright (c) 2020 ARM Limited. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND BUILD_TESTING)
-    add_subdirectory(tests/UNITTESTS)
+if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
+    if(BUILD_TESTING)
+        add_subdirectory(tests/UNITTESTS)
+    elseif(BUILD_GREENTEA_TESTS)
+        add_subdirectory(tests/TESTS)
+    endif()
 endif()
 
 target_include_directories(mbed-core

drivers/tests/TESTS/CMakeLists.txt

@@ -0,0 +1,4 @@
+# Copyright (c) 2021 ARM Limited. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+add_subdirectory(mbed_drivers/ticker)

drivers/tests/TESTS/mbed_drivers/ticker/CMakeLists.txt

@@ -1,18 +1,13 @@
 # Copyright (c) 2020 ARM Limited. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-cmake_minimum_required(VERSION 3.19.0 FATAL_ERROR)
-
-set(MBED_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../../../.. CACHE INTERNAL "")
-set(TEST_TARGET mbed-drivers-ticker)
-
-include(${MBED_PATH}/tools/cmake/mbed_greentea.cmake)
-
-project(${TEST_TARGET})
+include(mbed_greentea)
 
 mbed_greentea_add_test(
     TEST_NAME
-        ${TEST_TARGET}
+        mbed-drivers-ticker
     TEST_SOURCES
         main.cpp
+    HOST_TESTS_DIR
+        "${CMAKE_CURRENT_LIST_DIR}/../../host_tests"
 )

tools/cmake/mbed_greentea.cmake

@@ -3,10 +3,18 @@
 
 option(MBED_TEST_BAREMETAL OFF)
 
-set(MBED_CONFIG_PATH ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "")
+set(MBED_TARGET_SERIAL_PORT "" CACHE STRING "Serial port of the DUT")
+set(MBED_TARGET_SERIAL_NUM "" CACHE STRING "USB Serial number of the DUT")
+set(MBED_TARGET_MOUNT_POINT "" CACHE STRING "Mount point for the DUT")
+set(MBED_HTRUN_OPTIONAL_ARGUMENTS "" CACHE STRING "Optional argument list to forward to htrun.")
 
-include(${CMAKE_CURRENT_LIST_DIR}/app.cmake)
-set(MBED_ROOT ${CMAKE_CURRENT_LIST_DIR}/../.. CACHE INTERNAL "")
+# TODO: After we convert all greentea tests to use CTest, remove this code. We
+# define these parameters in mbed-os/CMakeLists.txt for greentea tests.
+if(NOT BUILD_GREENTEA_TESTS)
+    set(MBED_CONFIG_PATH ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "")
+    include(${CMAKE_CURRENT_LIST_DIR}/app.cmake)
+    set(MBED_ROOT ${CMAKE_CURRENT_LIST_DIR}/../.. CACHE INTERNAL "")
+endif()
 
 # CMake Macro for generalizing CMake configuration across the greentea test suite with configurable parameters
 # Macro args:
@@ -30,19 +38,23 @@ macro(mbed_greentea_add_test)
         TEST_INCLUDE_DIRS
         TEST_SOURCES
         TEST_REQUIRED_LIBS
+        HOST_TESTS_DIR
     )
     cmake_parse_arguments(MBED_GREENTEA
         "${options}"
         "${singleValueArgs}"
         "${multipleValueArgs}"
         ${ARGN}
     )
-    add_subdirectory(${MBED_ROOT} build)
 
-    add_executable(${MBED_GREENTEA_TEST_NAME})
+    # TODO: After we convert all greentea tests to use CTest, remove this
+    # add_subdirectory call. We will attach the tests to the mbed-os project,
+    # rather than creating a new project for each test that depends on mbed-os.
+    if(NOT BUILD_GREENTEA_TESTS)
+        add_subdirectory(${MBED_ROOT} build)
+    endif()
 
-    # Explicitly enable BUILD_TESTING until CTest is added to the Greentea client
-    set(BUILD_TESTING ON)
+    add_executable(${MBED_GREENTEA_TEST_NAME})
 
     target_include_directories(${MBED_GREENTEA_TEST_NAME}
         PRIVATE
@@ -70,6 +82,28 @@ macro(mbed_greentea_add_test)
 
     mbed_set_post_build(${MBED_GREENTEA_TEST_NAME})
 
+    if(NOT ${MBED_OUTPUT_EXT} STREQUAL "")
+        set(MBED_GREENTEA_TEST_IMAGE_NAME "${MBED_GREENTEA_TEST_NAME}.${MBED_OUTPUT_EXT}" CACHE INTERNAL "")
+    else()
+        set(MBED_GREENTEA_TEST_IMAGE_NAME "${MBED_GREENTEA_TEST_NAME}.bin" CACHE INTERNAL "")
+    endif()
+
+    if(DEFINED MBED_GREENTEA_HOST_TESTS_DIR)
+        list(APPEND MBED_HTRUN_OPTIONAL_ARGUMENTS "-e;${MBED_GREENTEA_HOST_TESTS_DIR}")
+    endif()
+
+    add_test(
+        NAME ${MBED_GREENTEA_TEST_NAME}
+        COMMAND mbedhtrun
+            -m ${MBED_TARGET}
+            -f ${MBED_GREENTEA_TEST_IMAGE_NAME}
+            -p ${MBED_TARGET_SERIAL_PORT}
+            -t ${MBED_TARGET_SERIAL_NUM}
+            -d ${MBED_TARGET_MOUNT_POINT}
+            ${MBED_HTRUN_OPTIONAL_ARGUMENTS}
+        COMMAND_EXPAND_LISTS
+    )
+
     option(VERBOSE_BUILD "Have a verbose build process")
     if(VERBOSE_BUILD)
         set(CMAKE_VERBOSE_MAKEFILE ON)