// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
//
// SPDX-License-Identifier: BSD-3-Clause

#include <ginkgo/core/config/registry.hpp>


#include <gtest/gtest.h>


#include <ginkgo/core/base/exception.hpp>
#include <ginkgo/core/base/executor.hpp>
#include <ginkgo/core/matrix/dense.hpp>
#include <ginkgo/core/solver/cg.hpp>
#include <ginkgo/core/solver/solver_base.hpp>
#include <ginkgo/core/stop/iteration.hpp>
#include <ginkgo/core/stop/time.hpp>


#include "core/config/config_helper.hpp"
#include "core/config/registry_accessor.hpp"
#include "core/test/utils.hpp"


using namespace gko::config;


class Registry : public ::testing::Test {
protected:
    using Matrix = gko::matrix::Dense<float>;
    using Solver = gko::solver::Cg<float>;
    using Stop = gko::stop::Iteration;

    Registry()
        : exec{gko::ReferenceExecutor::create()},
          matrix{Matrix::create(exec)},
          solver_factory{Solver::build().on(exec)},
          stop_factory{Stop::build().on(exec)},
          func{[](const pnode& config, const registry& context,
                  const type_descriptor& td_for_child) {
              return gko::solver::Cg<float>::build();
          }},
          reg{{{"func", func}}}
    {}

    std::shared_ptr<const gko::Executor> exec;
    std::shared_ptr<Matrix> matrix;
    std::shared_ptr<typename Solver::Factory> solver_factory;
    std::shared_ptr<typename Stop::Factory> stop_factory;
    std::function<gko::deferred_factory_parameter<gko::LinOpFactory>(
        const pnode&, const registry&, type_descriptor)>
        func;
    registry reg;
};


TEST_F(Registry, InsertData)
{
    {
        SCOPED_TRACE("can put data");
        ASSERT_TRUE(reg.emplace("matrix", matrix));
        ASSERT_TRUE(reg.emplace("solver_factory", solver_factory));
        ASSERT_TRUE(reg.emplace("stop_factory", stop_factory));
    }
    {
        SCOPED_TRACE("do not insert the same key like normal map");
        ASSERT_FALSE(reg.emplace("matrix", matrix));
        ASSERT_FALSE(reg.emplace("solver_factory", solver_factory));
        ASSERT_FALSE(reg.emplace("stop_factory", stop_factory));
    }
}


TEST_F(Registry, SearchData)
{
    reg.emplace("matrix", matrix);
    reg.emplace("solver_factory", solver_factory);
    reg.emplace("stop_factory", stop_factory);

    auto found_matrix =
        detail::registry_accessor::get_data<gko::LinOp>(reg, "matrix");
    auto found_solver_factory =
        detail::registry_accessor::get_data<gko::LinOpFactory>(
            reg, "solver_factory");
    auto found_stop_factory =
        detail::registry_accessor::get_data<gko::stop::CriterionFactory>(
            reg, "stop_factory");

    // get correct ptrs
    ASSERT_EQ(found_matrix, matrix);
    ASSERT_EQ(found_solver_factory, solver_factory);
    ASSERT_EQ(found_stop_factory, stop_factory);
    // get correct types
    testing::StaticAssertTypeEq<decltype(found_matrix),
                                std::shared_ptr<gko::LinOp>>();
    testing::StaticAssertTypeEq<decltype(found_solver_factory),
                                std::shared_ptr<gko::LinOpFactory>>();
    testing::StaticAssertTypeEq<decltype(found_stop_factory),
                                std::shared_ptr<gko::stop::CriterionFactory>>();
}


TEST_F(Registry, SearchDataWithType)
{
    reg.emplace("matrix", matrix);
    reg.emplace("solver_factory", solver_factory);
    reg.emplace("stop_factory", stop_factory);

    auto found_matrix =
        detail::registry_accessor::get_data<Matrix>(reg, "matrix");
    auto found_solver_factory =
        detail::registry_accessor::get_data<Solver::Factory>(reg,
                                                             "solver_factory");
    auto found_stop_factory =
        detail::registry_accessor::get_data<Stop::Factory>(reg, "stop_factory");

    // get correct ptrs
    ASSERT_EQ(found_matrix, matrix);
    ASSERT_EQ(found_solver_factory, solver_factory);
    ASSERT_EQ(found_stop_factory, stop_factory);
    // get correct types
    testing::StaticAssertTypeEq<decltype(found_matrix),
                                std::shared_ptr<Matrix>>();
    testing::StaticAssertTypeEq<decltype(found_solver_factory),
                                std::shared_ptr<typename Solver::Factory>>();
    testing::StaticAssertTypeEq<decltype(found_stop_factory),
                                std::shared_ptr<typename Stop::Factory>>();
}


TEST_F(Registry, BuildFromConstructor)
{
    registry reg_obj{{{"matrix", matrix},
                      {"solver_factory", solver_factory},
                      {"stop_factory", stop_factory}}};

    auto found_matrix =
        detail::registry_accessor::get_data<Matrix>(reg_obj, "matrix");
    auto found_solver_factory =
        detail::registry_accessor::get_data<Solver::Factory>(reg_obj,
                                                             "solver_factory");
    auto found_stop_factory =
        detail::registry_accessor::get_data<Stop::Factory>(reg_obj,
                                                           "stop_factory");
    // get correct ptrs
    ASSERT_EQ(found_matrix, matrix);
    ASSERT_EQ(found_solver_factory, solver_factory);
    ASSERT_EQ(found_stop_factory, stop_factory);
    // get correct types
    testing::StaticAssertTypeEq<decltype(found_matrix),
                                std::shared_ptr<Matrix>>();
    testing::StaticAssertTypeEq<decltype(found_solver_factory),
                                std::shared_ptr<typename Solver::Factory>>();
    testing::StaticAssertTypeEq<decltype(found_stop_factory),
                                std::shared_ptr<typename Stop::Factory>>();
}


TEST_F(Registry, ThrowIfNotFound)
{
    ASSERT_THROW(detail::registry_accessor::get_data<gko::LinOp>(reg, "N"),
                 std::out_of_range);
    ASSERT_THROW(
        detail::registry_accessor::get_data<gko::LinOpFactory>(reg, "N"),
        std::out_of_range);
    ASSERT_THROW(
        detail::registry_accessor::get_data<gko::stop::CriterionFactory>(reg,
                                                                         "N"),
        std::out_of_range);
}


TEST_F(Registry, ThrowWithWrongType)
{
    reg.emplace("matrix", matrix);
    reg.emplace("solver_factory", solver_factory);
    reg.emplace("stop_factory", stop_factory);

    ASSERT_THROW(
        detail::registry_accessor::get_data<gko::matrix::Dense<double>>(
            reg, "matrix"),
        gko::NotSupported);
    ASSERT_THROW(
        detail::registry_accessor::get_data<gko::solver::Cg<double>::Factory>(
            reg, "solver_factory"),
        gko::NotSupported);
    ASSERT_THROW(detail::registry_accessor::get_data<gko::stop::Time::Factory>(
                     reg, "stop_factory"),
                 gko::NotSupported);
}


TEST_F(Registry, GetBuildMap)
{
    auto factory =
        detail::registry_accessor::get_build_map(reg)
            .at("func")(pnode{"unused"}, reg, type_descriptor{"void", "void"})
            .on(exec);

    ASSERT_NE(factory, nullptr);
}
