tools: modularize ndn-autoconfig-server
refs #4158
Change-Id: I90eb570e2ca2ae611d48aeb1e456712c1d148531
diff --git a/tests/tools/ndn-autoconfig-server/program.t.cpp b/tests/tools/ndn-autoconfig-server/program.t.cpp
new file mode 100644
index 0000000..afcf908
--- /dev/null
+++ b/tests/tools/ndn-autoconfig-server/program.t.cpp
@@ -0,0 +1,146 @@
+/* -*- 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/>.
+ */
+
+#include "ndn-autoconfig-server/program.hpp"
+
+#include "tests/identity-management-fixture.hpp"
+#include <ndn-cxx/encoding/buffer.hpp>
+#include <ndn-cxx/util/dummy-client-face.hpp>
+
+namespace ndn {
+namespace tools {
+namespace autoconfig_server {
+namespace tests {
+
+using namespace ::nfd::tests;
+
+class AutoconfigServerFixture : public IdentityManagementFixture
+{
+public:
+ AutoconfigServerFixture()
+ : face({true, true})
+ {
+ }
+
+ void
+ initialize(const Options& options)
+ {
+ program = make_unique<Program>(options, face, m_keyChain);
+ face.processEvents(time::milliseconds(1));
+ face.sentInterests.clear();
+ }
+
+public:
+ util::DummyClientFace face;
+ unique_ptr<Program> program;
+};
+
+BOOST_AUTO_TEST_SUITE(NdnAutoconfigServer)
+BOOST_FIXTURE_TEST_SUITE(TestProgram, AutoconfigServerFixture)
+
+BOOST_AUTO_TEST_CASE(HubData)
+{
+ Options options;
+ options.hubFaceUri = FaceUri("udp4://192.0.2.1:6363");
+ this->initialize(options);
+
+ Interest interest("/localhop/ndn-autoconf/hub");
+ face.receive(interest);
+ face.processEvents(time::milliseconds(1));
+
+ BOOST_CHECK_EQUAL(face.sentData.size(), 1);
+ const Name& dataName = face.sentData.at(0).getName();
+ BOOST_CHECK_EQUAL(dataName.size(), interest.getName().size() + 1);
+ BOOST_CHECK(interest.getName().isPrefixOf(dataName));
+ BOOST_CHECK(dataName.at(-1).isVersion());
+
+ // interest2 asks for a different version, and should not be responded
+ Interest interest2(Name(interest.getName()).appendVersion(dataName.at(-1).toVersion() - 1));
+ face.receive(interest2);
+ face.processEvents(time::milliseconds(1));
+ BOOST_CHECK_EQUAL(face.sentData.size(), 1);
+}
+
+BOOST_AUTO_TEST_CASE(RoutablePrefixesDataset)
+{
+ Options options;
+ options.hubFaceUri = FaceUri("udp4://192.0.2.1:6363");
+ const int nRoutablePrefixes = 2000;
+ for (int i = 0; i < nRoutablePrefixes; ++i) {
+ options.routablePrefixes.push_back(Name("/PREFIX").appendNumber(i));
+ }
+ this->initialize(options);
+
+ Interest interest("/localhop/nfd/rib/routable-prefixes");
+ face.receive(interest);
+ face.processEvents(time::milliseconds(1));
+
+ BOOST_CHECK_EQUAL(face.sentData.size(), 1);
+ const Name& dataName0 = face.sentData.at(0).getName();
+ BOOST_CHECK_EQUAL(dataName0.size(), interest.getName().size() + 2);
+ BOOST_CHECK(interest.getName().isPrefixOf(dataName0));
+ BOOST_CHECK(dataName0.at(-2).isVersion());
+ BOOST_CHECK(dataName0.at(-1).isSegment());
+
+ while (face.sentData.back().getFinalBlockId() != face.sentData.back().getName().at(-1)) {
+ const Name& lastName = face.sentData.back().getName();
+ Interest interest2(lastName.getPrefix(-1).appendSegment(lastName.at(-1).toSegment() + 1));
+ face.receive(interest2);
+ face.processEvents(time::milliseconds(1));
+ }
+
+ auto buffer = make_shared<Buffer>();
+ for (const Data& data : face.sentData) {
+ const Block& content = data.getContent();
+ std::copy(content.value_begin(), content.value_end(), std::back_inserter(*buffer));
+ }
+
+ Block payload(tlv::Content, buffer);
+ payload.parse();
+ BOOST_CHECK_EQUAL(payload.elements_size(), nRoutablePrefixes);
+ for (int i = 0; i < nRoutablePrefixes; ++i) {
+ BOOST_CHECK_EQUAL(Name(payload.elements().at(i)), options.routablePrefixes.at(i));
+ }
+}
+
+BOOST_AUTO_TEST_CASE(RoutablePrefixesDisabled)
+{
+ Options options;
+ options.hubFaceUri = FaceUri("udp4://192.0.2.1:6363");
+ this->initialize(options);
+
+ Interest interest("/localhop/nfd/rib/routable-prefixes");
+ face.receive(interest);
+ face.processEvents(time::milliseconds(1));
+ BOOST_CHECK_EQUAL(face.sentData.size(), 0);
+}
+
+BOOST_AUTO_TEST_SUITE_END() // TestProgram
+BOOST_AUTO_TEST_SUITE_END() // NdnAutoconfigServer
+
+} // namespace tests
+} // namespace autoconfig_server
+} // namespace tools
+} // namespace ndn
diff --git a/tools/ndn-autoconfig-server.cpp b/tools/ndn-autoconfig-server.cpp
deleted file mode 100644
index 50632ee..0000000
--- a/tools/ndn-autoconfig-server.cpp
+++ /dev/null
@@ -1,219 +0,0 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
- * Copyright (c) 2014-2016, 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/>.
- */
-
-#include "core/version.hpp"
-#include <ndn-cxx/encoding/tlv-nfd.hpp>
-#include <ndn-cxx/face.hpp>
-#include <ndn-cxx/security/key-chain.hpp>
-
-namespace ndn {
-
-const static Name LOCALHOP_HUB = "/localhop/ndn-autoconf/hub";
-const static Name LOCALHOP_ROUTABLE_PREFIXES = "/localhop/nfd/rib/routable-prefixes";
-
-static void
-usage(const char* programName)
-{
- std::cout << "Usage:\n" << programName << " [-h] [-V] [-p prefix] [-p prefix] ... Uri \n"
- << " -h - print usage and exit\n"
- << " -V - print version number and exit\n"
- << " -p prefix - the local prefix of the hub\n"
- << "\n"
- << " Uri - a FaceMgmt URI\n"
- << std::endl;
-}
-
-class PrefixCollection : noncopyable
-{
-public:
- bool
- empty() const
- {
- return m_prefixes.empty();
- }
-
- void
- add(const Name& prefix)
- {
- m_prefixes.push_back(prefix);
- }
-
- template<bool T>
- size_t
- wireEncode(EncodingImpl<T>& encoder) const
- {
- size_t totalLength = 0;
-
- for (std::vector<Name>::const_reverse_iterator i = m_prefixes.rbegin();
- i != m_prefixes.rend(); ++i) {
- totalLength += i->wireEncode(encoder);
- }
-
- totalLength += encoder.prependVarNumber(totalLength);
- totalLength += encoder.prependVarNumber(tlv::Content);
- return totalLength;
- }
-
- Block
- wireEncode() const
- {
- Block block;
-
- EncodingEstimator estimator;
- size_t estimatedSize = wireEncode(estimator);
-
- EncodingBuffer buffer(estimatedSize);
- wireEncode(buffer);
-
- return buffer.block();
- }
-
-private:
- std::vector<Name> m_prefixes;
-};
-
-class NdnAutoconfigServer : noncopyable
-{
-public:
- NdnAutoconfigServer(const std::string& hubFaceUri, const PrefixCollection& routablePrefixes)
- {
- KeyChain m_keyChain;
-
- // pre-create hub Data
- m_hubData = make_shared<Data>(Name(LOCALHOP_HUB).appendVersion());
- m_hubData->setFreshnessPeriod(time::hours(1)); // 1 hour
- m_hubData->setContent(makeBinaryBlock(tlv::nfd::Uri,
- reinterpret_cast<const uint8_t*>(hubFaceUri.c_str()),
- hubFaceUri.size()));
- m_keyChain.sign(*m_hubData);
-
- // pre-create routable prefix Data
- if (!routablePrefixes.empty()) {
- Name routablePrefixesDataName(LOCALHOP_ROUTABLE_PREFIXES);
- routablePrefixesDataName.appendVersion();
- routablePrefixesDataName.appendSegment(0);
- m_routablePrefixesData = make_shared<Data>(routablePrefixesDataName);
- m_routablePrefixesData->setContent(routablePrefixes.wireEncode());
- m_routablePrefixesData->setFinalBlockId(routablePrefixesDataName.get(-1));
- m_routablePrefixesData->setFreshnessPeriod(time::seconds(5)); // 5s
- m_keyChain.sign(*m_routablePrefixesData);
- }
- }
-
- void
- onHubInterest(const Name& name, const Interest& interest)
- {
- m_face.put(*m_hubData);
- }
-
- void
- onRoutablePrefixesInterest(const Name& name, const Interest& interest)
- {
- m_face.put(*m_routablePrefixesData);
- }
-
- void
- onRegisterFailed(const Name& prefix, const std::string& reason)
- {
- std::cerr << "ERROR: Failed to register prefix in local hub's daemon (" <<
- reason << ")" << std::endl;
- m_face.shutdown();
- }
-
- void
- run()
- {
- m_face.setInterestFilter(LOCALHOP_HUB,
- bind(&NdnAutoconfigServer::onHubInterest, this, _1, _2),
- RegisterPrefixSuccessCallback(),
- bind(&NdnAutoconfigServer::onRegisterFailed, this, _1, _2));
-
- if (static_cast<bool>(m_routablePrefixesData)) {
- m_face.setInterestFilter(LOCALHOP_ROUTABLE_PREFIXES,
- bind(&NdnAutoconfigServer::onRoutablePrefixesInterest, this, _1, _2),
- RegisterPrefixSuccessCallback(),
- bind(&NdnAutoconfigServer::onRegisterFailed, this, _1, _2));
- }
-
- m_face.processEvents();
- }
-
-private:
- Face m_face;
-
- shared_ptr<Data> m_hubData;
- shared_ptr<Data> m_routablePrefixesData;
-};
-
-int
-main(int argc, char** argv)
-{
- const char* programName = argv[0];
-
- PrefixCollection routablePrefixes;
-
- int opt;
- while ((opt = getopt(argc, argv, "hVp:")) != -1) {
- switch (opt) {
- case 'h':
- usage(programName);
- return 0;
- case 'V':
- std::cout << NFD_VERSION_BUILD_STRING << std::endl;
- return 0;
- case 'p':
- routablePrefixes.add(Name(optarg));
- break;
- default:
- usage(programName);
- return 1;
- }
- }
-
- if (argc != optind + 1) {
- usage(programName);
- return 1;
- }
-
- std::string hubFaceUri = argv[optind];
- NdnAutoconfigServer instance(hubFaceUri, routablePrefixes);
-
- try {
- instance.run();
- }
- catch (const std::exception& error) {
- std::cerr << "ERROR: " << error.what() << std::endl;
- return 1;
- }
- return 0;
-}
-
-} // namespace ndn
-
-int
-main(int argc, char** argv)
-{
- return ndn::main(argc, argv);
-}
diff --git a/tools/ndn-autoconfig-server/main.cpp b/tools/ndn-autoconfig-server/main.cpp
new file mode 100644
index 0000000..3806d9a
--- /dev/null
+++ b/tools/ndn-autoconfig-server/main.cpp
@@ -0,0 +1,101 @@
+/* -*- 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/>.
+ */
+
+#include "program.hpp"
+#include "core/extended-error-message.hpp"
+#include "core/version.hpp"
+#include <unistd.h>
+
+namespace ndn {
+namespace tools {
+namespace autoconfig_server {
+
+static void
+usage(const char* programName)
+{
+ std::cout << "Usage:\n" << programName << " [-h] [-V] [-p prefix] [-p prefix] ... hub-face\n"
+ << " -h - print usage and exit\n"
+ << " -V - print version number and exit\n"
+ << " -p prefix - a local prefix of the HUB\n"
+ << "\n"
+ << " hub-face - a FaceUri to reach the HUB\n"
+ << std::endl;
+}
+
+int
+main(int argc, char** argv)
+{
+ Options options;
+
+ int opt = -1;
+ while ((opt = ::getopt(argc, argv, "hVp:")) != -1) {
+ switch (opt) {
+ case 'h':
+ usage(argv[0]);
+ return 0;
+ case 'V':
+ std::cout << NFD_VERSION_BUILD_STRING << std::endl;
+ return 0;
+ case 'p':
+ options.routablePrefixes.emplace_back(::optarg);
+ break;
+ default:
+ usage(argv[0]);
+ return 2;
+ }
+ }
+
+ if (argc != ::optind + 1) {
+ usage(argv[0]);
+ return 2;
+ }
+
+ if (!options.hubFaceUri.parse(argv[::optind])) {
+ std::cerr << "ERROR: cannot parse HUB FaceUri\n";
+ return 2;
+ }
+
+ try {
+ Face face;
+ KeyChain keyChain;
+ Program program(options, face, keyChain);
+ program.run();
+ }
+ catch (const std::exception& e) {
+ std::cerr << ::nfd::getExtendedErrorMessage(e) << std::endl;
+ return 1;
+ }
+ return 0;
+}
+
+} // namespace autoconfig_server
+} // namespace tools
+} // namespace ndn
+
+int
+main(int argc, char** argv)
+{
+ return ndn::tools::autoconfig_server::main(argc, argv);
+}
diff --git a/tools/ndn-autoconfig-server/program.cpp b/tools/ndn-autoconfig-server/program.cpp
new file mode 100644
index 0000000..c6c3b1a
--- /dev/null
+++ b/tools/ndn-autoconfig-server/program.cpp
@@ -0,0 +1,98 @@
+/* -*- 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/>.
+ */
+
+#include "program.hpp"
+#include <ndn-cxx/encoding/block-helpers.hpp>
+#include <ndn-cxx/encoding/tlv.hpp>
+#include <ndn-cxx/encoding/tlv-nfd.hpp>
+
+namespace ndn {
+namespace tools {
+namespace autoconfig_server {
+
+static const Name HUB_DATA_NAME("/localhop/ndn-autoconf/hub");
+static const Name ROUTABLE_PREFIXES_DATA_PREFIX("/localhop/nfd");
+static const PartialName ROUTABLE_PREFIXES_DATA_SUFFIX("rib/routable-prefixes");
+
+Program::Program(const Options& options, Face& face, KeyChain& keyChain)
+ : m_face(face)
+ , m_keyChain(keyChain)
+ , m_dispatcher(face, keyChain)
+{
+ this->enableHubData(options.hubFaceUri);
+ if (!options.routablePrefixes.empty()) {
+ this->enableRoutablePrefixesDataset(options.routablePrefixes);
+ }
+}
+
+void
+Program::enableHubData(const FaceUri& hubFaceUri)
+{
+ std::string uri = hubFaceUri.toString();
+
+ auto data = make_shared<Data>(Name(HUB_DATA_NAME).appendVersion());
+ data->setFreshnessPeriod(time::hours(1));
+ data->setContent(makeBinaryBlock(tlv::nfd::Uri,
+ reinterpret_cast<const uint8_t*>(uri.data()), uri.size()));
+ m_keyChain.sign(*data);
+
+ m_face.setInterestFilter(HUB_DATA_NAME,
+ [this, data] (const Name&, const Interest& interest) {
+ if (interest.matchesData(*data)) {
+ m_face.put(*data);
+ }
+ },
+ bind(&Program::handlePrefixRegistrationFailure, this, _1, _2));
+}
+
+void
+Program::enableRoutablePrefixesDataset(const std::vector<Name>& routablePrefixes)
+{
+ m_dispatcher.addStatusDataset(ROUTABLE_PREFIXES_DATA_SUFFIX,
+ mgmt::makeAcceptAllAuthorization(),
+ [=] (const Name& prefix, const Interest& interest, mgmt::StatusDatasetContext& context) {
+ for (const Name& routablePrefix : routablePrefixes) {
+ context.append(routablePrefix.wireEncode());
+ }
+ context.end();
+ });
+ m_dispatcher.addTopPrefix(ROUTABLE_PREFIXES_DATA_PREFIX, false);
+
+ m_face.registerPrefix(Name(ROUTABLE_PREFIXES_DATA_PREFIX).append(ROUTABLE_PREFIXES_DATA_SUFFIX),
+ nullptr,
+ bind(&Program::handlePrefixRegistrationFailure, this, _1, _2));
+}
+
+void
+Program::handlePrefixRegistrationFailure(const Name& prefix, const std::string& reason)
+{
+ std::cerr << "ERROR: cannot register prefix " << prefix
+ << " (" << reason << ")" << std::endl;
+ m_face.shutdown();
+}
+
+} // namespace autoconfig_server
+} // namespace tools
+} // namespace ndn
diff --git a/tools/ndn-autoconfig-server/program.hpp b/tools/ndn-autoconfig-server/program.hpp
new file mode 100644
index 0000000..39b5bce
--- /dev/null
+++ b/tools/ndn-autoconfig-server/program.hpp
@@ -0,0 +1,75 @@
+/* -*- 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_TOOLS_NDN_AUTOCONFIG_SERVER_PROGRAM_HPP
+#define NFD_TOOLS_NDN_AUTOCONFIG_SERVER_PROGRAM_HPP
+
+#include "core/common.hpp"
+#include <ndn-cxx/face.hpp>
+#include <ndn-cxx/mgmt/dispatcher.hpp>
+#include <ndn-cxx/security/key-chain.hpp>
+
+namespace ndn {
+namespace tools {
+namespace autoconfig_server {
+
+struct Options
+{
+ FaceUri hubFaceUri;
+ std::vector<Name> routablePrefixes;
+};
+
+class Program : noncopyable
+{
+public:
+ Program(const Options& options, Face& face, KeyChain& keyChain);
+
+ void
+ run()
+ {
+ m_face.processEvents();
+ }
+
+private:
+ void
+ enableHubData(const FaceUri& hubFaceUri);
+
+ void
+ enableRoutablePrefixesDataset(const std::vector<Name>& routablePrefixes);
+
+ void
+ handlePrefixRegistrationFailure(const Name& prefix, const std::string& reason);
+
+private:
+ Face& m_face;
+ KeyChain& m_keyChain;
+ mgmt::Dispatcher m_dispatcher;
+};
+
+} // namespace autoconfig_server
+} // namespace tools
+} // namespace ndn
+
+#endif // NFD_TOOLS_NDN_AUTOCONFIG_SERVER_PROGRAM_HPP