d6/d3c/ipv4-address-generator-test-suite_8cc_source.html

/*

 * Copyright (c) 2008 University of Washington

 *

 * SPDX-License-Identifier: GPL-2.0-only

 */


#include "ns3/ipv4-address-generator.h"

#include "ns3/simulation-singleton.h"

#include "ns3/test.h"


using namespace ns3;


/**

 * \ingroup internet-test

 *

 * \brief IPv4 network number Test

 */


class NetworkNumberAllocatorTestCase : public TestCase

{

  public:

    NetworkNumberAllocatorTestCase();

    void DoRun() override;

    void DoTeardown() override;

};


NetworkNumberAllocatorTestCase::NetworkNumberAllocatorTestCase()

    : TestCase("Make sure the network number allocator is working on some of network prefixes.")

{

}


void


NetworkNumberAllocatorTestCase::DoTeardown()

{

    Ipv4AddressGenerator::Reset();

}


void


NetworkNumberAllocatorTestCase::DoRun()

{

    Ipv4Address network;

    Ipv4AddressGenerator::Init(Ipv4Address("1.0.0.0"),

                               Ipv4Mask("255.0.0.0"),

                               Ipv4Address("0.0.0.0"));

    network = Ipv4AddressGenerator::GetNetwork(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("1.0.0.0"), "001");

    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("2.0.0.0"), "001");


    Ipv4AddressGenerator::Init(Ipv4Address("0.1.0.0"),

                               Ipv4Mask("255.255.0.0"),

                               Ipv4Address("0.0.0.0"));

    network = Ipv4AddressGenerator::GetNetwork(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.1.0.0"), "003");

    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.2.0.0"), "004");


    Ipv4AddressGenerator::Init(Ipv4Address("0.0.1.0"),

                               Ipv4Mask("255.255.255.0"),

                               Ipv4Address("0.0.0.0"));

    network = Ipv4AddressGenerator::GetNetwork(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.0.1.0"), "005");

    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.0.2.0"), "006");


    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("3.0.0.0"), "007");

    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.3.0.0"), "008");

    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.0.3.0"), "009");

}


/**

 * \ingroup internet-test

 *

 * \brief IPv4 address allocator Test

 */


class AddressAllocatorTestCase : public TestCase

{

  public:

    AddressAllocatorTestCase();


  private:

    void DoRun() override;

    void DoTeardown() override;

};


AddressAllocatorTestCase::AddressAllocatorTestCase()

    : TestCase("Sanity check on allocation of addresses")

{

}


void


AddressAllocatorTestCase::DoRun()

{

    Ipv4Address address;


    Ipv4AddressGenerator::Init(Ipv4Address("1.0.0.0"),

                               Ipv4Mask("255.0.0.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("1.0.0.3"), "100");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("1.0.0.4"), "101");


    Ipv4AddressGenerator::Init(Ipv4Address("0.1.0.0"),

                               Ipv4Mask("255.255.0.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.1.0.3"), "102");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.1.0.4"), "103");


    Ipv4AddressGenerator::Init(Ipv4Address("0.0.1.0"),

                               Ipv4Mask("255.255.255.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.0.1.3"), "104");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.0.1.4"), "105");

}


void


AddressAllocatorTestCase::DoTeardown()

{

    Ipv4AddressGenerator::Reset();

    Simulator::Destroy();

}


/**

 * \ingroup internet-test

 *

 * \brief IPv4 network and address allocator Test

 */


class NetworkAndAddressTestCase : public TestCase

{

  public:

    NetworkAndAddressTestCase();

    void DoRun() override;

    void DoTeardown() override;

};


NetworkAndAddressTestCase::NetworkAndAddressTestCase()

    : TestCase("Make sure Network and address allocation play together.")

{

}


void


NetworkAndAddressTestCase::DoTeardown()

{

    Ipv4AddressGenerator::Reset();

    Simulator::Destroy();

}


void


NetworkAndAddressTestCase::DoRun()

{

    Ipv4Address address;

    Ipv4Address network;


    Ipv4AddressGenerator::Init(Ipv4Address("3.0.0.0"),

                               Ipv4Mask("255.0.0.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("3.0.0.3"), "200");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("3.0.0.4"), "201");


    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("4.0.0.0"), "202");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.0.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("4.0.0.5"), "203");


    Ipv4AddressGenerator::Init(Ipv4Address("0.3.0.0"),

                               Ipv4Mask("255.255.0.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.3.0.3"), "204");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.3.0.4"), "205");


    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.4.0.0"), "206");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.0.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.4.0.5"), "207");


    Ipv4AddressGenerator::Init(Ipv4Address("0.0.3.0"),

                               Ipv4Mask("255.255.255.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.0.3.3"), "208");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.0.3.4"), "209");


    network = Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(network, Ipv4Address("0.0.4.0"), "210");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("0.0.4.5"), "211");

}


