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
|
// 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.
#ifndef CHROMEOS_DBUS_SHILL_CLIENT_UNITTEST_BASE_H_
#define CHROMEOS_DBUS_SHILL_CLIENT_UNITTEST_BASE_H_
#include <string>
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/message_loop/message_loop.h"
#include "chromeos/dbus/dbus_method_call_status.h"
#include "chromeos/dbus/shill_client_helper.h"
#include "chromeos/dbus/shill_property_changed_observer.h"
#include "dbus/mock_bus.h"
#include "dbus/mock_object_proxy.h"
#include "dbus/object_proxy.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::MatcherInterface;
using ::testing::MatchResultListener;
using ::testing::Matcher;
using ::testing::MakeMatcher;
namespace base {
class Value;
class DictionaryValue;
} // namespace base
namespace dbus {
class MessageReader;
} // namespace dbus
namespace chromeos {
// A gmock matcher for base::Value types, so we can match them in expectations.
class ValueMatcher : public MatcherInterface<const base::Value&> {
public:
explicit ValueMatcher(const base::Value& value);
// MatcherInterface overrides.
virtual bool MatchAndExplain(const base::Value& value,
MatchResultListener* listener) const OVERRIDE;
virtual void DescribeTo(::std::ostream* os) const OVERRIDE;
virtual void DescribeNegationTo(::std::ostream* os) const OVERRIDE;
private:
scoped_ptr<base::Value> expected_value_;
};
inline Matcher<const base::Value&> ValueEq(const base::Value& expected_value) {
return MakeMatcher(new ValueMatcher(expected_value));
}
// A class to provide functionalities needed for testing Shill D-Bus clients.
class ShillClientUnittestBase : public testing::Test {
public:
// A mock Closure.
class MockClosure {
public:
MockClosure();
~MockClosure();
MOCK_METHOD0(Run, void());
base::Closure GetCallback();
};
class MockListValueCallback {
public:
MockListValueCallback();
~MockListValueCallback();
MOCK_METHOD1(Run, void(const base::ListValue& list));
ShillClientHelper::ListValueCallback GetCallback();
};
// A mock ErrorCallback.
class MockErrorCallback {
public:
MockErrorCallback();
~MockErrorCallback();
MOCK_METHOD2(Run, void(const std::string& error_name,
const std::string& error_message));
ShillClientHelper::ErrorCallback GetCallback();
};
// A mock PropertyChangedObserver that can be used to check expected values.
class MockPropertyChangeObserver
: public ShillPropertyChangedObserver {
public:
MockPropertyChangeObserver();
~MockPropertyChangeObserver();
MOCK_METHOD2(OnPropertyChanged, void(const std::string& name,
const base::Value& value));
};
explicit ShillClientUnittestBase(const std::string& interface_name,
const dbus::ObjectPath& object_path);
virtual ~ShillClientUnittestBase();
virtual void SetUp() OVERRIDE;
virtual void TearDown() OVERRIDE;
protected:
// A callback to intercept and check the method call arguments.
typedef base::Callback<void(
dbus::MessageReader* reader)> ArgumentCheckCallback;
// Sets expectations for called method name and arguments, and sets response.
void PrepareForMethodCall(const std::string& method_name,
const ArgumentCheckCallback& argument_checker,
dbus::Response* response);
// Sends property changed signal to the tested client.
void SendPropertyChangedSignal(dbus::Signal* signal);
// Checks the name and the value which are sent by PropertyChanged signal.
static void ExpectPropertyChanged(const std::string& expected_name,
const base::Value* expected_value,
const std::string& name,
const base::Value& value);
// Expects the reader to be empty.
static void ExpectNoArgument(dbus::MessageReader* reader);
// Expects the reader to have a string.
static void ExpectStringArgument(const std::string& expected_string,
dbus::MessageReader* reader);
static void ExpectArrayOfStringsArgument(
const std::vector<std::string>& expected_strings,
dbus::MessageReader* reader);
// Expects the reader to have a Value.
static void ExpectValueArgument(const base::Value* expected_value,
dbus::MessageReader* reader);
// Expects the reader to have a string and a Value.
static void ExpectStringAndValueArguments(const std::string& expected_string,
const base::Value* expected_value,
dbus::MessageReader* reader);
// Expects the reader to have a string-to-variant dictionary.
static void ExpectDictionaryValueArgument(
const base::DictionaryValue* expected_dictionary,
dbus::MessageReader* reader);
// Creates a DictionaryValue with example Service properties. The caller owns
// the result.
static base::DictionaryValue* CreateExampleServiceProperties();
// Expects the call status to be SUCCESS.
static void ExpectNoResultValue(DBusMethodCallStatus call_status);
// Checks the result and expects the call status to be SUCCESS.
static void ExpectObjectPathResult(const dbus::ObjectPath& expected_result,
DBusMethodCallStatus call_status,
const dbus::ObjectPath& result);
static void ExpectObjectPathResultWithoutStatus(
const dbus::ObjectPath& expected_result,
const dbus::ObjectPath& result);
static void ExpectBoolResultWithoutStatus(
bool expected_result,
bool result);
static void ExpectStringResultWithoutStatus(
const std::string& expected_result,
const std::string& result);
// Checks the result and expects the call status to be SUCCESS.
static void ExpectDictionaryValueResult(
const base::DictionaryValue* expected_result,
DBusMethodCallStatus call_status,
const base::DictionaryValue& result);
// Expects the |expected_result| to match the |result|.
static void ExpectDictionaryValueResultWithoutStatus(
const base::DictionaryValue* expected_result,
const base::DictionaryValue& result);
// A message loop to emulate asynchronous behavior.
base::MessageLoop message_loop_;
// The mock bus.
scoped_refptr<dbus::MockBus> mock_bus_;
private:
// Checks the requested interface name and signal name.
// Used to implement the mock proxy.
void OnConnectToSignal(
const std::string& interface_name,
const std::string& signal_name,
const dbus::ObjectProxy::SignalCallback& signal_callback,
const dbus::ObjectProxy::OnConnectedCallback& on_connected_callback);
// Checks the content of the method call and returns the response.
// Used to implement the mock proxy.
void OnCallMethod(
dbus::MethodCall* method_call,
int timeout_ms,
const dbus::ObjectProxy::ResponseCallback& response_callback);
// Checks the content of the method call and returns the response.
// Used to implement the mock proxy.
void OnCallMethodWithErrorCallback(
dbus::MethodCall* method_call,
int timeout_ms,
const dbus::ObjectProxy::ResponseCallback& response_callback,
const dbus::ObjectProxy::ErrorCallback& error_callback);
// The interface name.
const std::string interface_name_;
// The object path.
const dbus::ObjectPath object_path_;
// The mock object proxy.
scoped_refptr<dbus::MockObjectProxy> mock_proxy_;
// The PropertyChanged signal handler given by the tested client.
dbus::ObjectProxy::SignalCallback property_changed_handler_;
// The name of the method which is expected to be called.
std::string expected_method_name_;
// The response which the mock object proxy returns.
dbus::Response* response_;
// A callback to intercept and check the method call arguments.
ArgumentCheckCallback argument_checker_;
};
} // namespace chromeos
#endif // CHROMEOS_DBUS_SHILL_CLIENT_UNITTEST_BASE_H_
|
