tests/unit-tests/util/test-scheduler.cpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
 * Copyright (c) 2013-2014 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library 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 Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */

#include "util/scheduler.hpp"

#include "boost-test.hpp"
#include "../unit-test-time-fixture.hpp"

namespace ndn {
namespace tests {

BOOST_FIXTURE_TEST_SUITE(UtilTestScheduler, UnitTestTimeFixture)

BOOST_AUTO_TEST_CASE(Events)
{
  size_t count1 = 0;
  size_t count2 = 0;

  Scheduler scheduler(io);
  scheduler.scheduleEvent(time::milliseconds(500), [&] {
      ++count1;
      BOOST_CHECK_EQUAL(count2, 1);
    });

  EventId i = scheduler.scheduleEvent(time::seconds(1), [&] {
      BOOST_ERROR("This event should not have been fired");
    });
  scheduler.cancelEvent(i);

  scheduler.scheduleEvent(time::milliseconds(250), [&] {
      BOOST_CHECK_EQUAL(count1, 0);
      ++count2;
    });

  i = scheduler.scheduleEvent(time::milliseconds(50), [&] {
      BOOST_ERROR("This event should not have been fired");
    });
  scheduler.cancelEvent(i);

  advanceClocks(time::milliseconds(1), 1000);
  BOOST_CHECK_EQUAL(count1, 1);
  BOOST_CHECK_EQUAL(count2, 1);
}

BOOST_AUTO_TEST_CASE(CancelEmptyEvent)
{
  Scheduler scheduler(io);

  EventId i;
  scheduler.cancelEvent(i);
}

BOOST_AUTO_TEST_CASE(SelfCancel)
{
  Scheduler scheduler(io);

  EventId selfEventId;
  selfEventId = scheduler.scheduleEvent(time::milliseconds(100), [&] {
      scheduler.cancelEvent(selfEventId);
    });

  BOOST_REQUIRE_NO_THROW(advanceClocks(time::milliseconds(100), 10));
}

class SelfRescheduleFixture : public UnitTestTimeFixture
{
public:
  SelfRescheduleFixture()
    : scheduler(io)
    , count(0)
  {
  }

  void
  reschedule()
  {
    EventId eventId = scheduler.scheduleEvent(time::milliseconds(100),
                                              bind(&SelfRescheduleFixture::reschedule, this));
    scheduler.cancelEvent(selfEventId);
    selfEventId = eventId;

    if (count < 5)
      count++;
    else
      scheduler.cancelEvent(selfEventId);
  }

  void
  reschedule2()
  {
    scheduler.cancelEvent(selfEventId);

    if (count < 5)  {
      selfEventId = scheduler.scheduleEvent(time::milliseconds(100),
                                            bind(&SelfRescheduleFixture::reschedule2, this));
      count++;
    }
  }

  void
  reschedule3()
  {
    scheduler.cancelEvent(selfEventId);

    scheduler.scheduleEvent(time::milliseconds(100), [&] { ++count; });
    scheduler.scheduleEvent(time::milliseconds(100), [&] { ++count; });
    scheduler.scheduleEvent(time::milliseconds(100), [&] { ++count; });
    scheduler.scheduleEvent(time::milliseconds(100), [&] { ++count; });
    scheduler.scheduleEvent(time::milliseconds(100), [&] { ++count; });
    scheduler.scheduleEvent(time::milliseconds(100), [&] { ++count; });
  }

  Scheduler scheduler;
  EventId selfEventId;
  size_t count;
};

BOOST_FIXTURE_TEST_CASE(Reschedule, SelfRescheduleFixture)
{
  selfEventId = scheduler.scheduleEvent(time::seconds(0),
                                        bind(&SelfRescheduleFixture::reschedule, this));

  BOOST_REQUIRE_NO_THROW(advanceClocks(time::milliseconds(10), 1000));

  BOOST_CHECK_EQUAL(count, 5);
}

BOOST_FIXTURE_TEST_CASE(Reschedule2, SelfRescheduleFixture)
{
  selfEventId = scheduler.scheduleEvent(time::seconds(0),
                                        bind(&SelfRescheduleFixture::reschedule2, this));

  BOOST_REQUIRE_NO_THROW(advanceClocks(time::milliseconds(10), 1000));

  BOOST_CHECK_EQUAL(count, 5);
}

BOOST_FIXTURE_TEST_CASE(Reschedule3, SelfRescheduleFixture)
{
  selfEventId = scheduler.scheduleEvent(time::seconds(0),
                                        bind(&SelfRescheduleFixture::reschedule3, this));

  BOOST_REQUIRE_NO_THROW(advanceClocks(time::milliseconds(10), 1000));

  BOOST_CHECK_EQUAL(count, 6);
}


struct CancelAllFixture : public UnitTestTimeFixture
{
  CancelAllFixture()
    : scheduler(io)
    , count(0)
  {
  }

  void
  event()
  {
    ++count;

    scheduler.scheduleEvent(time::seconds(1), [&] { event(); });
  }

  Scheduler scheduler;
  uint32_t count;
};


BOOST_FIXTURE_TEST_CASE(CancelAll, CancelAllFixture)
{
  scheduler.scheduleEvent(time::milliseconds(500), [&] { scheduler.cancelAllEvents(); });

  scheduler.scheduleEvent(time::seconds(1), [&] { event(); });

  scheduler.scheduleEvent(time::seconds(3), [] {
      BOOST_ERROR("This event should have been cancelled" );
    });

  advanceClocks(time::milliseconds(100), 100);

  BOOST_CHECK_EQUAL(count, 0);
}


BOOST_AUTO_TEST_SUITE_END()

} // namespace tests
} // namespace ndn