/**

 * \ingroup internet-test

 *

 * \brief IPv4 AddressGenerator example (sort of) Test

 */


class ExampleAddressGeneratorTestCase : public TestCase

{

  public:

    ExampleAddressGeneratorTestCase();


  private:

    void DoRun() override;

    void DoTeardown() override;

};


ExampleAddressGeneratorTestCase::ExampleAddressGeneratorTestCase()

    : TestCase("A quick kindof-semi-almost-real example")

{

}


void


ExampleAddressGeneratorTestCase::DoTeardown()

{

    Ipv4AddressGenerator::Reset();

}


void


ExampleAddressGeneratorTestCase::DoRun()

{

    Ipv4Address address;

    //

    // First, initialize our /24 network to 192.168.0.0 and begin

    // allocating with ip address 0.0.0.3 out of that prefix.

    //

    Ipv4AddressGenerator::Init(Ipv4Address("192.168.0.0"),

                               Ipv4Mask("255.255.255.0"),

                               Ipv4Address("0.0.0.3"));

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("192.168.0.3"), "300");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("192.168.0.4"), "301");

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("192.168.0.5"), "302");

    //

    // Allocate the next network out of our /24 network (this should be

    // 192.168.1.0) and begin allocating with IP address 0.0.0.3 out of that

    // prefix.

    //

    Ipv4AddressGenerator::NextNetwork(Ipv4Mask("255.255.255.0"));

    Ipv4AddressGenerator::InitAddress(Ipv4Address("0.0.0.3"), Ipv4Mask("255.255.255.0"));

    //

    // The first address we should get is the previous numbers ORed together, which

    // is 192.168.1.3, of course.

    //

    address = Ipv4AddressGenerator::NextAddress(Ipv4Mask("255.255.255.0"));

    NS_TEST_EXPECT_MSG_EQ(address, Ipv4Address("192.168.1.3"), "304");

}


/**

 * \ingroup internet-test

 *

 * \brief IPv4 address collision Test

 */


class AddressCollisionTestCase : public TestCase

{

  public:

    AddressCollisionTestCase();


  private:

    void DoRun() override;

    void DoTeardown() override;

};


AddressCollisionTestCase::AddressCollisionTestCase()

    : TestCase("Make sure that the address collision logic works.")

{

}


void


AddressCollisionTestCase::DoTeardown()

{

    Ipv4AddressGenerator::Reset();

    Simulator::Destroy();

}


void


AddressCollisionTestCase::DoRun()

