Adding a TEST build type
[apps/app-templates.git] / cmake / cmake.d / 03-macros.cmake
index bf297a2..6dd9d0a 100644 (file)
@@ -108,6 +108,17 @@ ENDMACRO(LIST_FILTER)
 
 # Generic useful macro
 # -----------------------
+macro(set_install_prefix)
+       if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND INSTALL_PREFIX)
+               message(STATUS "-- Overwrite the CMAKE default install prefix with ${INSTALL_PREFIX}")
+               set(CMAKE_INSTALL_PREFIX ${INSTALL_PREFIX} CACHE PATH "Install prefix" FORCE)
+       endif()
+       # (BUG!!!) as PKG_CONFIG_PATH does not work [should be an env variable]
+       # ---------------------------------------------------------------------
+       set(CMAKE_PREFIX_PATH ${CMAKE_INSTALL_PREFIX}/lib64/pkgconfig ${CMAKE_INSTALL_PREFIX}/lib/pkgconfig CACHE PATH 'Prefix Path list used by pkgconfig module')
+       set(LD_LIBRARY_PATH ${CMAKE_INSTALL_PREFIX}/lib64 ${CMAKE_INSTALL_PREFIX}/lib CACHE PATH 'Path list where to search for libraries')
+endmacro()
+
 macro(PROJECT_TARGET_ADD TARGET_NAME)
        set_property(GLOBAL APPEND PROPERTY PROJECT_TARGETS ${TARGET_NAME})
        set(TARGET_NAME ${TARGET_NAME})
@@ -247,10 +258,16 @@ endmacro()
 
 # To be call inside project_targets_populate macro
 macro(afb_genskel)
+       set (ARGSLIST ${ARGN})
+
+       if ("${PROJECT_LANGUAGES}" MATCHES "CXX")
+               list(APPEND ARGSLIST "--cpp")
+       endif()
+
        if (OPENAPI_DEF)
                add_custom_command(OUTPUT ${SD}/${OPENAPI_DEF}.h
                        DEPENDS ${SD}/${OPENAPI_DEF}.json
-                       COMMAND afb-genskel ${SD}/${OPENAPI_DEF}.json > ${SD}/${OPENAPI_DEF}.h
+                       COMMAND afb-genskel ${ARGSLIST} ${SD}/${OPENAPI_DEF}.json > ${SD}/${OPENAPI_DEF}.h
                )
                add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OPENAPI_DEF}.h
                        COMMENT "Generating OpenAPI header file ${OPENAPI_DEF}.h")
@@ -258,7 +275,7 @@ macro(afb_genskel)
        else()
                add_custom_command(OUTPUT ${SD}/${OUT}-apidef.h
                        DEPENDS ${SD}/${OUT}-apidef.json
-                       COMMAND afb-genskel ${SD}/${OUT}-apidef.json > ${SD}/${OUT}-apidef.h
+                       COMMAND afb-genskel ${ARGSLIST} ${SD}/${OUT}-apidef.json > ${SD}/${OUT}-apidef.h
                )
                add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OUT}-apidef.h
                        COMMENT "Generating OpenAPI header file ${OUT}-apidef.h")
@@ -269,20 +286,29 @@ endmacro()
 # Pre-packaging
 macro(project_targets_populate)
        # Default Widget default directory
-       set(BINDIR bin)
-       set(ETCDIR etc)
-       set(LIBDIR lib)
-       set(HTTPDIR htdocs)
-       set(DATADIR data)
        set(PACKAGE_BINDIR  ${PROJECT_PKG_BUILD_DIR}/${BINDIR})
        set(PACKAGE_ETCDIR  ${PROJECT_PKG_BUILD_DIR}/${ETCDIR})
        set(PACKAGE_LIBDIR  ${PROJECT_PKG_BUILD_DIR}/${LIBDIR})
        set(PACKAGE_HTTPDIR ${PROJECT_PKG_BUILD_DIR}/${HTTPDIR})
        set(PACKAGE_DATADIR ${PROJECT_PKG_BUILD_DIR}/${DATADIR})
