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 * SPDX-License-Identifier: GPL-2.0-only
6 */
7
8#include "ns3/ipv6-address-generator.h"
9#include "ns3/simulation-singleton.h"
10#include "ns3/test.h"
11
12using namespace ns3;
13
14/**
15 * \ingroup internet-test
16 *
17 * \brief IPv6 network number allocator Test
18 */
19class NetworkNumber6AllocatorTestCase : public TestCase
20{
21 public:
22 NetworkNumber6AllocatorTestCase();
23 void DoRun() override;
24 void DoTeardown() override;
25};
26
27NetworkNumber6AllocatorTestCase::NetworkNumber6AllocatorTestCase()
28 : TestCase("Make sure the network number allocator is working on some of network prefixes.")
29{
30}
31
32void
37
38void
39NetworkNumber6AllocatorTestCase::DoRun()
40{
41 Ipv6Address network;
42
43 Ipv6AddressGenerator::Init(Ipv6Address("1::0:0:0"), Ipv6Prefix("FFFF::0"), Ipv6Address("::"));
44 network = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix("FFFF::0"));
45 NS_TEST_EXPECT_MSG_EQ(network,
46 Ipv6Address("1::0:0:0"),
47 "network should equal the initialized network for given prefix");
48 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF::0"));
49 NS_TEST_EXPECT_MSG_EQ(network, Ipv6Address("2::0:0:0"), "network should equal next network");
50
51 Ipv6AddressGenerator::Init(Ipv6Address("0:1::0:0"),
52 Ipv6Prefix("FFFF:FFFF::0"),
53 Ipv6Address("::"));
54 network = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix("FFFF:FFFF::0"));
55 NS_TEST_EXPECT_MSG_EQ(network,
56 Ipv6Address("0:1::0"),
57 "network should equal the initialized network for given prefix");
58 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF:FFFF::0"));
59 NS_TEST_EXPECT_MSG_EQ(network, Ipv6Address("0:2::0"), "network should equal next network");
60
61 Ipv6AddressGenerator::Init(Ipv6Address("0:0:1::0"),
62 Ipv6Prefix("FFFF:FFFF:FFFF::0"),
63 Ipv6Address("::0"));
64 network = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix("FFFF:FFFF:FFFF::0"));
65 NS_TEST_EXPECT_MSG_EQ(network,
66 Ipv6Address("0:0:1::0"),
67 "network should equal the initialized network for given prefix");
68 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF:FFFF:FFFF::0"));
69 NS_TEST_EXPECT_MSG_EQ(network, Ipv6Address("0:0:2::0"), "network should equal next network");
70}
71
72/**
73 * \ingroup internet-test
74 *
75 * \brief IPv6 address allocator Test
76 */
77class AddressAllocator6TestCase : public TestCase
78{
79 public:
80 AddressAllocator6TestCase();
81
82 private:
83 void DoRun() override;
84 void DoTeardown() override;
85};
86
87AddressAllocator6TestCase::AddressAllocator6TestCase()
88 : TestCase("Sanity check on allocation of addresses")
89{
90}
91
92void
93AddressAllocator6TestCase::DoRun()
94{
95 Ipv6Address address;
96
97 Ipv6AddressGenerator::Init(Ipv6Address("2001::0"), Ipv6Prefix(64));
98 address = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix(64));
99 NS_TEST_EXPECT_MSG_EQ(address,
100 Ipv6Address("2001::0"),
101 "address should equal the initialized address for given prefix");
102 Ipv6AddressGenerator::NextNetwork(Ipv6Prefix(64));
103 address = Ipv6AddressGenerator::GetNetwork(Ipv6Prefix(64));
104 NS_TEST_EXPECT_MSG_EQ(address,
105 Ipv6Address("2001:0:0:1::0"),
106 "address should equal the initialized address for given prefix");
107 address = Ipv6AddressGenerator::GetAddress(Ipv6Prefix(64));
108 NS_TEST_EXPECT_MSG_EQ(address,
109 Ipv6Address("2001:0:0:1::1"),
110 "address should equal the initialized address for given prefix");
111 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(64));
112 NS_TEST_EXPECT_MSG_EQ(address,
113 Ipv6Address("2001:0:0:1::1"),
114 "address should equal the initialized address for given prefix");
115 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(64));
116 NS_TEST_EXPECT_MSG_EQ(address,
117 Ipv6Address("2001:0:0:1::2"),
118 "address should equal the initialized address for given prefix");
119
120 Ipv6AddressGenerator::Init(Ipv6Address("1::"), Ipv6Prefix("FFFF::"), Ipv6Address("::3"));
121 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
122 NS_TEST_EXPECT_MSG_EQ(address,
123 Ipv6Address("1::3"),
124 "address should equal initialized address for given prefix");
125 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
126 NS_TEST_EXPECT_MSG_EQ(address, Ipv6Address("1::4"), "address should equal next address");
127}
128
129void
135
136/**
137 * \ingroup internet-test
138 *
139 * \brief IPv6 network number and address allocator Test
140 */
141class NetworkAndAddress6TestCase : public TestCase
142{
143 public:
144 NetworkAndAddress6TestCase();
145 void DoRun() override;
146 void DoTeardown() override;
147};
148
149NetworkAndAddress6TestCase::NetworkAndAddress6TestCase()
150 : TestCase("Make sure Network and address allocation play together.")
151{
152}
153
154void
160
161void
162NetworkAndAddress6TestCase::DoRun()
163{
164 Ipv6Address address;
165 Ipv6Address network;
166
167 Ipv6AddressGenerator::Init(Ipv6Address("3::"), Ipv6Prefix("FFFF::"), Ipv6Address("::3"));
168 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
169 NS_TEST_EXPECT_MSG_EQ(address,
170 Ipv6Address("3::3"),
171 "address should equal initialized address for given prefix");
172 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
173 NS_TEST_EXPECT_MSG_EQ(address,
174 Ipv6Address("3::4"),
175 "address should equal next address for given prefix");
176
177 network = Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF::"));
178 NS_TEST_EXPECT_MSG_EQ(network,
179 Ipv6Address("4::0"),
180 "address should equal next address for given prefix");
181 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(16));
182 NS_TEST_EXPECT_MSG_EQ(address,
183 Ipv6Address("4::3"),
184 "address should equal next address for given prefix");
185}
186
187/**
188 * \ingroup internet-test
189 *
190 * \brief IPv6 example of an address generator Test
191 */
192class ExampleAddress6GeneratorTestCase : public TestCase
193{
194 public:
195 ExampleAddress6GeneratorTestCase();
196
197 private:
198 void DoRun() override;
199 void DoTeardown() override;
200};
201
202ExampleAddress6GeneratorTestCase::ExampleAddress6GeneratorTestCase()
203 : TestCase("A typical real-world example")
204{
205}
206
207void
212
213void
214ExampleAddress6GeneratorTestCase::DoRun()
215{
216 Ipv6Address address;
217
218 Ipv6AddressGenerator::Init(Ipv6Address("2001:0AB8::"),
219 Ipv6Prefix("FFFF:FFFF:FFFF::0"),
220 Ipv6Address("::3"));
221 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
222 NS_TEST_EXPECT_MSG_EQ(address,
223 Ipv6Address("2001:0AB8::0:3"),
224 "address should equal initialized address for given prefix");
225 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
226 NS_TEST_EXPECT_MSG_EQ(address,
227 Ipv6Address("2001:0AB8::0:4"),
228 "address should equal next address for given prefix");
229 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
230 NS_TEST_EXPECT_MSG_EQ(address,
231 Ipv6Address("2001:0AB8::0:5"),
232 "address should equal next address for given prefix");
233 //
234 // Allocate the next network based on the prefix passed in, which should
235 // be 2001:0AB0:0001
236 //
237 Ipv6AddressGenerator::NextNetwork(Ipv6Prefix("FFFF:FFFF:FFFF::0"));
238 //
239 // reset first address to be allocated back to ::0:3
240 //
241 Ipv6AddressGenerator::InitAddress(Ipv6Address("::3"), Ipv6Prefix(48));
242 //
243 // The first address we should get is the network and address ORed
244 //
245 address = Ipv6AddressGenerator::NextAddress(Ipv6Prefix(48));
246 NS_TEST_EXPECT_MSG_EQ(address,
247 Ipv6Address("2001:0AB8:1::3"),
248 "address should equal initialized address for given prefix");
249}
250
251/**
252 * \ingroup internet-test
253 *
254 * \brief IPv6 address collision Test
255 */
256class AddressCollision6TestCase : public TestCase
257{
258 public:
259 AddressCollision6TestCase();
260
261 private:
262 void DoRun() override;
263 void DoTeardown() override;
264};
265
266AddressCollision6TestCase::AddressCollision6TestCase()
267 : TestCase("Make sure that the address collision logic works.")
268{
269}
270
271void
277
278void
279AddressCollision6TestCase::DoRun()
280{
281 Ipv6AddressGenerator::AddAllocated("0::0:5");
282 Ipv6AddressGenerator::AddAllocated("0::0:10");
283 Ipv6AddressGenerator::AddAllocated("0::0:15");
284 Ipv6AddressGenerator::AddAllocated("0::0:20");
285
286 Ipv6AddressGenerator::AddAllocated("0::0:4");
287 Ipv6AddressGenerator::AddAllocated("0::0:3");
288 Ipv6AddressGenerator::AddAllocated("0::0:2");
289 Ipv6AddressGenerator::AddAllocated("0::0:1");
290
291 Ipv6AddressGenerator::AddAllocated("0::0:6");
292 Ipv6AddressGenerator::AddAllocated("0::0:7");
293 Ipv6AddressGenerator::AddAllocated("0::0:8");
294 Ipv6AddressGenerator::AddAllocated("0::0:9");
295
296 Ipv6AddressGenerator::AddAllocated("0::0:11");
297 Ipv6AddressGenerator::AddAllocated("0::0:12");
298 Ipv6AddressGenerator::AddAllocated("0::0:13");
299 Ipv6AddressGenerator::AddAllocated("0::0:14");
300
301 Ipv6AddressGenerator::AddAllocated("0::0:19");
302 Ipv6AddressGenerator::AddAllocated("0::0:18");
303 Ipv6AddressGenerator::AddAllocated("0::0:17");
304 Ipv6AddressGenerator::AddAllocated("0::0:16");
305
306 Ipv6AddressGenerator::TestMode();
307 bool allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:21");
308 NS_TEST_EXPECT_MSG_EQ(allocated, false, "0::0:21 should not be already allocated");
309 bool added = Ipv6AddressGenerator::AddAllocated("0::0:21");
310 NS_TEST_EXPECT_MSG_EQ(added, true, "address should get allocated");
311
312 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:4");
313 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:4 should be already allocated");
314 added = Ipv6AddressGenerator::AddAllocated("0::0:4");
315 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
316
317 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:9");
318 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:9 should be already allocated");
319 added = Ipv6AddressGenerator::AddAllocated("0::0:9");
320 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
321
322 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:16");
323 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:16 should be already allocated");
324 added = Ipv6AddressGenerator::AddAllocated("0::0:16");
325 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
326
327 allocated = Ipv6AddressGenerator::IsAddressAllocated("0::0:21");
328 NS_TEST_EXPECT_MSG_EQ(allocated, true, "0::0:21 should be already allocated");
329 added = Ipv6AddressGenerator::AddAllocated("0::0:21");
330 NS_TEST_EXPECT_MSG_EQ(added, false, "address should not get allocated");
331}
332
333/**
334 * \ingroup internet-test
335 *
336 * \brief IPv6 address generator TestSuite
337 */
338class Ipv6AddressGeneratorTestSuite : public TestSuite
339{
340 public:
341 Ipv6AddressGeneratorTestSuite()
342 : TestSuite("ipv6-address-generator")
343 {
344 AddTestCase(new NetworkNumber6AllocatorTestCase(), TestCase::Duration::QUICK);
345 AddTestCase(new AddressAllocator6TestCase(), TestCase::Duration::QUICK);
346 AddTestCase(new NetworkAndAddress6TestCase(), TestCase::Duration::QUICK);
347 AddTestCase(new ExampleAddress6GeneratorTestCase(), TestCase::Duration::QUICK);
348 AddTestCase(new AddressCollision6TestCase(), TestCase::Duration::QUICK);
349 }
350};
351
352static Ipv6AddressGeneratorTestSuite
353 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:130
AddressAllocator6TestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv6-address-generator-test-suite.cc:93
AddressCollision6TestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv6-address-generator-test-suite.cc:279
AddressCollision6TestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv6-address-generator-test-suite.cc:272
ExampleAddress6GeneratorTestCase
IPv6 example of an address generator Test.
Definition ipv6-address-generator-test-suite.cc:193
ExampleAddress6GeneratorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv6-address-generator-test-suite.cc:208
ExampleAddress6GeneratorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv6-address-generator-test-suite.cc:214
NetworkAndAddress6TestCase
IPv6 network number and address allocator Test.
Definition ipv6-address-generator-test-suite.cc:142
NetworkAndAddress6TestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv6-address-generator-test-suite.cc:162
NetworkAndAddress6TestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv6-address-generator-test-suite.cc:155
NetworkNumber6AllocatorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv6-address-generator-test-suite.cc:39
NetworkNumber6AllocatorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv6-address-generator-test-suite.cc:33
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:661
ns3::Ipv6AddressGenerator::TestMode
static void TestMode()
Used to turn off fatal errors and assertions, for testing.
Definition ipv6-address-generator.cc:743
ns3::Ipv6AddressGenerator::NextAddress
static Ipv6Address NextAddress(const Ipv6Prefix prefix)
Allocate the next Ipv6Address for the configured network and prefix.
Definition ipv6-address-generator.cc:703
ns3::Ipv6AddressGenerator::GetNetwork
static Ipv6Address GetNetwork(const Ipv6Prefix prefix)
Get the current network of the given Ipv6Prefix.
Definition ipv6-address-generator.cc:679
ns3::Ipv6AddressGenerator::InitAddress
static void InitAddress(const Ipv6Address interfaceId, const Ipv6Prefix prefix)
Set the interfaceId for the given Ipv6Prefix.
Definition ipv6-address-generator.cc:687
ns3::Ipv6AddressGenerator::AddAllocated
static bool AddAllocated(const Ipv6Address addr)
Add the Ipv6Address to the list of IPv6 entries.
Definition ipv6-address-generator.cc:719
ns3::Ipv6AddressGenerator::GetAddress
static Ipv6Address GetAddress(const Ipv6Prefix prefix)
Get the Ipv6Address that will be allocated upon NextAddress ()
Definition ipv6-address-generator.cc:695
ns3::Ipv6AddressGenerator::NextNetwork
static Ipv6Address NextNetwork(const Ipv6Prefix prefix)
Get the next network according to the given Ipv6Prefix.
Definition ipv6-address-generator.cc:671
ns3::Ipv6AddressGenerator::IsAddressAllocated
static bool IsAddressAllocated(const Ipv6Address addr)
Check the Ipv6Address allocation in the list of IPv6 entries.
Definition ipv6-address-generator.cc:727
ns3::Ipv6AddressGenerator::Reset
static void Reset()
Reset the networks and Ipv6Address to zero.
Definition ipv6-address-generator.cc:711
ns3::Ipv6Address
Describes an IPv6 address.
Definition ipv6-address.h:38
ns3::Ipv6Prefix
Describes an IPv6 prefix.
Definition ipv6-address.h:444
ns3::Simulator::Destroy
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition simulator.cc:131
ns3::TestCase
encapsulates test code
Definition test.h:1050
ns3::TestCase::AddTestCase
void AddTestCase(TestCase *testCase, Duration duration=Duration::QUICK)
Add an individual child TestCase to this test suite.
Definition test.cc:292
ns3::TestSuite
A suite of tests to run.
Definition test.h:1267
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:241
g_ipv6AddressGeneratorTestSuite
static Ipv6AddressGeneratorTestSuite g_ipv6AddressGeneratorTestSuite
Static variable for test initialization.
Definition ipv6-address-generator-test-suite.cc:353
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.