{

    Ipv4AddressGenerator::AddAllocated("0.0.0.5");

    Ipv4AddressGenerator::AddAllocated("0.0.0.10");

    Ipv4AddressGenerator::AddAllocated("0.0.0.15");

    Ipv4AddressGenerator::AddAllocated("0.0.0.20");


    Ipv4AddressGenerator::AddAllocated("0.0.0.4");

    Ipv4AddressGenerator::AddAllocated("0.0.0.3");

    Ipv4AddressGenerator::AddAllocated("0.0.0.2");

    Ipv4AddressGenerator::AddAllocated("0.0.0.1");


    Ipv4AddressGenerator::AddAllocated("0.0.0.6");

    Ipv4AddressGenerator::AddAllocated("0.0.0.7");

    Ipv4AddressGenerator::AddAllocated("0.0.0.8");

    Ipv4AddressGenerator::AddAllocated("0.0.0.9");


    Ipv4AddressGenerator::AddAllocated("0.0.0.11");

    Ipv4AddressGenerator::AddAllocated("0.0.0.12");

    Ipv4AddressGenerator::AddAllocated("0.0.0.13");

    Ipv4AddressGenerator::AddAllocated("0.0.0.14");


    Ipv4AddressGenerator::AddAllocated("0.0.0.19");

    Ipv4AddressGenerator::AddAllocated("0.0.0.18");

    Ipv4AddressGenerator::AddAllocated("0.0.0.17");

    Ipv4AddressGenerator::AddAllocated("0.0.0.16");


    Ipv4AddressGenerator::TestMode();

    bool allocated = Ipv4AddressGenerator::IsAddressAllocated("0.0.0.21");

    NS_TEST_EXPECT_MSG_EQ(allocated, false, "0.0.0.21 should not be already allocated");

    bool added = Ipv4AddressGenerator::AddAllocated("0.0.0.21");

    NS_TEST_EXPECT_MSG_EQ(added, true, "400");


    allocated = Ipv4AddressGenerator::IsAddressAllocated("0.0.0.4");

    NS_TEST_EXPECT_MSG_EQ(allocated, true, "0.0.0.4 should be already allocated");

    added = Ipv4AddressGenerator::AddAllocated("0.0.0.4");

    NS_TEST_EXPECT_MSG_EQ(added, false, "401");


    allocated = Ipv4AddressGenerator::IsAddressAllocated("0.0.0.9");

    NS_TEST_EXPECT_MSG_EQ(allocated, true, "0.0.0.9 should be already allocated");

    added = Ipv4AddressGenerator::AddAllocated("0.0.0.9");

    NS_TEST_EXPECT_MSG_EQ(added, false, "402");


    allocated = Ipv4AddressGenerator::IsAddressAllocated("0.0.0.16");

    NS_TEST_EXPECT_MSG_EQ(allocated, true, "0.0.0.16 should be already allocated");

    added = Ipv4AddressGenerator::AddAllocated("0.0.0.16");

    NS_TEST_EXPECT_MSG_EQ(added, false, "403");


    allocated = Ipv4AddressGenerator::IsAddressAllocated("0.0.0.21");

    NS_TEST_EXPECT_MSG_EQ(allocated, true, "0.0.0.21 should be already allocated");

    added = Ipv4AddressGenerator::AddAllocated("0.0.0.21");

    NS_TEST_EXPECT_MSG_EQ(added, false, "404");

}


/**

 * \ingroup internet-test

 *

 * \brief IPv4 Address Generator TestSuite

 */


class Ipv4AddressGeneratorTestSuite : public TestSuite

{

  public:

    Ipv4AddressGeneratorTestSuite();


  private:

};


Ipv4AddressGeneratorTestSuite::Ipv4AddressGeneratorTestSuite()

    : TestSuite("ipv4-address-generator", Type::UNIT)

{

    AddTestCase(new NetworkNumberAllocatorTestCase(), TestCase::Duration::QUICK);

    AddTestCase(new AddressAllocatorTestCase(), TestCase::Duration::QUICK);

    AddTestCase(new NetworkAndAddressTestCase(), TestCase::Duration::QUICK);

    AddTestCase(new ExampleAddressGeneratorTestCase(), TestCase::Duration::QUICK);

    AddTestCase(new AddressCollisionTestCase(), TestCase::Duration::QUICK);

}


static Ipv4AddressGeneratorTestSuite

    g_ipv4AddressGeneratorTestSuite; //!< Static variable for test initialization

AddressAllocatorTestCase
IPv4 address allocator Test.
Definition ipv4-address-generator-test-suite.cc:79

AddressAllocatorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv4-address-generator-test-suite.cc:124

AddressAllocatorTestCase::AddressAllocatorTestCase
AddressAllocatorTestCase()
Definition ipv4-address-generator-test-suite.cc:88

AddressAllocatorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv4-address-generator-test-suite.cc:94

AddressCollisionTestCase
IPv4 address collision Test.
Definition ipv4-address-generator-test-suite.cc:265

AddressCollisionTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv4-address-generator-test-suite.cc:280

AddressCollisionTestCase::AddressCollisionTestCase
AddressCollisionTestCase()
Definition ipv4-address-generator-test-suite.cc:274

AddressCollisionTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv4-address-generator-test-suite.cc:287

ExampleAddressGeneratorTestCase
IPv4 AddressGenerator example (sort of) Test.
Definition ipv4-address-generator-test-suite.cc:207

ExampleAddressGeneratorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv4-address-generator-test-suite.cc:228

ExampleAddressGeneratorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv4-address-generator-test-suite.cc:222

ExampleAddressGeneratorTestCase::ExampleAddressGeneratorTestCase
ExampleAddressGeneratorTestCase()
Definition ipv4-address-generator-test-suite.cc:216

Ipv4AddressGeneratorTestSuite
IPv4 Address Generator TestSuite.
Definition ipv4-address-generator-test-suite.cc:347

Ipv4AddressGeneratorTestSuite::Ipv4AddressGeneratorTestSuite
Ipv4AddressGeneratorTestSuite()
Definition ipv4-address-generator-test-suite.cc:354

NetworkAndAddressTestCase
IPv4 network and address allocator Test.
Definition ipv4-address-generator-test-suite.cc:136

NetworkAndAddressTestCase::NetworkAndAddressTestCase
NetworkAndAddressTestCase()
Definition ipv4-address-generator-test-suite.cc:143

NetworkAndAddressTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv4-address-generator-test-suite.cc:156

NetworkAndAddressTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv4-address-generator-test-suite.cc:149

NetworkNumberAllocatorTestCase
IPv4 network number Test.
Definition ipv4-address-generator-test-suite.cc:19

NetworkNumberAllocatorTestCase::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition ipv4-address-generator-test-suite.cc:38

NetworkNumberAllocatorTestCase::NetworkNumberAllocatorTestCase
NetworkNumberAllocatorTestCase()
Definition ipv4-address-generator-test-suite.cc:26

NetworkNumberAllocatorTestCase::DoTeardown
void DoTeardown() override
Implementation to do any local setup required for this TestCase.
Definition ipv4-address-generator-test-suite.cc:32

ns3::Ipv4AddressGenerator::NextAddress
static Ipv4Address NextAddress(const Ipv4Mask mask)
Allocate the next Ipv4Address for the configured network and mask.
Definition ipv4-address-generator.cc:574

ns3::Ipv4AddressGenerator::InitAddress
static void InitAddress(const Ipv4Address addr, const Ipv4Mask mask)
Set the address for the given mask.
Definition ipv4-address-generator.cc:558

ns3::Ipv4AddressGenerator::TestMode
static void TestMode()
Used to turn off fatal errors and assertions, for testing.
Definition ipv4-address-generator.cc:614

ns3::Ipv4AddressGenerator::NextNetwork
static Ipv4Address NextNetwork(const Ipv4Mask mask)
Get the next network according to the given Ipv4Mask.
Definition ipv4-address-generator.cc:542

ns3::Ipv4AddressGenerator::Reset
static void Reset()
Reset the networks and Ipv4Address to zero.
Definition ipv4-address-generator.cc:582

ns3::Ipv4AddressGenerator::AddAllocated
static bool AddAllocated(const Ipv4Address addr)
Add the Ipv4Address to the list of IPv4 entries.
Definition ipv4-address-generator.cc:590

ns3::Ipv4AddressGenerator::IsAddressAllocated
static bool IsAddressAllocated(const Ipv4Address addr)
Check the Ipv4Address allocation in the list of IPv4 entries.
Definition ipv4-address-generator.cc:598

ns3::Ipv4AddressGenerator::GetNetwork
static Ipv4Address GetNetwork(const Ipv4Mask mask)
Get the current network of the given Ipv4Mask.
Definition ipv4-address-generator.cc:550

ns3::Ipv4AddressGenerator::Init
static void Init(const Ipv4Address net, const Ipv4Mask mask, const Ipv4Address addr="0.0.0.1")
Initialise the base network, mask and address for the generator.
Definition ipv4-address-generator.cc:534

ns3::Ipv4Address
Ipv4 addresses are stored in host order in this class.
Definition ipv4-address.h:31

ns3::Ipv4Mask
a class to represent an Ipv4 address mask
Definition ipv4-address.h:246

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

ns3::TestSuite::Type
Type
Type of test.
Definition test.h:1274

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_ipv4AddressGeneratorTestSuite
static Ipv4AddressGeneratorTestSuite g_ipv4AddressGeneratorTestSuite
Static variable for test initialization.
Definition ipv4-address-generator-test-suite.cc:365

ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.