#===============================================================================
# @file   AkantuTestMacros.cmake
#
# @author Nicolas Richart <nicolas.richart@epfl.ch>
#
# @date creation: Mon Oct 25 2010
# @date last modification: Tue Jun 24 2014
#
# @brief  macros for tests
#
# @section LICENSE
#
# Copyright (©) 2010-2012, 2014 EPFL (Ecole Polytechnique Fédérale de Lausanne)
# Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
#
# Akantu is free  software: you can redistribute it and/or  modify it under the
# terms  of the  GNU Lesser  General Public  License as  published by  the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# Akantu is  distributed in the  hope that it  will be useful, but  WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A  PARTICULAR PURPOSE. See  the GNU  Lesser General  Public License  for more
# details.
#
# You should  have received  a copy  of the GNU  Lesser General  Public License
# along with Akantu. If not, see <http://www.gnu.org/licenses/>.
#

#[=======================================================================[.rst:
#AkantuTestsMacros
#-----------------
#
#This modules provides the functions to helper to declare tests and folders
#containing tests in akantu
#
#.. command:: add_test_tree
#
#    add_test_tree(<test_direcotry>)
#
#  ``<test_directory>`` is the entry direcroty of the full structure of
#  subfolders containing tests
#
#.. command:: add_akantu_test
#
#    add_akantu_test(<dir> <desc>)
#
#  This function add a subdirectory ``<dir>`` of tests that will be conditionnaly
#  activable and will be visible only if the parent folder as been activated An
#  option ``AKANTU_BUILD_TEST_<dir>`` will appear in ccmake with the description
#  ``<desc>``. The compilation of all tests can be forced with the option
#  ``AKANTU_BUILD_ALL_TESTS``
#
#.. command:: register_test
#
#    register_test(<test_name>
#      SOURCES <sources>...
#      PACKAGE <akantu_packages>...
#      [FILES_TO_COPY <filenames>...]
#      [DEPENDS <targets>...]
#      [DIRECTORIES_TO_CREATE <directories>...]
#      [COMPILE_OPTIONS <flags>...]
#      [EXTRA_FILES <filnames>...]
#      [UNSABLE]
#      )
#
#  This function defines a test ``<test_name>_run`` this test could be of
#  different nature depending on the context. If Just sources are provided the
#  test consist of running the executable generated. If a file ``<test_name>.sh``
#  is present the test will execute the script. And if a ``<test_name>.verified``
#  exists the output of the test will be compared to this reference file
#
#  The options are:
#
#  ``SOURCES <sources>...``
#    The list of source files to compile to generate the executable of the test
#
#  ``PACKAGE <akantu_packages>...``
#    The list of package to which this test belongs. The test will be activable
#    only of all the packages listed are activated
#
#  ``FILES_TO_COPY <filenames>...``
#    List of files to copy from the source directory to the build directory
#
#  ``DEPENDS <targets>...``
#    List of targets the test depends on, for example if a mesh as to be generated
#
#  ``DIRECTORIES_TO_CREATE <directories>...``
#    Obsolete. This specifies a list of directories that have to be created in
#    the build folder
#
#  ``COMPILE_OPTIONS <flags>...``
#    List of extra compilations options to pass to the compiler
#
#  ``EXTRA_FILES <filnames>...``
#    Files to consider when generating a package_source
#
#  ``UNSABLE``
#    If this option is specified the test can be unacitivated by the glocal option
#    ``AKANTU_BUILD_UNSTABLE_TESTS``, this is mainly intendeed to remove test
#    under developement from the continious integration
#
#  ``PARALLEL``
#    This specifies that this test should be run in parallel. It will generate a
#    series of test for different number of processors. This automaticaly adds a
#    dependency to the package ``AKANTU_PARALLEL``
#
#]=======================================================================]

set(AKANTU_DIFF_SCRIPT ${AKANTU_CMAKE_DIR}/akantu_diff.sh)
set(AKANTU_POSTPROCESS_SCRIPT ${AKANTU_CMAKE_DIR}/akantu_apply_post_process.sh)
set(AKANTU_DRIVER_SCRIPT ${AKANTU_CMAKE_DIR}/akantu_test_driver.sh)

# ==============================================================================
macro(add_test_tree dir)
  if(AKANTU_TESTS)
    enable_testing()
    include(CTest)
    mark_as_advanced(BUILD_TESTING)

    set(AKANTU_TESTS_EXCLUDE_FILES "" CACHE INTERNAL "")

    set(_akantu_current_parent_test ${dir} CACHE INTERNAL "Current test folder" FORCE)
    set(_akantu_${dir}_tests_count 0 CACHE INTERNAL "" FORCE)

    string(TOUPPER ${dir} _u_dir)
    set(AKANTU_BUILD_${_u_dir} ON CACHE INTERNAL "${desc}" FORCE)

    package_get_all_test_folders(_test_dirs)

    foreach(_dir ${_test_dirs})
      add_subdirectory(${_dir})
    endforeach()
  else()
    set(AKANTU_TESTS_EXCLUDE_FILES "${CMAKE_CURRENT_BINARY_DIR}/${dir}" CACHE INTERNAL "")
  endif()
