satellite-ncr-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: Bastien Tauran <bastien.tauran@viveris.fr>
 */

 
#include "ns3/cbr-application.h"
#include "ns3/cbr-helper.h"
#include "ns3/config.h"
#include "ns3/log.h"
#include "ns3/packet-sink-helper.h"
#include "ns3/packet-sink.h"
#include "ns3/satellite-env-variables.h"
#include "ns3/satellite-gw-mac.h"
#include "ns3/satellite-helper.h"
#include "ns3/satellite-topology.h"
#include "ns3/satellite-ut-mac-state.h"
#include "ns3/satellite-ut-mac.h"
#include "ns3/simulator.h"
#include "ns3/singleton.h"
#include "ns3/string.h"
#include "ns3/test.h"
 
using namespace ns3;

class SatNcrTest1 : public TestCase
{
  public:
    SatNcrTest1();
    virtual ~SatNcrTest1();
 
  private:
    virtual void DoRun(void);
    void GetData(Ptr<CbrApplication> sender, Ptr<PacketSink> receiver);
 
    Ptr<SatHelper> m_helper;
 
    std::vector<int> m_totalSent;
    std::vector<int> m_totalReceived;
    std::vector<SatUtMacState::RcstState_t> m_states;
};
 
// Add some help text to this case to describe what it is intended to test
SatNcrTest1::SatNcrTest1()
    : TestCase("This case tests logon mechanism, and that no data is sent by UT before entering "
               "TDMA_SYNC state.")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
SatNcrTest1::~SatNcrTest1()
{
}
 
