CamiTKTestsRequirement.h

Go to the documentation of this file.

#
camitk_tests_requirement(){)
    set(options "")
    set(oneValueArgs REASON 
                     REQUIRES)
    set(multiValueArgs TESTS)
    cmake_parse_arguments(CAMITK_TESTS_REQUIREMENT "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
    
    # -- analyze requirements
    # transform statement to list in order to access left/middle/right value if the requirement is a test
    string(REPLACE " " "" REQUIRES_STATEMENT ${CAMITK_TESTS_REQUIREMENT_REQUIRES})
    list(LENGTH REQUIRES_STATEMENT REQUIRES_STATEMENT_LENGTH)
    
    if(REQUIRES_STATEMENT_LENGTH EQUAL 3)
        # Requirement is a test, separate into parts and evaluate the requirement
        list(GET REQUIRES_STATEMENT 0 REQUIRES_STATEMENT_LEFT_VALUE)
        list(GET REQUIRES_STATEMENT 1 REQUIRES_STATEMENT_TEST)
        list(GET REQUIRES_STATEMENT 2 REQUIRES_STATEMENT_RIGHT_VALUE)
        # check the test statement. Can be either VERSION_LESS, VERSION_EQUAL or VERSION_GREATER
        if(REQUIRES_STATEMENT_TEST STREQUAL "VERSION_LESS")
            if (${REQUIRES_STATEMENT_LEFT_VALUE} VERSION_LESS ${REQUIRES_STATEMENT_RIGHT_VALUE})
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        elseif(REQUIRES_STATEMENT_TEST STREQUAL "VERSION_EQUAL")
            if (${REQUIRES_STATEMENT_LEFT_VALUE} VERSION_EQUAL ${REQUIRES_STATEMENT_RIGHT_VALUE})
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        elseif(REQUIRES_STATEMENT_TEST STREQUAL "VERSION_GREATER")
            if (${REQUIRES_STATEMENT_LEFT_VALUE} VERSION_GREATER ${REQUIRES_STATEMENT_RIGHT_VALUE})
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        else()
            message(FATAL_ERROR "\n Unknown three-parts requirement test: \"${CAMITK_TESTS_REQUIREMENT_REQUIRES}\"\n Use one of VERSION_LESS, VERSION_EQUAL or VERSION_GREATER.\n Check call stack below to fix this error.")
        endif()
    else()
        if(REQUIRES_STATEMENT_LENGTH EQUAL 2)
            list(GET REQUIRES_STATEMENT 0 REQUIRES_STATEMENT_NOT)
            list(GET REQUIRES_STATEMENT 1 REQUIRES_STATEMENT_TEST)
            # REQUIRES_STATEMENT_NOT should be "NOT"
            if(NOT REQUIRES_STATEMENT_NOT STREQUAL "NOT")
                message(FATAL_ERROR "\n Unknown two-parts requirement test: \"${CAMITK_TESTS_REQUIREMENT_REQUIRES}\"\n Only NOT is supported.\n Check call stack below to fix this error.")
            endif()
        else()
            list(GET REQUIRES_STATEMENT 0 REQUIRES_STATEMENT_TEST)
        endif()
        
        # possible statement are WIN32, WIN64, MSVC, APPLE or UNIX
        if(REQUIRES_STATEMENT_TEST STREQUAL "WIN32")
            if(WIN32)
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        elseif(REQUIRES_STATEMENT_TEST STREQUAL "WIN64")
            if(WIN64)
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        elseif(REQUIRES_STATEMENT_TEST STREQUAL "MSVC")
            if(MSVC)
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        elseif(REQUIRES_STATEMENT_TEST STREQUAL "APPLE")
            if(APPLE)
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        elseif(REQUIRES_STATEMENT_TEST STREQUAL "UNIX")
            if(UNIX)
                set(REQUIRES_EVAL TRUE)
            else()
                set(REQUIRES_EVAL FALSE)
            endif()
        endif()
        
        # negate if needed
        if(REQUIRES_STATEMENT_NOT STREQUAL "NOT")
            if(REQUIRES_EVAL STREQUAL "TRUE")
                set(REQUIRES_EVAL FALSE)
            else()
                set(REQUIRES_EVAL TRUE)
            endif()
        endif()
    endif()
    
    # -- disable tests if the requirement is not met
    string(REPLACE "" " " CAMITK_TESTS_REQUIREMENT_TESTS_STRING "${CAMITK_TESTS_REQUIREMENT_TESTS}")
    if(NOT ${REQUIRES_EVAL})    
        foreach(TEST_NAME ${CAMITK_TESTS_REQUIREMENT_TESTS})
            # CMake < 3.9 did not have the DISABLED test property. Use WILL_FAIL instead
            if(${CMAKE_VERSION} VERSION_LESS "3.9")
                set_tests_properties(${TEST_NAME} PROPERTIES WILL_FAIL true)
            else()
                set_tests_properties(${TEST_NAME} PROPERTIES DISABLED true)
            endif()
        endforeach()
        set(DISABLE_MESSAGE "Test requirement \"${CAMITK_TESTS_REQUIREMENT_REQUIRES}\": Failed\n   Disabled tests: ${CAMITK_TESTS_REQUIREMENT_TESTS_STRING}\n")
        if(${CMAKE_VERSION} VERSION_LESS "3.9")
            set(DISABLE_MESSAGE ${DISABLE_MESSAGE} "   (using WILL_FAIL property because CMake < 3.9)\n")
        endif()
        set(DISABLE_MESSAGE ${DISABLE_MESSAGE} "   Reason: ${CAMITK_TESTS_REQUIREMENT_REASON}\n")
        set(DISABLE_MESSAGE ${DISABLE_MESSAGE} "   Requirement statement unmet: ${CAMITK_TESTS_REQUIREMENT_REQUIRES}")
        message(STATUS ${DISABLE_MESSAGE})
    else()
        message(STATUS "Test requirement \"${CAMITK_TESTS_REQUIREMENT_REQUIRES}\": Passed\n   Enabled tests: ${CAMITK_TESTS_REQUIREMENT_TESTS_STRING}")
    endif()
end(){)