Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Prefer a reference for first parameter of {test,wait}_{all,any}.
[simgrid.git] / teshsuite / s4u / activity-lifecycle / testing_test-wait.cpp
index 6aa60c1..e47abd6 100644 (file)
@@ -7,8 +7,10 @@
 
 //========== Creators: create an async activity
 
+template <typename Activity> using creator_type = Activity (*)(double);
+
 // Create a new async execution with given duration
-static simgrid::s4u::ActivityPtr create_exec(double duration)
+static simgrid::s4u::ExecPtr create_exec(double duration)
 {
   double speed = simgrid::s4u::this_actor::get_host()->get_speed();
   return simgrid::s4u::this_actor::exec_async(speed * duration);
@@ -16,18 +18,18 @@ static simgrid::s4u::ActivityPtr create_exec(double duration)
 
 // TODO: check other kinds of activities too (Io, Comm, ...)
 
-using creator_type = decltype(create_exec);
-
 //========== Testers: test the completion of an activity
 
+template <typename Activity> using tester_type = bool (*)(const Activity&);
+
 // Calls activity->test() and returns its result
-static bool tester_test(const simgrid::s4u::ActivityPtr& activity)
+template <typename Activity> bool tester_test(const Activity& activity)
 {
   return activity->test();
 }
 
 // Calls activity->wait_for(Duration / 128.0) and returns true when activity is terminated, just like test()
-template <int Duration> bool tester_wait(const simgrid::s4u::ActivityPtr& activity)
+template <int Duration, typename Activity> bool tester_wait(const Activity& activity)
 {
   constexpr double duration = Duration / 128.0;
   const double timeout      = simgrid::s4u::Engine::get_clock() + duration;
@@ -39,7 +41,7 @@ template <int Duration> bool tester_wait(const simgrid::s4u::ActivityPtr& activi
     ret = true;
   } catch (const simgrid::TimeoutException& e) {
     XBT_DEBUG("wait_for() timed out (%s)", e.what());
-    INFO("wait_for() timeout should expire at expected date: " << timeout);
+    INFO("wait_for() timeout should expire at expected date: " + std::to_string(timeout));
     REQUIRE(simgrid::s4u::Engine::get_clock() == Approx(timeout));
     ret = false;
   } catch (const simgrid::Exception& e) {
@@ -51,35 +53,62 @@ template <int Duration> bool tester_wait(const simgrid::s4u::ActivityPtr& activi
   return ret;
 }
 
-using tester_type = decltype(tester_test);
+// Calls wait_any_for([activity], Duration / 128.0) and returns true when activity is terminated, just like test()
+template <int Duration, typename Activity> bool tester_wait_any(const Activity& activity)
+{
+  constexpr double duration = Duration / 128.0;
+  const double timeout      = simgrid::s4u::Engine::get_clock() + duration;
+  bool ret;
+  try {
+    std::vector<Activity> activities = {activity};
+    XBT_DEBUG("calling wait_any_for(%f)", duration);
+    int index = Activity::element_type::wait_any_for(activities, duration);
+    if (index == -1) {
+      XBT_DEBUG("wait_any_for() timed out");
+      INFO("wait_any_for() timeout should expire at expected date: " << timeout);
+      REQUIRE(simgrid::s4u::Engine::get_clock() == Approx(timeout));
+      ret = false;
+    } else {
+      XBT_DEBUG("wait_any_for() returned index %d", index);
+      REQUIRE(index == 0);
+      ret = true;
+    }
+  } catch (const simgrid::Exception& e) {
+    XBT_DEBUG("wait_any_for() threw an exception: %s", e.what());
+    ret = true;
+  }
+  INFO("wait_any_for() should return before timeout expiration at date: " << timeout);
+  REQUIRE(simgrid::s4u::Engine::get_clock() <= Approx(timeout));
+  return ret;
+}
 
 //========== Waiters: wait for the completion of an activity
 
+template <typename Activity> using waiter_type = void (*)(const Activity&);
+
 // Wait for 6s
-static void waiter_sleep6(const simgrid::s4u::ActivityPtr&)
+template <typename Activity> void waiter_sleep6(const Activity&)
 {
   simgrid::s4u::this_actor::sleep_for(6.0);
   XBT_DEBUG("wake up after 6s sleep");
 }
 
 // Wait for completion of activity
-static void waiter_wait(const simgrid::s4u::ActivityPtr& activity)
+template <typename Activity> void waiter_wait(const Activity& activity)
 {
   activity->wait();
   XBT_DEBUG("end of wait()");
 }
 
-using waiter_type = decltype(waiter_wait);
-
 //========== Finally, the test templates
 
-template <creator_type Create, tester_type Test> void test_trivial()
+template <typename Activity, creator_type<Activity> Create, tester_type<Activity> Test> void test_trivial()
 {
   XBT_INFO("Launch an activity for 5s, and let it proceed before test");
 
   simgrid::s4u::ActorPtr actor = simgrid::s4u::Actor::create("actor", all_hosts[1], []() {
     assert_exit(true, 6.);
-    simgrid::s4u::ActivityPtr activity = Create(5.0);
+    Activity activity = Create(5.0);
     simgrid::s4u::this_actor::sleep_for(6.0);
     INFO("activity should be terminated now");
     REQUIRE(Test(activity));
@@ -87,13 +116,13 @@ template <creator_type Create, tester_type Test> void test_trivial()
   actor->join();
 }
 
-template <creator_type Create, tester_type Test> void test_basic()
+template <typename Activity, creator_type<Activity> Create, tester_type<Activity> Test> void test_basic()
 {
   XBT_INFO("Launch an activity for 5s, and test while it proceeds");
 
   simgrid::s4u::ActorPtr actor = simgrid::s4u::Actor::create("actor", all_hosts[1], []() {
     assert_exit(true, 6.);
-    simgrid::s4u::ActivityPtr activity = Create(5.0);
+    Activity activity = Create(5.0);
     for (int i = 0; i < 3; i++) {
       const double timestep = simgrid::s4u::Engine::get_clock() + 2.0;
       INFO("activity should be still running (i = " << i << ")");
@@ -106,13 +135,13 @@ template <creator_type Create, tester_type Test> void test_basic()
   actor->join();
 }
 
-template <creator_type Create, tester_type Test> void test_cancel()
+template <typename Activity, creator_type<Activity> Create, tester_type<Activity> Test> void test_cancel()
 {
   XBT_INFO("Launch an activity for 5s, and cancel it after 2s");
 
   simgrid::s4u::ActorPtr actor = simgrid::s4u::Actor::create("actor", all_hosts[1], []() {
     assert_exit(true, 2.);
-    simgrid::s4u::ActivityPtr activity = Create(5.0);
+    Activity activity = Create(5.0);
     simgrid::s4u::this_actor::sleep_for(2.0);
     activity->cancel();
     INFO("activity should be terminated now");
@@ -121,39 +150,45 @@ template <creator_type Create, tester_type Test> void test_cancel()
   actor->join();
 }
 
-template <creator_type Create, tester_type Test, waiter_type Wait> void test_failure_actor()
+template <typename Activity, creator_type<Activity> Create, tester_type<Activity> Test, waiter_type<Activity> Wait>
+void test_failure_actor()
 {
   XBT_INFO("Launch an activity for 5s, and kill running actor after 2s");
 
-  simgrid::s4u::ActivityPtr activity;
+  Activity activity;
   simgrid::s4u::ActorPtr actor = simgrid::s4u::Actor::create("actor", all_hosts[1], [&activity]() {
     assert_exit(false, 2.);
     activity = Create(5.0);
     Wait(activity);
     FAIL("should not be here!");
   });
-  simgrid::s4u::this_actor::sleep_for(2.0);
+  const double timestep = simgrid::s4u::Engine::get_clock() + 2.0;
+  simgrid::s4u::this_actor::sleep_for(1.0);
   INFO("activity should be still running");
   REQUIRE(not Test(activity));
+  simgrid::s4u::this_actor::sleep_until(timestep);
   actor->kill();
   INFO("activity should be terminated now");
   REQUIRE(Test(activity));
 }
 
-template <creator_type Create, tester_type Test, waiter_type Wait> void test_failure_host()
+template <typename Activity, creator_type<Activity> Create, tester_type<Activity> Test, waiter_type<Activity> Wait>
+void test_failure_host()
 {
   XBT_INFO("Launch an activity for 5s, and shutdown host 2s");
 
-  simgrid::s4u::ActivityPtr activity;
+  Activity activity;
   simgrid::s4u::ActorPtr actor = simgrid::s4u::Actor::create("actor", all_hosts[1], [&activity]() {
     assert_exit(false, 2.);
     activity = Create(5.0);
     Wait(activity);
     FAIL("should not be here!");
   });
-  simgrid::s4u::this_actor::sleep_for(2.0);
+  const double timestep = simgrid::s4u::Engine::get_clock() + 2.0;
+  simgrid::s4u::this_actor::sleep_for(1.0);
   INFO("activity should be still running");
   REQUIRE(not Test(activity));
+  simgrid::s4u::this_actor::sleep_until(timestep);
   actor->get_host()->turn_off();
   actor->get_host()->turn_on();
   INFO("activity should be terminated now");
@@ -162,17 +197,23 @@ template <creator_type Create, tester_type Test, waiter_type Wait> void test_fai
 
 //==========
 
+using simgrid::s4u::ExecPtr;
+
 TEST_CASE("Activity test/wait: using <tester_test>")
 {
   XBT_INFO("#####[ launch next test ]#####");
 
-  RUN_SECTION("exec: run and test once", test_trivial<create_exec, tester_test>);
-  RUN_SECTION("exec: run and test many", test_basic<create_exec, tester_test>);
-  RUN_SECTION("exec: cancel and test", test_cancel<create_exec, tester_test>);
-  RUN_SECTION("exec: actor failure and test / sleep", test_failure_actor<create_exec, tester_test, waiter_sleep6>);
-  RUN_SECTION("exec: host failure and test / sleep", test_failure_host<create_exec, tester_test, waiter_sleep6>);
-  RUN_SECTION("exec: actor failure and test / wait", test_failure_actor<create_exec, tester_test, waiter_wait>);
-  RUN_SECTION("exec: host failure and test / wait", test_failure_host<create_exec, tester_test, waiter_wait>);
+  RUN_SECTION("exec: run and test once", test_trivial<ExecPtr, create_exec, tester_test>);
+  RUN_SECTION("exec: run and test many", test_basic<ExecPtr, create_exec, tester_test>);
+  RUN_SECTION("exec: cancel and test", test_cancel<ExecPtr, create_exec, tester_test>);
+  RUN_SECTION("exec: actor failure and test / sleep",
+              test_failure_actor<ExecPtr, create_exec, tester_test, waiter_sleep6>);
+  RUN_SECTION("exec: host failure and test / sleep",
+              test_failure_host<ExecPtr, create_exec, tester_test, waiter_sleep6>);
+  RUN_SECTION("exec: actor failure and test / wait",
+              test_failure_actor<ExecPtr, create_exec, tester_test, waiter_wait>);
+  RUN_SECTION("exec: host failure and test / wait",
+              test_failure_host<ExecPtr, create_exec, tester_test, waiter_wait>);
 
   simgrid::s4u::this_actor::sleep_for(10);
   assert_cleanup();
@@ -182,13 +223,17 @@ TEST_CASE("Activity test/wait: using <tester_wait<0>>")
 {
   XBT_INFO("#####[ launch next test ]#####");
 
-  RUN_SECTION("exec: run and wait<0> once", test_trivial<create_exec, tester_wait<0>>);
-  // exec: run and wait<0> many
-  RUN_SECTION("exec: cancel and wait<0>", test_cancel<create_exec, tester_wait<0>>);
-  // exec: actor failure and wait<0> / sleep
-  // exec: host failure and wait<0> / sleep
-  // exec: actor failure and wait<0> / wait
-  // exec: host failure and wait<0> / wait
+  RUN_SECTION("exec: run and wait<0> once", test_trivial<ExecPtr, create_exec, tester_wait<0>>);
+  RUN_SECTION("exec: run and wait<0> many", test_basic<ExecPtr, create_exec, tester_wait<0>>);
+  RUN_SECTION("exec: cancel and wait<0>", test_cancel<ExecPtr, create_exec, tester_wait<0>>);
+  RUN_SECTION("exec: actor failure and wait<0> / sleep",
+              test_failure_actor<ExecPtr, create_exec, tester_wait<0>, waiter_sleep6>);
+  RUN_SECTION("exec: host failure and wait<0> / sleep",
+              test_failure_host<ExecPtr, create_exec, tester_wait<0>, waiter_sleep6>);
+  RUN_SECTION("exec: actor failure and wait<0> / wait",
+              test_failure_actor<ExecPtr, create_exec, tester_wait<0>, waiter_wait>);
+  RUN_SECTION("exec: host failure and wait<0> / wait",
+              test_failure_host<ExecPtr, create_exec, tester_wait<0>, waiter_wait>);
 
   simgrid::s4u::this_actor::sleep_for(10);
   assert_cleanup();
@@ -198,37 +243,57 @@ TEST_CASE("Activity test/wait: using <tester_wait<1>>")
 {
   XBT_INFO("#####[ launch next test ]#####");
 
-  RUN_SECTION("exec: run and wait<1> once", test_trivial<create_exec, tester_wait<1>>);
-  // exec: run and wait<1> many
-  RUN_SECTION("exec: cancel and wait<1>", test_cancel<create_exec, tester_wait<1>>);
-  // exec: actor failure and wait<1> / sleep
-  // exec: host failure and wait<1> / sleep
-  // exec: actor failure and wait<1> / wait
-  // exec: host failure and wait<1> / wait
+  RUN_SECTION("exec: run and wait<1> once", test_trivial<ExecPtr, create_exec, tester_wait<1>>);
+  RUN_SECTION("exec: run and wait<1> many", test_basic<ExecPtr, create_exec, tester_wait<1>>);
+  RUN_SECTION("exec: cancel and wait<1>", test_cancel<ExecPtr, create_exec, tester_wait<1>>);
+  RUN_SECTION("exec: actor failure and wait<1> / sleep",
+              test_failure_actor<ExecPtr, create_exec, tester_wait<1>, waiter_sleep6>);
+  RUN_SECTION("exec: host failure and wait<1> / sleep",
+              test_failure_host<ExecPtr, create_exec, tester_wait<1>, waiter_sleep6>);
+  RUN_SECTION("exec: actor failure and wait<1> / wait",
+              test_failure_actor<ExecPtr, create_exec, tester_wait<1>, waiter_wait>);
+  RUN_SECTION("exec: host failure and wait<1> / wait",
+              test_failure_host<ExecPtr, create_exec, tester_wait<1>, waiter_wait>);
 
   simgrid::s4u::this_actor::sleep_for(10);
   assert_cleanup();
 }
 
-// FIXME: The tests grouped here are currently failing. Once fixed, they should be put in the right section above.
-//        The tests can be activated with run-time parameter '*' or, more specifically '[failing]'
-TEST_CASE("Activity test/wait: tests currently failing", "[.][failing]")
+TEST_CASE("Activity test/wait: using <tester_wait_any<0>>")
 {
-  XBT_INFO("#####[ launch next failing test ]#####");
+  XBT_INFO("#####[ launch next test ]#####");
+
+  RUN_SECTION("exec: run and wait_any<0> once", test_trivial<ExecPtr, create_exec, tester_wait_any<0>>);
+  RUN_SECTION("exec: run and wait_any<0> many", test_basic<ExecPtr, create_exec, tester_wait_any<0>>);
+  RUN_SECTION("exec: cancel and wait_any<0>", test_cancel<ExecPtr, create_exec, tester_wait_any<1>>);
+  RUN_SECTION("exec: actor failure and wait_any<0> / sleep",
+              test_failure_actor<ExecPtr, create_exec, tester_wait_any<0>, waiter_sleep6>);
+  RUN_SECTION("exec: host failure and wait_any<0> / sleep",
+              test_failure_host<ExecPtr, create_exec, tester_wait_any<0>, waiter_sleep6>);
+  RUN_SECTION("exec: actor failure and wait_any<0> / wait",
+              test_failure_actor<ExecPtr, create_exec, tester_wait_any<0>, waiter_wait>);
+  RUN_SECTION("exec: host failure and wait_any<0> / wait",
+              test_failure_host<ExecPtr, create_exec, tester_wait_any<0>, waiter_wait>);
 
-  // with tester_wait<0>
-  RUN_SECTION("exec: run and wait<0> many", test_basic<create_exec, tester_wait<0>>);
-  RUN_SECTION("exec: actor failure and wait<0> / sleep", test_failure_actor<create_exec, tester_wait<0>, waiter_sleep6>);
-  RUN_SECTION("exec: host failure and wait<0> / sleep", test_failure_host<create_exec, tester_wait<0>, waiter_sleep6>);
-  RUN_SECTION("exec: actor failure and wait<0> / wait", test_failure_actor<create_exec, tester_wait<0>, waiter_wait>);
-  RUN_SECTION("exec: host failure and wait<0> / wait", test_failure_host<create_exec, tester_wait<0>, waiter_wait>);
+  simgrid::s4u::this_actor::sleep_for(10);
+  assert_cleanup();
+}
+
+TEST_CASE("Activity test/wait: using <tester_wait_any<1>>")
+{
+  XBT_INFO("#####[ launch next test ]#####");
 
-  // with tester_test<1>
-  RUN_SECTION("exec: run and wait<1> many", test_basic<create_exec, tester_wait<1>>);
-  RUN_SECTION("exec: actor failure and wait<1> / sleep", test_failure_actor<create_exec, tester_wait<1>, waiter_sleep6>);
-  RUN_SECTION("exec: host failure and wait<1> / sleep", test_failure_host<create_exec, tester_wait<1>, waiter_sleep6>);
-  RUN_SECTION("exec: actor failure and wait<1> / wait", test_failure_actor<create_exec, tester_wait<1>, waiter_wait>);
-  RUN_SECTION("exec: host failure and wait<1> / wait", test_failure_host<create_exec, tester_wait<1>, waiter_wait>);
+  RUN_SECTION("exec: run and wait_any<1> once", test_trivial<ExecPtr, create_exec, tester_wait_any<1>>);
+  RUN_SECTION("exec: run and wait_any<1> many", test_basic<ExecPtr, create_exec, tester_wait_any<1>>);
+  RUN_SECTION("exec: cancel and wait_any<1>", test_cancel<ExecPtr, create_exec, tester_wait_any<1>>);
+  RUN_SECTION("exec: actor failure and wait_any<1> / sleep",
+              test_failure_actor<ExecPtr, create_exec, tester_wait_any<1>, waiter_sleep6>);
+  RUN_SECTION("exec: host failure and wait_any<1> / sleep",
+              test_failure_host<ExecPtr, create_exec, tester_wait_any<1>, waiter_sleep6>);
+  RUN_SECTION("exec: actor failure and wait_any<1> / wait",
+              test_failure_actor<ExecPtr, create_exec, tester_wait_any<1>, waiter_wait>);
+  RUN_SECTION("exec: host failure and wait_any<1> / wait",
+              test_failure_host<ExecPtr, create_exec, tester_wait_any<1>, waiter_wait>);
 
   simgrid::s4u::this_actor::sleep_for(10);
   assert_cleanup();