-
-       add_custom_command(OUTPUT ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR}
-               COMMAND mkdir -p ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
-       add_custom_target(populate DEPENDS ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
+       # Default test Widget default directory
+       string(REGEX REPLACE "/([^/]*)$" "/\\1-test" PROJECT_PKG_TEST_DIR "${PROJECT_PKG_BUILD_DIR}")
+       set(PACKAGE_TEST_BINDIR  ${PROJECT_PKG_TEST_DIR}/${BINDIR})
+       set(PACKAGE_TEST_ETCDIR  ${PROJECT_PKG_TEST_DIR}/${ETCDIR})
+       set(PACKAGE_TEST_LIBDIR  ${PROJECT_PKG_TEST_DIR}/${LIBDIR})
+       set(PACKAGE_TEST_HTTPDIR ${PROJECT_PKG_TEST_DIR}/${HTTPDIR})
+       set(PACKAGE_TEST_DATADIR ${PROJECT_PKG_TEST_DIR}/${DATADIR})
+
+       if(${CMAKE_BUILD_TYPE} STREQUAL "TEST")
+               add_custom_command(OUTPUT ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR} ${PACKAGE_TEST_BINDIR} ${PACKAGE_TEST_ETCDIR} ${PACKAGE_TEST_LIBDIR} ${PACKAGE_TEST_HTTPDIR} ${PACKAGE_TEST_DATADIR}
+                       COMMAND mkdir -p ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR}
+                       COMMAND mkdir -p ${PACKAGE_TEST_BINDIR} ${PACKAGE_TEST_ETCDIR} ${PACKAGE_TEST_LIBDIR} ${PACKAGE_TEST_HTTPDIR} ${PACKAGE_TEST_DATADIR})
+               add_custom_target(populate DEPENDS ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR} ${PACKAGE_TEST_BINDIR} ${PACKAGE_TEST_ETCDIR} ${PACKAGE_TEST_LIBDIR} ${PACKAGE_TEST_HTTPDIR} ${PACKAGE_TEST_DATADIR})
+       else()
+               add_custom_command(OUTPUT ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR}
+                       COMMAND mkdir -p ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
+               add_custom_target(populate DEPENDS ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
+       endif()
 
        # Dirty trick to define a default INSTALL command for app-templates handled
        # targets
@@ -322,11 +348,19 @@ macro(project_targets_populate)
                        if(${T} STREQUAL "LIBRARY")
                                unset(BD)
                                generate_one_populate_target(${IMPPATH} ${PACKAGE_LIBDIR})
+                       elseif(${T} STREQUAL "TEST-LIBRARY")
+                               unset(BD)
+                               generate_one_populate_target(${IMPPATH} ${PACKAGE_TEST_LIBDIR})
                        elseif(${T} STREQUAL "PLUGIN")
                                if(NOT S)
                                        set(S ".ctlso")
                                endif()
                                generate_one_populate_target(${P}${OUT}${S} "${PACKAGE_LIBDIR}/plugins")
+                       elseif(${CMAKE_BUILD_TYPE} STREQUAL "TEST" AND ${T} STREQUAL "TEST-PLUGIN")
+                               if(NOT S)
+                                       set(S ".ctlso")
+                               endif()
+                               generate_one_populate_target(${P}${OUT}${S} "${PACKAGE_TEST_LIBDIR}/plugins")
                        elseif(${T} STREQUAL "BINDING")
                                if(NOT S)
                                        set(S ".so")
@@ -337,7 +371,13 @@ macro(project_targets_populate)
                                if(NOT S)
                                        set(S ".so")
                                endif()
-                               afb_genskel()
+                               afb_genskel("-2")
+                               generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
+                       elseif(${T} STREQUAL "BINDINGV3")
+                               if(NOT S)
+                                       set(S ".so")
+                               endif()
+                               afb_genskel("-3")
                                generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
                        elseif(${T} STREQUAL "EXECUTABLE")
                                if(NOT S)
@@ -349,12 +389,28 @@ macro(project_targets_populate)
                                else()
                                        generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_BINDIR})
                                endif()
+                       elseif(${CMAKE_BUILD_TYPE} STREQUAL "TEST" AND ${T} STREQUAL "TEST-EXECUTABLE")
+                               if(NOT S)
+                                       set(S "")
+                               endif()
+                               if(NOT OUT AND IMPPATH)
+                                       unset(BD)
+                                       generate_one_populate_target(${IMPPATH} ${PACKAGE_TEST_BINDIR})
+                               else()
+                                       generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_TEST_BINDIR})
+                               endif()
                        elseif(${T} STREQUAL "HTDOCS")
                                generate_one_populate_target(${P}${OUT} ${PACKAGE_HTTPDIR})
