# ---------------------------------------------------------------
# Programmer(s): David J. Gardner @ LLNL
# ---------------------------------------------------------------
# SUNDIALS Copyright Start
# Copyright (c) 2025-2026, Lawrence Livermore National Security,
# University of Maryland Baltimore County, and the SUNDIALS contributors.
# Copyright (c) 2013-2025, Lawrence Livermore National Security
# and Southern Methodist University.
# Copyright (c) 2002-2013, Lawrence Livermore National Security.
# All rights reserved.
#
# See the top-level LICENSE and NOTICE files for details.
#
# SPDX-License-Identifier: BSD-3-Clause
# SUNDIALS Copyright End
# ---------------------------------------------------------------
# Enable SUNDIALS Testing
# ---------------------------------------------------------------

# Enable testing with 'make test'
include(CTest)

#
# Check if the test runner is needed
#
if(SUNDIALS_TEST_ENABLE_DIFF_OUTPUT OR (SUNDIALS_TEST_ENABLE_PROFILING
                                        AND ENABLE_CALIPER))
  set(SUNDIALS_TEST_USE_RUNNER TRUE)
  # Python is needed to use the test runner
  find_package(Python3 REQUIRED)
  # Look for the testRunner script in the test directory
  find_program(
    TESTRUNNER testRunner
    PATHS test
    NO_DEFAULT_PATH REQUIRED)
  message(STATUS "Found testRunner: ${TESTRUNNER}")
  set(TESTRUNNER
      ${TESTRUNNER}
      CACHE INTERNAL "")
else()
  set(SUNDIALS_TEST_USE_RUNNER FALSE)
endif()

#
# Print comparison settings
#
if(SUNDIALS_TEST_ENABLE_DIFF_OUTPUT)
  message(STATUS "Enabled comparing test output with answer files")

  # Create the test output directory
  if(NOT EXISTS ${SUNDIALS_TEST_OUTPUT_DIR})
    file(MAKE_DIRECTORY ${SUNDIALS_TEST_OUTPUT_DIR})
  endif()
  message(STATUS "Test output directory: ${SUNDIALS_TEST_OUTPUT_DIR}")

  # If a non-default answer directory was provided make sure it exists
  if(SUNDIALS_TEST_ANSWER_DIR)
    message(STATUS "Test answer directory: ${SUNDIALS_TEST_ANSWER_DIR}")
    if(NOT EXISTS ${SUNDIALS_TEST_ANSWER_DIR})
      message(FATAL_ERROR "${SUNDIALS_TEST_ANSWER_DIR} does not exist!")
    endif()
  endif()

  message(
    STATUS
      "Test float comparison precision (number of digits): ${SUNDIALS_TEST_FLOAT_PRECISION}"
  )
  message(
    STATUS
      "Test integer comparison precision (percent difference): ${SUNDIALS_TEST_INTEGER_PRECISION}"
  )
endif()

#
# Print Caliper profiling settings
#
if(SUNDIALS_TEST_ENABLE_PROFILING AND ENABLE_CALIPER)
  message(STATUS "Enabled test profiling with Caliper")
  if(NOT EXISTS ${SUNDIALS_TEST_CALIPER_OUTPUT_DIR})
    file(MAKE_DIRECTORY ${SUNDIALS_TEST_CALIPER_OUTPUT_DIR})
  endif()
  message(
    STATUS "Test Caliper output directory: ${SUNDIALS_TEST_CALIPER_OUTPUT_DIR}")
endif()

#
# Target to run tests in CI containers
#
if(NOT SUNDIALS_TEST_CONTAINER_EXE)
  find_program(container_exe docker)
  if(NOT container_exe)
    find_program(container_exe podman)
  endif()
  set(SUNDIALS_TEST_CONTAINER_EXE
      ${container_exe}
      CACHE PATH "Path to docker or podman" FORCE)
endif()

