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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
|
// 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/basictypes.h"
#include "base/bind.h"
#include "base/memory/ref_counted.h"
#include "base/message_loop/message_loop.h"
#include "base/win/scoped_handle.h"
#include "base/win/scoped_process_information.h"
#include "ipc/ipc_channel.h"
#include "ipc/ipc_channel_proxy.h"
#include "ipc/ipc_listener.h"
#include "ipc/ipc_message.h"
#include "remoting/base/auto_thread_task_runner.h"
#include "remoting/host/chromoting_messages.h"
#include "remoting/host/host_exit_codes.h"
#include "remoting/host/ipc_util.h"
#include "remoting/host/win/launch_process_with_token.h"
#include "remoting/host/win/worker_process_launcher.h"
#include "remoting/host/worker_process_ipc_delegate.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gmock_mutant.h"
#include "testing/gtest/include/gtest/gtest.h"
using base::win::ScopedHandle;
using testing::_;
using testing::AnyNumber;
using testing::CreateFunctor;
using testing::DoAll;
using testing::Expectation;
using testing::Invoke;
using testing::InvokeWithoutArgs;
using testing::Return;
namespace remoting {
namespace {
const char kIpcSecurityDescriptor[] = "D:(A;;GA;;;AU)";
class MockProcessLauncherDelegate : public WorkerProcessLauncher::Delegate {
public:
MockProcessLauncherDelegate() {}
virtual ~MockProcessLauncherDelegate() {}
// WorkerProcessLauncher::Delegate interface.
MOCK_METHOD1(LaunchProcess, void(WorkerProcessLauncher*));
MOCK_METHOD1(Send, void(IPC::Message*));
MOCK_METHOD0(CloseChannel, void());
MOCK_METHOD0(KillProcess, void());
private:
DISALLOW_COPY_AND_ASSIGN(MockProcessLauncherDelegate);
};
class MockIpcDelegate : public WorkerProcessIpcDelegate {
public:
MockIpcDelegate() {}
virtual ~MockIpcDelegate() {}
// WorkerProcessIpcDelegate interface.
MOCK_METHOD1(OnChannelConnected, void(int32));
MOCK_METHOD1(OnMessageReceived, bool(const IPC::Message&));
MOCK_METHOD1(OnPermanentError, void(int));
private:
DISALLOW_COPY_AND_ASSIGN(MockIpcDelegate);
};
class MockWorkerListener : public IPC::Listener {
public:
MockWorkerListener() {}
virtual ~MockWorkerListener() {}
MOCK_METHOD3(OnCrash, void(const std::string&, const std::string&, int));
// IPC::Listener implementation
virtual bool OnMessageReceived(const IPC::Message& message) override;
private:
DISALLOW_COPY_AND_ASSIGN(MockWorkerListener);
};
bool MockWorkerListener::OnMessageReceived(const IPC::Message& message) {
bool handled = true;
IPC_BEGIN_MESSAGE_MAP(MockWorkerListener, message)
IPC_MESSAGE_HANDLER(ChromotingDaemonMsg_Crash, OnCrash)
IPC_MESSAGE_UNHANDLED(handled = false)
IPC_END_MESSAGE_MAP()
EXPECT_TRUE(handled);
return handled;
}
} // namespace
class WorkerProcessLauncherTest
: public testing::Test,
public IPC::Listener {
public:
WorkerProcessLauncherTest();
virtual ~WorkerProcessLauncherTest();
virtual void SetUp() override;
virtual void TearDown() override;
// IPC::Listener implementation.
virtual bool OnMessageReceived(const IPC::Message& message) override;
virtual void OnChannelConnected(int32 peer_pid) override;
virtual void OnChannelError() override;
// WorkerProcessLauncher::Delegate mocks
void LaunchProcess(
WorkerProcessLauncher* event_handler);
void LaunchProcessAndConnect(
WorkerProcessLauncher* event_handler);
void FailLaunchAndStopWorker(
WorkerProcessLauncher* event_handler);
void KillProcess();
void TerminateWorker(DWORD exit_code);
// Connects the client end of the channel (the worker process's end).
void ConnectClient();
// Disconnects the client end of the channel.
void DisconnectClient();
// Disconnects the server end of the channel (the launcher's end).
void DisconnectServer();
// Sends a message to the worker process.
void SendToProcess(IPC::Message* message);
// Sends a fake message to the launcher.
void SendFakeMessageToLauncher();
// Requests the worker to crash.
void CrashWorker();
// Starts the worker.
void StartWorker();
// Stops the worker.
void StopWorker();
// Quits |message_loop_|.
void QuitMainMessageLoop();
protected:
void DoLaunchProcess();
base::MessageLoopForIO message_loop_;
scoped_refptr<AutoThreadTaskRunner> task_runner_;
// Receives messages sent to the worker process.
MockWorkerListener client_listener_;
// Receives messages sent from the worker process.
MockIpcDelegate server_listener_;
// Implements WorkerProcessLauncher::Delegate.
scoped_ptr<MockProcessLauncherDelegate> launcher_delegate_;
// The name of the IPC channel.
std::string channel_name_;
// Client and server ends of the IPC channel.
scoped_ptr<IPC::ChannelProxy> channel_client_;
scoped_ptr<IPC::ChannelProxy> channel_server_;
WorkerProcessLauncher* event_handler_;
// The worker process launcher.
scoped_ptr<WorkerProcessLauncher> launcher_;
// An event that is used to emulate the worker process's handle.
ScopedHandle worker_process_;
};
WorkerProcessLauncherTest::WorkerProcessLauncherTest() : event_handler_(NULL) {
}
WorkerProcessLauncherTest::~WorkerProcessLauncherTest() {
}
void WorkerProcessLauncherTest::SetUp() {
task_runner_ = new AutoThreadTaskRunner(
message_loop_.message_loop_proxy(),
base::Bind(&WorkerProcessLauncherTest::QuitMainMessageLoop,
base::Unretained(this)));
// Set up process launcher delegate
launcher_delegate_.reset(new MockProcessLauncherDelegate());
EXPECT_CALL(*launcher_delegate_, Send(_))
.Times(AnyNumber())
.WillRepeatedly(Invoke(this, &WorkerProcessLauncherTest::SendToProcess));
EXPECT_CALL(*launcher_delegate_, CloseChannel())
.Times(AnyNumber())
.WillRepeatedly(Invoke(this,
&WorkerProcessLauncherTest::DisconnectServer));
EXPECT_CALL(*launcher_delegate_, KillProcess())
.Times(AnyNumber())
.WillRepeatedly(Invoke(this, &WorkerProcessLauncherTest::KillProcess));
// Set up IPC delegate.
EXPECT_CALL(server_listener_, OnMessageReceived(_))
.Times(0);
}
void WorkerProcessLauncherTest::TearDown() {
}
bool WorkerProcessLauncherTest::OnMessageReceived(const IPC::Message& message) {
return event_handler_->OnMessageReceived(message);
}
void WorkerProcessLauncherTest::OnChannelConnected(int32 peer_pid) {
event_handler_->OnChannelConnected(peer_pid);
}
void WorkerProcessLauncherTest::OnChannelError() {
event_handler_->OnChannelError();
}
void WorkerProcessLauncherTest::LaunchProcess(
WorkerProcessLauncher* event_handler) {
EXPECT_FALSE(event_handler_);
event_handler_ = event_handler;
DoLaunchProcess();
}
void WorkerProcessLauncherTest::LaunchProcessAndConnect(
WorkerProcessLauncher* event_handler) {
EXPECT_FALSE(event_handler_);
event_handler_ = event_handler;
DoLaunchProcess();
task_runner_->PostTask(
FROM_HERE,
base::Bind(&WorkerProcessLauncherTest::ConnectClient,
base::Unretained(this)));
}
void WorkerProcessLauncherTest::FailLaunchAndStopWorker(
WorkerProcessLauncher* event_handler) {
EXPECT_FALSE(event_handler_);
event_handler->OnFatalError();
task_runner_->PostTask(
FROM_HERE,
base::Bind(&WorkerProcessLauncherTest::StopWorker,
base::Unretained(this)));
}
void WorkerProcessLauncherTest::KillProcess() {
event_handler_ = NULL;
if (worker_process_.IsValid()) {
TerminateProcess(worker_process_.Get(), CONTROL_C_EXIT);
worker_process_.Close();
}
}
void WorkerProcessLauncherTest::TerminateWorker(DWORD exit_code) {
if (worker_process_.IsValid())
TerminateProcess(worker_process_.Get(), exit_code);
}
void WorkerProcessLauncherTest::ConnectClient() {
channel_client_ = IPC::ChannelProxy::Create(IPC::ChannelHandle(channel_name_),
IPC::Channel::MODE_CLIENT,
&client_listener_,
task_runner_);
// Pretend that |kLaunchSuccessTimeoutSeconds| passed since launching
// the worker process. This will make the backoff algorithm think that this
// launch attempt was successful and it will not delay the next launch.
launcher_->RecordSuccessfulLaunchForTest();
}
void WorkerProcessLauncherTest::DisconnectClient() {
channel_client_.reset();
}
void WorkerProcessLauncherTest::DisconnectServer() {
channel_server_.reset();
}
void WorkerProcessLauncherTest::SendToProcess(IPC::Message* message) {
if (channel_server_) {
channel_server_->Send(message);
return;
}
delete message;
}
void WorkerProcessLauncherTest::SendFakeMessageToLauncher() {
if (channel_client_)
channel_client_->Send(new ChromotingDesktopNetworkMsg_DisconnectSession());
}
void WorkerProcessLauncherTest::CrashWorker() {
launcher_->Crash(FROM_HERE);
}
void WorkerProcessLauncherTest::StartWorker() {
launcher_.reset(new WorkerProcessLauncher(
launcher_delegate_.Pass(),
&server_listener_));
launcher_->SetKillProcessTimeoutForTest(base::TimeDelta::FromMilliseconds(0));
}
void WorkerProcessLauncherTest::StopWorker() {
launcher_.reset();
DisconnectClient();
channel_name_.clear();
channel_server_.reset();
task_runner_ = NULL;
}
void WorkerProcessLauncherTest::QuitMainMessageLoop() {
message_loop_.PostTask(FROM_HERE, base::MessageLoop::QuitClosure());
}
void WorkerProcessLauncherTest::DoLaunchProcess() {
EXPECT_TRUE(event_handler_);
EXPECT_FALSE(worker_process_.IsValid());
WCHAR notepad[MAX_PATH + 1];
ASSERT_GT(ExpandEnvironmentStrings(
L"\045SystemRoot\045\\system32\\notepad.exe", notepad, MAX_PATH), 0u);
STARTUPINFOW startup_info = { 0 };
startup_info.cb = sizeof(startup_info);
PROCESS_INFORMATION temp_process_info = {};
ASSERT_TRUE(CreateProcess(NULL,
notepad,
NULL, // default process attibutes
NULL, // default thread attibutes
FALSE, // do not inherit handles
CREATE_SUSPENDED,
NULL, // no environment
NULL, // default current directory
&startup_info,
&temp_process_info));
base::win::ScopedProcessInformation process_information(temp_process_info);
worker_process_.Set(process_information.TakeProcessHandle());
ASSERT_TRUE(worker_process_.IsValid());
channel_name_ = IPC::Channel::GenerateUniqueRandomChannelID();
ScopedHandle pipe;
ASSERT_TRUE(CreateIpcChannel(channel_name_, kIpcSecurityDescriptor, &pipe));
// Wrap the pipe into an IPC channel.
channel_server_ = IPC::ChannelProxy::Create(
IPC::ChannelHandle(pipe.Get()), IPC::Channel::MODE_SERVER, this,
task_runner_);
HANDLE temp_handle;
ASSERT_TRUE(DuplicateHandle(GetCurrentProcess(),
worker_process_.Get(),
GetCurrentProcess(),
&temp_handle,
0,
FALSE,
DUPLICATE_SAME_ACCESS));
ScopedHandle copy(temp_handle);
event_handler_->OnProcessLaunched(copy.Pass());
}
TEST_F(WorkerProcessLauncherTest, Start) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(1)
.WillRepeatedly(Invoke(this, &WorkerProcessLauncherTest::LaunchProcess));
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(0);
EXPECT_CALL(server_listener_, OnPermanentError(_))
.Times(0);
StartWorker();
StopWorker();
message_loop_.Run();
}
// Starts and connects to the worker process. Expect OnChannelConnected to be
// called.
TEST_F(WorkerProcessLauncherTest, StartAndConnect) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(1)
.WillRepeatedly(Invoke(
this, &WorkerProcessLauncherTest::LaunchProcessAndConnect));
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(1)
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::StopWorker));
EXPECT_CALL(server_listener_, OnPermanentError(_))
.Times(0);
StartWorker();
message_loop_.Run();
}
// Kills the worker process after the 1st connect and expects it to be
// restarted.
TEST_F(WorkerProcessLauncherTest, Restart) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(2)
.WillRepeatedly(Invoke(
this, &WorkerProcessLauncherTest::LaunchProcessAndConnect));
Expectation first_connect =
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(2)
.WillOnce(InvokeWithoutArgs(CreateFunctor(
this, &WorkerProcessLauncherTest::TerminateWorker,
CONTROL_C_EXIT)))
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::StopWorker));
EXPECT_CALL(server_listener_, OnPermanentError(_))
.Times(0);
StartWorker();
message_loop_.Run();
}
// Drops the IPC channel to the worker process after the 1st connect and expects
// the worker process to be restarted.
TEST_F(WorkerProcessLauncherTest, DropIpcChannel) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(2)
.WillRepeatedly(Invoke(
this, &WorkerProcessLauncherTest::LaunchProcessAndConnect));
Expectation first_connect =
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(2)
.WillOnce(InvokeWithoutArgs(
this, &WorkerProcessLauncherTest::DisconnectClient))
.WillOnce(InvokeWithoutArgs(
this, &WorkerProcessLauncherTest::StopWorker));
EXPECT_CALL(server_listener_, OnPermanentError(_))
.Times(0);
StartWorker();
message_loop_.Run();
}
// Returns a permanent error exit code and expects OnPermanentError() to be
// invoked.
TEST_F(WorkerProcessLauncherTest, PermanentError) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(1)
.WillRepeatedly(Invoke(
this, &WorkerProcessLauncherTest::LaunchProcessAndConnect));
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(1)
.WillOnce(InvokeWithoutArgs(CreateFunctor(
this, &WorkerProcessLauncherTest::TerminateWorker,
kMinPermanentErrorExitCode)));
EXPECT_CALL(server_listener_, OnPermanentError(_))
.Times(1)
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::StopWorker));
StartWorker();
message_loop_.Run();
}
// Requests the worker to crash and expects it to honor the request.
TEST_F(WorkerProcessLauncherTest, Crash) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(2)
.WillRepeatedly(Invoke(
this, &WorkerProcessLauncherTest::LaunchProcessAndConnect));
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(2)
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::CrashWorker))
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::StopWorker));
EXPECT_CALL(client_listener_, OnCrash(_, _, _))
.Times(1)
.WillOnce(InvokeWithoutArgs(CreateFunctor(
this, &WorkerProcessLauncherTest::TerminateWorker,
EXCEPTION_BREAKPOINT)));
StartWorker();
message_loop_.Run();
}
// Requests the worker to crash and terminates the worker even if it does not
// comply.
TEST_F(WorkerProcessLauncherTest, CrashAnyway) {
EXPECT_CALL(*launcher_delegate_, LaunchProcess(_))
.Times(2)
.WillRepeatedly(Invoke(
this, &WorkerProcessLauncherTest::LaunchProcessAndConnect));
EXPECT_CALL(server_listener_, OnChannelConnected(_))
.Times(2)
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::CrashWorker))
.WillOnce(InvokeWithoutArgs(this,
&WorkerProcessLauncherTest::StopWorker));
// Ignore the crash request and try send another message to the launcher.
EXPECT_CALL(client_listener_, OnCrash(_, _, _))
.Times(1)
.WillOnce(InvokeWithoutArgs(
this, &WorkerProcessLauncherTest::SendFakeMessageToLauncher));
StartWorker();
message_loop_.Run();
}
} // namespace remoting
|