endmacro()

# ==============================================================================
function(add_akantu_test dir desc)
  set(_my_parent_dir ${_akantu_current_parent_test})

  # initialize variables
  set(_akantu_current_parent_test ${dir} CACHE INTERNAL "Current test folder" FORCE)
  set(_akantu_${dir}_tests_count 0 CACHE INTERNAL "" FORCE)

  # set the option for this directory
  string(TOUPPER ${dir} _u_dir)
  option(AKANTU_BUILD_${_u_dir} "${desc}")
  mark_as_advanced(AKANTU_BUILD_${_u_dir})

  # add the sub-directory
  add_subdirectory(${dir})

  # if no test can be activated make the option disappear
  set(_force_deactivate_count FALSE)
  if(${_akantu_${dir}_tests_count} EQUAL 0)
    set(_force_deactivate_count TRUE)
  endif()

  # if parent off make the option disappear
  set(_force_deactivate_parent FALSE)
  string(TOUPPER ${_my_parent_dir} _u_parent_dir)
  if(NOT AKANTU_BUILD_${_u_parent_dir})
    set(_force_deactivate_parent TRUE)
  endif()

  if(_force_deactivate_parent OR _force_deactivate_count OR AKANTU_BUILD_ALL_TESTS)
    if(NOT DEFINED _AKANTU_BUILD_${_u_dir}_SAVE)
      set(_AKANTU_BUILD_${_u_dir}_SAVE ${AKANTU_BUILD_${_u_dir}} CACHE INTERNAL "" FORCE)
    endif()
    unset(AKANTU_BUILD_${_u_dir} CACHE)
    if(AKANTU_BUILD_ALL_TESTS AND NOT _force_deactivate_count)
      set(AKANTU_BUILD_${_u_dir} ON CACHE INTERNAL "${desc}" FORCE)
    else()
      set(AKANTU_BUILD_${_u_dir} OFF CACHE INTERNAL "${desc}" FORCE)
    endif()
  else()
    if(DEFINED _AKANTU_BUILD_${_u_dir}_SAVE)
      unset(AKANTU_BUILD_${_u_dir} CACHE)
      set(AKANTU_BUILD_${_u_dir} ${_AKANTU_BUILD_${_u_dir}_SAVE} CACHE BOOL "${desc}")
      unset(_AKANTU_BUILD_${_u_dir}_SAVE CACHE)
    endif()
  endif()

  # adding up to the parent count
  math(EXPR _tmp_parent_count "${_akantu_${dir}_tests_count} + ${_akantu_${_my_parent_dir}_tests_count}")
  set(_akantu_${_my_parent_dir}_tests_count ${_tmp_parent_count} CACHE INTERNAL "" FORCE)

  # restoring the parent current dir
  set(_akantu_current_parent_test ${_my_parent_dir} CACHE INTERNAL "Current test folder" FORCE)
endfunction()


