A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ipv4-address-generator-test-suite.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 University of Washington
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/test.h"
20 #include "ns3/ipv4-address-generator.h"
21 #include "ns3/simulation-singleton.h"
22 
23 using namespace ns3;
24 
25 class NetworkNumberAllocatorTestCase : public TestCase
26 {
27 public:
28  NetworkNumberAllocatorTestCase ();
29  virtual void DoRun (void);
30  virtual void DoTeardown (void);
31 };
32 
33 NetworkNumberAllocatorTestCase::NetworkNumberAllocatorTestCase ()
34  : TestCase ("Make sure the network number allocator is working on some of network prefixes.")
35 {
36 }
37 void
38 NetworkNumberAllocatorTestCase::DoTeardown (void)
39 {
40  Ipv4AddressGenerator::Reset ();
41 }
42 void
43 NetworkNumberAllocatorTestCase::DoRun (void)
44 {
45  Ipv4Address network;
46  Ipv4AddressGenerator::Init (Ipv4Address ("1.0.0.0"), Ipv4Mask ("255.0.0.0"),
47  Ipv4Address ("0.0.0.0"));
48  network = Ipv4AddressGenerator::GetNetwork (Ipv4Mask ("255.0.0.0"));
49  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("1.0.0.0"), "001");
50  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.0.0.0"));
51  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("2.0.0.0"), "001");
52 
53  Ipv4AddressGenerator::Init (Ipv4Address ("0.1.0.0"),
54  Ipv4Mask ("255.255.0.0"), Ipv4Address ("0.0.0.0"));
55  network = Ipv4AddressGenerator::GetNetwork (Ipv4Mask ("255.255.0.0"));
56  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.1.0.0"), "003");
57  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.0.0"));
58  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.2.0.0"), "004");
59 
60  Ipv4AddressGenerator::Init (Ipv4Address ("0.0.1.0"),
61  Ipv4Mask ("255.255.255.0"), Ipv4Address ("0.0.0.0"));
62  network = Ipv4AddressGenerator::GetNetwork (Ipv4Mask ("255.255.255.0"));
63  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.0.1.0"), "005");
64  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.255.0"));
65  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.0.2.0"), "006");
66 
67  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.0.0.0"));
68  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("3.0.0.0"), "007");
69  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.0.0"));
70  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.3.0.0"), "008");
71  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.255.0"));
72  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.0.3.0"), "009");
73 }
74 
75 class AddressAllocatorTestCase : public TestCase
76 {
77 public:
78  AddressAllocatorTestCase ();
79 private:
80  virtual void DoRun (void);
81  virtual void DoTeardown (void);
82 };
83 
84 AddressAllocatorTestCase::AddressAllocatorTestCase ()
85  : TestCase ("Sanity check on allocation of addresses")
86 {
87 }
88 
89 void
90 AddressAllocatorTestCase::DoRun (void)
91 {
92  Ipv4Address address;
93 
94  Ipv4AddressGenerator::Init (Ipv4Address ("1.0.0.0"), Ipv4Mask ("255.0.0.0"),
95  Ipv4Address ("0.0.0.3"));
96  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.0.0.0"));
97  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("1.0.0.3"), "100");
98  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.0.0.0"));
99  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("1.0.0.4"), "101");
100 
101  Ipv4AddressGenerator::Init (Ipv4Address ("0.1.0.0"),
102  Ipv4Mask ("255.255.0.0"), Ipv4Address ("0.0.0.3"));
103  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.0.0"));
104  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.1.0.3"), "102");
105  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.0.0"));
106  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.1.0.4"), "103");
107 
108  Ipv4AddressGenerator::Init (Ipv4Address ("0.0.1.0"),
109  Ipv4Mask ("255.255.255.0"), Ipv4Address ("0.0.0.3"));
110  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
111  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.0.1.3"), "104");
112  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
113  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.0.1.4"), "105");
114 }
115 
116 void
117 AddressAllocatorTestCase::DoTeardown (void)
118 {
119  Ipv4AddressGenerator::Reset ();
120  Simulator::Destroy ();
121 }
122 
123 
124 class NetworkAndAddressTestCase : public TestCase
125 {
126 public:
127  NetworkAndAddressTestCase ();
128  virtual void DoRun (void);
129  virtual void DoTeardown (void);
130 };
131 
132 NetworkAndAddressTestCase::NetworkAndAddressTestCase ()
133  : TestCase ("Make sure Network and address allocation play together.")
134 {
135 }
136 
137 void
138 NetworkAndAddressTestCase::DoTeardown (void)
139 {
140  Ipv4AddressGenerator::Reset ();
141  Simulator::Destroy ();
142 }
143 
144 void
145 NetworkAndAddressTestCase::DoRun (void)
146 {
147  Ipv4Address address;
148  Ipv4Address network;
149 
150  Ipv4AddressGenerator::Init (Ipv4Address ("3.0.0.0"), Ipv4Mask ("255.0.0.0"),
151  Ipv4Address ("0.0.0.3"));
152  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.0.0.0"));
153  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("3.0.0.3"), "200");
154  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.0.0.0"));
155  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("3.0.0.4"), "201");
156 
157  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.0.0.0"));
158  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("4.0.0.0"), "202");
159  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.0.0.0"));
160  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("4.0.0.5"), "203");
161 
162  Ipv4AddressGenerator::Init (Ipv4Address ("0.3.0.0"),
163  Ipv4Mask ("255.255.0.0"), Ipv4Address ("0.0.0.3"));
164  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.0.0"));
165  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.3.0.3"), "204");
166  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.0.0"));
167  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.3.0.4"), "205");
168 
169  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.0.0"));
170  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.4.0.0"), "206");
171  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.0.0"));
172  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.4.0.5"), "207");
173 
174  Ipv4AddressGenerator::Init (Ipv4Address ("0.0.3.0"),
175  Ipv4Mask ("255.255.255.0"), Ipv4Address ("0.0.0.3"));
176  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
177  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.0.3.3"), "208");
178  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
179  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.0.3.4"), "209");
180 
181  network = Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.255.0"));
182  NS_TEST_EXPECT_MSG_EQ (network, Ipv4Address ("0.0.4.0"), "210");
183  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
184  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("0.0.4.5"), "211");
185 }
186 
187 class ExampleAddressGeneratorTestCase : public TestCase
188 {
189 public:
190  ExampleAddressGeneratorTestCase ();
191 private:
192  virtual void DoRun (void);
193  virtual void DoTeardown (void);
194 };
195 
196 ExampleAddressGeneratorTestCase::ExampleAddressGeneratorTestCase ()
197  : TestCase ("A quick kindof-semi-almost-real example")
198 {
199 }
200 
201 void
202 ExampleAddressGeneratorTestCase::DoTeardown (void)
203 {
204  Ipv4AddressGenerator::Reset ();
205 }
206 
207 void
208 ExampleAddressGeneratorTestCase::DoRun (void)
209 {
210  Ipv4Address address;
211  //
212  // First, initialize our /24 network to 192.168.0.0 and begin
213  // allocating with ip address 0.0.0.3 out of that prefix.
214  //
215  Ipv4AddressGenerator::Init (Ipv4Address ("192.168.0.0"),
216  Ipv4Mask ("255.255.255.0"), Ipv4Address ("0.0.0.3"));
217  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
218  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("192.168.0.3"), "300");
219  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
220  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("192.168.0.4"), "301");
221  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
222  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("192.168.0.5"), "302");
223  //
224  // Allocate the next network out of our /24 network (this should be
225  // 192.168.1.0) and begin allocating with IP address 0.0.0.3 out of that
226  // prefix.
227  //
228  Ipv4AddressGenerator::NextNetwork (Ipv4Mask ("255.255.255.0"));
229  Ipv4AddressGenerator::InitAddress (Ipv4Address ("0.0.0.3"),
230  Ipv4Mask ("255.255.255.0"));
231  //
232  // The first address we should get is the previous numbers ORed together, which
233  // is 192.168.1.3, of course.
234  //
235  address = Ipv4AddressGenerator::NextAddress (Ipv4Mask ("255.255.255.0"));
236  NS_TEST_EXPECT_MSG_EQ (address, Ipv4Address ("192.168.1.3"), "304");
237 }
238 
239 class AddressCollisionTestCase : public TestCase
240 {
241 public:
242  AddressCollisionTestCase ();
243 private:
244  void DoRun (void);
245  void DoTeardown (void);
246 };
247 
248 AddressCollisionTestCase::AddressCollisionTestCase ()
249  : TestCase ("Make sure that the address collision logic works.")
250 {
251 }
252 
253 void
254 AddressCollisionTestCase::DoTeardown (void)
255 {
256  Ipv4AddressGenerator::Reset ();
257  Simulator::Destroy ();
258 }
259 void
260 AddressCollisionTestCase::DoRun (void)
261 {
262  Ipv4AddressGenerator::AddAllocated ("0.0.0.5");
263  Ipv4AddressGenerator::AddAllocated ("0.0.0.10");
264  Ipv4AddressGenerator::AddAllocated ("0.0.0.15");
265  Ipv4AddressGenerator::AddAllocated ("0.0.0.20");
266 
267  Ipv4AddressGenerator::AddAllocated ("0.0.0.4");
268  Ipv4AddressGenerator::AddAllocated ("0.0.0.3");
269  Ipv4AddressGenerator::AddAllocated ("0.0.0.2");
270  Ipv4AddressGenerator::AddAllocated ("0.0.0.1");
271 
272  Ipv4AddressGenerator::AddAllocated ("0.0.0.6");
273  Ipv4AddressGenerator::AddAllocated ("0.0.0.7");
274  Ipv4AddressGenerator::AddAllocated ("0.0.0.8");
275  Ipv4AddressGenerator::AddAllocated ("0.0.0.9");
276 
277  Ipv4AddressGenerator::AddAllocated ("0.0.0.11");
278  Ipv4AddressGenerator::AddAllocated ("0.0.0.12");
279  Ipv4AddressGenerator::AddAllocated ("0.0.0.13");
280  Ipv4AddressGenerator::AddAllocated ("0.0.0.14");
281 
282  Ipv4AddressGenerator::AddAllocated ("0.0.0.19");
283  Ipv4AddressGenerator::AddAllocated ("0.0.0.18");
284  Ipv4AddressGenerator::AddAllocated ("0.0.0.17");
285  Ipv4AddressGenerator::AddAllocated ("0.0.0.16");
286 
287  Ipv4AddressGenerator::TestMode ();
288  bool added = Ipv4AddressGenerator::AddAllocated ("0.0.0.21");
289  NS_TEST_EXPECT_MSG_EQ (added, true, "400");
290 
291  added = Ipv4AddressGenerator::AddAllocated ("0.0.0.4");
292  NS_TEST_EXPECT_MSG_EQ (added, false, "401");
293 
294  added = Ipv4AddressGenerator::AddAllocated ("0.0.0.9");
295  NS_TEST_EXPECT_MSG_EQ (added, false, "402");
296 
297  added = Ipv4AddressGenerator::AddAllocated ("0.0.0.16");
298  NS_TEST_EXPECT_MSG_EQ (added, false, "403");
299 
300  added = Ipv4AddressGenerator::AddAllocated ("0.0.0.21");
301  NS_TEST_EXPECT_MSG_EQ (added, false, "404");
302 }
303 
304 
305 static class Ipv4AddressGeneratorTestSuite : public TestSuite
306 {
307 public:
308  Ipv4AddressGeneratorTestSuite ()
309  : TestSuite ("ipv4-address-generator")
310  {
311  AddTestCase (new NetworkNumberAllocatorTestCase (), TestCase::QUICK);
312  AddTestCase (new AddressAllocatorTestCase (), TestCase::QUICK);
313  AddTestCase (new NetworkAndAddressTestCase (), TestCase::QUICK);
314  AddTestCase (new ExampleAddressGeneratorTestCase (), TestCase::QUICK);
315  AddTestCase (new AddressCollisionTestCase (), TestCase::QUICK);
316  }
317 } g_ipv4AddressGeneratorTestSuite;
ns3::Config::Reset
void Reset(void)
Reset the initial value of every attribute as well as the value of every global to what they were bef...
Definition: config.cc:642
ns3::Ipv4Mask
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:222
ns3::TestSuite
A suite of tests to run.
Definition: test.h:1105
NetworkAndAddressTestCase::DoRun
virtual void DoRun(void)
Implementation to actually run this TestCase.
Definition: ipv4-address-generator-test-suite.cc:145
AddressCollisionTestCase::DoTeardown
void DoTeardown(void)
Implementation to do any local setup required for this TestCase.
Definition: ipv4-address-generator-test-suite.cc:254
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:265
ns3::TestCase
encapsulates test code
Definition: test.h:929
ExampleAddressGeneratorTestCase::DoTeardown
virtual void DoTeardown(void)
Implementation to do any local setup required for this TestCase.
Definition: ipv4-address-generator-test-suite.cc:202
AddressAllocatorTestCase::DoTeardown
virtual void DoTeardown(void)
Implementation to do any local setup required for this TestCase.
Definition: ipv4-address-generator-test-suite.cc:117
NetworkNumberAllocatorTestCase::DoRun
virtual void DoRun(void)
Implementation to actually run this TestCase.
Definition: ipv4-address-generator-test-suite.cc:43
ExampleAddressGeneratorTestCase::DoRun
virtual void DoRun(void)
Implementation to actually run this TestCase.
Definition: ipv4-address-generator-test-suite.cc:208
NetworkAndAddressTestCase::DoTeardown
virtual void DoTeardown(void)
Implementation to do any local setup required for this TestCase.
Definition: ipv4-address-generator-test-suite.cc:138
ns3::TestCase::AddTestCase
void AddTestCase(TestCase *testCase) NS_DEPRECATED
Add an individual child TestCase case to this TestCase.
Definition: test.cc:184
g_ipv4AddressGeneratorTestSuite
Ipv4AddressGeneratorTestSuite g_ipv4AddressGeneratorTestSuite
NetworkNumberAllocatorTestCase::DoTeardown
virtual void DoTeardown(void)
Implementation to do any local setup required for this TestCase.
Definition: ipv4-address-generator-test-suite.cc:38
ns3::Ipv4Address
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
first.address
tuple address
Definition: first.py:37
AddressAllocatorTestCase::DoRun
virtual void DoRun(void)
Implementation to actually run this TestCase.
Definition: ipv4-address-generator-test-suite.cc:90
AddressCollisionTestCase::DoRun
void DoRun(void)
Implementation to actually run this TestCase.
Definition: ipv4-address-generator-test-suite.cc:260