blob: 03ac32f3fd60a5f8262af5ce04f1ae38ce50ef4e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
// Copyright (c) 2011 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.
#ifndef IPC_IPC_TEST_BASE_H_
#define IPC_IPC_TEST_BASE_H_
#include <string>
#include "base/basictypes.h"
#include "base/memory/scoped_ptr.h"
#include "base/process/process.h"
#include "base/test/multiprocess_test.h"
#include "ipc/ipc_channel.h"
#include "ipc/ipc_channel_factory.h"
#include "ipc/ipc_channel_proxy.h"
#include "ipc/ipc_multiprocess_test.h"
namespace base {
class MessageLoop;
}
namespace IPC {
class AttachmentBroker;
}
// A test fixture for multiprocess IPC tests. Such tests include a "client" side
// (running in a separate process). The same client may be shared between
// several different tests.
class IPCTestBase : public base::MultiProcessTest {
public:
// The channel name is based on the client's name. This is a public static
// helper to be used by the client-side code; server-side test code should
// usually not use this (directly).
static std::string GetChannelName(const std::string& test_client_name);
protected:
IPCTestBase();
~IPCTestBase() override;
void TearDown() override;
// Initializes the test to use the given client and creates an IO message loop
// on the current thread.
void Init(const std::string& test_client_name);
// Some tests create separate thread for IO message loop and run non-IO
// message loop on the main thread. As IPCTestBase creates IO message loop by
// default, such tests need to provide a custom message loop for the main
// thread.
void InitWithCustomMessageLoop(const std::string& test_client_name,
scoped_ptr<base::MessageLoop> message_loop);
// Creates a channel with the given listener and connects to the channel
// (returning true if successful), respectively. Use these to use a channel
// directly. Since the listener must outlive the channel, you must destroy the
// channel before the listener gets destroyed.
void CreateChannel(IPC::Listener* listener);
bool ConnectChannel();
void DestroyChannel();
// Releases or replaces existing channel.
// These are useful for testing specific types of channel subclasses.
scoped_ptr<IPC::Channel> ReleaseChannel();
void SetChannel(scoped_ptr<IPC::Channel> channel);
// Use this instead of CreateChannel() if you want to use some different
// channel specification (then use ConnectChannel() as usual).
void CreateChannelFromChannelHandle(const IPC::ChannelHandle& channel_handle,
IPC::Listener* listener);
// Creates a channel proxy with the given listener and task runner. (The
// channel proxy will automatically create and connect a channel.) You must
// (manually) destroy the channel proxy before the task runner's thread is
// destroyed.
void CreateChannelProxy(
IPC::Listener* listener,
const scoped_refptr<base::SingleThreadTaskRunner>& ipc_task_runner);
void DestroyChannelProxy();
// Starts the client process, returning true if successful; this should be
// done after connecting to the channel.
bool StartClient();
#if defined(OS_POSIX)
// A StartClient() variant that allows caller to pass the FD of IPC pipe
bool StartClientWithFD(int ipcfd);
#endif
// Waits for the client to shut down, returning true if successful. Note that
// this does not initiate client shutdown; that must be done by the test
// (somehow). This must be called before the end of the test whenever
// StartClient() was called successfully.
bool WaitForClientShutdown();
IPC::ChannelHandle GetTestChannelHandle();
// Use this to send IPC messages (when you don't care if you're using a
// channel or a proxy).
IPC::Sender* sender() {
return channel_.get() ? static_cast<IPC::Sender*>(channel_.get()) :
static_cast<IPC::Sender*>(channel_proxy_.get());
}
IPC::Channel* channel() { return channel_.get(); }
IPC::ChannelProxy* channel_proxy() { return channel_proxy_.get(); }
void set_attachment_broker(IPC::AttachmentBroker* broker) {
attachment_broker_ = broker;
}
const base::Process& client_process() const { return client_process_; }
scoped_refptr<base::SequencedTaskRunner> task_runner();
virtual scoped_ptr<IPC::ChannelFactory> CreateChannelFactory(
const IPC::ChannelHandle& handle, base::SequencedTaskRunner* runner);
virtual bool DidStartClient();
private:
std::string GetTestMainName() const;
std::string test_client_name_;
scoped_ptr<base::MessageLoop> message_loop_;
scoped_ptr<IPC::Channel> channel_;
scoped_ptr<IPC::ChannelProxy> channel_proxy_;
// The AttachmentBroker that should be passed to |channel_| when it is
// created.
IPC::AttachmentBroker* attachment_broker_;
base::Process client_process_;
DISALLOW_COPY_AND_ASSIGN(IPCTestBase);
};
// Use this to declare the client side for tests using IPCTestBase.
#define MULTIPROCESS_IPC_TEST_CLIENT_MAIN(test_client_name) \
MULTIPROCESS_IPC_TEST_MAIN(test_client_name ## TestClientMain)
#endif // IPC_IPC_TEST_BASE_H_
|
