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
|
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "remoting/base/telemetry_log_writer.h"
#include <array>
#include "base/containers/circular_deque.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/run_loop.h"
#include "base/test/task_environment.h"
#include "base/timer/timer.h"
#include "net/http/http_status_code.h"
#include "remoting/base/chromoting_event.h"
#include "remoting/base/fake_oauth_token_getter.h"
#include "remoting/base/http_status.h"
#include "remoting/base/protobuf_http_test_responder.h"
#include "remoting/proto/remoting/v1/telemetry_messages.pb.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace remoting {
namespace {
MATCHER_P(HasDurations, durations, "") {
apis::v1::CreateEventRequest request;
EXPECT_TRUE(ProtobufHttpTestResponder::ParseRequestMessage(arg, &request));
if (!request.has_payload() ||
static_cast<std::size_t>(request.payload().events_size()) !=
durations.size()) {
return false;
}
for (std::size_t i = 0; i < durations.size(); ++i) {
auto event = request.payload().events(i);
if (!event.has_session_duration() ||
event.session_duration() != durations[i]) {
return false;
}
}
return true;
}
template <typename... Args>
std::array<int, sizeof...(Args)> MakeIntArray(Args&&... args) {
return {std::forward<Args>(args)...};
}
// Sets expectation for call to CreateEvent with the set of events specified,
// identified by their session_duration field. (Session duration is incremented
// after each call to LogFakeEvent.)
//
// responder: The ProtobufHttpTestResponder on which to set the expectation.
// durations: The durations of the expected events, grouped with parentheses.
// E.g., (0) or (1, 2).
//
// Example usage:
// EXPECT_EVENTS(test_responder_, (1, 2))
// .WillOnce(DoSucceed(&test_responder_));
#define EXPECT_EVENTS(responder, durations) \
EXPECT_CALL((responder.GetMockInterceptor()), \
Run(HasDurations(MakeIntArray durations)))
// Creates a success action to be passed to WillOnce and friends.
decltype(auto) DoSucceed(ProtobufHttpTestResponder* responder) {
return [responder](const network::ResourceRequest& request) {
return responder->AddResponse(request.url.spec(),
apis::v1::CreateEventResponse());
};
}
// Creates a failure action to be passed to WillOnce and friends.
decltype(auto) DoFail(ProtobufHttpTestResponder* responder) {
return [responder](const network::ResourceRequest& request) {
return responder->AddError(request.url.spec(),
HttpStatus(HttpStatus::Code::UNAVAILABLE,
"The service is unavailable."));
};
}
} // namespace
class TelemetryLogWriterTest : public testing::Test {
public:
TelemetryLogWriterTest() {
log_writer_.Init(test_responder_.GetUrlLoaderFactory());
}
~TelemetryLogWriterTest() override {
// It's an async process to create request to send all pending events.
RunUntilIdle();
}
protected:
void LogFakeEvent() {
ChromotingEvent entry;
entry.SetInteger(ChromotingEvent::kSessionDurationKey, duration_);
duration_++;
log_writer_.Log(entry);
}
// Waits until TelemetryLog is idle.
void RunUntilIdle() {
// gRPC has its own event loop, which means sometimes the task queue will
// be empty while gRPC is working. Thus, TaskEnvironment::RunUntilIdle can't
// be used, as it would return early. Instead, TelemetryLogWriter is polled
// to determine when it has finished.
base::RunLoop run_loop;
base::RepeatingTimer timer;
// Mock clock will auto-fast-forward, so the delay here is somewhat
// arbitrary.
timer.Start(
FROM_HERE, base::Seconds(1),
base::BindRepeating(
[](TelemetryLogWriter* log_writer,
base::RepeatingClosure quit_closure) {
if (log_writer->IsIdleForTesting()) {
quit_closure.Run();
}
},
base::Unretained(&log_writer_), run_loop.QuitWhenIdleClosure()));
run_loop.Run();
}
ProtobufHttpTestResponder test_responder_;
TelemetryLogWriter log_writer_{
std::make_unique<FakeOAuthTokenGetter>(OAuthTokenGetter::SUCCESS,
OAuthTokenInfo())};
private:
// Incremented for each event to allow them to be distinguished.
int duration_ = 0;
// MOCK_TIME will fast forward through back-off delays.
base::test::SingleThreadTaskEnvironment task_environment_{
base::test::SingleThreadTaskEnvironment::TimeSource::MOCK_TIME};
};
TEST_F(TelemetryLogWriterTest, PostOneLogImmediately) {
EXPECT_EVENTS(test_responder_, (0)).WillOnce(DoSucceed(&test_responder_));
LogFakeEvent();
}
TEST_F(TelemetryLogWriterTest, PostOneLogAndHaveTwoPendingLogs) {
::testing::InSequence sequence;
// First one is sent right away. Second two are batched and sent once the
// first request has completed.
EXPECT_EVENTS(test_responder_, (0)).WillOnce(DoSucceed(&test_responder_));
EXPECT_EVENTS(test_responder_, (1, 2)).WillOnce(DoSucceed(&test_responder_));
LogFakeEvent();
LogFakeEvent();
LogFakeEvent();
}
TEST_F(TelemetryLogWriterTest, PostLogFailedAndRetry) {
EXPECT_EVENTS(test_responder_, (0))
.Times(5)
.WillRepeatedly(DoFail(&test_responder_));
LogFakeEvent();
}
TEST_F(TelemetryLogWriterTest, PostOneLogFailedResendWithTwoPendingLogs) {
EXPECT_EVENTS(test_responder_, (0)).WillOnce(DoFail(&test_responder_));
EXPECT_EVENTS(test_responder_, (0, 1, 2))
.WillOnce(DoSucceed(&test_responder_));
LogFakeEvent();
LogFakeEvent();
LogFakeEvent();
}
TEST_F(TelemetryLogWriterTest, PostThreeLogsFailedAndResendWithOnePending) {
// This tests the ordering of the resent log.
EXPECT_EVENTS(test_responder_, (0)).WillOnce(DoFail(&test_responder_));
EXPECT_EVENTS(test_responder_, (0, 1, 2))
.WillOnce(testing::DoAll(
testing::InvokeWithoutArgs([this]() { LogFakeEvent(); }),
DoFail(&test_responder_)));
EXPECT_EVENTS(test_responder_, (0, 1, 2, 3))
.WillOnce(DoSucceed(&test_responder_));
LogFakeEvent();
LogFakeEvent();
LogFakeEvent();
}
TEST_F(TelemetryLogWriterTest, PostOneFailedThenSucceed) {
EXPECT_EVENTS(test_responder_, (0))
.WillOnce(DoFail(&test_responder_))
.WillOnce(DoSucceed(&test_responder_));
LogFakeEvent();
}
} // namespace remoting
|
