A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ipv6-address-generator-test-suite.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 University of Washington
3 * Copyright (c) 2011 Atishay Jain
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
18
19#include "ns3/ipv6-address-generator.h"
20#include "ns3/simulation-singleton.h"
21#include "ns3/test.h"
22
23using namespace ns3;
24
25/**
26 * \ingroup internet-test
27 *
28 * \brief IPv6 network number allocator Test
29 */
30class NetworkNumber6AllocatorTestCase : public TestCase
31{
32 public:
33 NetworkNumber6AllocatorTestCase();
34 void DoRun() override;
35 void DoTeardown() override;
36};
37
38NetworkNumber6AllocatorTestCase::NetworkNumber6AllocatorTestCase()
39 : TestCase("Make sure the network number allocator is working on some of network prefixes.")
40{
41}
42
43void
44NetworkNumber6AllocatorTestCase::DoTeardown()
45{
46 Ipv6AddressGenerator::Reset();
47}
48
49void
50NetworkNumber6AllocatorTestCase::DoRun()
51{
52 Ipv6Address network;
53
54 Ipv6AddressGenerator::Init(Ipv6Address("1::0:0:0"), Ipv6Prefix("FFFF::0"), Ipv6Address("::"));
55 network = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix("FFFF::0"));
56 NS_TEST_EXPECT_MSG_EQ(network,
57 Ipv6Address("1::0:0:0"),
58 "network should equal the initialized network for given prefix");
59 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF::0"));
60 NS_TEST_EXPECT_MSG_EQ(network, Ipv6Address("2::0:0:0"), "network should equal next network");
61
62 Ipv6AddressGenerator::Init(Ipv6Address("0:1::0:0"),
63 Ipv6Prefix("FFFF:FFFF::0"),
64 Ipv6Address("::"));
65 network = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix("FFFF:FFFF::0"));
66 NS_TEST_EXPECT_MSG_EQ(network,
67 Ipv6Address("0:1::0"),
68 "network should equal the initialized network for given prefix");
69 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF:FFFF::0"));
70 NS_TEST_EXPECT_MSG_EQ(network, Ipv6Address("0:2::0"), "network should equal next network");
71
72 Ipv6AddressGenerator::Init(Ipv6Address("0:0:1::0"),
73 Ipv6Prefix("FFFF:FFFF:FFFF::0"),
74 Ipv6Address("::0"));
75 network = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix("FFFF:FFFF:FFFF::0"));
76 NS_TEST_EXPECT_MSG_EQ(network,
77 Ipv6Address("0:0:1::0"),
78 "network should equal the initialized network for given prefix");
79 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF:FFFF:FFFF::0"));
80 NS_TEST_EXPECT_MSG_EQ(network, Ipv6Address("0:0:2::0"), "network should equal next network");
81}
82
83/**
84 * \ingroup internet-test
85 *
86 * \brief IPv6 address allocator Test
87 */
88class AddressAllocator6TestCase : public TestCase
89{
90 public:
91 AddressAllocator6TestCase();
92
93 private:
94 void DoRun() override;
95 void DoTeardown() override;
96};
97
98AddressAllocator6TestCase::AddressAllocator6TestCase()
99 : TestCase("Sanity check on allocation of addresses")
100{
101}
102
103void
104AddressAllocator6TestCase::DoRun()
105{
106 Ipv6Address address;
107
108 Ipv6AddressGenerator::Init(Ipv6Address("2001::0"), Ipv6Prefix(64));
109 address = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix(64));
110 NS_TEST_EXPECT_MSG_EQ(address,
111 Ipv6Address("2001::0"),
112 "address should equal the initialized address for given prefix");
113 Ipv6AddressGenerator::NextNetwork(Ipv6Prefix(64));
114 address = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix(64));
115 NS_TEST_EXPECT_MSG_EQ(address,
116 Ipv6Address("2001:0:0:1::0"),
117 "address should equal the initialized address for given prefix");
118 address = Ipv6AddressGenerator::GetAddress(Ipv6Prefix(64));
119 NS_TEST_EXPECT_MSG_EQ(address,
120 Ipv6Address("2001:0:0:1::1"),
121 "address should equal the initialized address for given prefix");
122 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(64));
123 NS_TEST_EXPECT_MSG_EQ(address,
124 Ipv6Address("2001:0:0:1::1"),
125 "address should equal the initialized address for given prefix");
126 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(64));
127 NS_TEST_EXPECT_MSG_EQ(address,
128 Ipv6Address("2001:0:0:1::2"),
129 "address should equal the initialized address for given prefix");
130
131 Ipv6AddressGenerator::Init(Ipv6Address("1::"), Ipv6Prefix("FFFF::"), Ipv6Address("::3"));
132 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
133 NS_TEST_EXPECT_MSG_EQ(address,
134 Ipv6Address("1::3"),
135 "address should equal initialized address for given prefix");
136 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
137 NS_TEST_EXPECT_MSG_EQ(address, Ipv6Address("1::4"), "address should equal next address");
138}
139
140void
141AddressAllocator6TestCase::DoTeardown()
142{
143 Ipv6AddressGenerator::Reset();
144 Simulator::Destroy();
145}
146
147/**
148 * \ingroup internet-test
149 *
150 * \brief IPv6 network number and address allocator Test
151 */
152class NetworkAndAddress6TestCase : public TestCase
153{
154 public:
155 NetworkAndAddress6TestCase();
156 void DoRun() override;
157 void DoTeardown() override;
158};
159
160NetworkAndAddress6TestCase::NetworkAndAddress6TestCase()
161 : TestCase("Make sure Network and address allocation play together.")
162{
163}
164
165void
166NetworkAndAddress6TestCase::DoTeardown()
167{
168 Ipv6AddressGenerator::Reset();
169 Simulator::Destroy();
170}
171
172void
173NetworkAndAddress6TestCase::DoRun()
174{
175 Ipv6Address address;
176 Ipv6Address network;
177
178 Ipv6AddressGenerator::Init(Ipv6Address("3::"), Ipv6Prefix("FFFF::"), Ipv6Address("::3"));
179 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
180 NS_TEST_EXPECT_MSG_EQ(address,
181 Ipv6Address("3::3"),
182 "address should equal initialized address for given prefix");
183 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
184 NS_TEST_EXPECT_MSG_EQ(address,
185 Ipv6Address("3::4"),
186 "address should equal next address for given prefix");
187
188 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF::"));
189 NS_TEST_EXPECT_MSG_EQ(network,
190 Ipv6Address("4::0"),
191 "address should equal next address for given prefix");
192 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
193 NS_TEST_EXPECT_MSG_EQ(address,
194 Ipv6Address("4::3"),
195 "address should equal next address for given prefix");
196}
197
198/**
199 * \ingroup internet-test
200 *
201 * \brief IPv6 example of an address generator Test
202 */
203class ExampleAddress6GeneratorTestCase : public TestCase
204{
205 public:
206 ExampleAddress6GeneratorTestCase();
207
208 private:
209 void DoRun() override;
210 void DoTeardown() override;
211};
212
213ExampleAddress6GeneratorTestCase::ExampleAddress6GeneratorTestCase()
214 : TestCase("A typical real-world example")
215{
216}
217
218void
219ExampleAddress6GeneratorTestCase::DoTeardown()
220{
221 Ipv6AddressGenerator::Reset();
222}
223
224void
225ExampleAddress6GeneratorTestCase::DoRun()
226{
227 Ipv6Address address;
228
229 Ipv6AddressGenerator::Init(Ipv6Address("2001:0AB8::"),
230 Ipv6Prefix("FFFF:FFFF:FFFF::0"),
231 Ipv6Address("::3"));
232 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
233 NS_TEST_EXPECT_MSG_EQ(address,
234 Ipv6Address("2001:0AB8::0:3"),
235 "address should equal initialized address for given prefix");
236 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
237 NS_TEST_EXPECT_MSG_EQ(address,
238 Ipv6Address("2001:0AB8::0:4"),
239 "address should equal next address for given prefix");
240 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
241 NS_TEST_EXPECT_MSG_EQ(address,
242 Ipv6Address("2001:0AB8::0:5"),
243 "address should equal next address for given prefix");
244 //
245 // Allocate the next network based on the prefix passed in, which should
246 // be 2001:0AB0:0001
247 //
248 Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF:FFFF:FFFF::0"));
249 //
250 // reset first address to be allocated back to ::0:3
251 //
252 Ipv6AddressGenerator::InitAddress(Ipv6Address("::3"), Ipv6Prefix(48));
253 //
254 // The first address we should get is the network and address ORed
255 //
256 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
257 NS_TEST_EXPECT_MSG_EQ(address,
258 Ipv6Address("2001:0AB8:1::3"),
259 "address should equal initialized address for given prefix");
260}
261
262/**
263 * \ingroup internet-test
264 *
265 * \brief IPv6 address collision Test
266 */
267class AddressCollision6TestCase : public TestCase
268{
269 public:
270 AddressCollision6TestCase();
271
272 private:
273 void DoRun() override;
274 void DoTeardown() override;
275};
276
277AddressCollision6TestCase::AddressCollision6TestCase()
278 : TestCase("Make sure that the address collision logic works.")
279{
280}
281
282void
283AddressCollision6TestCase::DoTeardown()
284{
285 Ipv6AddressGenerator::Reset();
286 Simulator::Destroy();
287}
288
289void
290AddressCollision6TestCase::DoRun()
291{
292 Ipv6AddressGenerator::AddAllocated("0::0:5");
293 Ipv6AddressGenerator::AddAllocated("0::0:10");
294 Ipv6AddressGenerator::AddAllocated("0::0:15");
295 Ipv6AddressGenerator::AddAllocated("0::0:20");
296
297 Ipv6AddressGenerator::AddAllocated("0::0:4");
298 Ipv6AddressGenerator::AddAllocated("0::0:3");
299 Ipv6AddressGenerator::AddAllocated("0::0:2");
300 Ipv6AddressGenerator::AddAllocated("0::0:1");
301
302 Ipv6AddressGenerator::AddAllocated("0::0:6");
303 Ipv6AddressGenerator::AddAllocated("0::0:7");
304 Ipv6AddressGenerator::AddAllocated("0::0:8");
305 Ipv6AddressGenerator::AddAllocated("0::0:9");
306
307 Ipv6AddressGenerator::AddAllocated("0::0:11");
308 Ipv6AddressGenerator::AddAllocated("0::0:12");
309 Ipv6AddressGenerator::AddAllocated("0::0:13");
310 Ipv6AddressGenerator::AddAllocated("0::0:14");
311
312 Ipv6AddressGenerator::AddAllocated("0::0:19");
313 Ipv6AddressGenerator::AddAllocated("0::0:18");
314 Ipv6AddressGenerator::AddAllocated("0::0:17");
315 Ipv6AddressGenerator::AddAllocated("0::0:16");
316
317 Ipv6AddressGenerator::TestMode();
318 bool allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:21");
319 NS_TEST_EXPECT_MSG_EQ(allocated, false, "0::0:21 should not be already allocated");
320 bool added = Ipv6AddressGenerator::AddAllocated("0::0:21");
321 NS_TEST_EXPECT_MSG_EQ(added, true, "address should get allocated");
322
323 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:4");
324 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:4 should be already allocated");
325 added = Ipv6AddressGenerator::AddAllocated("0::0:4");
326 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
327
328 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:9");
329 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:9 should be already allocated");
330 added = Ipv6AddressGenerator::AddAllocated("0::0:9");
331 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
332
333 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:16");
334 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:16 should be already allocated");
335 added = Ipv6AddressGenerator::AddAllocated("0::0:16");
336 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
337
338 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:21");
339 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:21 should be already allocated");
340 added = Ipv6AddressGenerator::AddAllocated("0::0:21");
341 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
342}
343
344/**
345 * \ingroup internet-test
346 *
347 * \brief IPv6 address generator TestSuite
348 */
349class Ipv6AddressGeneratorTestSuite : public TestSuite
350{
351 public:
352 Ipv6AddressGeneratorTestSuite()
353 : TestSuite("ipv6-address-generator")
354 {
355 AddTestCase(new NetworkNumber6AllocatorTestCase(), TestCase::Duration::QUICK);
356 AddTestCase(new AddressAllocator6TestCase(), TestCase::Duration::QUICK);
357 AddTestCase(new NetworkAndAddress6TestCase(), TestCase::Duration::QUICK);
358 AddTestCase(new ExampleAddress6GeneratorTestCase(), TestCase::Duration::QUICK);
359 AddTestCase(new AddressCollision6TestCase(), TestCase::Duration::QUICK);
360 }
361};
362
363static Ipv6AddressGeneratorTestSuite
364 g_ipv6AddressGeneratorTestSuite; //!< Static variable for test initialization
AddressAllocator6TestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition: ipv6-address-generator-test-suite.cc:141
AddressAllocator6TestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition: ipv6-address-generator-test-suite.cc:104
AddressCollision6TestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition: ipv6-address-generator-test-suite.cc:290
AddressCollision6TestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition: ipv6-address-generator-test-suite.cc:283
ExampleAddress6GeneratorTestCase
IPv6 example of an address generator Test.
Definition: ipv6-address-generator-test-suite.cc:204
ExampleAddress6GeneratorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition: ipv6-address-generator-test-suite.cc:219
ExampleAddress6GeneratorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition: ipv6-address-generator-test-suite.cc:225
NetworkAndAddress6TestCase
IPv6 network number and address allocator Test.
Definition: ipv6-address-generator-test-suite.cc:153
NetworkAndAddress6TestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition: ipv6-address-generator-test-suite.cc:173
NetworkAndAddress6TestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition: ipv6-address-generator-test-suite.cc:166
NetworkNumber6AllocatorTestCase
IPv6 network number allocator Test.
Definition: ipv6-address-generator-test-suite.cc:31
NetworkNumber6AllocatorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition: ipv6-address-generator-test-suite.cc:50
NetworkNumber6AllocatorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition: ipv6-address-generator-test-suite.cc:44
ns3::Ipv6AddressGenerator::Init
static void Init(const Ipv6Address net, const Ipv6Prefix prefix, const Ipv6Address interfaceId="::1")
Initialise the base network and interfaceId for the generator.
Definition: ipv6-address-generator.cc:672
ns3::Ipv6AddressGenerator::TestMode
static void TestMode()
Used to turn off fatal errors and assertions, for testing.
Definition: ipv6-address-generator.cc:754
ns3::Ipv6AddressGenerator::NextAddress
static Ipv6Address NextAddress(const Ipv6Prefix prefix)
Allocate the next Ipv6Address for the configured network and prefix.
Definition: ipv6-address-generator.cc:714
ns3::Ipv6AddressGenerator::GetNetwork
static Ipv6Address GetNetwork(const Ipv6Prefix prefix)
Get the current network of the given Ipv6Prefix.
Definition: ipv6-address-generator.cc:690
ns3::Ipv6AddressGenerator::InitAddress
static void InitAddress(const Ipv6Address interfaceId, const Ipv6Prefix prefix)
Set the interfaceId for the given Ipv6Prefix.
Definition: ipv6-address-generator.cc:698
ns3::Ipv6AddressGenerator::AddAllocated
static bool AddAllocated(const Ipv6Address addr)
Add the Ipv6Address to the list of IPv6 entries.
Definition: ipv6-address-generator.cc:730
ns3::Ipv6AddressGenerator::GetAddress
static Ipv6Address GetAddress(const Ipv6Prefix prefix)
Get the Ipv6Address that will be allocated upon NextAddress ()
Definition: ipv6-address-generator.cc:706
ns3::Ipv6AddressGenerator::NextNetwork
static Ipv6Address NextNetwork(const Ipv6Prefix prefix)
Get the next network according to the given Ipv6Prefix.
Definition: ipv6-address-generator.cc:682
ns3::Ipv6AddressGenerator::IsAddressAllocated
static bool IsAddressAllocated(const Ipv6Address addr)
Check the Ipv6Address allocation in the list of IPv6 entries.
Definition: ipv6-address-generator.cc:738
ns3::Ipv6AddressGenerator::Reset
static void Reset()
Reset the networks and Ipv6Address to zero.
Definition: ipv6-address-generator.cc:722
ns3::Ipv6Address
Describes an IPv6 address.
Definition: ipv6-address.h:49
ns3::Ipv6Prefix
Describes an IPv6 prefix.
Definition: ipv6-address.h:455
ns3::Simulator::Destroy
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
ns3::TestCase
encapsulates test code
Definition: test.h:1061
ns3::TestCase::AddTestCase
void AddTestCase(TestCase *testCase, Duration duration=Duration::QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:301
ns3::TestSuite
A suite of tests to run.
Definition: test.h:1268
NS_TEST_EXPECT_MSG_EQ
#define NS_TEST_EXPECT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report if not.
Definition: test.h:252
g_ipv6AddressGeneratorTestSuite
static Ipv6AddressGeneratorTestSuite g_ipv6AddressGeneratorTestSuite
Static variable for test initialization.
Definition: ipv6-address-generator-test-suite.cc:364
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.