blob: 2419627b0132a76e6544ef7d8c47cb3bbccf91f9 [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shi7b6b79d2014-03-26 20:59:35 -07002/**
Spyridon Mastorakis429634f2015-02-19 17:35:33 -08003 * Copyright (c) 2013-2015 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070020 */
21
22#include "management/nfd-controller.hpp"
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070023#include "management/nfd-control-response.hpp"
24
Alexander Afanasyev258ec2b2014-05-14 16:15:37 -070025#include <boost/tuple/tuple.hpp>
26
Alexander Afanasyevb1db7c62014-04-03 14:57:25 -070027#include "boost-test.hpp"
Junxiao Shia60d9362014-11-12 09:38:21 -070028#include "util/dummy-client-face.hpp"
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -080029#include "../unit-test-time-fixture.hpp"
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070030
31namespace ndn {
32namespace nfd {
Alexander Afanasyev4abdbf12014-08-11 12:48:54 -070033namespace tests {
34
Junxiao Shia60d9362014-11-12 09:38:21 -070035using ndn::util::DummyClientFace;
36using ndn::util::makeDummyClientFace;
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070037
Spyridon Mastorakis429634f2015-02-19 17:35:33 -080038BOOST_AUTO_TEST_SUITE(ManagementNfdController)
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070039
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -080040class CommandFixture : public ndn::tests::UnitTestTimeFixture
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070041{
42protected:
43 CommandFixture()
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -080044 : face(makeDummyClientFace(io))
Junxiao Shi415b17c2014-11-12 00:43:25 -070045 , controller(*face, keyChain)
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070046 , commandSucceedCallback(bind(&CommandFixture::onCommandSucceed, this, _1))
47 , commandFailCallback(bind(&CommandFixture::onCommandFail, this, _1, _2))
48 {
49 }
50
51private:
52 void
53 onCommandSucceed(const ControlParameters& parameters)
54 {
55 commandSucceedHistory.push_back(boost::make_tuple(parameters));
56 }
57
58 void
59 onCommandFail(uint32_t code, const std::string& reason)
60 {
61 commandFailHistory.push_back(boost::make_tuple(code, reason));
62 }
63
64protected:
Alexander Afanasyev4abdbf12014-08-11 12:48:54 -070065 shared_ptr<DummyClientFace> face;
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070066 KeyChain keyChain;
Junxiao Shi415b17c2014-11-12 00:43:25 -070067 Controller controller;
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070068
69 Controller::CommandSucceedCallback commandSucceedCallback;
70 typedef boost::tuple<ControlParameters> CommandSucceedArgs;
71 std::vector<CommandSucceedArgs> commandSucceedHistory;
72
73 Controller::CommandFailCallback commandFailCallback;
74 typedef boost::tuple<uint32_t,std::string> CommandFailArgs;
75 std::vector<CommandFailArgs> commandFailHistory;
76};
77
78BOOST_FIXTURE_TEST_CASE(CommandSuccess, CommandFixture)
79{
80 ControlParameters parameters;
Junxiao Shi5de006b2014-10-26 20:20:52 -070081 parameters.setUri("tcp4://192.0.2.1:6363");
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070082
83 BOOST_CHECK_NO_THROW(controller.start<FaceCreateCommand>(
Junxiao Shi70911652014-08-12 10:14:24 -070084 parameters,
85 commandSucceedCallback,
86 commandFailCallback));
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -080087
88 advanceClocks(time::milliseconds(1));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070089
Junxiao Shia60d9362014-11-12 09:38:21 -070090 BOOST_REQUIRE_EQUAL(face->sentInterests.size(), 1);
91 const Interest& requestInterest = face->sentInterests[0];
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070092
93 FaceCreateCommand command;
Junxiao Shi5de006b2014-10-26 20:20:52 -070094 BOOST_CHECK(Name("/localhost/nfd/faces/create").isPrefixOf(requestInterest.getName()));
95 // 9 components: ndn:/localhost/nfd/faces/create/<parameters>/<signed Interest x4>
Junxiao Shi6a90f372014-10-13 20:29:30 -070096 BOOST_REQUIRE_EQUAL(requestInterest.getName().size(), 9);
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070097 ControlParameters request;
98 // 4th component: <parameters>
Junxiao Shi6a90f372014-10-13 20:29:30 -070099 BOOST_REQUIRE_NO_THROW(request.wireDecode(requestInterest.getName().at(4).blockFromValue()));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700100 BOOST_CHECK_NO_THROW(command.validateRequest(request));
101 BOOST_CHECK_EQUAL(request.getUri(), parameters.getUri());
Junxiao Shi415b17c2014-11-12 00:43:25 -0700102 BOOST_CHECK_EQUAL(requestInterest.getInterestLifetime(), CommandOptions::DEFAULT_TIMEOUT);
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700103
104 ControlParameters responseBody;
105 responseBody.setUri("tcp4://192.0.2.1:6363")
106 .setFaceId(22);
107 ControlResponse responsePayload(201, "created");
108 responsePayload.setBody(responseBody.wireEncode());
109
Junxiao Shi6a90f372014-10-13 20:29:30 -0700110 Data responseData(requestInterest.getName());
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700111 responseData.setContent(responsePayload.wireEncode());
112 keyChain.sign(responseData);
113 face->receive(responseData);
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800114
115 advanceClocks(time::milliseconds(1));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700116
117 BOOST_CHECK_EQUAL(commandFailHistory.size(), 0);
118 BOOST_REQUIRE_EQUAL(commandSucceedHistory.size(), 1);
119 const ControlParameters& response = commandSucceedHistory[0].get<0>();
120 BOOST_CHECK_EQUAL(response.getUri(), responseBody.getUri());
121 BOOST_CHECK_EQUAL(response.getFaceId(), responseBody.getFaceId());
122}
123
124BOOST_FIXTURE_TEST_CASE(CommandInvalidRequest, CommandFixture)
125{
126 ControlParameters parameters;
127 parameters.setName("ndn:/should-not-have-this-field");
128 // Uri is missing
129
130 BOOST_CHECK_THROW(controller.start<FaceCreateCommand>(
131 parameters,
132 commandSucceedCallback,
133 commandFailCallback),
134 ControlCommand::ArgumentError);
135}
136
137BOOST_FIXTURE_TEST_CASE(CommandErrorCode, CommandFixture)
138{
139 ControlParameters parameters;
Junxiao Shi5de006b2014-10-26 20:20:52 -0700140 parameters.setUri("tcp4://192.0.2.1:6363");
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700141
142 BOOST_CHECK_NO_THROW(controller.start<FaceCreateCommand>(
143 parameters,
144 commandSucceedCallback,
145 commandFailCallback));
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800146 advanceClocks(time::milliseconds(1));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700147
Junxiao Shia60d9362014-11-12 09:38:21 -0700148 BOOST_REQUIRE_EQUAL(face->sentInterests.size(), 1);
149 const Interest& requestInterest = face->sentInterests[0];
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700150
151 ControlResponse responsePayload(401, "Not Authenticated");
152
Junxiao Shi6a90f372014-10-13 20:29:30 -0700153 Data responseData(requestInterest.getName());
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700154 responseData.setContent(responsePayload.wireEncode());
155 keyChain.sign(responseData);
156 face->receive(responseData);
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800157 advanceClocks(time::milliseconds(1));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700158
159 BOOST_CHECK_EQUAL(commandSucceedHistory.size(), 0);
160 BOOST_REQUIRE_EQUAL(commandFailHistory.size(), 1);
161 BOOST_CHECK_EQUAL(commandFailHistory[0].get<0>(), 401);
162}
163
164BOOST_FIXTURE_TEST_CASE(CommandInvalidResponse, CommandFixture)
165{
166 ControlParameters parameters;
Junxiao Shi5de006b2014-10-26 20:20:52 -0700167 parameters.setUri("tcp4://192.0.2.1:6363");
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700168
169 BOOST_CHECK_NO_THROW(controller.start<FaceCreateCommand>(
170 parameters,
171 commandSucceedCallback,
172 commandFailCallback));
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800173 advanceClocks(time::milliseconds(1));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700174
Junxiao Shia60d9362014-11-12 09:38:21 -0700175 BOOST_REQUIRE_EQUAL(face->sentInterests.size(), 1);
176 const Interest& requestInterest = face->sentInterests[0];
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700177
178 ControlParameters responseBody;
179 responseBody.setUri("tcp4://192.0.2.1:6363")
180 .setName("ndn:/should-not-have-this-field");
181 // FaceId is missing
182 ControlResponse responsePayload(201, "created");
183 responsePayload.setBody(responseBody.wireEncode());
184
Junxiao Shi6a90f372014-10-13 20:29:30 -0700185 Data responseData(requestInterest.getName());
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700186 responseData.setContent(responsePayload.wireEncode());
187 keyChain.sign(responseData);
188 face->receive(responseData);
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800189 advanceClocks(time::milliseconds(1));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700190
191 BOOST_CHECK_EQUAL(commandSucceedHistory.size(), 0);
192 BOOST_REQUIRE_EQUAL(commandFailHistory.size(), 1);
193}
194
Junxiao Shi5de006b2014-10-26 20:20:52 -0700195BOOST_FIXTURE_TEST_CASE(OptionsPrefix, CommandFixture)
196{
197 ControlParameters parameters;
198 parameters.setName("/ndn/com/example");
199 parameters.setFaceId(400);
200
201 CommandOptions options;
202 options.setPrefix("/localhop/net/example/router1/nfd");
203
204 BOOST_CHECK_NO_THROW(controller.start<RibRegisterCommand>(
205 parameters,
206 commandSucceedCallback,
207 commandFailCallback,
208 options));
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800209 advanceClocks(time::milliseconds(1));
Junxiao Shi5de006b2014-10-26 20:20:52 -0700210
Junxiao Shia60d9362014-11-12 09:38:21 -0700211 BOOST_REQUIRE_EQUAL(face->sentInterests.size(), 1);
212 const Interest& requestInterest = face->sentInterests[0];
Junxiao Shi5de006b2014-10-26 20:20:52 -0700213
214 FaceCreateCommand command;
215 BOOST_CHECK(Name("/localhop/net/example/router1/nfd/rib/register").isPrefixOf(
216 requestInterest.getName()));
217}
218
219BOOST_FIXTURE_TEST_CASE(OptionsTimeout, CommandFixture)
220{
221 ControlParameters parameters;
222 parameters.setUri("tcp4://192.0.2.1:6363");
223
224 CommandOptions options;
225 options.setTimeout(time::milliseconds(50));
226
227 BOOST_CHECK_NO_THROW(controller.start<FaceCreateCommand>(
228 parameters,
229 commandSucceedCallback,
230 commandFailCallback,
231 options));
Alexander Afanasyevd3a55b22014-11-18 19:23:28 -0800232 advanceClocks(time::milliseconds(1), 101); // Face's PIT granularity is 100ms
Junxiao Shi5de006b2014-10-26 20:20:52 -0700233
234 BOOST_REQUIRE_EQUAL(commandFailHistory.size(), 1);
235 BOOST_CHECK_EQUAL(commandFailHistory[0].get<0>(), Controller::ERROR_TIMEOUT);
236}
237
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700238BOOST_AUTO_TEST_SUITE_END()
239
Alexander Afanasyev4abdbf12014-08-11 12:48:54 -0700240} // namespace tests
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700241} // namespace nfd
242} // namespace ndn