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
|
// 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.
#include "chrome/common/metrics_helpers.h"
#include "chrome/common/metrics_log_manager.h"
#include "testing/gtest/include/gtest/gtest.h"
#include <string>
#include <vector>
namespace {
class MetricsLogManagerTest : public testing::Test {
};
// Dummy serializer that just stores logs in memory.
class DummyLogSerializer : public MetricsLogManager::LogSerializer {
public:
virtual void SerializeLogs(const std::vector<std::string>& logs,
MetricsLogManager::LogType log_type) {
persisted_logs_[log_type] = logs;
}
virtual void DeserializeLogs(MetricsLogManager::LogType log_type,
std::vector<std::string>* logs) {
ASSERT_NE(static_cast<void*>(NULL), logs);
*logs = persisted_logs_[log_type];
}
// Returns the number of logs of the given type.
size_t TypeCount(MetricsLogManager::LogType log_type) {
return persisted_logs_[log_type].size();
}
// In-memory "persitent storage".
std::vector<std::string> persisted_logs_[2];
};
}; // namespace
TEST(MetricsLogManagerTest, StandardFlow) {
MetricsLogManager log_manager;
// Make sure a new manager has a clean slate.
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
EXPECT_FALSE(log_manager.has_unsent_logs());
// Check that the normal flow works.
MetricsLogBase* initial_log = new MetricsLogBase("id", 0, "version");
log_manager.BeginLoggingWithLog(initial_log);
EXPECT_EQ(initial_log, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
log_manager.StageCurrentLogForUpload();
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_TRUE(log_manager.has_staged_log());
EXPECT_FALSE(log_manager.staged_log_text().empty());
MetricsLogBase* second_log = new MetricsLogBase("id", 0, "version");
log_manager.BeginLoggingWithLog(second_log);
EXPECT_EQ(second_log, log_manager.current_log());
EXPECT_TRUE(log_manager.has_staged_log());
log_manager.DiscardStagedLog();
EXPECT_EQ(second_log, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
EXPECT_TRUE(log_manager.staged_log_text().empty());
EXPECT_FALSE(log_manager.has_unsent_logs());
}
TEST(MetricsLogManagerTest, AbandonedLog) {
MetricsLogManager log_manager;
MetricsLogBase* dummy_log = new MetricsLogBase("id", 0, "version");
log_manager.BeginLoggingWithLog(dummy_log);
EXPECT_EQ(dummy_log, log_manager.current_log());
log_manager.DiscardCurrentLog();
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
}
TEST(MetricsLogManagerTest, InterjectedLog) {
MetricsLogManager log_manager;
MetricsLogBase* ongoing_log = new MetricsLogBase("id", 0, "version");
MetricsLogBase* temp_log = new MetricsLogBase("id", 0, "version");
log_manager.BeginLoggingWithLog(ongoing_log);
EXPECT_EQ(ongoing_log, log_manager.current_log());
log_manager.PauseCurrentLog();
EXPECT_EQ(NULL, log_manager.current_log());
log_manager.BeginLoggingWithLog(temp_log);
EXPECT_EQ(temp_log, log_manager.current_log());
log_manager.StageCurrentLogForUpload();
EXPECT_TRUE(log_manager.has_staged_log());
log_manager.DiscardStagedLog();
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
log_manager.ResumePausedLog();
EXPECT_EQ(ongoing_log, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
EXPECT_FALSE(log_manager.has_unsent_logs());
}
TEST(MetricsLogManagerTest, StoreAndLoad) {
std::vector<std::string> initial_logs;
std::vector<std::string> ongoing_logs;
// Set up some in-progress logging in a scoped log manager simulating the
// leadup to quitting, then persist as would be done on quit.
{
MetricsLogManager log_manager;
DummyLogSerializer* serializer = new DummyLogSerializer;
log_manager.set_log_serializer(serializer);
// Simulate a log having already been unsent from a previous session.
serializer->persisted_logs_[MetricsLogManager::ONGOING_LOG].push_back("a");
EXPECT_FALSE(log_manager.has_unsent_logs());
log_manager.LoadPersistedUnsentLogs();
EXPECT_TRUE(log_manager.has_unsent_logs());
MetricsLogBase* log1 = new MetricsLogBase("id", 0, "version");
MetricsLogBase* log2 = new MetricsLogBase("id", 0, "version");
log_manager.BeginLoggingWithLog(log1);
log_manager.StageCurrentLogForUpload();
log_manager.BeginLoggingWithLog(log2);
log_manager.StoreStagedLogAsUnsent(MetricsLogManager::INITIAL_LOG);
log_manager.StageCurrentLogForUpload();
log_manager.StoreStagedLogAsUnsent(MetricsLogManager::ONGOING_LOG);
// Nothing should be written out until PersistUnsentLogs is called.
EXPECT_EQ(0U, serializer->TypeCount(MetricsLogManager::INITIAL_LOG));
EXPECT_EQ(1U, serializer->TypeCount(MetricsLogManager::ONGOING_LOG));
log_manager.PersistUnsentLogs();
EXPECT_EQ(1U, serializer->TypeCount(MetricsLogManager::INITIAL_LOG));
EXPECT_EQ(2U, serializer->TypeCount(MetricsLogManager::ONGOING_LOG));
// Save the logs to transfer over to a new serializer (since log_manager
// owns |serializer|, so it's about to go away.
initial_logs = serializer->persisted_logs_[MetricsLogManager::INITIAL_LOG];
ongoing_logs = serializer->persisted_logs_[MetricsLogManager::ONGOING_LOG];
}
// Now simulate the relaunch, ensure that the log manager restores
// everything correctly, and verify that once the are handled they are not
// re-persisted.
{
MetricsLogManager log_manager;
DummyLogSerializer* serializer = new DummyLogSerializer;
serializer->persisted_logs_[MetricsLogManager::INITIAL_LOG] = initial_logs;
serializer->persisted_logs_[MetricsLogManager::ONGOING_LOG] = ongoing_logs;
log_manager.set_log_serializer(serializer);
log_manager.LoadPersistedUnsentLogs();
EXPECT_TRUE(log_manager.has_unsent_logs());
log_manager.StageNextStoredLogForUpload();
log_manager.DiscardStagedLog();
// The initial log should be sent first; update the persisted storage to
// verify.
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, serializer->TypeCount(MetricsLogManager::INITIAL_LOG));
EXPECT_EQ(2U, serializer->TypeCount(MetricsLogManager::ONGOING_LOG));
// Handle the first ongoing log.
log_manager.StageNextStoredLogForUpload();
log_manager.DiscardStagedLog();
EXPECT_TRUE(log_manager.has_unsent_logs());
// Handle the last log.
log_manager.StageNextStoredLogForUpload();
log_manager.DiscardStagedLog();
EXPECT_FALSE(log_manager.has_unsent_logs());
// Nothing should have changed "on disk" since PersistUnsentLogs hasn't been
// called again.
EXPECT_EQ(2U, serializer->TypeCount(MetricsLogManager::ONGOING_LOG));
// Persist, and make sure nothing is left.
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, serializer->TypeCount(MetricsLogManager::INITIAL_LOG));
EXPECT_EQ(0U, serializer->TypeCount(MetricsLogManager::ONGOING_LOG));
}
}
TEST(MetricsLogManagerTest, LargeLogDiscarding) {
MetricsLogManager log_manager;
DummyLogSerializer* serializer = new DummyLogSerializer;
log_manager.set_log_serializer(serializer);
// Set the size threshold very low, to verify that it's honored.
log_manager.set_max_ongoing_log_store_size(1);
MetricsLogBase* log1 = new MetricsLogBase("id", 0, "version");
MetricsLogBase* log2 = new MetricsLogBase("id", 0, "version");
log_manager.BeginLoggingWithLog(log1);
log_manager.StageCurrentLogForUpload();
log_manager.BeginLoggingWithLog(log2);
log_manager.StoreStagedLogAsUnsent(MetricsLogManager::INITIAL_LOG);
log_manager.StageCurrentLogForUpload();
log_manager.StoreStagedLogAsUnsent(MetricsLogManager::ONGOING_LOG);
// Only the ongoing log should be written out, due to the threshold.
log_manager.PersistUnsentLogs();
EXPECT_EQ(1U, serializer->TypeCount(MetricsLogManager::INITIAL_LOG));
EXPECT_EQ(0U, serializer->TypeCount(MetricsLogManager::ONGOING_LOG));
}
|