//
// SatNcrTest1 TestCase implementation
//
void
SatNcrTest1::DoRun(void)
{
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-ncr", "", true);
 
    // Set 2 RA frames including one for logon
    Config::SetDefault("ns3::SatConf::SuperFrameConfForSeq0",
                       EnumValue(SatSuperframeConf::SUPER_FRAME_CONFIG_0));
    Config::SetDefault("ns3::SatBeamHelper::RandomAccessModel",
                       EnumValue(SatEnums::RA_MODEL_SLOTTED_ALOHA));
    Config::SetDefault("ns3::SatBeamHelper::RaInterferenceModel",
                       EnumValue(SatPhyRxCarrierConf::IF_PER_PACKET));
    Config::SetDefault("ns3::SatBeamHelper::RaCollisionModel",
                       EnumValue(SatPhyRxCarrierConf::RA_COLLISION_CHECK_AGAINST_SINR));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame0_RandomAccessFrame", BooleanValue(true));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_RandomAccessFrame", BooleanValue(true));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_LogonFrame", BooleanValue(true));
 
    Config::SetDefault("ns3::SatSuperframeConf0::Frame0_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame2_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame3_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame4_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame5_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame6_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame7_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame8_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame9_GuardTimeSymbols", UintegerValue(4));
 
    Config::SetDefault("ns3::SatUtMac::WindowInitLogon", TimeValue(Seconds(20)));
    Config::SetDefault("ns3::SatUtMac::MaxWaitingTimeLogonResponse", TimeValue(Seconds(1)));
 
    // Set default values for NCR
    Config::SetDefault("ns3::SatMac::NcrVersion2", BooleanValue(false));
    Config::SetDefault("ns3::SatGwMac::NcrBroadcastPeriod", TimeValue(MilliSeconds(100)));
    Config::SetDefault("ns3::SatGwMac::UseCmt", BooleanValue(true));
    Config::SetDefault("ns3::SatUtMacState::NcrSyncTimeout", TimeValue(Seconds(1)));
    Config::SetDefault("ns3::SatUtMacState::NcrRecoveryTimeout", TimeValue(Seconds(10)));
    Config::SetDefault("ns3::SatNcc::UtTimeout", TimeValue(Seconds(10)));
 
    Config::SetDefault("ns3::SatBeamScheduler::ControlSlotsEnabled", BooleanValue(true));
    Config::SetDefault("ns3::SatBeamScheduler::ControlSlotInterval", TimeValue(MilliSeconds(500)));
 
    Config::SetDefault("ns3::SatUtMac::ClockDrift", IntegerValue(100));
    Config::SetDefault("ns3::SatGwMac::CmtPeriodMin", TimeValue(MilliSeconds(550)));
 
    // Creating the reference system.
    m_helper = CreateObject<SatHelper>(SatEnvVariables::GetInstance()->LocateDataDirectory() +
                                       "/scenarios/geo-33E");
    m_helper->CreatePredefinedScenario(SatHelper::SIMPLE);
 
    NodeContainer gwUsers = Singleton<SatTopology>::Get()->GetGwUserNodes();
 
    // Create the Cbr application to send UDP datagrams of size
    // 512 bytes at a rate of 500 Kb/s (defaults), one packet send (interval 100ms)
    uint16_t port = 9; // Discard port (RFC 863)
    CbrHelper cbr("ns3::UdpSocketFactory",
                  Address(InetSocketAddress(m_helper->GetUserAddress(gwUsers.Get(0)), port)));
    cbr.SetAttribute("Interval", StringValue("100ms"));
    ApplicationContainer utApps = cbr.Install(Singleton<SatTopology>::Get()->GetUtUserNodes());
    utApps.Start(Seconds(1.0));
    utApps.Stop(Seconds(59.0));
 
    // Create a packet sink to receive these packets
    PacketSinkHelper sink(
        "ns3::UdpSocketFactory",
        Address(InetSocketAddress(m_helper->GetUserAddress(gwUsers.Get(0)), port)));
    ApplicationContainer gwApps = sink.Install(gwUsers);
    gwApps.Start(Seconds(1.0));
    gwApps.Stop(Seconds(60.0));
 
    Ptr<PacketSink> receiver = DynamicCast<PacketSink>(gwApps.Get(0));
    Ptr<CbrApplication> sender = DynamicCast<CbrApplication>(utApps.Get(0));
 
    Simulator::Schedule(Seconds(1), &SatNcrTest1::GetData, this, sender, receiver);
 
    Simulator::Stop(Seconds(60));
    Simulator::Run();
 
    Simulator::Destroy();
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    uint32_t indexSwitchTdmaSync = 0;
    for (uint32_t i = 0; i < m_states.size(); i++)
    {
        if (m_states[i] == SatUtMacState::TDMA_SYNC)
        {
            indexSwitchTdmaSync = i;
            break;
        }
    }
 
    // Check if switch to TDMA_SYNC state
    NS_TEST_ASSERT_MSG_NE(indexSwitchTdmaSync,
                          0,
                          "UT should switch to TDMA_SYNC before the end of simulation");
 
    // Check that nothing has been received before logon
    NS_TEST_ASSERT_MSG_NE(m_totalSent[indexSwitchTdmaSync - 1], 0, "Data sent before logon");
    NS_TEST_ASSERT_MSG_EQ(m_totalReceived[indexSwitchTdmaSync - 1],
                          0,
                          "Nothing received before logon");
 
    // Receiver has always received data after logon
    for (uint32_t i = indexSwitchTdmaSync + 1; i < m_totalReceived.size() - 1; i++)
    {
        NS_TEST_ASSERT_MSG_GT(m_totalReceived[i + 1],
                              m_totalReceived[i],
                              "Receiver should always receive data after logon");
    }
 
    // At the end, receiver got all all data sent
    NS_TEST_ASSERT_MSG_EQ(receiver->GetTotalRx(), sender->GetSent(), "Packets were lost !");
}
 
void
SatNcrTest1::GetData(Ptr<CbrApplication> sender, Ptr<PacketSink> receiver)
{
    m_totalSent.push_back(sender->GetSent());
    m_totalReceived.push_back(receiver->GetTotalRx());
    m_states.push_back(
        DynamicCast<SatUtMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetUtNode(0)->GetDevice(2))
                ->GetMac())
            ->GetRcstState());
 
    Simulator::Schedule(Seconds(1), &SatNcrTest1::GetData, this, sender, receiver);
}

class SatNcrTest2 : public TestCase
{
  public:
    SatNcrTest2();
    virtual ~SatNcrTest2();
 
  private:
    virtual void DoRun(void);
    void GetData(Ptr<CbrApplication> sender, Ptr<PacketSink> receiver);
    void ChangeTxStatus(bool enable);
 
    Ptr<SatHelper> m_helper;
 
