/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2023,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NFD_TESTS_DAEMON_FACE_TRANSPORT_TEST_COMMON_HPP
#define NFD_TESTS_DAEMON_FACE_TRANSPORT_TEST_COMMON_HPP

#include "face/transport.hpp"
#include "tests/test-common.hpp"
#include "test-ip.hpp"

namespace nfd::tests {

/**
 * \brief Check that a transport has all its static properties set after initialization.
 *
 * This check shall be inserted to the StaticProperties test case for each transport,
 * in addition to checking the values of properties.
 * When a new static property is defined, this test case shall be updated.
 * Thus, if a transport forgets to set a static property, this check would fail.
 */
inline void
checkStaticPropertiesInitialized(const face::Transport& transport)
{
  BOOST_TEST(transport.getLocalUri().getScheme().empty() == false);
  BOOST_TEST(transport.getRemoteUri().getScheme().empty() == false);
  BOOST_TEST(transport.getScope() != ndn::nfd::FACE_SCOPE_NONE);
  BOOST_TEST(transport.getPersistency() != ndn::nfd::FACE_PERSISTENCY_NONE);
  BOOST_TEST(transport.getLinkType() != ndn::nfd::LINK_TYPE_NONE);
  BOOST_TEST(transport.getMtu() != face::MTU_INVALID);
}

/**
 * \brief Generic wrapper for transport fixtures that require an IP address.
 */
template<typename TransportFixtureBase,
         AddressFamily AF = AddressFamily::Any,
         AddressScope AS = AddressScope::Any,
         MulticastInterface MC = MulticastInterface::Any>
class IpTransportFixture : public TransportFixtureBase
{
protected:
  IpTransportFixture()
  {
    std::tie(interface, address) = getTestInterfaceAndIp(AF, AS, MC);

    BOOST_TEST_MESSAGE("Testing with AddressFamily=" << AF <<
                       " AddressScope=" << AS <<
                       " MulticastInterface=" << MC <<
                       " TestInterface=" << (interface == nullptr ? "N/A" : interface->getName()) <<
                       " TestIp=" << (address.is_unspecified() ? "N/A" : address.to_string()));
  }

  [[nodiscard]] std::tuple<bool, std::string>
  checkPreconditions() const
  {
    return {interface != nullptr && !address.is_unspecified(),
            "no appropriate interface or IP address available"};
  }

  template<typename... Args>
  void
  initialize(Args&&... args)
  {
    TransportFixtureBase::initialize(interface, address, std::forward<Args>(args)...);
  }

protected:
  static constexpr AddressFamily addressFamily = AF;
  static constexpr AddressScope addressScope = AS;

  shared_ptr<const ndn::net::NetworkInterface> interface;
  boost::asio::ip::address address;
};

} // namespace nfd::tests

#define GENERATE_IP_TRANSPORT_FIXTURE_INSTANTIATIONS(F) \
  IpTransportFixture<F, AddressFamily::V4, AddressScope::Loopback>,  \
  IpTransportFixture<F, AddressFamily::V4, AddressScope::Global>,    \
  IpTransportFixture<F, AddressFamily::V6, AddressScope::Loopback>,  \
  IpTransportFixture<F, AddressFamily::V6, AddressScope::LinkLocal>, \
  IpTransportFixture<F, AddressFamily::V6, AddressScope::Global>

#define TRANSPORT_TEST_CHECK_PRECONDITIONS() \
  do { \
    auto [ok, reason] = this->checkPreconditions(); \
    if (!ok) { \
      BOOST_WARN_MESSAGE(false, "skipping test case: " << reason); \
      return; \
    } \
  } while (false)

#define TRANSPORT_TEST_INIT(...) \
  do { \
    TRANSPORT_TEST_CHECK_PRECONDITIONS(); \
    this->initialize(__VA_ARGS__); \
  } while (false)

#endif // NFD_TESTS_DAEMON_FACE_TRANSPORT_TEST_COMMON_HPP