satellite-control-msg-container-test.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 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: Sami Rantanen <sami.rantanen@magister.fi>
 */

 
// Include a header file from your module to test.
#include "../model/satellite-control-message.h"
#include "../utils/satellite-env-variables.h"
 
#include "ns3/boolean.h"
#include "ns3/config.h"
#include "ns3/log.h"
#include "ns3/simulator.h"
#include "ns3/singleton.h"
#include "ns3/string.h"
#include "ns3/test.h"
#include "ns3/timer.h"
 
using namespace ns3;
 
class SatCtrlMsgContBaseTestCase : public TestCase
{
  public:
    SatCtrlMsgContBaseTestCase()
        : TestCase("")
    {
    }
 
    SatCtrlMsgContBaseTestCase(std::string info)
        : TestCase(info)
    {
    }
 
    virtual ~SatCtrlMsgContBaseTestCase()
    {
    }
 
    // add message to container
    void AddMessage(Ptr<SatControlMessage> msg);
 
    // get message.
    void GetMessage(uint32_t msgId);
 
  protected:
    virtual void DoRun(void) = 0;
    Ptr<SatControlMsgContainer> m_container;
    std::vector<Ptr<SatControlMessage>> m_msgsRead;
 
  private:
    std::vector<uint32_t> m_recvIds;
};
 
void
SatCtrlMsgContBaseTestCase::AddMessage(Ptr<SatControlMessage> msg)
{
    uint32_t sendId = m_container->ReserveIdAndStore(msg);
    uint32_t recvId = m_container->Send(sendId);
 
    m_recvIds.push_back(recvId);
}
 
void
SatCtrlMsgContBaseTestCase::GetMessage(uint32_t msgId)
{
    m_msgsRead.push_back(m_container->Read(msgId));
}

class SatCtrlMsgContDelOnTestCase : public SatCtrlMsgContBaseTestCase
{
  public:
    SatCtrlMsgContDelOnTestCase()
        : SatCtrlMsgContBaseTestCase(
              "Test satellite control message container with flag deletedOnRead set.")
    {
    }
 
    virtual ~SatCtrlMsgContDelOnTestCase()
    {
    }
 
  protected:
    virtual void DoRun(void);
};
 
void
SatCtrlMsgContDelOnTestCase::DoRun(void)
{
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-ctrl-msg-container-unit",
                                                       "delon",
                                                       true);
 
    // create container with store time 100 ms and flag deletedOnRead set
    m_container = Create<SatControlMsgContainer>(Seconds(0.10), true);
    Ptr<SatControlMessage> crMsg = CreateObject<SatCrMessage>();
    Ptr<SatControlMessage> tbtpMsg = CreateObject<SatTbtpMessage>();
 
    // simulate message additions
    Simulator::Schedule(Seconds(0.09),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        crMsg); // id 0
    Simulator::Schedule(Seconds(0.20),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        tbtpMsg); // id 1
    Simulator::Schedule(Seconds(0.31),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        tbtpMsg); // id 2
    Simulator::Schedule(Seconds(0.40),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        crMsg); // id 3
 
    // simulate get operations
    Simulator::Schedule(Seconds(0.10),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        0); // crMsg expected
    Simulator::Schedule(Seconds(0.21),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        1); // tbtpMsg expected
    Simulator::Schedule(Seconds(0.35),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        2); // tbtpMsg expected
    Simulator::Schedule(Seconds(0.43),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        3); // crMsg expected
 
    Simulator::Run();
 
    // After simulation check that messages are what expected
 
    // ref messages created successfully
    NS_TEST_ASSERT_MSG_EQ((crMsg == nullptr), false, "CR message creation failed");
    NS_TEST_ASSERT_MSG_EQ((tbtpMsg == nullptr), false, "TBTP message failed");
 
    // container content correct at points messages got
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[0] == crMsg), true, "first message incorrect");
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[1] == tbtpMsg), true, "second message incorrect");
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[2] == tbtpMsg), true, "third message incorrect");
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[3] == crMsg), true, "fourth message incorrect");
 
    Simulator::Destroy();
 
    SatEnvVariables::GetInstance()->DoDispose();
}

class SatCtrlMsgContDelOffTestCase : public SatCtrlMsgContBaseTestCase
{
  public:
    SatCtrlMsgContDelOffTestCase()
        : SatCtrlMsgContBaseTestCase(
              "Test satellite control message container with flag deletedOnRead NOT set.")
    {
    }
 
    virtual ~SatCtrlMsgContDelOffTestCase()
    {
    }
 
  protected:
    virtual void DoRun(void);
};
 
void
SatCtrlMsgContDelOffTestCase::DoRun(void)
{
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-ctrl-msg-container-unit",
                                                       "deloff",
                                                       true);
 
    // create container with store time 100 ms and flag deletedOnRead NOT set
    m_container = Create<SatControlMsgContainer>(Seconds(0.10), false);
    Ptr<SatControlMessage> crMsg = CreateObject<SatCrMessage>();
    Ptr<SatControlMessage> tbtpMsg = CreateObject<SatTbtpMessage>();
 
    // simulate message additions
    Simulator::Schedule(Seconds(0.09),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        crMsg); // id 0
    Simulator::Schedule(Seconds(0.20),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        tbtpMsg); // id 1
    Simulator::Schedule(Seconds(0.31),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        tbtpMsg); // id 2
    Simulator::Schedule(Seconds(0.40),
                        &SatCtrlMsgContDelOnTestCase::AddMessage,
                        this,
                        crMsg); // id 3
 
    // simulate get operations
    Simulator::Schedule(Seconds(0.10),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        0); // crMsg expected
    Simulator::Schedule(Seconds(0.21),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        1); // tbtpMsg expected
    Simulator::Schedule(Seconds(0.40),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        2); // tbtpMsg expected
    Simulator::Schedule(Seconds(0.49),
                        &SatCtrlMsgContDelOnTestCase::GetMessage,
                        this,
                        3); // crMsg expected
 
    Simulator::Run();
 
    // After simulation check that messages are what expected
 
    // ref messages created successfully
    NS_TEST_ASSERT_MSG_EQ((crMsg == nullptr), false, "CR message creation failed");
    NS_TEST_ASSERT_MSG_EQ((tbtpMsg == nullptr), false, "TBTP message failed");
 
    // container content correct at points messages got
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[0] == crMsg), true, "first message incorrect");
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[1] == tbtpMsg), true, "second message incorrect");
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[2] == tbtpMsg), true, "third message incorrect");
    NS_TEST_ASSERT_MSG_EQ((m_msgsRead[3] == crMsg), true, "fourth message incorrect");
 
    Simulator::Destroy();
 
    SatEnvVariables::GetInstance()->DoDispose();
}

class SatCtrlMsgContainerTestSuite : public TestSuite
{
  public:
    SatCtrlMsgContainerTestSuite();
};
 
SatCtrlMsgContainerTestSuite::SatCtrlMsgContainerTestSuite()
    : TestSuite("sat-ctrl-msg-container-unit-test", Type::UNIT)
{
    AddTestCase(new SatCtrlMsgContDelOnTestCase, TestCase::Duration::QUICK);
    AddTestCase(new SatCtrlMsgContDelOffTestCase, TestCase::Duration::QUICK);
}
 
// Do allocate an instance of this TestSuite
static SatCtrlMsgContainerTestSuite satCtrlMsgContUnit;