    std::vector<int> m_totalSent;
    std::vector<int> m_totalReceived;
    std::vector<SatUtMacState::RcstState_t> m_states;
    Ptr<SatChannel> m_channel;
};
 
// Add some help text to this case to describe what it is intended to test
SatNcrTest2::SatNcrTest2()
    : TestCase("This case tests ncr recovery mechanism.")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
SatNcrTest2::~SatNcrTest2()
{
}
 
//
// SatNcrTest2 TestCase implementation
//
void
SatNcrTest2::DoRun(void)
{
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-ncr", "", true);
 
    // Configure a static error probability
    SatPhyRxCarrierConf::ErrorModel em(SatPhyRxCarrierConf::EM_NONE);
    Config::SetDefault("ns3::SatUtHelper::FwdLinkErrorModel", EnumValue(em));
 
    // Set 2 RA frames including one for logon
    Config::SetDefault("ns3::SatConf::SuperFrameConfForSeq0",
                       EnumValue(SatSuperframeConf::SUPER_FRAME_CONFIG_0));
    Config::SetDefault("ns3::SatBeamHelper::RandomAccessModel",
                       EnumValue(SatEnums::RA_MODEL_SLOTTED_ALOHA));
    Config::SetDefault("ns3::SatBeamHelper::RaInterferenceModel",
                       EnumValue(SatPhyRxCarrierConf::IF_PER_PACKET));
    Config::SetDefault("ns3::SatBeamHelper::RaCollisionModel",
                       EnumValue(SatPhyRxCarrierConf::RA_COLLISION_CHECK_AGAINST_SINR));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame0_RandomAccessFrame", BooleanValue(true));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_RandomAccessFrame", BooleanValue(true));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_LogonFrame", BooleanValue(true));
 
    Config::SetDefault("ns3::SatSuperframeConf0::Frame0_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame2_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame3_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame4_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame5_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame6_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame7_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame8_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame9_GuardTimeSymbols", UintegerValue(4));
 
    Config::SetDefault("ns3::SatUtMac::WindowInitLogon", TimeValue(Seconds(20)));
    Config::SetDefault("ns3::SatUtMac::MaxWaitingTimeLogonResponse", TimeValue(Seconds(1)));
 
    // Set default values for NCR
    Config::SetDefault("ns3::SatMac::NcrVersion2", BooleanValue(false));
    Config::SetDefault("ns3::SatGwMac::NcrBroadcastPeriod", TimeValue(MilliSeconds(100)));
    Config::SetDefault("ns3::SatGwMac::UseCmt", BooleanValue(true));
    Config::SetDefault("ns3::SatUtMacState::NcrSyncTimeout", TimeValue(Seconds(1)));
    Config::SetDefault("ns3::SatUtMacState::NcrRecoveryTimeout", TimeValue(Seconds(10)));
    Config::SetDefault("ns3::SatNcc::UtTimeout", TimeValue(Seconds(10)));
 
    Config::SetDefault("ns3::SatBeamScheduler::ControlSlotsEnabled", BooleanValue(true));
    Config::SetDefault("ns3::SatBeamScheduler::ControlSlotInterval", TimeValue(MilliSeconds(500)));
 
    Config::SetDefault("ns3::SatUtMac::ClockDrift", IntegerValue(100));
    Config::SetDefault("ns3::SatGwMac::CmtPeriodMin", TimeValue(MilliSeconds(550)));
 
    // Creating the reference system.
    m_helper = CreateObject<SatHelper>(SatEnvVariables::GetInstance()->LocateDataDirectory() +
                                       "/scenarios/geo-33E");
    m_helper->CreatePredefinedScenario(SatHelper::SIMPLE);
 
    NodeContainer gwUsers = Singleton<SatTopology>::Get()->GetGwUserNodes();
 
    // Create the Cbr application to send UDP datagrams of size
    // 512 bytes at a rate of 500 Kb/s (defaults), one packet send (interval 100ms)
    uint16_t port = 9; // Discard port (RFC 863)
    CbrHelper cbr("ns3::UdpSocketFactory",
                  Address(InetSocketAddress(m_helper->GetUserAddress(gwUsers.Get(0)), port)));
    cbr.SetAttribute("Interval", StringValue("100ms"));
    ApplicationContainer utApps = cbr.Install(Singleton<SatTopology>::Get()->GetUtUserNodes());
    utApps.Start(Seconds(1.0));
    utApps.Stop(Seconds(59.0));
 
    // Create a packet sink to receive these packets
    PacketSinkHelper sink(
        "ns3::UdpSocketFactory",
        Address(InetSocketAddress(m_helper->GetUserAddress(gwUsers.Get(0)), port)));
    ApplicationContainer gwApps = sink.Install(gwUsers);
    gwApps.Start(Seconds(1.0));
    gwApps.Stop(Seconds(60.0));
 
    Ptr<PacketSink> receiver = DynamicCast<PacketSink>(gwApps.Get(0));
    Ptr<CbrApplication> sender = DynamicCast<CbrApplication>(utApps.Get(0));
 
    Simulator::Schedule(Seconds(1), &SatNcrTest2::GetData, this, sender, receiver);
 
    // Schedule GW transmitter switch off and switch on
    Simulator::Schedule(Seconds(30), &SatNcrTest2::ChangeTxStatus, this, false);
    Simulator::Schedule(Seconds(38), &SatNcrTest2::ChangeTxStatus, this, true);
 
    Simulator::Stop(Seconds(60));
    Simulator::Run();
 
    Simulator::Destroy();
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    uint32_t indexSwitchTdmaSync = 0;
    for (uint32_t i = 0; i < m_states.size(); i++)
    {
        if (m_states[i] == SatUtMacState::TDMA_SYNC)
        {
            indexSwitchTdmaSync = i;
            break;
        }
    }
 
    // Check if switch to TDMA_SYNC state
    NS_TEST_ASSERT_MSG_NE(indexSwitchTdmaSync,
                          0,
                          "UT should switch to TDMA_SYNC before the end of simulation");
 
    // State is never OFF_STANDBY nor READY_FOR_LOGON after logon
    for (uint32_t i = indexSwitchTdmaSync; i < m_states.size() - 1; i++)
    {
        NS_TEST_ASSERT_MSG_NE(m_states[i],
                              SatUtMacState::OFF_STANDBY,
                              "UT should not switch to OFF_STANDBY after NCR_RECOVERY");
        NS_TEST_ASSERT_MSG_NE(m_states[i],
                              SatUtMacState::READY_FOR_LOGON,
                              "UT should not switch to READY_FOR_LOGON after NCR_RECOVERY");
    }
 
    // State is NCR RECOVERY between 32s and 38s
    for (uint32_t i = 31; i < 39; i++)
    {
        NS_TEST_ASSERT_MSG_EQ(m_states[i],
                              SatUtMacState::NCR_RECOVERY,
                              "UT should be in NCR_RECOVERY after loss of NCR");
    }
 
    uint32_t receivedBeforeNcrRecovery = m_totalReceived[32];
    // Nothing received between 31s and 38s
    for (uint32_t i = 31; i < 39; i++)
    {
        NS_TEST_ASSERT_MSG_EQ((uint32_t)m_totalReceived[i],
                              receivedBeforeNcrRecovery,
                              "Receiver should not receive anything between 31s and 38s");
    }
 
    // Receiver has always received data after recovering NCR messages
    for (uint32_t i = 39; i < m_totalReceived.size() - 1; i++)
    {
        NS_TEST_ASSERT_MSG_GT(m_totalReceived[i + 1],
                              m_totalReceived[i],
                              "Receiver should always receive data after logon");
    }
 
    // At the end, receiver got all all data sent
    NS_TEST_ASSERT_MSG_EQ(receiver->GetTotalRx(), sender->GetSent(), "Packets were lost !");
}
 
