Make SignalSenderVerificationTest more robust

dbus/signal_sender_verification_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/bind.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/metrics/histogram_samples.h"
 #include "base/metrics/statistics_recorder.h"
@@ skipping 24 matching lines @@
     thread_options.message_loop_type = MessageLoop::TYPE_IO;
     ASSERT_TRUE(dbus_thread_->StartWithOptions(thread_options));
 
     // Start the test service, using the D-Bus thread.
     dbus::TestService::Options options;
     options.dbus_thread_message_loop_proxy = dbus_thread_->message_loop_proxy();
     test_service_.reset(new dbus::TestService(options));
     ASSERT_TRUE(test_service_->StartService());
     ASSERT_TRUE(test_service_->WaitUntilServiceIsStarted());
     ASSERT_TRUE(test_service_->HasDBusThread());
+    ASSERT_TRUE(test_service_->has_ownership());
 
     // Same setup for the second TestService. This service should not have the
     // ownership of the name at this point.
     test_service2_.reset(new dbus::TestService(options));
     ASSERT_TRUE(test_service2_->StartService());
     ASSERT_TRUE(test_service2_->WaitUntilServiceIsStarted());
     ASSERT_TRUE(test_service2_->HasDBusThread());
+    ASSERT_FALSE(test_service2_->has_ownership());
 
     // Create the client, using the D-Bus thread.
     dbus::Bus::Options bus_options;
     bus_options.bus_type = dbus::Bus::SESSION;
     bus_options.connection_type = dbus::Bus::PRIVATE;
     bus_options.dbus_thread_message_loop_proxy =
         dbus_thread_->message_loop_proxy();
     bus_ = new dbus::Bus(bus_options);
     object_proxy_ = bus_->GetObjectProxy(
         "org.chromium.TestService",
         dbus::ObjectPath("/org/chromium/TestObject"));
     ASSERT_TRUE(bus_->HasDBusThread());
 
+    object_proxy_->SetNameOwnerChangedCallback(
+        base::Bind(&SignalSenderVerificationTest::OnNameOwnerChanged,
+                   base::Unretained(this)));
+
     // Connect to the "Test" signal of "org.chromium.TestInterface" from
     // the remote object.
     object_proxy_->ConnectToSignal(
         "org.chromium.TestInterface",
         "Test",
         base::Bind(&SignalSenderVerificationTest::OnTestSignal,
                    base::Unretained(this)),
         base::Bind(&SignalSenderVerificationTest::OnConnected,
                    base::Unretained(this)));
     // Wait until the object proxy is connected to the signal.
     message_loop_.Run();
   }
 
+  void OnOwnership(bool expected, bool success) {
+    ASSERT_EQ(expected, success);
+  }
+
+  void OnNameOwnerChanged(dbus::Signal* signal) {
+    dbus::MessageReader reader(signal);
+    std::string name, old_owner, new_owner;
+    ASSERT_TRUE(reader.PopString(&name));
+    ASSERT_TRUE(reader.PopString(&old_owner));
+    ASSERT_TRUE(reader.PopString(&new_owner));
+    latest_name_owner_ = new_owner;
+    // PostTask to quit the mMessageLoop as this is called from D-Bus thread.

[satorux1, 2012/11/13 06:32:03]

mMessageLoop -> MessageLoop

Thank you for adding the comment.

[Haruki Sato, 2012/11/14 06:35:15]

This part is changed. Thank you for the review!

+    message_loop_.PostTask(
+        FROM_HERE,
+        base::Bind(&SignalSenderVerificationTest::QuitMessageLoop,
+                   base::Unretained(this)));
+  }
+
   virtual void TearDown() {
     bus_->ShutdownOnDBusThreadAndBlock();
 
     // Shut down the service.
     test_service_->ShutdownAndBlock();
     test_service2_->ShutdownAndBlock();
 
     // Reset to the default.
     base::ThreadRestrictions::SetIOAllowed(true);
 
@@ skipping 20 matching lines @@
     ASSERT_TRUE(success);
     message_loop_.Quit();
   }
 
   // Wait for the hey signal to be received.
   void WaitForTestSignal() {
     // OnTestSignal() will quit the message loop.
     message_loop_.Run();
   }
 