-                       elseif(${T} STREQUAL "DATA")
+                       elseif(${CMAKE_BUILD_TYPE} STREQUAL "TEST" AND ${T} STREQUAL "TEST-HTDOCS")
+                               generate_one_populate_target(${P}${OUT} ${PACKAGE_HTTPDIR})
+                       elseif(${T} STREQUAL "DATA" )
                                generate_one_populate_target(${TARGET} ${PACKAGE_DATADIR})
-                       elseif(${T} STREQUAL "BINDING-CONFIG")
+                       elseif(${CMAKE_BUILD_TYPE} STREQUAL "TEST" AND ${T} STREQUAL "TEST-DATA")
+                               generate_one_populate_target(${TARGET} ${PACKAGE_TEST_DATADIR})
+                       elseif(${T} STREQUAL "BINDING-CONFIG" )
                                generate_one_populate_target(${TARGET} ${PACKAGE_ETCDIR})
+                       elseif(${CMAKE_BUILD_TYPE} STREQUAL "TEST" AND ${T} STREQUAL "TEST-CONFIG")
+                               generate_one_populate_target(${TARGET} ${PACKAGE_TEST_ETCDIR})
                        endif()
                        elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
                                MESSAGE("${Yellow}.. Warning: ${TARGET} ignored when packaging.${ColourReset}")
@@ -445,9 +501,20 @@ macro(wgt_package_build)
        add_custom_command(OUTPUT ${PROJECT_PKG_BUILD_DIR}/config.xml
                COMMAND ${CMAKE_COMMAND} -DINFILE=${WIDGET_CONFIG_TEMPLATE} -DOUTFILE=${PROJECT_PKG_BUILD_DIR}/config.xml -DPROJECT_BINARY_DIR=${CMAKE_CURRENT_BINARY_DIR} -P ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/cmake/configure_file.cmake
                COMMAND cp ${ICON_PATH} ${PROJECT_PKG_BUILD_DIR}/${PROJECT_ICON}
-
        )
-       add_custom_target(packaging_wgt DEPENDS ${PROJECT_PKG_BUILD_DIR}/config.xml)
+       add_custom_command(OUTPUT ${PROJECT_PKG_TEST_DIR}/test-config.xml ${PROJECT_PKG_TEST_DIR}/bin/launcher
+               COMMAND ${CMAKE_COMMAND} -DINFILE=${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/test-widget/test-config.xml.in -DOUTFILE=${PROJECT_PKG_TEST_DIR}/config.xml -DPROJECT_BINARY_DIR=${CMAKE_CURRENT_BINARY_DIR} -P ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/cmake/configure_file.cmake
+               COMMAND cp ${ICON_PATH} ${PROJECT_PKG_TEST_DIR}/${PROJECT_ICON}
+               COMMAND cp ${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}//test-widget/launcher.sh.in ${PROJECT_PKG_TEST_DIR}/bin/launcher
+       )
+
+       if(${CMAKE_BUILD_TYPE} STREQUAL "TEST")
+               string(TOLOWER "${PROJECT_NAME}-${CMAKE_BUILD_TYPE}" WGT_NAME)
+               add_custom_target(packaging_wgt DEPENDS ${PROJECT_PKG_BUILD_DIR}/config.xml ${PROJECT_PKG_TEST_DIR}/test-config.xml ${PROJECT_PKG_TEST_DIR}/bin/launcher)
+       else()
+               string(TOLOWER "${PROJECT_NAME}" WGT_NAME)
+               add_custom_target(packaging_wgt DEPENDS ${PROJECT_PKG_BUILD_DIR}/config.xml)
+       endif()
 
        # Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
        file(GLOB PROJECT_CONF_FILES "${TEMPLATE_DIR}/etc/*")
@@ -455,14 +522,39 @@ macro(wgt_package_build)
                file(COPY "${TEMPLATE_DIR}/etc/*" DESTINATION ${PROJECT_PKG_BUILD_DIR}/etc/)
        endif(${PROJECT_CONF_FILES})
 
-       add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
+       find_program(wgtpkgCMD "wgtpkg-pack")
+       if(wgtpkgCMD)
+               set(packCMD ${wgtpkgCMD} "-f" "-o" "${WGT_NAME}.wgt" ${PROJECT_PKG_BUILD_DIR})
+               set(packCMDTest ${wgtpkgCMD} "-f" "-o" "${WGT_NAME}-test.wgt" ${PROJECT_PKG_TEST_DIR})
+       else()
+               find_program(wgtpkgCMD "zip")
+               if(wgtpkgCMD)
+                       set(packCMD ${CMAKE_COMMAND} -E cmake_echo_color --yellow "Warning: Widget will be built using Zip, NOT using the Application Framework widget pack command." && cd ${PROJECT_PKG_BUILD_DIR} && ${wgtpkgCMD} "../${WGT_NAME}.wgt" "*")
+                       set(packCMDTest ${CMAKE_COMMAND} -E cmake_echo_color --yellow "Warning: Test widget will be built using Zip, NOT using the Application Framework widget pack command." && cd ${PROJECT_PKG_TEST_DIR} && ${wgtpkgCMD} "../${WGT_NAME}-test.wgt" "*")
+               else()
+                       set(packCMD ${CMAKE_COMMAND} -E cmake_echo_color --red "Error: No utility found to build a widget. Either install wgtpkg-pack from App Framework or zip command")
+               endif()
+       endif()
+
+       add_custom_command(OUTPUT ${WGT_NAME}.wgt
+               DEPENDS ${PROJECT_TARGETS}
+               COMMAND ${packCMD}
+       )
+
+       add_custom_command(OUTPUT ${WGT_NAME}-test.wgt
                DEPENDS ${PROJECT_TARGETS}
-               COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${PROJECT_PKG_BUILD_DIR}
+               COMMAND ${packCMDTest}
        )
 
-       add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
+       if(${CMAKE_BUILD_TYPE} STREQUAL "TEST")
+               add_custom_target(widget DEPENDS ${WGT_NAME}.wgt ${WGT_NAME}-test.wgt)
+               set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/${WGT_NAME}-test.wgt")
+       else()
+               add_custom_target(widget DEPENDS ${WGT_NAME}.wgt)
+       endif()
+
        add_dependencies(widget populate packaging_wgt)
-       set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.wgt")
+       set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/${WGT_NAME}.wgt")
 
        if(NOT RSYNC_TARGET)
                message ("${Yellow}.. Warning: RSYNC_TARGET not defined 'make widget-target-install' not instanciated${ColourReset}")
@@ -471,13 +563,13 @@ macro(wgt_package_build)
                        COMMAND exit -1
                )
        else()
