watchdog-test-suite.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2007 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#include "ns3/test.h"
#include "ns3/watchdog.h"
 
/**
 * \file
 * \ingroup core-tests
 * \ingroup timer
 * \ingroup timer-tests
 * Watchdog test suite.
 */
 
namespace ns3
{
 
namespace tests
{
 
/**
 * \ingroup timer-tests
 *  Watchdog test
 */
class WatchdogTestCase : public TestCase
{
  public:
    /** Constructor. */
    WatchdogTestCase();
    void DoRun() override;
    /**
     * Function to invoke when Watchdog expires.
     * \param arg The argument passed.
     */
    void Expire(int arg);
    bool m_expired;        //!< Flag for expired Watchdog
    Time m_expiredTime;    //!< Time when Watchdog expired
    int m_expiredArgument; //!< Argument supplied to expired Watchdog
};
 
WatchdogTestCase::WatchdogTestCase()
    : TestCase("Check that we can keepalive a watchdog")
{
}
 
void
WatchdogTestCase::Expire(int arg)
{
    m_expired = true;
    m_expiredTime = Simulator::Now();
    m_expiredArgument = arg;
}
 
void
WatchdogTestCase::DoRun()
{
    m_expired = false;
    m_expiredArgument = 0;
    m_expiredTime = Seconds(0);
 
    Watchdog watchdog;
    watchdog.SetFunction(&WatchdogTestCase::Expire, this);
    watchdog.SetArguments(1);
    watchdog.Ping(MicroSeconds(10));
    Simulator::Schedule(MicroSeconds(5), &Watchdog::Ping, &watchdog, MicroSeconds(20));
    Simulator::Schedule(MicroSeconds(20), &Watchdog::Ping, &watchdog, MicroSeconds(2));
    Simulator::Schedule(MicroSeconds(23), &Watchdog::Ping, &watchdog, MicroSeconds(17));
    Simulator::Run();
    Simulator::Destroy();
    NS_TEST_ASSERT_MSG_EQ(m_expired, true, "The timer did not expire ??");
    NS_TEST_ASSERT_MSG_EQ(m_expiredTime,
                          MicroSeconds(40),
                          "The timer did not expire at the expected time ?");
    NS_TEST_ASSERT_MSG_EQ(m_expiredArgument, 1, "We did not get the right argument");
}
 
/**
 * \ingroup timer-tests
 *  Watchdog test suite
 */
class WatchdogTestSuite : public TestSuite
{
  public:
    /** Constructor. */
    WatchdogTestSuite()
        : TestSuite("watchdog")
    {
        AddTestCase(new WatchdogTestCase());
    }
};
 
/**
 * \ingroup timer-tests
 * WatchdogTestSuite instance variable.
 */
static WatchdogTestSuite g_watchdogTestSuite;
 
} // namespace tests
 
} // namespace ns3