blob: 96e91c07e44b3b257ac9622f16d7bc4bc2fea58e (
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
|
// Copyright (c) 2010 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 CHROME_COMMON_IPC_TEST_SINK_H_
#define CHROME_COMMON_IPC_TEST_SINK_H_
#include <utility>
#include <vector>
#include "base/basictypes.h"
#include "ipc/ipc_channel.h"
#include "ipc/ipc_message.h"
namespace IPC {
// This test sink provides a "sink" for IPC messages that are sent. It allows
// the caller to query messages received in various different ways. It is
// designed for tests for objects that use the IPC system.
//
// Typical usage:
//
// test_sink.ClearMessages();
// do_something();
//
// // We should have gotten exactly one update state message.
// EXPECT_TRUE(test_sink.GetUniqeMessageMatching(ViewHostMsg_Update::ID));
// // ...and no start load messages.
// EXPECT_FALSE(test_sink.GetFirstMessageMatching(ViewHostMsg_Start::ID));
//
// // Now inspect a message. This assumes a message that was declared like
// // this: IPC_MESSAGE_ROUTED2(ViewMsg_Foo, bool, int)
// IPC::Message* msg = test_sink.GetFirstMessageMatching(ViewMsg_Foo::ID));
// ASSERT_TRUE(msg);
// bool first_param;
// int second_param;
// ViewMsg_Foo::Read(msg, &first_param, &second_param);
//
// // Go on to the next phase of the test.
// test_sink.ClearMessages();
//
// To hook up the sink, all you need to do is call OnMessageReceived when a
// message is received.
class TestSink : public IPC::Channel {
public:
TestSink();
~TestSink();
// Interface in IPC::Channel. This copies the message to the sink and then
// deletes it.
virtual bool Send(IPC::Message* message);
// Used by the source of the messages to send the message to the sink. This
// will make a copy of the message and store it in the list.
void OnMessageReceived(const Message& msg);
// Returns the number of messages in the queue.
size_t message_count() const { return messages_.size(); }
// Clears the message queue of saved messages.
void ClearMessages();
// Returns the message at the given index in the queue. The index may be out
// of range, in which case the return value is NULL. The returned pointer will
// only be valid until another message is received or the list is cleared.
const Message* GetMessageAt(size_t index) const;
// Returns the first message with the given ID in the queue. If there is no
// message with the given ID, returns NULL. The returned pointer will only be
// valid until another message is received or the list is cleared.
const Message* GetFirstMessageMatching(uint32 id) const;
// Returns the message with the given ID in the queue. If there is no such
// message or there is more than one of that message, this will return NULL
// (with the expectation that you'll do an ASSERT_TRUE() on the result).
// The returned pointer will only be valid until another message is received
// or the list is cleared.
const Message* GetUniqueMessageMatching(uint32 id) const;
private:
// The actual list of received messages.
std::vector<Message> messages_;
DISALLOW_COPY_AND_ASSIGN(TestSink);
};
} // namespace IPC
#endif // CHROME_COMMON_IPC_TEST_SINK_H_
|
