morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 1 | // Copyright 2014 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 "ipc/mojo/ipc_channel_mojo.h" |
| 6 | |
| 7 | #include "base/base_paths.h" |
| 8 | #include "base/files/file.h" |
| 9 | #include "base/message_loop/message_loop.h" |
| 10 | #include "base/path_service.h" |
| 11 | #include "base/pickle.h" |
| 12 | #include "base/threading/thread.h" |
| 13 | #include "ipc/ipc_message.h" |
| 14 | #include "ipc/ipc_test_base.h" |
| 15 | #include "ipc/ipc_test_channel_listener.h" |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 16 | #include "ipc/mojo/ipc_channel_mojo_host.h" |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 17 | #include "ipc/mojo/ipc_channel_mojo_readers.h" |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 18 | |
| 19 | #if defined(OS_POSIX) |
| 20 | #include "base/file_descriptor_posix.h" |
| 21 | #endif |
| 22 | |
| 23 | namespace { |
| 24 | |
| 25 | class ListenerThatExpectsOK : public IPC::Listener { |
| 26 | public: |
morrita@chromium.org | e2bbe78 | 2014-08-09 06:45:13 +0900 | [diff] [blame] | 27 | ListenerThatExpectsOK() |
| 28 | : received_ok_(false) {} |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 29 | |
| 30 | virtual ~ListenerThatExpectsOK() {} |
| 31 | |
| 32 | virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE { |
| 33 | PickleIterator iter(message); |
| 34 | std::string should_be_ok; |
| 35 | EXPECT_TRUE(iter.ReadString(&should_be_ok)); |
| 36 | EXPECT_EQ(should_be_ok, "OK"); |
morrita@chromium.org | e2bbe78 | 2014-08-09 06:45:13 +0900 | [diff] [blame] | 37 | received_ok_ = true; |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 38 | base::MessageLoop::current()->Quit(); |
| 39 | return true; |
| 40 | } |
| 41 | |
| 42 | virtual void OnChannelError() OVERRIDE { |
morrita@chromium.org | e2bbe78 | 2014-08-09 06:45:13 +0900 | [diff] [blame] | 43 | // The connection should be healthy while the listener is waiting |
| 44 | // message. An error can occur after that because the peer |
| 45 | // process dies. |
| 46 | DCHECK(received_ok_); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | static void SendOK(IPC::Sender* sender) { |
| 50 | IPC::Message* message = new IPC::Message( |
| 51 | 0, 2, IPC::Message::PRIORITY_NORMAL); |
| 52 | message->WriteString(std::string("OK")); |
| 53 | ASSERT_TRUE(sender->Send(message)); |
| 54 | } |
morrita@chromium.org | e2bbe78 | 2014-08-09 06:45:13 +0900 | [diff] [blame] | 55 | |
| 56 | private: |
| 57 | bool received_ok_; |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 58 | }; |
| 59 | |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 60 | class ChannelClient { |
| 61 | public: |
| 62 | explicit ChannelClient(IPC::Listener* listener, const char* name) { |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 63 | channel_ = IPC::ChannelMojo::Create(NULL, |
| 64 | IPCTestBase::GetChannelName(name), |
| 65 | IPC::Channel::MODE_CLIENT, |
| 66 | listener); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 67 | } |
| 68 | |
| 69 | void Connect() { |
| 70 | CHECK(channel_->Connect()); |
| 71 | } |
| 72 | |
| 73 | IPC::ChannelMojo* channel() const { return channel_.get(); } |
| 74 | |
| 75 | private: |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 76 | base::MessageLoopForIO main_message_loop_; |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 77 | scoped_ptr<IPC::ChannelMojo> channel_; |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 78 | }; |
| 79 | |
| 80 | class IPCChannelMojoTest : public IPCTestBase { |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 81 | protected: |
morrita | ab77970 | 2014-09-10 04:35:24 +0900 | [diff] [blame] | 82 | virtual scoped_ptr<IPC::ChannelFactory> CreateChannelFactory( |
| 83 | const IPC::ChannelHandle& handle, |
| 84 | base::TaskRunner* runner) OVERRIDE { |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 85 | host_.reset(new IPC::ChannelMojoHost(task_runner())); |
| 86 | return IPC::ChannelMojo::CreateServerFactory(host_.get(), handle); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 87 | } |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 88 | |
| 89 | virtual bool DidStartClient() OVERRIDE { |
| 90 | bool ok = IPCTestBase::DidStartClient(); |
| 91 | DCHECK(ok); |
| 92 | host_->OnClientLaunched(client_process()); |
| 93 | return ok; |
| 94 | } |
| 95 | |
| 96 | private: |
| 97 | scoped_ptr<IPC::ChannelMojoHost> host_; |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 98 | }; |
| 99 | |
| 100 | |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 101 | class TestChannelListenerWithExtraExpectations |
| 102 | : public IPC::TestChannelListener { |
| 103 | public: |
| 104 | TestChannelListenerWithExtraExpectations() |
| 105 | : is_connected_called_(false) { |
| 106 | } |
| 107 | |
| 108 | virtual void OnChannelConnected(int32 peer_pid) OVERRIDE { |
| 109 | IPC::TestChannelListener::OnChannelConnected(peer_pid); |
| 110 | EXPECT_TRUE(base::kNullProcessId != peer_pid); |
| 111 | is_connected_called_ = true; |
| 112 | } |
| 113 | |
| 114 | bool is_connected_called() const { return is_connected_called_; } |
| 115 | |
| 116 | private: |
| 117 | bool is_connected_called_; |
| 118 | }; |
| 119 | |
| 120 | TEST_F(IPCChannelMojoTest, ConnectedFromClient) { |
| 121 | Init("IPCChannelMojoTestClient"); |
| 122 | |
| 123 | // Set up IPC channel and start client. |
| 124 | TestChannelListenerWithExtraExpectations listener; |
morrita | ab77970 | 2014-09-10 04:35:24 +0900 | [diff] [blame] | 125 | CreateChannel(&listener); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 126 | listener.Init(sender()); |
| 127 | ASSERT_TRUE(ConnectChannel()); |
| 128 | ASSERT_TRUE(StartClient()); |
| 129 | |
| 130 | IPC::TestChannelListener::SendOneMessage( |
| 131 | sender(), "hello from parent"); |
| 132 | |
| 133 | base::MessageLoop::current()->Run(); |
| 134 | EXPECT_TRUE(base::kNullProcessId != this->channel()->GetPeerPID()); |
| 135 | |
| 136 | this->channel()->Close(); |
| 137 | |
| 138 | EXPECT_TRUE(WaitForClientShutdown()); |
| 139 | EXPECT_TRUE(listener.is_connected_called()); |
| 140 | EXPECT_TRUE(listener.HasSentAll()); |
| 141 | |
| 142 | DestroyChannel(); |
| 143 | } |
| 144 | |
| 145 | // A long running process that connects to us |
| 146 | MULTIPROCESS_IPC_TEST_CLIENT_MAIN(IPCChannelMojoTestClient) { |
| 147 | TestChannelListenerWithExtraExpectations listener; |
| 148 | ChannelClient client(&listener, "IPCChannelMojoTestClient"); |
| 149 | client.Connect(); |
| 150 | listener.Init(client.channel()); |
| 151 | |
| 152 | IPC::TestChannelListener::SendOneMessage( |
| 153 | client.channel(), "hello from child"); |
| 154 | base::MessageLoop::current()->Run(); |
| 155 | EXPECT_TRUE(listener.is_connected_called()); |
| 156 | EXPECT_TRUE(listener.HasSentAll()); |
| 157 | |
| 158 | return 0; |
| 159 | } |
| 160 | |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 161 | // Close given handle before use to simulate an error. |
| 162 | class ErraticChannelMojo : public IPC::ChannelMojo { |
| 163 | public: |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 164 | ErraticChannelMojo(IPC::ChannelMojoHost* host, |
| 165 | const IPC::ChannelHandle& channel_handle, |
| 166 | IPC::Channel::Mode mode, |
| 167 | IPC::Listener* listener, |
| 168 | scoped_refptr<base::TaskRunner> runner) |
| 169 | : ChannelMojo(host, channel_handle, mode, listener) {} |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 170 | |
| 171 | virtual void OnConnected(mojo::ScopedMessagePipeHandle pipe) { |
| 172 | MojoClose(pipe.get().value()); |
| 173 | OnConnected(pipe.Pass()); |
| 174 | } |
| 175 | }; |
| 176 | |
| 177 | // Exists to create ErraticChannelMojo. |
| 178 | class ErraticChannelFactory : public IPC::ChannelFactory { |
| 179 | public: |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 180 | explicit ErraticChannelFactory(IPC::ChannelMojoHost* host, |
| 181 | const IPC::ChannelHandle& handle, |
| 182 | base::TaskRunner* runner) |
| 183 | : host_(host), handle_(handle), runner_(runner) {} |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 184 | |
| 185 | virtual std::string GetName() const OVERRIDE { |
| 186 | return ""; |
| 187 | } |
| 188 | |
| 189 | virtual scoped_ptr<IPC::Channel> BuildChannel( |
| 190 | IPC::Listener* listener) OVERRIDE { |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 191 | return scoped_ptr<IPC::Channel>(new ErraticChannelMojo( |
| 192 | host_, handle_, IPC::Channel::MODE_SERVER, listener, runner_)); |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | private: |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 196 | IPC::ChannelMojoHost* host_; |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 197 | IPC::ChannelHandle handle_; |
| 198 | scoped_refptr<base::TaskRunner> runner_; |
| 199 | }; |
| 200 | |
| 201 | class ListenerExpectingErrors : public IPC::Listener { |
| 202 | public: |
| 203 | ListenerExpectingErrors() |
| 204 | : has_error_(false) { |
| 205 | } |
| 206 | |
| 207 | virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE { |
| 208 | return true; |
| 209 | } |
| 210 | |
| 211 | virtual void OnChannelError() OVERRIDE { |
| 212 | has_error_ = true; |
| 213 | base::MessageLoop::current()->Quit(); |
| 214 | } |
| 215 | |
| 216 | bool has_error() const { return has_error_; } |
| 217 | |
| 218 | private: |
| 219 | bool has_error_; |
| 220 | }; |
| 221 | |
| 222 | |
| 223 | class IPCChannelMojoErrorTest : public IPCTestBase { |
| 224 | protected: |
| 225 | virtual scoped_ptr<IPC::ChannelFactory> CreateChannelFactory( |
| 226 | const IPC::ChannelHandle& handle, |
| 227 | base::TaskRunner* runner) OVERRIDE { |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 228 | host_.reset(new IPC::ChannelMojoHost(task_runner())); |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 229 | return scoped_ptr<IPC::ChannelFactory>( |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 230 | new ErraticChannelFactory(host_.get(), handle, runner)); |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 231 | } |
morrita | 7c48ab8 | 2014-09-24 06:16:00 +0900 | [diff] [blame] | 232 | |
| 233 | virtual bool DidStartClient() OVERRIDE { |
| 234 | bool ok = IPCTestBase::DidStartClient(); |
| 235 | DCHECK(ok); |
| 236 | host_->OnClientLaunched(client_process()); |
| 237 | return ok; |
| 238 | } |
| 239 | |
| 240 | private: |
| 241 | scoped_ptr<IPC::ChannelMojoHost> host_; |
morrita | fa3ab75 | 2014-09-16 12:20:48 +0900 | [diff] [blame] | 242 | }; |
| 243 | |
| 244 | class ListenerThatQuits : public IPC::Listener { |
| 245 | public: |
| 246 | ListenerThatQuits() { |
| 247 | } |
| 248 | |
| 249 | virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE { |
| 250 | return true; |
| 251 | } |
| 252 | |
| 253 | virtual void OnChannelConnected(int32 peer_pid) OVERRIDE { |
| 254 | base::MessageLoop::current()->Quit(); |
| 255 | } |
| 256 | }; |
| 257 | |
| 258 | // A long running process that connects to us. |
| 259 | MULTIPROCESS_IPC_TEST_CLIENT_MAIN(IPCChannelMojoErraticTestClient) { |
| 260 | ListenerThatQuits listener; |
| 261 | ChannelClient client(&listener, "IPCChannelMojoErraticTestClient"); |
| 262 | client.Connect(); |
| 263 | |
| 264 | base::MessageLoop::current()->Run(); |
| 265 | |
| 266 | return 0; |
| 267 | } |
| 268 | |
| 269 | TEST_F(IPCChannelMojoErrorTest, SendFailWithPendingMessages) { |
| 270 | Init("IPCChannelMojoErraticTestClient"); |
| 271 | |
| 272 | // Set up IPC channel and start client. |
| 273 | ListenerExpectingErrors listener; |
| 274 | CreateChannel(&listener); |
| 275 | ASSERT_TRUE(ConnectChannel()); |
| 276 | |
| 277 | // This messages are queued as pending. |
| 278 | for (size_t i = 0; i < 2; ++i) { |
| 279 | IPC::TestChannelListener::SendOneMessage( |
| 280 | sender(), "hello from parent"); |
| 281 | } |
| 282 | |
| 283 | ASSERT_TRUE(StartClient()); |
| 284 | base::MessageLoop::current()->Run(); |
| 285 | |
| 286 | this->channel()->Close(); |
| 287 | |
| 288 | EXPECT_TRUE(WaitForClientShutdown()); |
| 289 | EXPECT_TRUE(listener.has_error()); |
| 290 | |
| 291 | DestroyChannel(); |
| 292 | } |
| 293 | |
| 294 | |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 295 | #if defined(OS_POSIX) |
| 296 | class ListenerThatExpectsFile : public IPC::Listener { |
| 297 | public: |
| 298 | ListenerThatExpectsFile() |
| 299 | : sender_(NULL) {} |
| 300 | |
| 301 | virtual ~ListenerThatExpectsFile() {} |
| 302 | |
| 303 | virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE { |
| 304 | PickleIterator iter(message); |
morrita | ab20725 | 2014-09-25 05:11:45 +0900 | [diff] [blame^] | 305 | |
| 306 | base::ScopedFD fd; |
| 307 | EXPECT_TRUE(message.ReadFile(&iter, &fd)); |
| 308 | base::File file(fd.release()); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 309 | std::string content(GetSendingFileContent().size(), ' '); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 310 | file.Read(0, &content[0], content.size()); |
| 311 | EXPECT_EQ(content, GetSendingFileContent()); |
| 312 | base::MessageLoop::current()->Quit(); |
| 313 | ListenerThatExpectsOK::SendOK(sender_); |
| 314 | return true; |
| 315 | } |
| 316 | |
| 317 | virtual void OnChannelError() OVERRIDE { |
| 318 | NOTREACHED(); |
| 319 | } |
| 320 | |
| 321 | static std::string GetSendingFileContent() { |
| 322 | return "Hello"; |
| 323 | } |
| 324 | |
| 325 | static base::FilePath GetSendingFilePath() { |
| 326 | base::FilePath path; |
| 327 | bool ok = PathService::Get(base::DIR_CACHE, &path); |
| 328 | EXPECT_TRUE(ok); |
| 329 | return path.Append("ListenerThatExpectsFile.txt"); |
| 330 | } |
| 331 | |
| 332 | static void WriteAndSendFile(IPC::Sender* sender, base::File& file) { |
| 333 | std::string content = GetSendingFileContent(); |
| 334 | file.WriteAtCurrentPos(content.data(), content.size()); |
| 335 | file.Flush(); |
| 336 | IPC::Message* message = new IPC::Message( |
| 337 | 0, 2, IPC::Message::PRIORITY_NORMAL); |
morrita | ab20725 | 2014-09-25 05:11:45 +0900 | [diff] [blame^] | 338 | message->WriteFile(base::ScopedFD(file.TakePlatformFile())); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 339 | ASSERT_TRUE(sender->Send(message)); |
| 340 | } |
| 341 | |
| 342 | void set_sender(IPC::Sender* sender) { sender_ = sender; } |
| 343 | |
| 344 | private: |
| 345 | IPC::Sender* sender_; |
| 346 | }; |
| 347 | |
| 348 | |
| 349 | TEST_F(IPCChannelMojoTest, SendPlatformHandle) { |
| 350 | Init("IPCChannelMojoTestSendPlatformHandleClient"); |
| 351 | |
| 352 | ListenerThatExpectsOK listener; |
morrita | ab77970 | 2014-09-10 04:35:24 +0900 | [diff] [blame] | 353 | CreateChannel(&listener); |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 354 | ASSERT_TRUE(ConnectChannel()); |
| 355 | ASSERT_TRUE(StartClient()); |
| 356 | |
| 357 | base::File file(ListenerThatExpectsFile::GetSendingFilePath(), |
| 358 | base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE | |
| 359 | base::File::FLAG_READ); |
| 360 | ListenerThatExpectsFile::WriteAndSendFile(channel(), file); |
| 361 | base::MessageLoop::current()->Run(); |
| 362 | |
| 363 | this->channel()->Close(); |
| 364 | |
| 365 | EXPECT_TRUE(WaitForClientShutdown()); |
| 366 | DestroyChannel(); |
| 367 | } |
| 368 | |
| 369 | MULTIPROCESS_IPC_TEST_CLIENT_MAIN(IPCChannelMojoTestSendPlatformHandleClient) { |
| 370 | ListenerThatExpectsFile listener; |
| 371 | ChannelClient client( |
| 372 | &listener, "IPCChannelMojoTestSendPlatformHandleClient"); |
| 373 | client.Connect(); |
| 374 | listener.set_sender(client.channel()); |
| 375 | |
| 376 | base::MessageLoop::current()->Run(); |
| 377 | |
| 378 | return 0; |
| 379 | } |
| 380 | #endif |
| 381 | |
| 382 | } // namespace |