void
SatNcrTest2::GetData(Ptr<CbrApplication> sender, Ptr<PacketSink> receiver)
{
    m_totalSent.push_back(sender->GetSent());
    m_totalReceived.push_back(receiver->GetTotalRx());
    m_states.push_back(
        DynamicCast<SatUtMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetUtNode(0)->GetDevice(2))
                ->GetMac())
            ->GetRcstState());
 
    Simulator::Schedule(Seconds(1), &SatNcrTest2::GetData, this, sender, receiver);
}
 
void
SatNcrTest2::ChangeTxStatus(bool enable)
{
    if (enable)
    {
        DynamicCast<SatGwMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetGwNode(0)->GetDevice(1))
                ->GetMac())
            ->SetAttribute("NcrBroadcastPeriod", TimeValue(MilliSeconds(100)));
    }
    else
    {
        DynamicCast<SatGwMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetGwNode(0)->GetDevice(1))
                ->GetMac())
            ->SetAttribute("NcrBroadcastPeriod", TimeValue(Seconds(9)));
    }
}

class SatNcrTest3 : public TestCase
{
  public:
    SatNcrTest3(SatEnums::RegenerationMode_t regenerationMode);
    virtual ~SatNcrTest3();
 
  private:
    virtual void DoRun(void);
    void GetData(Ptr<CbrApplication> sender, Ptr<PacketSink> receiver);
    void ChangeTxStatus(bool enable);
 