# ==============================================================================
function(register_test test_name)
   set(multi_variables
    SOURCES FILES_TO_COPY DEPENDS DIRECTORIES_TO_CREATE COMPILE_OPTIONS EXTRA_FILES PACKAGE
    )

  cmake_parse_arguments(_register_test
    "UNSTABLE PARALLEL"
    "POSTPROCESS"
    "${multi_variables}"
    ${ARGN}
    )

  if(NOT _register_test_PACKAGE)
    message(FATAL_ERROR "No reference package was defined for the test ${test_name} in folder ${CMAKE_CURRENT_SOURCE_DIR}")
  endif()

  set(_test_act TRUE)
  # Activate the test anly if all packages associated to the test are activated
  foreach(_package ${_register_test_PACKAGE})
    package_is_activated(${_package} _act)
    if(NOT _act)
      set(_test_act FALSE)
    endif()
  endforeach()

  # check if the test is marked unstable and if the unstable test should be run
  if(_register_test_UNSTABLE AND NOT AKANTU_BUILD_UNSTABLE_TESTS)
    set(_test_act FALSE)
  endif()

  # todo this should be checked for the build package_sources since the file will not be listed.
  if(_test_act)
    math(EXPR _tmp_parent_count "${_akantu_${_akantu_current_parent_test}_tests_count} + 1")
    set(_akantu_${_akantu_current_parent_test}_tests_count ${_tmp_parent_count} CACHE INTERNAL "" FORCE)

    string(TOUPPER ${_akantu_current_parent_test} _u_parent)
    if(AKANTU_BUILD_${_u_parent} OR AKANTU_BUILD_ALL_TESTS)
      # get the include directories for sources in activated directories
      package_get_all_include_directories(
        AKANTU_LIBRARY_INCLUDE_DIRS
        )

      # get the external packages compilation and linking informations
      package_get_all_external_informations(
        AKANTU_EXTERNAL_INCLUDE_DIR
        AKANTU_EXTERNAL_LIBRARIES
        )

      # set the proper includes to build most of the tests
      include_directories(
        ${AKANTU_INCLUDE_DIRS}
        ${AKANTU_EXTERNAL_LIB_INCLUDE_DIR}
        )

      # Register the executable to compile
      add_executable(${test_name} ${_register_test_SOURCES} ${_register_test_UNPARSED_ARGUMENTS})
      set_property(TARGET ${test_name}  APPEND
        PROPERTY INCLUDE_DIRECTORIES ${AKANTU_LIBRARY_INCLUDE_DIRS} ${AKANTU_EXTERNAL_INCLUDE_DIR})
      target_link_libraries(${test_name} akantu ${AKANTU_EXTERNAL_LIBRARIES})

      # add the extra compilation options
      if(_register_test_COMPILE_OPTIONS)
        set_target_properties(${test_name}
          PROPERTIES COMPILE_DEFINITIONS "${_register_test_COMPILE_OPTIONS}")
      endif()

      set(_test_all_files)
      # add the different dependencies (meshes, local libraries, ...)
      foreach(_dep ${_register_test_DEPENDS})
        add_dependencies(${test_name} ${_dep})
        get_target_property(_dep_in_ressources ${_dep} RESSOURCES)

        if(_dep_in_ressources)
          list(APPEND _test_all_files "${_dep_in_ressources}")
        endif()
      endforeach()

      # copy the needed files to the build folder
      if(_register_test_FILES_TO_COPY)
        foreach(_file ${_register_test_FILES_TO_COPY})
          file(COPY "${_file}" DESTINATION .)
          list(APPEND _test_all_files "${CMAKE_CURRENT_SOURCE_DIR}/${_file}")
        endforeach()
      endif()

      # create the needed folders in the build folder
      if(_register_test_DIRECTORIES_TO_CREATE)
        foreach(_dir ${_register_test_DIRECTORIES_TO_CREATE})
          if(IS_ABSOLUTE ${dir})
            file(MAKE_DIRECTORY "${_dir}")
          else()
            file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${_dir}")
          endif()
        endforeach()
      endif()

      # add the source files in the list of all files
      foreach(_file ${_register_test_SOURCES} ${_register_test_UNPARSED_ARGUMENTS} ${_register_test_EXTRA_FILES})
        if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${_file})
          list(APPEND _test_all_files "${CMAKE_CURRENT_SOURCE_DIR}/${_file}")
        else()
          message("The file \"${_file}\" registred by the test \"${test_name}\" does not exists")
        endif()
      endforeach()


      set(_arguments -n "${test_name}")
      # register the test for ctest
      if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.sh")
        file(COPY ${test_name}.sh DESTINATION .)
        list(APPEND _test_all_files "${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.sh")
        list(APPEND _arguments -e "${test_name}.sh")
      else()
        list(APPEND _arguments -e "${test_name}")
      endif()

      if(_register_test_PARALLEL)
        list(APPEND _arguments -p "${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG}")
      endif()

      list(APPEND _arguments -w "${CMAKE_CURRENT_BINARY_DIR}")

      if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified")
        list(APPEND _arguments -r "${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified")
      endif()

      string(REPLACE ";" " " _command "${_arguments}")

      add_test(NAME ${test_name}_run
        COMMAND ${AKANTU_DRIVER_SCRIPT} ${_arguments})

      # add the executable as a dependency of the run
      set_tests_properties(${test_name}_run PROPERTIES DEPENDS ${test_name})


      #   add_test(${test_name}_run
      #     ${AKANTU_REDIRECT_SCRIPT} ${CMAKE_CURRENT_BINARY_DIR}/${test_name}.sh)
      # elseif(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified)
      #   list(APPEND _test_all_files ${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified)
      #   add_test(${test_name}_run
      #     ${AKANTU_DIFF_SCRIPT} ${test_name} ${CMAKE_CURRENT_SOURCE_DIR}/${test_name}.verified)
      # else()
      #   add_test(${test_name}_run
      #     ${CMAKE_CURRENT_BINARY_DIR}/${test_name})
      # endif()


      # clean the list of all files for this test and add them in the total list
      set(_tmp ${AKANTU_TESTS_FILES})
      foreach(_file ${_source_file})
        get_filename_component(_full ${_file} ABSOLUTE)
        file(RELATIVE_PATH __file ${PROJECT_SOURCE_DIR} ${_full})
        list(APPEND _tmp "${__file}")
        list(APPEND _pkg_tmp "${__file}")
      endforeach()
      set(AKANTU_TESTS_FILES ${_tmp} CACHE INTERNAL "")
    endif()
  endif()
endfunction()