ipc/ipc_test_base.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "build/build_config.h"
   6
   7 #include "ipc/ipc_test_base.h"
   8
   9 #include "base/command_line.h"
  10 #include "base/process/kill.h"
  11 #include "base/threading/thread.h"
  12 #include "base/time/time.h"
  13 #include "ipc/ipc_descriptors.h"
  14
  15 #if defined(OS_POSIX)
  16 #include "base/posix/global_descriptors.h"
  17 #endif
  18
  19 // static
  20 std::string IPCTestBase::GetChannelName(const std::string& test_client_name) {
  21   DCHECK(!test_client_name.empty());
  22   return test_client_name + "__Channel";
  23 }
  24
  25 IPCTestBase::IPCTestBase() {
  26 }
  27
  28 IPCTestBase::~IPCTestBase() {
  29 }
  30
  31 void IPCTestBase::TearDown() {
  32   message_loop_.reset();
  33   MultiProcessTest::TearDown();
  34 }
  35
  36 void IPCTestBase::Init(const std::string& test_client_name) {
  37   InitWithCustomMessageLoop(
  38       test_client_name,
  39       scoped_ptr<base::MessageLoop>(new base::MessageLoopForIO()));
  40 }
  41
  42 void IPCTestBase::InitWithCustomMessageLoop(
  43     const std::string& test_client_name,
  44     scoped_ptr<base::MessageLoop> message_loop) {
  45   DCHECK(!test_client_name.empty());
  46   DCHECK(test_client_name_.empty());
  47   DCHECK(!message_loop_);
  48
  49   test_client_name_ = test_client_name;
  50   message_loop_ = message_loop.Pass();
  51 }
  52
  53 void IPCTestBase::CreateChannel(IPC::Listener* listener) {
  54   CreateChannelFromChannelHandle(GetTestChannelHandle(), listener);
  55 }
  56
  57 bool IPCTestBase::ConnectChannel() {
  58   CHECK(channel_.get());
  59   return channel_->Connect();
  60 }
  61
  62 scoped_ptr<IPC::Channel> IPCTestBase::ReleaseChannel() {
  63   return channel_.Pass();
  64 }
  65
  66 void IPCTestBase::SetChannel(scoped_ptr<IPC::Channel> channel) {
  67   channel_ = channel.Pass();
  68 }
  69
  70
  71 void IPCTestBase::DestroyChannel() {
  72   DCHECK(channel_.get());
  73   channel_.reset();
  74 }
  75
  76 void IPCTestBase::CreateChannelFromChannelHandle(
  77     const IPC::ChannelHandle& channel_handle,
  78     IPC::Listener* listener) {
  79   CHECK(!channel_.get());
  80   CHECK(!channel_proxy_.get());
  81   channel_ = CreateChannelFactory(
  82       channel_handle, task_runner().get())->BuildChannel(listener);
  83 }
  84
  85 void IPCTestBase::CreateChannelProxy(
  86     IPC::Listener* listener,
  87     const scoped_refptr<base::SingleThreadTaskRunner>& ipc_task_runner) {
  88   CHECK(!channel_.get());
  89   CHECK(!channel_proxy_.get());
  90   channel_proxy_ = IPC::ChannelProxy::Create(
  91       CreateChannelFactory(GetTestChannelHandle(), ipc_task_runner.get()),
  92       listener,
  93       ipc_task_runner);
  94 }
  95
  96 void IPCTestBase::DestroyChannelProxy() {
  97   CHECK(channel_proxy_.get());
  98   channel_proxy_.reset();
  99 }
 100
 101 std::string IPCTestBase::GetTestMainName() const {
 102   return test_client_name_ + "TestClientMain";
 103 }
 104
 105 bool IPCTestBase::DidStartClient() {
 106   DCHECK(client_process_.IsValid());
 107   return client_process_.IsValid();
 108 }
 109
 110 #if defined(OS_POSIX)
 111
 112 bool IPCTestBase::StartClient() {
 113   return StartClientWithFD(channel_
 114                                ? channel_->GetClientFileDescriptor()
 115                                : channel_proxy_->GetClientFileDescriptor());
 116 }
 117
 118 bool IPCTestBase::StartClientWithFD(int ipcfd) {
 119   DCHECK(!client_process_.IsValid());
 120
 121   base::FileHandleMappingVector fds_to_map;
 122   if (ipcfd > -1)
 123     fds_to_map.push_back(std::pair<int, int>(ipcfd,
 124         kPrimaryIPCChannel + base::GlobalDescriptors::kBaseDescriptor));
 125   base::LaunchOptions options;
 126   options.fds_to_remap = &fds_to_map;
 127   client_process_ = SpawnChildWithOptions(GetTestMainName(), options);
 128
 129   return DidStartClient();
 130 }
 131
 132 #elif defined(OS_WIN)
 133
 134 bool IPCTestBase::StartClient() {
 135   DCHECK(!client_process_.IsValid());
 136   client_process_ = SpawnChild(GetTestMainName());
 137   return DidStartClient();
 138 }
 139
 140 #endif
 141
 142 bool IPCTestBase::WaitForClientShutdown() {
 143   DCHECK(client_process_.IsValid());
 144
 145   int exit_code;
 146   bool rv = client_process_.WaitForExitWithTimeout(
 147       base::TimeDelta::FromSeconds(5), &exit_code);
 148   client_process_.Close();
 149   return rv;
 150 }
 151
 152 IPC::ChannelHandle IPCTestBase::GetTestChannelHandle() {
 153   return GetChannelName(test_client_name_);
 154 }
 155
 156 scoped_refptr<base::SequencedTaskRunner> IPCTestBase::task_runner() {
 157   return message_loop_->message_loop_proxy();
 158 }
 159
 160 scoped_ptr<IPC::ChannelFactory> IPCTestBase::CreateChannelFactory(
 161     const IPC::ChannelHandle& handle,
 162     base::SequencedTaskRunner* runner) {
 163   return IPC::ChannelFactory::Create(handle, IPC::Channel::MODE_SERVER);
 164 }