    SatEnums::RegenerationMode_t m_regenerationMode;
 
    Ptr<SatHelper> m_helper;
 
    std::vector<int> m_totalSent;
    std::vector<int> m_totalReceived;
    std::vector<SatUtMacState::RcstState_t> m_states;
    Ptr<SatChannel> m_channel;
};
 
// Add some help text to this case to describe what it is intended to test
SatNcrTest3::SatNcrTest3(SatEnums::RegenerationMode_t regenerationMode)
    : TestCase("This case tests ncr recovery timeout mechanism and logoff.")
{
    m_regenerationMode = regenerationMode;
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
SatNcrTest3::~SatNcrTest3()
{
}
 
//
// SatNcrTest3 TestCase implementation
//
void
SatNcrTest3::DoRun(void)
{
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-ncr", "", true);
 
    // Configure a static error probability
    SatPhyRxCarrierConf::ErrorModel em(SatPhyRxCarrierConf::EM_NONE);
    Config::SetDefault("ns3::SatUtHelper::FwdLinkErrorModel", EnumValue(em));
 
    Config::SetDefault("ns3::SatConf::ReturnLinkRegenerationMode", EnumValue(m_regenerationMode));
 
    // Set 2 RA frames including one for logon
    Config::SetDefault("ns3::SatConf::SuperFrameConfForSeq0",
                       EnumValue(SatSuperframeConf::SUPER_FRAME_CONFIG_0));
    Config::SetDefault("ns3::SatBeamHelper::RandomAccessModel",
                       EnumValue(SatEnums::RA_MODEL_SLOTTED_ALOHA));
    Config::SetDefault("ns3::SatBeamHelper::RaInterferenceModel",
                       EnumValue(SatPhyRxCarrierConf::IF_PER_PACKET));
    Config::SetDefault("ns3::SatBeamHelper::RaCollisionModel",
                       EnumValue(SatPhyRxCarrierConf::RA_COLLISION_CHECK_AGAINST_SINR));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame0_RandomAccessFrame", BooleanValue(true));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_RandomAccessFrame", BooleanValue(true));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_LogonFrame", BooleanValue(true));
 
    Config::SetDefault("ns3::SatSuperframeConf0::Frame0_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame1_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame2_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame3_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame4_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame5_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame6_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame7_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame8_GuardTimeSymbols", UintegerValue(4));
    Config::SetDefault("ns3::SatSuperframeConf0::Frame9_GuardTimeSymbols", UintegerValue(4));
 
    Config::SetDefault("ns3::SatUtMac::WindowInitLogon", TimeValue(Seconds(20)));
    Config::SetDefault("ns3::SatUtMac::MaxWaitingTimeLogonResponse", TimeValue(Seconds(1)));
 
    // Set default values for NCR
    Config::SetDefault("ns3::SatMac::NcrVersion2", BooleanValue(false));
    Config::SetDefault("ns3::SatGwMac::NcrBroadcastPeriod", TimeValue(MilliSeconds(100)));
    Config::SetDefault("ns3::SatGwMac::UseCmt", BooleanValue(true));
    Config::SetDefault("ns3::SatUtMacState::NcrSyncTimeout", TimeValue(Seconds(1)));
    Config::SetDefault("ns3::SatUtMacState::NcrRecoveryTimeout", TimeValue(Seconds(10)));
    Config::SetDefault("ns3::SatNcc::UtTimeout", TimeValue(Seconds(10)));
 
    Config::SetDefault("ns3::SatBeamScheduler::ControlSlotsEnabled", BooleanValue(true));
    Config::SetDefault("ns3::SatBeamScheduler::ControlSlotInterval", TimeValue(MilliSeconds(500)));
 
    Config::SetDefault("ns3::SatUtMac::ClockDrift", IntegerValue(100));
    Config::SetDefault("ns3::SatGwMac::CmtPeriodMin", TimeValue(MilliSeconds(550)));
 
    // Creating the reference system.
    m_helper = CreateObject<SatHelper>(SatEnvVariables::GetInstance()->LocateDataDirectory() +
                                       "/scenarios/geo-33E");
    m_helper->CreatePredefinedScenario(SatHelper::SIMPLE);
 
    NodeContainer gwUsers = Singleton<SatTopology>::Get()->GetGwUserNodes();
 
    // Create the Cbr application to send UDP datagrams of size
    // 512 bytes at a rate of 500 Kb/s (defaults), one packet send (interval 100ms)
    uint16_t port = 9; // Discard port (RFC 863)
    CbrHelper cbr("ns3::UdpSocketFactory",
                  Address(InetSocketAddress(m_helper->GetUserAddress(gwUsers.Get(0)), port)));
    cbr.SetAttribute("Interval", StringValue("100ms"));
    ApplicationContainer utApps = cbr.Install(Singleton<SatTopology>::Get()->GetUtUserNodes());
    utApps.Start(Seconds(1.0));
    utApps.Stop(Seconds(119.0));
 
    // Create a packet sink to receive these packets
    PacketSinkHelper sink(
        "ns3::UdpSocketFactory",
        Address(InetSocketAddress(m_helper->GetUserAddress(gwUsers.Get(0)), port)));
    ApplicationContainer gwApps = sink.Install(gwUsers);
    gwApps.Start(Seconds(1.0));
    gwApps.Stop(Seconds(120.0));
 
    Ptr<PacketSink> receiver = DynamicCast<PacketSink>(gwApps.Get(0));
    Ptr<CbrApplication> sender = DynamicCast<CbrApplication>(utApps.Get(0));
 
    Simulator::Schedule(Seconds(1), &SatNcrTest3::GetData, this, sender, receiver);
 
    // Schedule GW transmitter switch off and switch on
    Simulator::Schedule(Seconds(30), &SatNcrTest3::ChangeTxStatus, this, false);
    Simulator::Schedule(Seconds(55), &SatNcrTest3::ChangeTxStatus, this, true);
 
    Simulator::Stop(Seconds(120));
    Simulator::Run();
 
    Simulator::Destroy();
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    uint32_t indexSwitchTdmaSync = 0;
    uint32_t indexSwitchNcrRecovery = 0;
    uint32_t indexSwitchTdmaSyncSecondTime = 0;
    for (uint32_t i = 0; i < m_states.size(); i++)
    {
        if (m_states[i] == SatUtMacState::TDMA_SYNC && indexSwitchTdmaSync == 0)
        {
            indexSwitchTdmaSync = i;
        }
        if (m_states[i] == SatUtMacState::NCR_RECOVERY && indexSwitchNcrRecovery == 0)
        {
            indexSwitchNcrRecovery = i;
        }
        if (indexSwitchTdmaSync & indexSwitchNcrRecovery)
        {
            break;
        }
    }
 
    for (uint32_t i = indexSwitchNcrRecovery; i < m_states.size(); i++)
    {
        if (m_states[i] == SatUtMacState::TDMA_SYNC)
        {
            indexSwitchTdmaSyncSecondTime = i;
            break;
        }
    }
 
    // Check if transitions exist
    NS_TEST_ASSERT_MSG_NE(indexSwitchTdmaSync,
                          0,
                          "UT should switch to TDMA_SYNC before the end of simulation");
    NS_TEST_ASSERT_MSG_NE(indexSwitchNcrRecovery,
                          0,
                          "UT should switch to NCR_RECOVERY before the end of simulation");
    NS_TEST_ASSERT_MSG_NE(
        indexSwitchTdmaSyncSecondTime,
        0,
        "UT should switch to TDMA_SYNC after NCR_RECOVERY and before the end of simulation");
 
    // State is NCR RECOVERY between 32s and 40s
    for (uint32_t i = 31; i < 41; i++)
    {
        NS_TEST_ASSERT_MSG_EQ(m_states[i],
                              SatUtMacState::NCR_RECOVERY,
                              "UT should be in NCR_RECOVERY after loss of NCR");
    }
 
    // State is READY_FOR_LOGON after timeout logon
    bool stateFound = false;
    for (uint32_t i = indexSwitchNcrRecovery; i < m_states.size() - 1; i++)
    {
        if (m_states[i] == SatUtMacState::OFF_STANDBY ||
            m_states[i] == SatUtMacState::READY_FOR_LOGON)
        {
            stateFound = true;
        }
    }
    NS_TEST_ASSERT_MSG_EQ(stateFound,
                          true,
                          "UT should switch to OFF_STANDBY or READY_FOR_LOGON after NCR_RECOVERY");
 
    uint32_t receivedBeforeNcrRecovery = m_totalReceived[indexSwitchNcrRecovery + 1];
    // Nothing received between 31s and 55s (no NCR control message)
    for (uint32_t i = 31; i < 56; i++)
    {
        NS_TEST_ASSERT_MSG_EQ((uint32_t)m_totalReceived[i],
                              receivedBeforeNcrRecovery,
                              "Receiver should not receive anything between 31s and 50s");
    }
 
    // Receiver has always received data after recovering NCR messages
    for (uint32_t i = indexSwitchTdmaSyncSecondTime + 2; i < m_totalReceived.size() - 1; i++)
    {
        NS_TEST_ASSERT_MSG_GT(m_totalReceived[i + 1],
                              m_totalReceived[i],
                              "Receiver should always receive data after second logon");
    }
 
    // At the end, receiver got all all data sent
    NS_TEST_ASSERT_MSG_EQ(receiver->GetTotalRx(), sender->GetSent(), "Packets were lost !");
}
 
