Test SubscriptionOptions::ignore_local_publications (#192)

* Test SubscriptionOptions::ignore_local_publications

Signed-off-by: Jose Antonio Moral <[email protected]>

* Address requested changes

Signed-off-by: Jose Antonio Moral <[email protected]>

* Modify test for unique pub and wait_set

Signed-off-by: Jose Antonio Moral <[email protected]>

* Check condition to not be NULL

Signed-off-by: Jose Antonio Moral <[email protected]>

* Change comment

Signed-off-by: Jose Antonio Moral <[email protected]>

Author: jamoralp

test_rmw_implementation/test/test_subscription.cpp

@@ -524,6 +524,107 @@ TEST_F(CLASSNAME(TestSubscriptionUse, RMW_IMPLEMENTATION), take_with_info_with_b
   sub->implementation_identifier = implementation_identifier;
 }
 
+TEST_F(CLASSNAME(TestSubscriptionUse, RMW_IMPLEMENTATION), ignore_local_publications) {
+  rmw_ret_t ret;
+  bool taken = false;
+
+  // Create publisher
+  rmw_publisher_options_t pub_options = rmw_get_default_publisher_options();
+  rmw_publisher_t * pub = rmw_create_publisher(node, ts, topic_name, &qos_profile, &pub_options);
+  ASSERT_NE(nullptr, pub) << rmw_get_error_string().str;
+  OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT(
+  {
+    EXPECT_EQ(RMW_RET_OK, rmw_destroy_publisher(node, pub)) << rmw_get_error_string().str;
+  });
+
+  // Create subscription with ignore_local_publications = true
+  rmw_subscription_options_t sub_options_ignorelocal = rmw_get_default_subscription_options();
+  sub_options_ignorelocal.ignore_local_publications = true;
+  rmw_subscription_t * sub_ignorelocal =
+    rmw_create_subscription(node, ts, topic_name, &qos_profile, &sub_options_ignorelocal);
+  ASSERT_NE(nullptr, sub_ignorelocal) << rmw_get_error_string().str;
+  OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT(
+  {
+    EXPECT_EQ(
+      RMW_RET_OK, rmw_destroy_subscription(node, sub_ignorelocal)) << rmw_get_error_string().str;
+  });
+
+  size_t subscription_count = 0u;
+  SLEEP_AND_RETRY_UNTIL(rmw_intraprocess_discovery_delay, rmw_intraprocess_discovery_delay * 10) {
+    ret = rmw_publisher_count_matched_subscriptions(pub, &subscription_count);
+    if (RMW_RET_OK == ret && 2u == subscription_count) {  // Early return on failure.
+      break;
+    }
+  }
+
+  // Roundtrip message from publisher to both subscriptions
+  test_msgs__msg__BasicTypes original_message{};
+  ASSERT_TRUE(test_msgs__msg__BasicTypes__init(&original_message));
+  original_message.bool_value = true;
+  original_message.char_value = 'k';
+  original_message.float32_value = 3.14159f;
+  OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT(
+  {
+    test_msgs__msg__BasicTypes__fini(&original_message);
+  });
+
+  rmw_publisher_allocation_t * null_allocation_p{nullptr};
+  rmw_subscription_allocation_t * null_allocation_s{nullptr};
+
+  ret = rmw_publish(pub, &original_message, null_allocation_p);
+  EXPECT_EQ(RMW_RET_OK, ret) << rmw_get_error_string().str;
+
+  rmw_subscriptions_t subscriptions;
+  void * subscriptions_storage[2];
+  subscriptions_storage[0] = sub_ignorelocal->data;
+  subscriptions_storage[1] = sub->data;
+  subscriptions.subscribers = subscriptions_storage;
+  subscriptions.subscriber_count = 2;
+
+  rmw_wait_set_t * wait_set = rmw_create_wait_set(&context, 2);
+  ASSERT_NE(nullptr, wait_set) << rmw_get_error_string().str;
+  OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT(
+  {
+    EXPECT_EQ(
+      RMW_RET_OK, rmw_destroy_wait_set(wait_set)) << rmw_get_error_string().str;
+  });
+  rmw_time_t timeout = {1, 0};  // 1000ms
+  ret = rmw_wait(&subscriptions, nullptr, nullptr, nullptr, nullptr, wait_set, &timeout);
+  EXPECT_EQ(RMW_RET_OK, ret) << rmw_get_error_string().str;
+  // Subscriptions that ignore local publications may or may not be awaken by locally sent messages.
+  // ASSERT_NE(nullptr, subscriptions.subscribers[0]);
+  ASSERT_NE(nullptr, subscriptions.subscribers[1]);
+
+  // ignore_local_publications = true
+  {
+    test_msgs__msg__BasicTypes output_message{};
+    ASSERT_TRUE(test_msgs__msg__BasicTypes__init(&output_message));
+    OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT(
+    {
+      test_msgs__msg__BasicTypes__fini(&output_message);
+    });
+
+    ret = rmw_take(sub_ignorelocal, &output_message, &taken, null_allocation_s);
+    EXPECT_EQ(RMW_RET_OK, ret) << rmw_get_error_string().str;
+    EXPECT_FALSE(taken);
+  }
+
+  // ignore_local_publications = false
+  {
+    test_msgs__msg__BasicTypes output_message{};
+    ASSERT_TRUE(test_msgs__msg__BasicTypes__init(&output_message));
+    OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT(
+    {
+      test_msgs__msg__BasicTypes__fini(&output_message);
+    });
+
+    ret = rmw_take(sub, &output_message, &taken, null_allocation_s);
+    EXPECT_EQ(RMW_RET_OK, ret) << rmw_get_error_string().str;
+    EXPECT_TRUE(taken);
+    EXPECT_EQ(original_message, output_message);
+  }
+}
+
 TEST_F(CLASSNAME(TestSubscriptionUse, RMW_IMPLEMENTATION), take_sequence) {
   size_t count = 1u;
   size_t taken = 10u;  // Non-zero value to check variable update