calamares/CMakeModules/CalamaresAddTest.cmake

# === This file is part of Calamares - <https://calamares.io> ===
#
#   SPDX-FileCopyrightText: 2020 Adriaan de Groot <groot@kde.org>
#   SPDX-License-Identifier: BSD-2-Clause
#
#   Calamares is Free Software: see the License-Identifier above.
#
#
###
#
# Support functions for building Calamares tests.
# This extends KDE's ECM tests with some custom patterns.
#
# calamares_add_test(
#   <NAME>
#   [GUI]
#   [RESOURCES FILE]
#   SOURCES <FILE..>
#   )

include(CMakeParseArguments)
include(CalamaresAutomoc)

function(calamares_add_test name)
    set(options GUI)
    set(oneValueArgs RESOURCES)
    set(multiValueArgs SOURCES LIBRARIES DEFINITIONS)
    cmake_parse_arguments(TEST "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    set(TEST_NAME ${name})

    if(ECM_FOUND AND BUILD_TESTING)
        ecm_add_test(
            ${TEST_SOURCES} ${TEST_RESOURCES}
            TEST_NAME
                ${TEST_NAME}
            LINK_LIBRARIES
                Calamares::calamares
                ${TEST_LIBRARIES}
                Qt5::Core
                Qt5::Test
        )
        calamares_automoc( ${TEST_NAME} )
        # We specifically pass in the source directory of the test-being-
        # compiled, so that it can find test-files in that source dir.
        target_compile_definitions(
            ${TEST_NAME}
            PRIVATE -DBUILD_AS_TEST="${CMAKE_CURRENT_SOURCE_DIR}" ${TEST_DEFINITIONS}
        )
        if(TEST_GUI)
            target_link_libraries(${TEST_NAME} Calamares::calamaresui Qt5::Gui)
        endif()
        if(TEST_RESOURCES)
            calamares_autorcc( ${TEST_NAME} ${TEST_RESOURCES} )
        endif()
    endif()
endfunction()
REUSE: Giant boilerplate cleanup - point to main Calamares site in the 'part of' headers instead of to github (this is the "this file is part of Calamares" opening line for most files). - remove boilerplate from all source files, CMake modules and completions, this is the 3-paragraph summary of the GPL-3.0-or-later, which has a meaning entirely covered by the SPDX tag. 2020-08-25 16:05:56 +02:00			`# === This file is part of Calamares - <https://calamares.io> ===`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`#`
REUSE: (BSD-2-Clause) CMakeModules/ The intended license for the CMake modules is BSD-2-Clause; there's no desire to restrict what can be done with these, and CMake modules are generally 2-clause licensed. 2020-08-26 00:24:40 +02:00			`# SPDX-FileCopyrightText: 2020 Adriaan de Groot <groot@kde.org>`
			`# SPDX-License-Identifier: BSD-2-Clause`
			`#`
REUSE: Giant boilerplate cleanup - point to main Calamares site in the 'part of' headers instead of to github (this is the "this file is part of Calamares" opening line for most files). - remove boilerplate from all source files, CMake modules and completions, this is the 3-paragraph summary of the GPL-3.0-or-later, which has a meaning entirely covered by the SPDX tag. 2020-08-25 16:05:56 +02:00			`# Calamares is Free Software: see the License-Identifier above.`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`#`
			`#`
			`###`
			`#`
			`# Support functions for building Calamares tests.`
			`# This extends KDE's ECM tests with some custom patterns.`
			`#`
			`# calamares_add_test(`
			`# <NAME>`
			`# [GUI]`
CMake: add resources to tests Some tests -- notably the keyboard module -- need to have the QRC for the module loaded as well (e.g. because of data in the QRC). Add a RESOURCES parameter to calamares_add_test() like calamares_add_plugin() already has, to build the resources into the test. Keyboard test now passes, since it was missing the data for lookups before. 2020-09-09 11:58:56 +02:00			`# [RESOURCES FILE]`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`# SOURCES <FILE..>`
			`# )`

CMake: drop NAME option from add_test - drop the unused "NAME" option for calamares_add_test - while here reformat the module with the CMake style tool 2021-09-16 11:45:12 +02:00			`include(CMakeParseArguments)`
			`include(CalamaresAutomoc)`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00
CMake: drop NAME option from add_test - drop the unused "NAME" option for calamares_add_test - while here reformat the module with the CMake style tool 2021-09-16 11:45:12 +02:00			`function(calamares_add_test name)`
			`set(options GUI)`
			`set(oneValueArgs RESOURCES)`
			`set(multiValueArgs SOURCES LIBRARIES DEFINITIONS)`
			`cmake_parse_arguments(TEST "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})`
			`set(TEST_NAME ${name})`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00
CMake: drop NAME option from add_test - drop the unused "NAME" option for calamares_add_test - while here reformat the module with the CMake style tool 2021-09-16 11:45:12 +02:00			`if(ECM_FOUND AND BUILD_TESTING)`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`ecm_add_test(`
CMake: add resources to tests Some tests -- notably the keyboard module -- need to have the QRC for the module loaded as well (e.g. because of data in the QRC). Add a RESOURCES parameter to calamares_add_test() like calamares_add_plugin() already has, to build the resources into the test. Keyboard test now passes, since it was missing the data for lookups before. 2020-09-09 11:58:56 +02:00			`${TEST_SOURCES} ${TEST_RESOURCES}`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`TEST_NAME`
			`${TEST_NAME}`
			`LINK_LIBRARIES`
CMake: tidy up automatic linking of Calamares libraries - Modules and plugins don't need to mention libcalamares themselves for linking -- we can do that automatically. Use the IMPORTED names so that it works in Calamares main repo and external repositories. - Complain about unknown module types. 2021-07-26 14:27:52 +02:00			`Calamares::calamares`
CMake: Allow extra libraries in calamares_add_test - Extra libraries specified via LIBRARIES part of CMake function - Convert all the other module tests 2020-02-17 14:36:52 +01:00			`${TEST_LIBRARIES}`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`Qt5::Core`
			`Qt5::Test`
CMake: drop NAME option from add_test - drop the unused "NAME" option for calamares_add_test - while here reformat the module with the CMake style tool 2021-09-16 11:45:12 +02:00			`)`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`calamares_automoc( ${TEST_NAME} )`
CMake: comment on BUILD_AS_TEST 2020-11-02 12:01:02 +01:00			`# We specifically pass in the source directory of the test-being-`
			`# compiled, so that it can find test-files in that source dir.`
CMake: drop NAME option from add_test - drop the unused "NAME" option for calamares_add_test - while here reformat the module with the CMake style tool 2021-09-16 11:45:12 +02:00			`target_compile_definitions(`
			`${TEST_NAME}`
			`PRIVATE -DBUILD_AS_TEST="${CMAKE_CURRENT_SOURCE_DIR}" ${TEST_DEFINITIONS}`
			`)`
			`if(TEST_GUI)`
			`target_link_libraries(${TEST_NAME} Calamares::calamaresui Qt5::Gui)`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`endif()`
CMake: drop NAME option from add_test - drop the unused "NAME" option for calamares_add_test - while here reformat the module with the CMake style tool 2021-09-16 11:45:12 +02:00			`if(TEST_RESOURCES)`
CMake: add resources to tests Some tests -- notably the keyboard module -- need to have the QRC for the module loaded as well (e.g. because of data in the QRC). Add a RESOURCES parameter to calamares_add_test() like calamares_add_plugin() already has, to build the resources into the test. Keyboard test now passes, since it was missing the data for lookups before. 2020-09-09 11:58:56 +02:00			`calamares_autorcc( ${TEST_NAME} ${TEST_RESOURCES} )`
			`endif()`
CMake: new convenience module CalamaresAddTest 2020-02-17 12:02:53 +01:00			`endif()`
			`endfunction()`