void
SatNcrTest3::GetData(Ptr<CbrApplication> sender, Ptr<PacketSink> receiver)
{
    m_totalSent.push_back(sender->GetSent());
    m_totalReceived.push_back(receiver->GetTotalRx());
    m_states.push_back(
        DynamicCast<SatUtMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetUtNode(0)->GetDevice(2))
                ->GetMac())
            ->GetRcstState());
 
    Simulator::Schedule(Seconds(1), &SatNcrTest3::GetData, this, sender, receiver);
}
 
void
SatNcrTest3::ChangeTxStatus(bool enable)
{
    if (enable)
    {
        DynamicCast<SatGwMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetGwNode(0)->GetDevice(1))
                ->GetMac())
            ->SetAttribute("NcrBroadcastPeriod", TimeValue(MilliSeconds(100)));
    }
    else
    {
        DynamicCast<SatGwMac>(
            DynamicCast<SatNetDevice>(Singleton<SatTopology>::Get()->GetGwNode(0)->GetDevice(1))
                ->GetMac())
            ->SetAttribute("NcrBroadcastPeriod", TimeValue(Seconds(30)));
    }
}
 
// The TestSuite class names the TestSuite as sat-ncr-test, identifies what type of TestSuite
// (Type::SYSTEM), and enables the TestCases to be run.  Typically, only the constructor for this
// class must be defined
//
class SatNcrTestSuite : public TestSuite
{
  public:
    SatNcrTestSuite();
};
 
SatNcrTestSuite::SatNcrTestSuite()
    : TestSuite("sat-ncr-test", Type::SYSTEM)
{
    AddTestCase(new SatNcrTest1, TestCase::Duration::QUICK);
    AddTestCase(new SatNcrTest2, TestCase::Duration::QUICK);
    AddTestCase(new SatNcrTest3(SatEnums::TRANSPARENT), TestCase::Duration::QUICK);
    AddTestCase(new SatNcrTest3(SatEnums::REGENERATION_PHY), TestCase::Duration::QUICK);
    AddTestCase(new SatNcrTest3(SatEnums::REGENERATION_LINK), TestCase::Duration::QUICK);
    AddTestCase(new SatNcrTest3(SatEnums::REGENERATION_NETWORK), TestCase::Duration::QUICK);
}
 
// Allocate an instance of this TestSuite
static SatNcrTestSuite satNcrTestSuite;