Provide an iOS message pump for IO implementation.

base/message_pump_io_ios_unittest.cc

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Copyright 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/message_pump_libevent.h"
+#include "base/message_pump_io_ios.h"
 
 #include <unistd.h>
 
 #include "base/message_loop.h"
 #include "base/posix/eintr_wrapper.h"
 #include "base/threading/thread.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
-#if defined(USE_SYSTEM_LIBEVENT)
-#include <event.h>
-#else
-#include "third_party/libevent/event.h"
-#endif
-
 namespace base {
 
-class MessagePumpLibeventTest : public testing::Test {
+class MessagePumpIOSForIOTest : public testing::Test {
  protected:
-  MessagePumpLibeventTest()
+  MessagePumpIOSForIOTest()
       : ui_loop_(MessageLoop::TYPE_UI),
-        io_thread_("MessagePumpLibeventTestIOThread") {}
-  virtual ~MessagePumpLibeventTest() {}
+        io_thread_("MessagePumpIOSForIOTestIOThread") {}
+  virtual ~MessagePumpIOSForIOTest() {}
 
-  virtual void SetUp() OVERRIDE {
+  virtual void SetUp() {
     Thread::Options options(MessageLoop::TYPE_IO, 0);
     ASSERT_TRUE(io_thread_.StartWithOptions(options));
     ASSERT_EQ(MessageLoop::TYPE_IO, io_thread_.message_loop()->type());
-    int err = pipe(pipefds_);
-    ASSERT_EQ(0, err);
+    int ret = pipe(pipefds_);
+    ASSERT_EQ(0, ret);
+    ret = pipe(alternate_pipefds_);
+    ASSERT_EQ(0, ret);
   }
 
   virtual void TearDown() OVERRIDE {
     if (HANDLE_EINTR(close(pipefds_[0])) < 0)
       PLOG(ERROR) << "close";
     if (HANDLE_EINTR(close(pipefds_[1])) < 0)
       PLOG(ERROR) << "close";
   }
 
   MessageLoop* ui_loop() { return &ui_loop_; }
   MessageLoopForIO* io_loop() const {
     return static_cast<MessageLoopForIO*>(io_thread_.message_loop());
   }
 
-  void OnLibeventNotification(
-      MessagePumpLibevent* pump,
-      MessagePumpLibevent::FileDescriptorWatcher* controller) {
-    pump->OnLibeventNotification(0, EV_WRITE | EV_READ, controller);
+  void SetWatcherDelegate(MessageLoopForIO::FileDescriptorWatcher* watcher,
+                          MessageLoopForIO::Watcher* delegate) {
+    watcher->set_watcher(delegate);
   }
 
+  void HandleFdIOEvent(MessageLoopForIO::FileDescriptorWatcher* watcher) {
+    MessagePumpIOSForIO::HandleFdIOEvent(watcher->fdref_,
+        kCFFileDescriptorReadCallBack | kCFFileDescriptorWriteCallBack,
+        watcher);
+  }
+
+  int pipefds_[2];
+  int alternate_pipefds_[2];
+
+ private:
   MessageLoop ui_loop_;
   Thread io_thread_;
-  int pipefds_[2];
+
+  DISALLOW_COPY_AND_ASSIGN(MessagePumpIOSForIOTest);
 };
 
 namespace {
 
-// Concrete implementation of MessagePumpLibevent::Watcher that does
+// Concrete implementation of MessagePumpIOSForIO::Watcher that does
 // nothing useful.
-class StupidWatcher : public MessagePumpLibevent::Watcher {
+class StupidWatcher : public MessagePumpIOSForIO::Watcher {
  public:
   virtual ~StupidWatcher() {}
 
-  // base:MessagePumpLibevent::Watcher interface
-  virtual void OnFileCanReadWithoutBlocking(int fd) OVERRIDE {}
-  virtual void OnFileCanWriteWithoutBlocking(int fd) OVERRIDE {}
+  // base:MessagePumpIOSForIO::Watcher interface
+  virtual void OnFileCanReadWithoutBlocking(int fd) {}
+  virtual void OnFileCanWriteWithoutBlocking(int fd) {}
 };
 
-#if GTEST_HAS_DEATH_TEST && !defined(NDEBUG)
+#if GTEST_HAS_DEATH_TEST
 
 // Test to make sure that we catch calling WatchFileDescriptor off of the
-// wrong thread.
-TEST_F(MessagePumpLibeventTest, TestWatchingFromBadThread) {
-  MessagePumpLibevent::FileDescriptorWatcher watcher;
+//  wrong thread.
+TEST_F(MessagePumpIOSForIOTest, TestWatchingFromBadThread) {
+  MessagePumpIOSForIO::FileDescriptorWatcher watcher;
   StupidWatcher delegate;
 
-  ASSERT_DEATH(io_loop()->WatchFileDescriptor(
+  ASSERT_DEBUG_DEATH(io_loop()->WatchFileDescriptor(
       STDOUT_FILENO, false, MessageLoopForIO::WATCH_READ, &watcher, &delegate),
       "Check failed: "
       "watch_file_descriptor_caller_checker_.CalledOnValidThread()");
 }
 
-#endif  // GTEST_HAS_DEATH_TEST && !defined(NDEBUG)
+#endif  // GTEST_HAS_DEATH_TEST
 
-class BaseWatcher : public MessagePumpLibevent::Watcher {
+class BaseWatcher : public MessagePumpIOSForIO::Watcher {
  public:
-  BaseWatcher(MessagePumpLibevent::FileDescriptorWatcher* controller)
+  BaseWatcher(MessagePumpIOSForIO::FileDescriptorWatcher* controller)
       : controller_(controller) {
     DCHECK(controller_);
   }
   virtual ~BaseWatcher() {}
 
-  // base:MessagePumpLibevent::Watcher interface
+  // MessagePumpIOSForIO::Watcher interface
   virtual void OnFileCanReadWithoutBlocking(int /* fd */) OVERRIDE {
     NOTREACHED();
   }
 
   virtual void OnFileCanWriteWithoutBlocking(int /* fd */) OVERRIDE {
     NOTREACHED();
   }
 
  protected:
-  MessagePumpLibevent::FileDescriptorWatcher* controller_;
+  MessagePumpIOSForIO::FileDescriptorWatcher* controller_;
 };
 
 class DeleteWatcher : public BaseWatcher {
  public:
   explicit DeleteWatcher(
-      MessagePumpLibevent::FileDescriptorWatcher* controller)
+      MessagePumpIOSForIO::FileDescriptorWatcher* controller)
       : BaseWatcher(controller) {}
 
   virtual ~DeleteWatcher() {
     DCHECK(!controller_);
   }
 
   virtual void OnFileCanWriteWithoutBlocking(int /* fd */) OVERRIDE {
     DCHECK(controller_);
     delete controller_;
     controller_ = NULL;
   }
 };
 
-TEST_F(MessagePumpLibeventTest, DeleteWatcher) {
-  scoped_refptr<MessagePumpLibevent> pump(new MessagePumpLibevent);
-  MessagePumpLibevent::FileDescriptorWatcher* watcher =
-      new MessagePumpLibevent::FileDescriptorWatcher;
+TEST_F(MessagePumpIOSForIOTest, DeleteWatcher) {
+  scoped_refptr<MessagePumpIOSForIO> pump(new MessagePumpIOSForIO);
+  MessagePumpIOSForIO::FileDescriptorWatcher* watcher =
+      new MessagePumpIOSForIO::FileDescriptorWatcher;
   DeleteWatcher delegate(watcher);
+  SetWatcherDelegate(watcher, &delegate);
+
   pump->WatchFileDescriptor(pipefds_[1],
-      false, MessagePumpLibevent::WATCH_READ_WRITE, watcher, &delegate);
+      false, MessagePumpIOSForIO::WATCH_READ_WRITE, watcher, &delegate);
 
-  // Spoof a libevent notification.
-  OnLibeventNotification(pump, watcher);
+  // Spoof a callback.
+  HandleFdIOEvent(watcher);
 }
 
 class StopWatcher : public BaseWatcher {
  public:
   explicit StopWatcher(
-      MessagePumpLibevent::FileDescriptorWatcher* controller)
-      : BaseWatcher(controller) {}
+      MessagePumpIOSForIO::FileDescriptorWatcher* controller,
+      MessagePumpIOSForIO* pump,
+      int fd_to_start_watching = 0)

[wtc, 2012/11/29 20:30:34]

1. Remove "explicit".

2. Nit: the native fd 0 is a valid fd (for standard input).
It may be better to use -1 as the default argument.

Our Style Guide recommends against default arguments. I am
not sure if it is appropriate here.

You can avoid this issue by using a different subclass of
BaseWatcher for the StopWatcherAndWatchSomethingElse test,
rather than trying to share StopWatcher between two tests.

3. The |pump| argument is not necessary. We can just use
controller_->pump().

[blundell, 2012/11/30 11:19:52]

1. Done.

2. Changed the value of the default argument to -1. Thanks! Re: having the
default argument, I couldn't find anything in the Chromium style guide (let me
know if I missed it), but the Google C++ style guide says the following
(http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Default_Arguments):
"One specific exception is when the function is a static function (or in an
unnamed namespace) in a .cc file. In this case, the cons don't apply since the
function's use is so localized."

3. |pump()| is a private method, and I can't make |StopWatcher| a friend class
of |FileDescriptorWatcher| as it's in an unnamed namespace here. 

On 2012/11/29 20:30:34, wtc wrote:

+      : BaseWatcher(controller),
+        pump_(pump),
+        fd_to_start_watching_(fd_to_start_watching) {}
 
   virtual ~StopWatcher() {}
 
   virtual void OnFileCanWriteWithoutBlocking(int /* fd */) OVERRIDE {
     controller_->StopWatchingFileDescriptor();
+    if (fd_to_start_watching_) {

[wtc, 2012/11/29 20:30:34]

If you use -1 as the default value, this test should become
    if (fd_to_start_watching_ != -1)
or
    if (fd_to_start_watching_ >= 0)

[blundell, 2012/11/30 11:19:52]

Done.

+      pump_->WatchFileDescriptor(fd_to_start_watching_,
+          false, MessagePumpIOSForIO::WATCH_READ_WRITE, controller_, this);
+    }
   }
+
+ private:
+  MessagePumpIOSForIO* pump_;
+  int fd_to_start_watching_;
 };
 
-TEST_F(MessagePumpLibeventTest, StopWatcher) {
-  scoped_refptr<MessagePumpLibevent> pump(new MessagePumpLibevent);
-  MessagePumpLibevent::FileDescriptorWatcher watcher;
-  StopWatcher delegate(&watcher);
+TEST_F(MessagePumpIOSForIOTest, StopWatcher) {
+  scoped_refptr<MessagePumpIOSForIO> pump(new MessagePumpIOSForIO);
+  MessagePumpIOSForIO::FileDescriptorWatcher watcher;
+  StopWatcher delegate(&watcher, pump);
+  SetWatcherDelegate(&watcher, &delegate);
+
   pump->WatchFileDescriptor(pipefds_[1],
-      false, MessagePumpLibevent::WATCH_READ_WRITE, &watcher, &delegate);
+      false, MessagePumpIOSForIO::WATCH_READ_WRITE, &watcher, &delegate);
 
-  // Spoof a libevent notification.
-  OnLibeventNotification(pump, &watcher);
+  // Spoof a callback.
+  HandleFdIOEvent(&watcher);
+}
+
+TEST_F(MessagePumpIOSForIOTest, StopWatcherAndWatchSomethingElse) {
+  scoped_refptr<MessagePumpIOSForIO> pump(new MessagePumpIOSForIO);
+  MessagePumpIOSForIO::FileDescriptorWatcher watcher;
+  StopWatcher delegate(&watcher, pump, alternate_pipefds_[1]);
+  SetWatcherDelegate(&watcher, &delegate);
+
+  pump->WatchFileDescriptor(pipefds_[1],
+      false, MessagePumpIOSForIO::WATCH_READ_WRITE, &watcher, &delegate);
+
+  // Spoof a callback.
+  HandleFdIOEvent(&watcher);
 }
 
 }  // namespace
 
 }  // namespace base