tests/tools/nfdc/mock-nfd-mgmt-fixture.hpp - NFD - Gitiles

 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /**
  * Copyright (c) 2014-2017,  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_TOOLS_NFDC_MOCK_NFD_MGMT_FIXTURE_HPP
 #define NFD_TESTS_TOOLS_NFDC_MOCK_NFD_MGMT_FIXTURE_HPP

 #include <ndn-cxx/mgmt/nfd/face-query-filter.hpp>
 #include <ndn-cxx/util/dummy-client-face.hpp>

 #include "tests/test-common.hpp"
 #include "tests/identity-management-fixture.hpp"

 namespace nfd {
 namespace tools {
 namespace nfdc {
 namespace tests {

 using namespace nfd::tests;
 using ndn::nfd::ControlParameters;

 /** \brief fixture to emulate NFD management
  */
 class MockNfdMgmtFixture : public IdentityManagementTimeFixture
 {
 protected:
   MockNfdMgmtFixture()
     : face(g_io, m_keyChain,
            {true, false, bind(&MockNfdMgmtFixture::processEventsOverride, this, _1)})
   {
     face.onSendInterest.connect([=] (const Interest& interest) {
       g_io.post([=] {
         if (processInterest != nullptr) {
           processInterest(interest);
         }
       });
     });
   }

 protected: // ControlCommand
   /** \brief check the Interest is a command with specified prefix
    *  \retval nullopt last Interest is not the expected command
    *  \return command parameters
    */
   static ndn::optional<ControlParameters>
   parseCommand(const Interest& interest, const Name& expectedPrefix)
   {
     if (!expectedPrefix.isPrefixOf(interest.getName())) {
       return ndn::nullopt;
     }
     return ControlParameters(interest.getName().at(expectedPrefix.size()).blockFromValue());
   }

   DEPRECATED(
   ndn::optional<ControlParameters>
   getCommand(const Name& expectedPrefix) const)
   {
     if (face.sentInterests.empty()) {
       return ndn::nullopt;
     }
     return parseCommand(face.sentInterests.back(), expectedPrefix);
   }

   /** \brief respond to the last command
    */
   void
   succeedCommand(const Interest& interest, const ControlParameters& parameters)
   {
     ndn::nfd::ControlResponse resp(200, "OK");
     resp.setBody(parameters.wireEncode());
     this->sendCommandReply(interest, resp);
   }

   DEPRECATED(
   void
   succeedCommand(const ControlParameters& parameters))
   {
     this->succeedCommand(face.sentInterests.back(), parameters);
   }

   /** \brief respond to the last command
    *  \pre last Interest is a command
    */
   void
   failCommand(const Interest& interest, uint32_t code, const std::string& text)
   {
     this->sendCommandReply(interest, {code, text});
   }

   DEPRECATED(
   void
   failCommand(uint32_t code, const std::string& text))
   {
     this->sendCommandReply(face.sentInterests.back(), {code, text});
   }

   void
   failCommand(const Interest& interest, uint32_t code, const std::string& text, const ControlParameters& body)
   {
     this->sendCommandReply(interest, code, text, body.wireEncode());
   }

   DEPRECATED(
   void
   failCommand(uint32_t code, const std::string& text, const ControlParameters& body))
   {
     this->failCommand(face.sentInterests.back(), code, text, body);
   }

 protected: // StatusDataset
   /** \brief send an empty dataset in reply to StatusDataset request
    *  \param prefix dataset prefix without version and segment
    *  \pre Interest for dataset has been expressed, sendDataset has not been invoked
    */
   void
   sendEmptyDataset(const Name& prefix)
   {
     this->sendDatasetReply(prefix, nullptr, 0);
   }

   /** \brief send one WireEncodable in reply to StatusDataset request
    *  \param prefix dataset prefix without version and segment
    *  \param payload payload block
    *  \note payload must fit in one Data
    *  \pre Interest for dataset has been expressed, sendDataset has not been invoked
    */
   template<typename T>
   void
   sendDataset(const Name& prefix, const T& payload)
   {
     BOOST_CONCEPT_ASSERT((ndn::WireEncodable<T>));

     this->sendDatasetReply(prefix, payload.wireEncode());
   }

   /** \brief send two WireEncodables in reply to StatusDataset request
    *  \param prefix dataset prefix without version and segment
    *  \param payload1 first vector item
    *  \param payload2 second vector item
    *  \note all payloads must fit in one Data
    *  \pre Interest for dataset has been expressed, sendDataset has not been invoked
    */
   template<typename T1, typename T2>
   void
   sendDataset(const Name& prefix, const T1& payload1, const T2& payload2)
   {
     BOOST_CONCEPT_ASSERT((ndn::WireEncodable<T1>));
     BOOST_CONCEPT_ASSERT((ndn::WireEncodable<T2>));

     ndn::encoding::EncodingBuffer buffer;
     payload2.wireEncode(buffer);
     payload1.wireEncode(buffer);

     this->sendDatasetReply(prefix, buffer.buf(), buffer.size());
   }

   /** \brief respond to specific FaceQuery requests
    *  \retval true the Interest matches one of the defined patterns and is responded
    *  \retval false the Interest is not responded
    */
   bool
   respondFaceQuery(const Interest& interest)
   {
     using ndn::nfd::FacePersistency;
     using ndn::nfd::FaceQueryFilter;
     using ndn::nfd::FaceStatus;

     if (!Name("/localhost/nfd/faces/query").isPrefixOf(interest.getName())) {
       return false;
     }
     BOOST_CHECK_EQUAL(interest.getName().size(), 5);
     FaceQueryFilter filter(interest.getName().at(4).blockFromValue());

     if (filter == FaceQueryFilter().setFaceId(10156)) {
       FaceStatus faceStatus;
       faceStatus.setFaceId(10156)
                 .setLocalUri("tcp4://151.26.163.27:22967")
                 .setRemoteUri("tcp4://198.57.27.40:6363")
                 .setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERSISTENT);
       this->sendDataset(interest.getName(), faceStatus);
       return true;
     }

     if (filter == FaceQueryFilter().setRemoteUri("tcp4://32.121.182.82:6363")) {
       FaceStatus faceStatus;
       faceStatus.setFaceId(2249)
                 .setLocalUri("tcp4://30.99.87.98:31414")
                 .setRemoteUri("tcp4://32.121.182.82:6363")
                 .setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERSISTENT);
       this->sendDataset(interest.getName(), faceStatus);
       return true;
     }

     if (filter == FaceQueryFilter().setFaceId(23728)) {
       this->sendEmptyDataset(interest.getName());
       return true;
     }

     if (filter == FaceQueryFilter().setRemoteUri("udp4://225.131.75.231:56363")) {
       FaceStatus faceStatus1, faceStatus2;
       faceStatus1.setFaceId(6720)
                  .setLocalUri("udp4://202.83.168.28:56363")
                  .setRemoteUri("udp4://225.131.75.231:56363")
                  .setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERMANENT);
       faceStatus2.setFaceId(31066)
                  .setLocalUri("udp4://25.90.26.32:56363")
                  .setRemoteUri("udp4://225.131.75.231:56363")
                  .setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERMANENT);
       this->sendDataset(interest.getName(), faceStatus1, faceStatus2);
       return true;
     }

     return false;
   }

 private:
   virtual void
   processEventsOverride(time::milliseconds timeout)
   {
     if (timeout <= time::milliseconds::zero()) {
       // give enough time to finish execution
       timeout = time::seconds(30);
     }
     this->advanceClocks(time::milliseconds(100), timeout);
   }

   void
   sendCommandReply(const Interest& interest, const ndn::nfd::ControlResponse& resp)
   {
     auto data = makeData(interest.getName());
     data->setContent(resp.wireEncode());
     face.receive(*data);
   }

   void
   sendCommandReply(const Interest& interest, uint32_t code, const std::string& text,
                    const Block& body)
   {
     this->sendCommandReply(interest,
                            ndn::nfd::ControlResponse(code, text).setBody(body));
   }

   /** \brief send a payload in reply to StatusDataset request
    *  \param name dataset prefix without version and segment
    *  \param contentArgs passed to Data::setContent
    */
   template<typename ...ContentArgs>
   void
   sendDatasetReply(Name name, ContentArgs&&... contentArgs)
   {
     name.appendVersion().appendSegment(0);

     // These warnings assist in debugging when nfdc does not receive StatusDataset.
     // They usually indicate a misspelled prefix or incorrect timing in the test case.
     if (face.sentInterests.empty()) {
       BOOST_WARN_MESSAGE(false, "no Interest expressed");
     }
     else {
       BOOST_WARN_MESSAGE(face.sentInterests.back().getName().isPrefixOf(name),
                          "last Interest " << face.sentInterests.back().getName() <<
                          " cannot be satisfied by this Data " << name);
     }

     auto data = make_shared<Data>(name);
     data->setFinalBlockId(name[-1]);
     data->setContent(std::forward<ContentArgs>(contentArgs)...);
     this->signDatasetReply(*data);
     face.receive(*data);
   }

   virtual void
   signDatasetReply(Data& data)
   {
     signData(data);
   }

 protected:
   ndn::util::DummyClientFace face;
   std::function<void(const Interest&)> processInterest;
 };

 } // namespace tests
 } // namespace nfdc
 } // namespace tools
 } // namespace nfd

 /** \brief require the command in \p interest has expected prefix
  *  \note This must be used in processInterest lambda, and the Interest must be named 'interest'.
  */
 #define MOCK_NFD_MGMT_REQUIRE_COMMAND_IS(expectedPrefix) \
   [interest] { \
     auto params = parseCommand(interest, (expectedPrefix)); \
     BOOST_REQUIRE_MESSAGE(params, "Interest " << interest.getName() << \
                           " does not match command prefix " << (expectedPrefix)); \
     return *params; \
   } ()

 ///\deprecated use MOCK_NFD_MGMT_REQUIRE_COMMAND_IS
 #define MOCK_NFD_MGMT_REQUIRE_LAST_COMMAND_IS(expectedPrefix) \
   [this] { \
     BOOST_REQUIRE_MESSAGE(!face.sentInterests.empty(), "no Interest expressed"); \
     const Interest& interest = face.sentInterests.back(); \
     return MOCK_NFD_MGMT_REQUIRE_COMMAND_IS(expectedPrefix); \
   } ()

 #endif // NFD_TESTS_TOOLS_NFDC_MOCK_NFD_MGMT_FIXTURE_HPP
	/* -- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -- */
	/**
	* Copyright (c) 2014-2017, 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_TOOLS_NFDC_MOCK_NFD_MGMT_FIXTURE_HPP
	#define NFD_TESTS_TOOLS_NFDC_MOCK_NFD_MGMT_FIXTURE_HPP

	#include <ndn-cxx/mgmt/nfd/face-query-filter.hpp>
	#include <ndn-cxx/util/dummy-client-face.hpp>

	#include "tests/test-common.hpp"
	#include "tests/identity-management-fixture.hpp"

	namespace nfd {
	namespace tools {
	namespace nfdc {
	namespace tests {

	using namespace nfd::tests;
	using ndn::nfd::ControlParameters;

	/** \brief fixture to emulate NFD management
	*/
	class MockNfdMgmtFixture : public IdentityManagementTimeFixture
	{
	protected:
	MockNfdMgmtFixture()
	: face(g_io, m_keyChain,
	{true, false, bind(&MockNfdMgmtFixture::processEventsOverride, this, _1)})
	{
	face.onSendInterest.connect([=] (const Interest& interest) {
	g_io.post([=] {
	if (processInterest != nullptr) {
	processInterest(interest);
	}
	});
	});
	}

	protected: // ControlCommand
	/** \brief check the Interest is a command with specified prefix
	* \retval nullopt last Interest is not the expected command
	* \return command parameters
	*/
	static ndn::optional<ControlParameters>
	parseCommand(const Interest& interest, const Name& expectedPrefix)
	{
	if (!expectedPrefix.isPrefixOf(interest.getName())) {
	return ndn::nullopt;
	}
	return ControlParameters(interest.getName().at(expectedPrefix.size()).blockFromValue());
	}

	DEPRECATED(
	ndn::optional<ControlParameters>
	getCommand(const Name& expectedPrefix) const)
	{
	if (face.sentInterests.empty()) {
	return ndn::nullopt;
	}
	return parseCommand(face.sentInterests.back(), expectedPrefix);
	}

	/** \brief respond to the last command
	*/
	void
	succeedCommand(const Interest& interest, const ControlParameters& parameters)
	{
	ndn::nfd::ControlResponse resp(200, "OK");
	resp.setBody(parameters.wireEncode());
	this->sendCommandReply(interest, resp);
	}

	DEPRECATED(
	void
	succeedCommand(const ControlParameters& parameters))
	{
	this->succeedCommand(face.sentInterests.back(), parameters);
	}

	/** \brief respond to the last command
	* \pre last Interest is a command
	*/
	void
	failCommand(const Interest& interest, uint32_t code, const std::string& text)
	{
	this->sendCommandReply(interest, {code, text});
	}

	DEPRECATED(
	void
	failCommand(uint32_t code, const std::string& text))
	{
	this->sendCommandReply(face.sentInterests.back(), {code, text});
	}

	void
	failCommand(const Interest& interest, uint32_t code, const std::string& text, const ControlParameters& body)
	{
	this->sendCommandReply(interest, code, text, body.wireEncode());
	}

	DEPRECATED(
	void
	failCommand(uint32_t code, const std::string& text, const ControlParameters& body))
	{
	this->failCommand(face.sentInterests.back(), code, text, body);
	}

	protected: // StatusDataset
	/** \brief send an empty dataset in reply to StatusDataset request
	* \param prefix dataset prefix without version and segment
	* \pre Interest for dataset has been expressed, sendDataset has not been invoked
	*/
	void
	sendEmptyDataset(const Name& prefix)
	{
	this->sendDatasetReply(prefix, nullptr, 0);
	}

	/** \brief send one WireEncodable in reply to StatusDataset request
	* \param prefix dataset prefix without version and segment
	* \param payload payload block
	* \note payload must fit in one Data
	* \pre Interest for dataset has been expressed, sendDataset has not been invoked
	*/
	template<typename T>
	void
	sendDataset(const Name& prefix, const T& payload)
	{
	BOOST_CONCEPT_ASSERT((ndn::WireEncodable<T>));

	this->sendDatasetReply(prefix, payload.wireEncode());
	}

	/** \brief send two WireEncodables in reply to StatusDataset request
	* \param prefix dataset prefix without version and segment
	* \param payload1 first vector item
	* \param payload2 second vector item
	* \note all payloads must fit in one Data
	* \pre Interest for dataset has been expressed, sendDataset has not been invoked
	*/
	template<typename T1, typename T2>
	void
	sendDataset(const Name& prefix, const T1& payload1, const T2& payload2)
	{
	BOOST_CONCEPT_ASSERT((ndn::WireEncodable<T1>));
	BOOST_CONCEPT_ASSERT((ndn::WireEncodable<T2>));

	ndn::encoding::EncodingBuffer buffer;
	payload2.wireEncode(buffer);
	payload1.wireEncode(buffer);

	this->sendDatasetReply(prefix, buffer.buf(), buffer.size());
	}

	/** \brief respond to specific FaceQuery requests
	* \retval true the Interest matches one of the defined patterns and is responded
	* \retval false the Interest is not responded
	*/
	bool
	respondFaceQuery(const Interest& interest)
	{
	using ndn::nfd::FacePersistency;
	using ndn::nfd::FaceQueryFilter;
	using ndn::nfd::FaceStatus;

	if (!Name("/localhost/nfd/faces/query").isPrefixOf(interest.getName())) {
	return false;
	}
	BOOST_CHECK_EQUAL(interest.getName().size(), 5);
	FaceQueryFilter filter(interest.getName().at(4).blockFromValue());

	if (filter == FaceQueryFilter().setFaceId(10156)) {
	FaceStatus faceStatus;
	faceStatus.setFaceId(10156)
	.setLocalUri("tcp4://151.26.163.27:22967")
	.setRemoteUri("tcp4://198.57.27.40:6363")
	.setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERSISTENT);
	this->sendDataset(interest.getName(), faceStatus);
	return true;
	}

	if (filter == FaceQueryFilter().setRemoteUri("tcp4://32.121.182.82:6363")) {
	FaceStatus faceStatus;
	faceStatus.setFaceId(2249)
	.setLocalUri("tcp4://30.99.87.98:31414")
	.setRemoteUri("tcp4://32.121.182.82:6363")
	.setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERSISTENT);
	this->sendDataset(interest.getName(), faceStatus);
	return true;
	}

	if (filter == FaceQueryFilter().setFaceId(23728)) {
	this->sendEmptyDataset(interest.getName());
	return true;
	}

	if (filter == FaceQueryFilter().setRemoteUri("udp4://225.131.75.231:56363")) {
	FaceStatus faceStatus1, faceStatus2;
	faceStatus1.setFaceId(6720)
	.setLocalUri("udp4://202.83.168.28:56363")
	.setRemoteUri("udp4://225.131.75.231:56363")
	.setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERMANENT);
	faceStatus2.setFaceId(31066)
	.setLocalUri("udp4://25.90.26.32:56363")
	.setRemoteUri("udp4://225.131.75.231:56363")
	.setFacePersistency(FacePersistency::FACE_PERSISTENCY_PERMANENT);
	this->sendDataset(interest.getName(), faceStatus1, faceStatus2);
	return true;
	}

	return false;
	}

	private:
	virtual void
	processEventsOverride(time::milliseconds timeout)
	{
	if (timeout <= time::milliseconds::zero()) {
	// give enough time to finish execution
	timeout = time::seconds(30);
	}
	this->advanceClocks(time::milliseconds(100), timeout);
	}

	void
	sendCommandReply(const Interest& interest, const ndn::nfd::ControlResponse& resp)
	{
	auto data = makeData(interest.getName());
	data->setContent(resp.wireEncode());
	face.receive(*data);
	}

	void
	sendCommandReply(const Interest& interest, uint32_t code, const std::string& text,
	const Block& body)
	{
	this->sendCommandReply(interest,
	ndn::nfd::ControlResponse(code, text).setBody(body));
	}

	/** \brief send a payload in reply to StatusDataset request
	* \param name dataset prefix without version and segment
	* \param contentArgs passed to Data::setContent
	*/
	template<typename ...ContentArgs>
	void
	sendDatasetReply(Name name, ContentArgs&&... contentArgs)
	{
	name.appendVersion().appendSegment(0);

	// These warnings assist in debugging when nfdc does not receive StatusDataset.
	// They usually indicate a misspelled prefix or incorrect timing in the test case.
	if (face.sentInterests.empty()) {
	BOOST_WARN_MESSAGE(false, "no Interest expressed");
	}
	else {
	BOOST_WARN_MESSAGE(face.sentInterests.back().getName().isPrefixOf(name),
	"last Interest " << face.sentInterests.back().getName() <<
	" cannot be satisfied by this Data " << name);
	}

	auto data = make_shared<Data>(name);
	data->setFinalBlockId(name[-1]);
	data->setContent(std::forward<ContentArgs>(contentArgs)...);
	this->signDatasetReply(*data);
	face.receive(*data);
	}

	virtual void
	signDatasetReply(Data& data)
	{
	signData(data);
	}

	protected:
	ndn::util::DummyClientFace face;
	std::function<void(const Interest&)> processInterest;
	};

	} // namespace tests
	} // namespace nfdc
	} // namespace tools
	} // namespace nfd

	/** \brief require the command in \p interest has expected prefix
	* \note This must be used in processInterest lambda, and the Interest must be named 'interest'.
	*/
	#define MOCK_NFD_MGMT_REQUIRE_COMMAND_IS(expectedPrefix) \
	[interest] { \
	auto params = parseCommand(interest, (expectedPrefix)); \
	BOOST_REQUIRE_MESSAGE(params, "Interest " << interest.getName() << \
	" does not match command prefix " << (expectedPrefix)); \
	return *params; \
	} ()

	///\deprecated use MOCK_NFD_MGMT_REQUIRE_COMMAND_IS
	#define MOCK_NFD_MGMT_REQUIRE_LAST_COMMAND_IS(expectedPrefix) \
	[this] { \
	BOOST_REQUIRE_MESSAGE(!face.sentInterests.empty(), "no Interest expressed"); \
	const Interest& interest = face.sentInterests.back(); \
	return MOCK_NFD_MGMT_REQUIRE_COMMAND_IS(expectedPrefix); \
	} ()

	#endif // NFD_TESTS_TOOLS_NFDC_MOCK_NFD_MGMT_FIXTURE_HPP