+  void QuitMessageLoop() {
+    message_loop_.Quit();
+  }
+
   MessageLoop message_loop_;
   scoped_ptr<base::Thread> dbus_thread_;
   scoped_refptr<dbus::Bus> bus_;
   dbus::ObjectProxy* object_proxy_;
   scoped_ptr<dbus::TestService> test_service_;
   scoped_ptr<dbus::TestService> test_service2_;
   // Text message from "Test" signal.
   std::string test_signal_string_;
+
+  // The known latest name owner of TestService. Updated in OnNameOwnerChanged.
+  std::string latest_name_owner_;
 };
 
 TEST_F(SignalSenderVerificationTest, TestSignalAccepted) {
   const char kMessage[] = "hello, world";
   // Send the test signal from the exported object.
   test_service_->SendTestSignal(kMessage);
   // Receive the signal with the object proxy. The signal is handled in
   // SignalSenderVerificationTest::OnTestSignal() in the main thread.
   WaitForTestSignal();
   ASSERT_EQ(kMessage, test_signal_string_);
@@ skipping 14 matching lines @@
   // Sleep to have message delivered to the client via the D-Bus service.
   base::PlatformThread::Sleep(TestTimeouts::action_timeout());
 
   scoped_ptr<base::HistogramSamples> samples2(
       reject_signal_histogram->SnapshotSamples());
 
   ASSERT_EQ("", test_signal_string_);
   EXPECT_EQ(samples1->TotalCount() + 1, samples2->TotalCount());
 }
 
-TEST_F(SignalSenderVerificationTest, DISABLED_TestOwnerChanged) {
+TEST_F(SignalSenderVerificationTest, TestOwnerChanged) {
   const char kMessage[] = "hello, world";
 
   // Send the test signal from the exported object.
   test_service_->SendTestSignal(kMessage);
   // Receive the signal with the object proxy. The signal is handled in
   // SignalSenderVerificationTest::OnTestSignal() in the main thread.
   WaitForTestSignal();
   ASSERT_EQ(kMessage, test_signal_string_);
 
   // Release and aquire the name ownership.
+  latest_name_owner_ = "dummyowner";

[satorux1, 2012/11/13 06:32:03]

this looks rather unclean. At this moment, test_service_ owns the name, right? 

// latest_name_owner_ is non empty, as the name is owned by test_service_ now.
ASSERT_FALSE(latest_name_owner_.empty());

[Haruki Sato, 2012/11/14 06:35:15]

Done.

   test_service_->ShutdownAndBlock();
-  test_service2_->RequestOwnership();
+  // OnNameOwnerChanged will PostTask to quit the message loop.
+  message_loop_.Run();
+  // latest_name_owner_ should be empty as the owner is gone.
+  ASSERT_TRUE(latest_name_owner_.empty());
+
+  test_service2_->RequestOwnership(
+      base::Bind(&SignalSenderVerificationTest::OnOwnership,
+                 base::Unretained(this), true));
+  // OnNameOwnerChanged will PostTask to quit the message loop.

[satorux1, 2012/11/13 06:32:03]

OnNameOwnerChanged()

Let's add () for function names in comments.

[Haruki Sato, 2012/11/14 06:35:15]

Done.

+  message_loop_.Run();

[satorux1, 2012/11/13 06:32:03]

What about calling this twice:

message_loop_.Run();  // For OnOwnership().
message_loop_.Run();  // For OnNameOwnerChanged().

We should also add message_loop_.Quit() in OnOwnership() too.

[Haruki Sato, 2012/11/14 06:35:15]

As discussed offline, I added more checks for callback calls using boolean
flags.

+  // latest_name_owner_ becomes non empty as the new owner appears.
+  ASSERT_FALSE(latest_name_owner_.empty());
 
   // Now the second service owns the name.
   const char kNewMessage[] = "hello, new world";
 
   test_service2_->SendTestSignal(kNewMessage);
   WaitForTestSignal();
   ASSERT_EQ(kNewMessage, test_signal_string_);
 }