if(SUNDIALS_TEST_CONTAINER_EXE)
  add_custom_target(setup_local_ci ${CMAKE_COMMAND} -E cmake_echo_color --cyan
                                   "Pulled SUNDIALS CI containers.")

  add_custom_target(
    test_local_ci ${CMAKE_COMMAND} -E cmake_echo_color --cyan
                  "All testing with SUNDIALS CI containers complete.")

  macro(add_local_ci_target index_size precision tag)
    string(TOLOWER "${precision}" precision_)
    set(container sundials-ci-int${index_size}-${precision_})
    set(container_exe_args
        run
        ${SUNDIALS_TEST_CONTAINER_RUN_EXTRA_ARGS}
        -t
        -d
        --name
        ${container}
        --cap-add
        SYS_PTRACE
        -v
        ${CMAKE_SOURCE_DIR}:${SUNDIALS_TEST_CONTAINER_MNT}
        ghcr.io/llnl/${container}:${tag})
    add_custom_target(
      setup_local_ci_${index_size}_${precision_}
      COMMENT "Pulling SUNDIALS CI container ghcr.io/llnl/${container}:${tag}"
      COMMAND ${SUNDIALS_TEST_CONTAINER_EXE} ${container_exe_args})
    add_dependencies(setup_local_ci setup_local_ci_${index_size}_${precision_})

    set(container_test_exe ./test_driver.sh)
    set(container_test_exe_args
        --testtype
        CUSTOM
        --env
        env/docker.sh
        --tpls
        --sunrealtype
        ${precision_}
        --indexsize
        ${index_size})
    set(container_exe_args
        exec -w ${SUNDIALS_TEST_CONTAINER_MNT}/test ${container}
        ${container_test_exe} ${container_test_exe_args})
    add_custom_target(
      test_local_ci_${index_size}_${precision_}
      COMMENT "Running tests in CI container ${container}:${tag}"
      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
      COMMAND ${SUNDIALS_TEST_CONTAINER_EXE} ${container_exe_args}
      VERBATIM)
    add_dependencies(test_local_ci test_local_ci_${index_size}_${precision_})

    unset(container)
    unset(container_exe_args)
    unset(container_test_exe)
    unset(container_test_exe_args)
  endmacro()

  add_local_ci_target(${SUNDIALS_INDEX_SIZE} ${SUNDIALS_PRECISION} latest)
endif()

#
# Check if GTest is needed
#
if(SUNDIALS_TEST_ENABLE_GTEST)
  # find_package(GTest)
  if(NOT (TARGET GTest::gtest_main OR TARGET GTest::Main))
    include(FetchContent)
    FetchContent_Declare(
      googletest
      URL https://github.com/google/googletest/archive/refs/tags/v1.16.0.zip
      URL_HASH
        SHA256=a9607c9215866bd425a725610c5e0f739eeb50887a57903df48891446ce6fb3c)
    if(WIN32)
      # For Windows: Prevent overriding the parent project's compiler/linker
      # settings
      set(gtest_force_shared_crt
          ON
          CACHE BOOL "" FORCE)
    endif()
    FetchContent_MakeAvailable(googletest)
    include(GoogleTest)
  endif()
endif()

#
# Create `make test_install` and `make test_install_all`
#
if(EXAMPLES_INSTALL)

  # Directories for installation testing
  set(TEST_INSTALL_DIR ${PROJECT_BINARY_DIR}/Testing_Install)
  set(TEST_INSTALL_ALL_DIR ${PROJECT_BINARY_DIR}/Testing_Install_All)

  # Create installation testing directories
  if(NOT EXISTS ${TEST_INSTALL_DIR})
    file(MAKE_DIRECTORY ${TEST_INSTALL_DIR})
  endif()

  if(NOT EXISTS ${TEST_INSTALL_ALL_DIR})
    file(MAKE_DIRECTORY ${TEST_INSTALL_ALL_DIR})
  endif()

  # Create test_install and test_install_all targets
  add_custom_target(test_install ${CMAKE_COMMAND} -E cmake_echo_color --cyan
                                 "All installation tests complete.")

  add_custom_target(test_install_all ${CMAKE_COMMAND} -E cmake_echo_color
                                     --cyan "All installation tests complete.")

endif()