patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity
zephyr/cmake/modules/unittest.cmake

143 lines
3.7 KiB
CMake
Raw Normal View History

license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-06 15:08:09 +02:00
# SPDX-License-Identifier: Apache-2.0
cmake: increase minimal required version to 3.20.0 Move to CMake 3.20.0. At the Toolchain WG it was decided to move to CMake 3.20.0. The main reason for increasing CMake version is better toolchain support. Better toolchain support is added in the following CMake versions: - armclang, CMake 3.15 - Intel oneAPI, CMake 3.20 - IAR, CMake 3.15 and 3.20 Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-08-10 14:44:56 +02:00
cmake_minimum_required(VERSION 3.20.0)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
unittest: update unittest to hwmv2 Follow-up: fe25709a9c twister: add unit_testing soc and board Moving the soc.yml and board.yml to subsys/testsuite tree. Introduce subsys/testsuite/arch/archs.yml with unit_testing arch. Update the Zephyr CMake module unittest.cmake to include HWMv2 and reorder includes to follow same order as zephyr_default.cmake. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2024-03-05 11:39:57 +01:00
include(extensions)
include(west)
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
include(root)
unittest: update unittest to hwmv2 Follow-up: fe25709a9c twister: add unit_testing soc and board Moving the soc.yml and board.yml to subsys/testsuite tree. Introduce subsys/testsuite/arch/archs.yml with unit_testing arch. Update the Zephyr CMake module unittest.cmake to include HWMv2 and reorder includes to follow same order as zephyr_default.cmake. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2024-03-05 11:39:57 +01:00
include(zephyr_module)
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
include(boards)
unittest: update unittest to hwmv2 Follow-up: fe25709a9c twister: add unit_testing soc and board Moving the soc.yml and board.yml to subsys/testsuite tree. Introduce subsys/testsuite/arch/archs.yml with unit_testing arch. Update the Zephyr CMake module unittest.cmake to include HWMv2 and reorder includes to follow same order as zephyr_default.cmake. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2024-03-05 11:39:57 +01:00
include(hwm_v2)
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
include(configuration_files)
unittest: Generate symbol for existent modules Generate ZEPHYR_{MODULE_NAME}_MODULE for existent modules for unittests as well since they may be using Zephyr modules. Fixes: 64348 Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-10-25 23:53:02 +02:00
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
include(kconfig)
unittest: update unittest to hwmv2 Follow-up: fe25709a9c twister: add unit_testing soc and board Moving the soc.yml and board.yml to subsys/testsuite tree. Introduce subsys/testsuite/arch/archs.yml with unit_testing arch. Update the Zephyr CMake module unittest.cmake to include HWMv2 and reorder includes to follow same order as zephyr_default.cmake. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2024-03-05 11:39:57 +01:00
include(arch_v2)
include(soc_v2)
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
unittest: update coverage library non gcc toolchains When building with clang, the unittests were giving us an error: ``` error: undefined symbol: llvm_gcda_start_file ``` This seems to be from linking in `gcov` regardless of the toolchain. It appears that clang doesn't need any special library for coverage. With this change the following now produce identical coverage reports: ``` $ ZEPHYR_TOOLCHAIN_VARIANT=zephyr ./scripts/twister -p unit_testing \ --coverage -i -T tests/unit/intmath/ $ ZEPHYR_TOOLCHAIN_VARIANT=host ./scripts/twister -p unit_testing \ --coverage -i -T tests/unit/intmath/ $ ZEPHYR_TOOLCHAIN_VARIANT=llvm ./scripts/twister -p unit_testing \ --coverage -i --coverage-tool lcov \ --gcov-tool $(pwd)/scripts/utils/llvm-gcov.sh \ -T tests/unit/intmath/ ``` Signed-off-by: Yuval Peress <peress@google.com>
2022-11-07 06:43:14 +01:00
find_package(TargetTools)
enable_language(C CXX ASM)
include(${ZEPHYR_BASE}/cmake/target_toolchain_flags.cmake)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
# Parameters:
# SOURCES: list of source files, default main.c
# INCLUDE: list of additional include paths relative to ZEPHYR_BASE
cmake: fix improper use of separate_arguments The use of `separate_arguments()` in extra_flags.cmake and unittest.cmake prevents the use of proper CMake lists. A CMake list can be specified on command line as: `-DMY_LIST="itemA;itemB;itemC"` Users are expected to be able to provide extra compile flags using CMake lists, like `-DEXTRA_CFLAGS="--flag1;--flag2"` but also using space separated lists, like: `-DEXTRA_CFLAGS="--flag1 --flag2"`. However, the way FLAGS was passed to separate_arguments() would result in a list being treated as extra arguments to the function and thus result in a CMake error. To allow the use of CMake lists, the length of the argument as a CMake list is tested. This ensures that when the argument contains a single `;` then the length is >1 and no conversion is needed. This allows a user to freely choose between the two forms: - `-DFLAGS="--flag1 --flag2"` - `-DFLAGS="--flag1;--flag2"` or when passing flags which themselves contains spaces, like: - `-DFLAGS="--flag1 \"val1 val2\""` - `-DFLAGS="--flag1;val1 val2"` Note that the extra escaped qouting is no longer needed for proper CMake lists as the `;` itself informs the system that spaces are to be kept as spaces. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-03-14 12:56:40 +01:00
foreach(extra_flags EXTRA_CPPFLAGS EXTRA_LDFLAGS EXTRA_CFLAGS EXTRA_CXXFLAGS EXTRA_AFLAGS)
list(LENGTH ${extra_flags} flags_length)
if(flags_length LESS_EQUAL 1)
# A length of zero means no argument.
# A length of one means a single argument or a space separated list was provided.
# In both cases, it is safe to do a separate_arguments on the argument.
separate_arguments(${extra_flags}_AS_LIST UNIX_COMMAND ${${extra_flags}})
else()
# Already a proper list, no conversion needed.
set(${extra_flags}_AS_LIST "${${extra_flags}}")
endif()
endforeach()
unittest: Support EXTRA_*_FLAGS Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-11-10 13:27:53 +01:00
cmake: using ${ZEPHYR_BASE} instead of $ENV{ZEPHYR_BASE} With the introduction of ZephyrConfig.cmake all parts of CMake code should rely on the CMake ZEPHYR_BASE variable instead of the environment setting. This ensures that after the first CMake invocation, then all subsequent invocation in same build folder will use same zephyr base. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-02-12 15:42:09 +01:00
set(ENV_ZEPHYR_BASE $ENV{ZEPHYR_BASE})
# This add support for old style boilerplate include.
if((NOT DEFINED ZEPHYR_BASE) AND (DEFINED ENV_ZEPHYR_BASE))
set(ZEPHYR_BASE ${ENV_ZEPHYR_BASE} CACHE PATH "Zephyr base")
endif()
unittest: update coverage library non gcc toolchains When building with clang, the unittests were giving us an error: ``` error: undefined symbol: llvm_gcda_start_file ``` This seems to be from linking in `gcov` regardless of the toolchain. It appears that clang doesn't need any special library for coverage. With this change the following now produce identical coverage reports: ``` $ ZEPHYR_TOOLCHAIN_VARIANT=zephyr ./scripts/twister -p unit_testing \ --coverage -i -T tests/unit/intmath/ $ ZEPHYR_TOOLCHAIN_VARIANT=host ./scripts/twister -p unit_testing \ --coverage -i -T tests/unit/intmath/ $ ZEPHYR_TOOLCHAIN_VARIANT=llvm ./scripts/twister -p unit_testing \ --coverage -i --coverage-tool lcov \ --gcov-tool $(pwd)/scripts/utils/llvm-gcov.sh \ -T tests/unit/intmath/ ``` Signed-off-by: Yuval Peress <peress@google.com>
2022-11-07 06:43:14 +01:00
find_package(Deprecated COMPONENTS SOURCES)
unittest: Only add main.c if it exists Downstream it's easier to write tests that use target_sources after including the unittest package instead of specifying a list of sources before. But if we do that, currently, main.c is added and the build breaks because it doesn't exist. Signed-off-by: Yuval Peress <peress@google.com>
2022-10-06 18:31:18 +02:00
if(NOT SOURCES AND EXISTS main.c)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
set(SOURCES main.c)
endif()
scripts: gen_kobject_list: Generate enums and case statements Adding a new kernel object type or driver subsystem requires changes in various different places. This patch makes it easier to create those devices by generating as much as possible in compile time. No behavior change. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2018-04-05 22:59:33 +02:00
add_executable(testbinary ${SOURCES})
cmake: create test_interface interface library Creating a test_interface allows more complex unittest projects to create additional libraries, for example mock libs, that can be re-used between test projects. To support the possibility of such libs to build with same flags as the testbinary the test_interface is now populated with the public compile and include flags from testbinary. testbinary has been updated to use test_interface. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-09-01 10:11:36 +02:00
add_library(test_interface INTERFACE)
target_link_libraries(testbinary PRIVATE test_interface)
scripts: gen_kobject_list: Generate enums and case statements Adding a new kernel object type or driver subsystem requires changes in various different places. This patch makes it easier to create those devices by generating as much as possible in compile time. No behavior change. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2018-04-05 22:59:33 +02:00
cmake: Use variables for target names There is an effort underway to make most of the Zephyr build script's reentrant. Meaning, the build scripts can be executed multiple times during the same CMake invocation. Reentrancy enables several use-cases, the motivating one is the ability to build several Zephyr executables, or images, for instance a bootloader and an application. For build scripts to be reentrant they cannot be directly referencing global variables, like target names, but must instead reference variables, which can vary from entry to entry. Therefore, in this patch, we replace global targets with variables. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2019-01-14 16:39:33 +01:00
set(KOBJ_TYPES_H_TARGET kobj_types_h_target)
cmake: using ${ZEPHYR_BASE} instead of $ENV{ZEPHYR_BASE} With the introduction of ZephyrConfig.cmake all parts of CMake code should rely on the CMake ZEPHYR_BASE variable instead of the environment setting. This ensures that after the first CMake invocation, then all subsequent invocation in same build folder will use same zephyr base. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-02-12 15:42:09 +01:00
include(${ZEPHYR_BASE}/cmake/kobj.cmake)
cmake: create test_interface interface library Creating a test_interface allows more complex unittest projects to create additional libraries, for example mock libs, that can be re-used between test projects. To support the possibility of such libs to build with same flags as the testbinary the test_interface is now populated with the public compile and include flags from testbinary. testbinary has been updated to use test_interface. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-09-01 10:11:36 +02:00
add_dependencies(test_interface ${KOBJ_TYPES_H_TARGET})
scripts: gen_kobject_list: Generate enums and case statements Adding a new kernel object type or driver subsystem requires changes in various different places. This patch makes it easier to create those devices by generating as much as possible in compile time. No behavior change. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2018-04-05 22:59:33 +02:00
gen_kobj(KOBJ_GEN_DIR)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
list(APPEND INCLUDE
ztest: add support for new and legacy include paths The ztest unittest module relies on some headers that fake the real ones, e.g. <zephyr/arch/cpu.h>. When new header location was introduced, their path was not updates. This patch fixes this problem and provides ztest with both, legacy and new include paths so that it can keep working on both scenarios. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-05-06 15:27:18 +02:00
subsys/testsuite/ztest/include/zephyr
testing: add zephyr/ prefix to testing include path Continuation of issue #41543 to add prefix scope for Zephyr's include files. Signed-off-by: Yuval Peress <peress@google.com>
2022-04-19 19:54:42 +02:00
subsys/testsuite/include/zephyr
tests: move testsuite and configs into subsys/ Move test related code and the testsuite away from tests/ and make it a proper subsystem. The way tests were integrate in the tree was not obvious and actual tests were intermixed with the testsuite code. This will allow us to have trees with the testcode and without the samples by just remove the folders tests/ and samples, needed for isolating actual code from test/sample code. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-19 21:45:18 +01:00
subsys/testsuite/ztest/include
subsys/testsuite/include
include: Prefix includes to use a scope Move include paths and add new target_include_directories to support backwards compatibility: * /include -> /include/zephyr example: <irq.h> -> <zephyr/irq.h> Issue #41543 Signed-off-by: Yuval Peress <peress@google.com>
2022-03-29 21:52:59 +02:00
include/zephyr
build: make non zephyr/ include prefix configurable Add a Kconfig to disable non prefixed includes. By setting `CONFIG_LEGACY_INCLUDE_PATH=n` developers can disable having `include/zephyr` in the search path. This means that includes such as `#include <kernel.h>` will no longer work. Internally, every header should be updated to add the `zephyr/` prefix to the headers. Only then, will developers be able to use this config value for their applications. Signed-off-by: Yuval Peress <peress@google.com>
2022-04-01 05:05:42 +02:00
include
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
.
scripts: gen_kobject_list: Generate enums and case statements Adding a new kernel object type or driver subsystem requires changes in various different places. This patch makes it easier to create those devices by generating as much as possible in compile time. No behavior change. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2018-04-05 22:59:33 +02:00
)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
tests: unit: do not build with -m32 on macOS on macOS, i386 is deprecated, so build as 64bit instead. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-09-25 11:40:11 +02:00
if(CMAKE_HOST_APPLE)
else()
tests: move test timeutil into "unit" directory. We don't have to build an image for running test timeutil. We can just build a native app to test it. So move it into "unit" directory. Also, add 64-bit support for unit testing framework. Signed-off-by: Steven Wang <steven.l.wang@linux.intel.com>
2019-10-14 16:23:18 +02:00
if(M64_MODE)
set (CMAKE_C_FLAGS "-m64")
testsuite: fix unittest cross-language flags Unit tests may include C++ code, so ensure the compiler flags are consistent to avoid link errors. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-08-31 12:48:34 +02:00
set (CMAKE_CXX_FLAGS "-m64")
tests: move test timeutil into "unit" directory. We don't have to build an image for running test timeutil. We can just build a native app to test it. So move it into "unit" directory. Also, add 64-bit support for unit testing framework. Signed-off-by: Steven Wang <steven.l.wang@linux.intel.com>
2019-10-14 16:23:18 +02:00
else()
tests: unit: do not build with -m32 on macOS on macOS, i386 is deprecated, so build as 64bit instead. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-09-25 11:40:11 +02:00
set (CMAKE_C_FLAGS "-m32") #deprecated on macOS
testsuite: fix unittest cross-language flags Unit tests may include C++ code, so ensure the compiler flags are consistent to avoid link errors. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-08-31 12:48:34 +02:00
set (CMAKE_CXX_FLAGS "-m32") #deprecated on macOS
tests: move test timeutil into "unit" directory. We don't have to build an image for running test timeutil. We can just build a native app to test it. So move it into "unit" directory. Also, add 64-bit support for unit testing framework. Signed-off-by: Steven Wang <steven.l.wang@linux.intel.com>
2019-10-14 16:23:18 +02:00
endif(M64_MODE)
tests: unit: do not build with -m32 on macOS on macOS, i386 is deprecated, so build as 64bit instead. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-09-25 11:40:11 +02:00
endif()
test: unittest: run for 32bit architecture Running tests compiled for 64bit architecture were causing errors in logger module. Updated unittest.cmake to build tests only for 32bit architecture. Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
2018-11-21 14:50:41 +01:00
cmake: create test_interface interface library Creating a test_interface allows more complex unittest projects to create additional libraries, for example mock libs, that can be re-used between test projects. To support the possibility of such libs to build with same flags as the testbinary the test_interface is now populated with the public compile and include flags from testbinary. testbinary has been updated to use test_interface. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-09-01 10:11:36 +02:00
target_compile_options(test_interface INTERFACE
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
-imacros ${AUTOCONF_H}
unittest: Support EXTRA_*_FLAGS Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-11-10 13:27:53 +01:00
-Wall
scripts: gen_kobject_list: Generate enums and case statements Adding a new kernel object type or driver subsystem requires changes in various different places. This patch makes it easier to create those devices by generating as much as possible in compile time. No behavior change. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2018-04-05 22:59:33 +02:00
-I ${KOBJ_GEN_DIR}
unittest: Support EXTRA_*_FLAGS Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-11-10 13:27:53 +01:00
${EXTRA_CPPFLAGS_AS_LIST}
${EXTRA_CFLAGS_AS_LIST}
$<$<COMPILE_LANGUAGE:CXX>:${EXTRA_CXXFLAGS_AS_LIST}>
$<$<COMPILE_LANGUAGE:ASM>:${EXTRA_AFLAGS_AS_LIST}>
)
ztest: Add register functionality Add new functionality to ztest to improve test modularity. The two primary new entry points are: * ztest_register_test_suite * ztest_run_registered_test_suites When registering a new test suite, users provide the name as well as an optional predicate used to filter the tests for each run. Using NULL as the predicate ensures that the test is run exactly once (after which it is automatically filtered from future runs). Calls to ztest_run_registered_test_suites take a state pointer as an argument. This allows the the pragma functions to decide whether the test should be run. The biggest benefit of this system (other than the ability to filter tests and maintain a larger test state) is the ability to better modularize the test source code. Instead of all the various tests having to coordinate and the main function having to know which tests to run, each source file manages registering its own test suite and handling the conditions for running the suite. Signed-off-by: Yuval Peress <peress@chromium.org>
2021-07-23 19:47:52 +02:00
target_link_options(testbinary PRIVATE
testing: add zephyr/ prefix to testing include path Continuation of issue #41543 to add prefix scope for Zephyr's include files. Signed-off-by: Yuval Peress <peress@google.com>
2022-04-19 19:54:42 +02:00
-T "${ZEPHYR_BASE}/subsys/testsuite/include/zephyr/ztest_unittest.ld"
ztest: Add register functionality Add new functionality to ztest to improve test modularity. The two primary new entry points are: * ztest_register_test_suite * ztest_run_registered_test_suites When registering a new test suite, users provide the name as well as an optional predicate used to filter the tests for each run. Using NULL as the predicate ensures that the test is run exactly once (after which it is automatically filtered from future runs). Calls to ztest_run_registered_test_suites take a state pointer as an argument. This allows the the pragma functions to decide whether the test should be run. The biggest benefit of this system (other than the ability to filter tests and maintain a larger test state) is the ability to better modularize the test source code. Instead of all the various tests having to coordinate and the main function having to know which tests to run, each source file manages registering its own test suite and handling the conditions for running the suite. Signed-off-by: Yuval Peress <peress@chromium.org>
2021-07-23 19:47:52 +02:00
)
unittest: Support EXTRA_*_FLAGS Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-11-10 13:27:53 +01:00
target_link_libraries(testbinary PRIVATE
${EXTRA_LDFLAGS_AS_LIST}
)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
unittest: add support for coverage Some missing features for getting coverage data for unit tests: - Setting the unit_testing board to have coverage support and native application. - Fixing the CONFIG_COVERAGE check Signed-off-by: Yuval Peress <peress@google.com>
2022-11-28 19:33:11 +01:00
if(CONFIG_COVERAGE)
unittest: update coverage library non gcc toolchains When building with clang, the unittests were giving us an error: ``` error: undefined symbol: llvm_gcda_start_file ``` This seems to be from linking in `gcov` regardless of the toolchain. It appears that clang doesn't need any special library for coverage. With this change the following now produce identical coverage reports: ``` $ ZEPHYR_TOOLCHAIN_VARIANT=zephyr ./scripts/twister -p unit_testing \ --coverage -i -T tests/unit/intmath/ $ ZEPHYR_TOOLCHAIN_VARIANT=host ./scripts/twister -p unit_testing \ --coverage -i -T tests/unit/intmath/ $ ZEPHYR_TOOLCHAIN_VARIANT=llvm ./scripts/twister -p unit_testing \ --coverage -i --coverage-tool lcov \ --gcov-tool $(pwd)/scripts/utils/llvm-gcov.sh \ -T tests/unit/intmath/ ``` Signed-off-by: Yuval Peress <peress@google.com>
2022-11-07 06:43:14 +01:00
target_compile_options(test_interface INTERFACE $<TARGET_PROPERTY:compiler,coverage>)
target_link_libraries(testbinary PRIVATE $<TARGET_PROPERTY:linker,coverage>)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
endif()
if(LIBS)
message(FATAL_ERROR "This variable is not supported, see SOURCES instead")
endif()
ztest: remove old ztest api Remove old Ztest API entirely. New API is the now the default. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-10-10 02:06:05 +02:00
target_sources(testbinary PRIVATE
${ZEPHYR_BASE}/subsys/testsuite/ztest/src/ztest.c
${ZEPHYR_BASE}/subsys/testsuite/ztest/src/ztest_mock.c
${ZEPHYR_BASE}/subsys/testsuite/ztest/src/ztest_rules.c
${ZEPHYR_BASE}/subsys/testsuite/ztest/src/ztest_defaults.c
)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
cmake: create test_interface interface library Creating a test_interface allows more complex unittest projects to create additional libraries, for example mock libs, that can be re-used between test projects. To support the possibility of such libs to build with same flags as the testbinary the test_interface is now populated with the public compile and include flags from testbinary. testbinary has been updated to use test_interface. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-09-01 10:11:36 +02:00
target_compile_definitions(test_interface INTERFACE ZTEST_UNITTEST)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
foreach(inc ${INCLUDE})
cmake: create test_interface interface library Creating a test_interface allows more complex unittest projects to create additional libraries, for example mock libs, that can be re-used between test projects. To support the possibility of such libs to build with same flags as the testbinary the test_interface is now populated with the public compile and include flags from testbinary. testbinary has been updated to use test_interface. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-09-01 10:11:36 +02:00
target_include_directories(test_interface INTERFACE ${ZEPHYR_BASE}/${inc})
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
endforeach()
find_program(VALGRIND_PROGRAM valgrind)
if(VALGRIND_PROGRAM)
set(VALGRIND ${VALGRIND_PROGRAM})
set(VALGRIND_FLAGS
--leak-check=full
--error-exitcode=1
cmake: kconfig: introduce dedicated unit testing board This commit introduces a dedicated unit testing board. Today, a dedicated Zephyr unit testing scheme exists but is different from how a Zephyr build generally works. For example Kconfig is not possible, resulting on various different hacks to pass Kconfig settings from test cases / testcase.yaml through CMake to the code. Some directly as compile definitions, some as header files with forced inclusion on sources, some with wrapper flags which again results in different define being enabled. There is even cases where a second forced header inclusion undefines previous defines. Unit test often does a manual check for the right boards, like this: > if (NOT BOARD STREQUAL unit_testing) > message(FATAL_ERROR "This project can only be used with...") > endif() Introducing a dedicated unit_testing board under `tests/root` allows us to use Kconfig in unit test samples, and thus proper `prj.conf` and extra Kconfig fragments. Generation of autoconf.h so the overall architecture follows regular Zephyr builds. Proper and uniform error messages when invalid board is selected. The unit_testing board and arch is located under: `subsys/testsuite` so that it is only available when find_package(Zephyr COMPONENTS unittest) is used, and not available for regular Zephyr builds. Kconfig generates autoconf.h which is applied as compile flag to test binary which means that kconfig defines placed in ztest.h can now be removed. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-08-05 11:09:26 +02:00
--log-file=valgrind.log
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
)
endif()
add_custom_target(run-test
COMMAND
${VALGRIND} ${VALGRIND_FLAGS}
$<TARGET_FILE:testbinary>
DEPENDS testbinary
WORKING_DIRECTORY ${APPLICATION_BINARY_DIR}
)
# TODO: Redirect output to unit.log
Reference in a new issue Copy permalink