blob: 247337d4a99fd0cf3fdf634951c24c6514edde16 [file] [log] [blame]
Junxiao Shid9ee45c2014-02-27 15:38:11 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Alexander Afanasyevc026d252014-06-16 11:14:15 -07003 * Copyright (c) 2014, Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070010 *
11 * This file is part of NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
Alexander Afanasyevc026d252014-06-16 11:14:15 -070024 */
Junxiao Shid9ee45c2014-02-27 15:38:11 -070025
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070026#ifndef NFD_TESTS_TEST_COMMON_HPP
27#define NFD_TESTS_TEST_COMMON_HPP
Junxiao Shid9ee45c2014-02-27 15:38:11 -070028
Alexander Afanasyev8552a382014-05-15 20:13:42 -070029#include "boost-test.hpp"
30
Junxiao Shid9ee45c2014-02-27 15:38:11 -070031#include "core/global-io.hpp"
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -060032#include "core/logger.hpp"
Alexander Afanasyev8552a382014-05-15 20:13:42 -070033
Junxiao Shi455581d2014-11-17 18:38:40 -070034#include <ndn-cxx/util/time-unit-test-clock.hpp>
Alexander Afanasyev4a771362014-04-24 21:29:33 -070035#include <ndn-cxx/security/key-chain.hpp>
Junxiao Shid9ee45c2014-02-27 15:38:11 -070036
37namespace nfd {
38namespace tests {
39
40/** \brief base test fixture
41 *
42 * Every test case should be based on this fixture,
43 * to have per test case io_service initialization.
44 */
45class BaseFixture
46{
47protected:
48 BaseFixture()
49 : g_io(getGlobalIoService())
50 {
51 }
Junxiao Shif3c07812014-03-11 21:48:49 -070052
Junxiao Shid9ee45c2014-02-27 15:38:11 -070053 ~BaseFixture()
54 {
55 resetGlobalIoService();
56 }
57
58protected:
59 /// reference to global io_service
60 boost::asio::io_service& g_io;
61};
62
Junxiao Shi455581d2014-11-17 18:38:40 -070063/** \brief a base test fixture that overrides steady clock and system clock
64 */
65class UnitTestTimeFixture : public BaseFixture
66{
Junxiao Shie368d992014-12-02 23:44:31 -070067protected:
Junxiao Shi455581d2014-11-17 18:38:40 -070068 UnitTestTimeFixture()
69 : steadyClock(make_shared<time::UnitTestSteadyClock>())
70 , systemClock(make_shared<time::UnitTestSystemClock>())
71 {
72 time::setCustomClocks(steadyClock, systemClock);
73 }
74
75 ~UnitTestTimeFixture()
76 {
77 time::setCustomClocks(nullptr, nullptr);
78 }
79
80 /** \brief advance steady and system clocks
81 *
82 * Clocks are advanced in increments of \p tick for \p nTicks ticks.
83 * After each tick, global io_service is polled to process pending I/O events.
84 *
85 * Exceptions thrown during I/O events are propagated to the caller.
86 * Clock advancing would stop in case of an exception.
87 */
88 void
89 advanceClocks(const time::nanoseconds& tick, size_t nTicks = 1)
90 {
Junxiao Shie368d992014-12-02 23:44:31 -070091 BOOST_ASSERT(nTicks >= 0);
92
93 this->advanceClocks(tick, tick * nTicks);
94 }
95
96 /** \brief advance steady and system clocks
97 *
98 * Clocks are advanced in increments of \p tick for \p total time.
99 * The last increment might be shorter than \p tick.
100 * After each tick, global io_service is polled to process pending I/O events.
101 *
102 * Exceptions thrown during I/O events are propagated to the caller.
103 * Clock advancing would stop in case of an exception.
104 */
105 void
106 advanceClocks(const time::nanoseconds& tick, const time::nanoseconds& total)
107 {
108 BOOST_ASSERT(tick > time::nanoseconds::zero());
109 BOOST_ASSERT(total >= time::nanoseconds::zero());
110
111 time::nanoseconds remaining = total;
112 while (remaining > time::nanoseconds::zero()) {
113 if (remaining >= tick) {
114 steadyClock->advance(tick);
115 systemClock->advance(tick);
116 remaining -= tick;
117 }
118 else {
119 steadyClock->advance(remaining);
120 systemClock->advance(remaining);
121 remaining = time::nanoseconds::zero();
122 }
Junxiao Shi455581d2014-11-17 18:38:40 -0700123
124 if (g_io.stopped())
125 g_io.reset();
126 g_io.poll();
127 }
128 }
129
Junxiao Shi3cb4fc62014-12-25 22:17:39 -0700130 friend class LimitedIo;
131
Junxiao Shi455581d2014-11-17 18:38:40 -0700132protected:
133 shared_ptr<time::UnitTestSteadyClock> steadyClock;
134 shared_ptr<time::UnitTestSystemClock> systemClock;
135};
Junxiao Shif3c07812014-03-11 21:48:49 -0700136
137inline shared_ptr<Interest>
138makeInterest(const Name& name)
139{
140 return make_shared<Interest>(name);
141}
142
143inline shared_ptr<Data>
Alexander Afanasyev4b3fc862014-06-19 14:57:57 -0700144signData(const shared_ptr<Data>& data)
Junxiao Shif3c07812014-03-11 21:48:49 -0700145{
Junxiao Shif3c07812014-03-11 21:48:49 -0700146 ndn::SignatureSha256WithRsa fakeSignature;
Ilya Moiseenko96b80bb2014-04-05 20:53:27 -0400147 fakeSignature.setValue(ndn::dataBlock(tlv::SignatureValue,
Junxiao Shi455581d2014-11-17 18:38:40 -0700148 static_cast<const uint8_t*>(nullptr), 0));
Junxiao Shif3c07812014-03-11 21:48:49 -0700149 data->setSignature(fakeSignature);
Alexander Afanasyevc026d252014-06-16 11:14:15 -0700150 data->wireEncode();
Junxiao Shif3c07812014-03-11 21:48:49 -0700151
152 return data;
153}
154
Alexander Afanasyev4b3fc862014-06-19 14:57:57 -0700155inline shared_ptr<Data>
156makeData(const Name& name)
157{
158 shared_ptr<Data> data = make_shared<Data>(name);
159
160 return signData(data);
161}
162
163
Junxiao Shid9ee45c2014-02-27 15:38:11 -0700164} // namespace tests
165} // namespace nfd
166
Alexander Afanasyev613e2a92014-04-15 13:36:58 -0700167#endif // NFD_TESTS_TEST_COMMON_HPP