satellite-rle-test.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Jani Puttonen <jani.puttonen@magister.fi>
 */

 
#include "../model/satellite-queue.h"
#include "../model/satellite-return-link-encapsulator.h"
#include "../utils/satellite-env-variables.h"
 
#include "ns3/callback.h"
#include "ns3/log.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"
#include "ns3/random-variable-stream.h"
#include "ns3/singleton.h"
#include "ns3/test.h"
 
#include <vector>
 
using namespace ns3;

class SatRleTestCase : public TestCase
{
  public:
    SatRleTestCase();
    virtual ~SatRleTestCase();

    void Receive(Ptr<Packet> p, Mac48Address source, Mac48Address dest);
 
  private:
    virtual void DoRun(void);

    std::vector<uint32_t> m_sentPacketSizes;

    std::vector<uint32_t> m_rcvdPacketSizes;
};
 
SatRleTestCase::SatRleTestCase()
    : TestCase("Test RLE.")
{
}
 
SatRleTestCase::~SatRleTestCase()
{
}
 
void
SatRleTestCase::DoRun(void)
{
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-rle", "", true);
 
    Mac48Address source = Mac48Address::Allocate();
    Mac48Address dest = Mac48Address::Allocate();
 
    uint8_t rcIndex(0);
    Ptr<SatQueue> queue = CreateObject<SatQueue>(rcIndex);
    Ptr<SatReturnLinkEncapsulator> rle =
        CreateObject<SatReturnLinkEncapsulator>(source, dest, source, dest, rcIndex);
    rle->SetQueue(queue);
 
    // Create a receive callback to Receive method of this class.
    rle->SetReceiveCallback(MakeCallback(&SatRleTestCase::Receive, this));
 
    // Random variable for sent packet sizes and tx opportunities
    Ptr<UniformRandomVariable> unif = CreateObject<UniformRandomVariable>();
 
    // Number of created packets
    uint32_t numPackets(100);
 
    // Create packets and push them to RLE
    for (uint32_t i = 0; i < numPackets; ++i)
    {
        uint32_t packetSize = unif->GetInteger(3, 1500);
        Ptr<Packet> packet = Create<Packet>(packetSize);
        m_sentPacketSizes.push_back(packetSize);
        rle->EnquePdu(packet, dest);
    }

    uint32_t nextMinTxO(0);
    uint32_t bytesLeft(1);
    while (bytesLeft > 0)
    {
        Ptr<Packet> p = rle->NotifyTxOpportunity(unif->GetInteger(3, 1500), bytesLeft, nextMinTxO);
        rle->ReceivePdu(p);
    }

    NS_TEST_ASSERT_MSG_EQ(m_sentPacketSizes.size(),
                          m_rcvdPacketSizes.size(),
                          "All sent packets are not received");
 
    Simulator::Destroy();
 
    SatEnvVariables::GetInstance()->DoDispose();
}
 
void
SatRleTestCase::Receive(Ptr<Packet> p, Mac48Address source, Mac48Address dest)
{
    uint32_t rcvdPacketSize = p->GetSize();
    m_rcvdPacketSizes.push_back(rcvdPacketSize);
    uint32_t numRcvdPackets = m_rcvdPacketSizes.size();

    NS_TEST_ASSERT_MSG_EQ(m_sentPacketSizes[numRcvdPackets - 1],
                          m_rcvdPacketSizes[numRcvdPackets - 1],
                          "Wrong size packet received");
}

class SatRleTraceSuite : public TestSuite
{
  public:
    SatRleTraceSuite();
};
 
SatRleTraceSuite::SatRleTraceSuite()
    : TestSuite("sat-rle-test", Type::UNIT)
{
    AddTestCase(new SatRleTestCase, TestCase::Duration::QUICK);
}
 
// Do allocate an instance of this TestSuite
static SatRleTraceSuite SatRleTestSuite;