-       configure_files_in_dir(${TEMPLATE_DIR})
-       add_custom_target(widget-target-install
-       DEPENDS widget
-       COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
-       COMMAND ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
-       )
-endif()
+               configure_files_in_dir(${TEMPLATE_DIR})
+               add_custom_target(widget-target-install
+                       DEPENDS widget
+                       COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
+                       COMMAND ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
+               )
+       endif()
 
        if(PACKAGE_MESSAGE)
        add_custom_command(TARGET widget
@@ -522,6 +614,8 @@ macro(project_subdirs_add)
        foreach(filename ${filelist})
                if(EXISTS "${filename}/CMakeLists.txt")
                        add_subdirectory(${filename})
+               elseif(${filename} MATCHES "^.*\\.cmake$")
+                       include(${filename})
                endif(EXISTS "${filename}/CMakeLists.txt")
        endforeach()
 endmacro(project_subdirs_add)
@@ -539,3 +633,23 @@ macro(project_closing_msg)
                        ${PROJECT_TARGETS} populate)
        endif()
 endmacro()
+
+macro(check_version)
+       if(GIT_PROJECT_VERSION)
+               if(${GIT_PROJECT_VERSION} VERSION_GREATER ${APP_TEMPLATES_VERSION})
+                       message(STATUS "${Yellow}.. Your app-templates submodule version seems outdated. You should update it with 'git submodule update --remote ${PROJECT_APP_TEMPLATES_DIR}'.
+               - App-templates version: ${APP_TEMPLATES_VERSION}
+               - Project version according AGL Git tag: ${GIT_PROJECT_VERSION}"
+               )
+               endif()
+       elseif(PROJECT_VERSION)
+               if(${PROJECT_VERSION} VERSION_GREATER ${APP_TEMPLATES_VERSION})
+                       message(STATUS "${Yellow}.. Your app-templates submodule version seems outdated. You should update it with 'git submodule update --remote ${PROJECT_APP_TEMPLATES_DIR}'.
+               - App-templates version: ${APP_TEMPLATES_VERSION}
+               - Project version according AGL Git tag: ${PROJECT_VERSION}"
+               )
+               endif()
+       else()
+               message(STATUS "${Yellow} Your git project repo doesn't have any version tags nor hosted by AGL gerrit infrastructure. Can't compare version between project and app-templates ${APP_TEMPLATES_VERSION} ${ColourReset}")
+       endif()
+endmacro()