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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/test/metrics/histogram_tester.h"
#include <memory>
#include <string>
#include "base/metrics/histogram_macros.h"
#include "base/metrics/histogram_samples.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest-spi.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
namespace {
using ::testing::ElementsAre;
using ::testing::IsEmpty;
using ::testing::Pair;
using ::testing::UnorderedElementsAre;
const char kHistogram1[] = "Test1";
const char kHistogram2[] = "Test2";
const char kHistogram3[] = "Test3";
const char kHistogram4[] = "Test4";
const char kHistogram5[] = "Test5";
const char kHistogram6[] = "Test6";
TEST(HistogramTesterTest, Scope) {
// Record a histogram before the creation of the recorder.
UMA_HISTOGRAM_BOOLEAN(kHistogram1, true);
HistogramTester tester;
// Verify that no histogram is recorded.
tester.ExpectTotalCount(kHistogram1, 0);
// Record a histogram after the creation of the recorder.
UMA_HISTOGRAM_BOOLEAN(kHistogram1, true);
// Verify that one histogram is recorded.
std::unique_ptr<HistogramSamples> samples(
tester.GetHistogramSamplesSinceCreation(kHistogram1));
EXPECT_TRUE(samples);
EXPECT_EQ(1, samples->TotalCount());
}
TEST(HistogramTesterTest, GetHistogramSamplesSinceCreationNotNull) {
// Chose the histogram name uniquely, to ensure nothing was recorded for it so
// far.
static const char kHistogram[] =
"GetHistogramSamplesSinceCreationNotNullHistogram";
HistogramTester tester;
// Verify that the returned samples are empty but not null.
std::unique_ptr<HistogramSamples> samples(
tester.GetHistogramSamplesSinceCreation(kHistogram1));
EXPECT_TRUE(samples);
tester.ExpectTotalCount(kHistogram, 0);
}
TEST(HistogramTesterTest, TestUniqueSample) {
HistogramTester tester;
// Emit '2' three times.
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
tester.ExpectUniqueSample(kHistogram2, 2, 3);
tester.ExpectUniqueTimeSample(kHistogram2, base::Milliseconds(2), 3);
}
// Verify that the expectation is violated if the bucket contains an incorrect
// number of samples.
TEST(HistogramTesterTest, TestUniqueSample_TooManySamplesInActualBucket) {
auto failing_code = [] {
HistogramTester tester;
// Emit '2' four times.
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
// Expect exactly three samples in bucket 2. This is supposed to fail.
tester.ExpectUniqueSample(kHistogram2, 2, 3);
};
EXPECT_NONFATAL_FAILURE(failing_code(),
"Histogram \"Test2\" did not meet its expectations.");
}
// Verify that the expectation is violated if the bucket contains the correct
// number of samples but another bucket contains extra samples.
TEST(HistogramTesterTest, TestUniqueSample_OneExtraSampleInWrongBucket) {
auto failing_code = [] {
HistogramTester tester;
// Emit '2' three times.
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
// Emit one unexpected '3'.
UMA_HISTOGRAM_COUNTS_100(kHistogram2, 3);
// Expect exactly three samples in bucket 2. This is supposed to fail.
tester.ExpectUniqueSample(kHistogram2, 2, 3);
};
EXPECT_NONFATAL_FAILURE(failing_code(),
"Histogram \"Test2\" did not meet its expectations.");
}
TEST(HistogramTesterTest, TestBucketsSample) {
HistogramTester tester;
UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
UMA_HISTOGRAM_COUNTS_100(kHistogram3, 3);
tester.ExpectBucketCount(kHistogram3, 2, 4);
tester.ExpectBucketCount(kHistogram3, 3, 1);
tester.ExpectTotalCount(kHistogram3, 5);
}
TEST(HistogramTesterTest, TestBucketsSampleWithScope) {
// Emit values twice, once before the tester creation and once after.
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 2);
HistogramTester tester;
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 3);
tester.ExpectBucketCount(kHistogram4, 2, 0);
tester.ExpectBucketCount(kHistogram4, 3, 1);
tester.ExpectTotalCount(kHistogram4, 1);
}
TEST(HistogramTesterTest, TestGetAllSamples) {
HistogramTester tester;
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 2, 5);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 3, 5);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 3, 5);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 5, 5);
EXPECT_THAT(tester.GetAllSamples(kHistogram5),
ElementsAre(Bucket(2, 1), Bucket(3, 2), Bucket(5, 1)));
}
TEST(HistogramTesterTest, TestGetAllSamples_NoSamples) {
HistogramTester tester;
EXPECT_THAT(tester.GetAllSamples(kHistogram5), IsEmpty());
}
TEST(HistogramTesterTest, TestGetAllSamplesForPrefixMultipleHistograms) {
HistogramTester tester;
UMA_HISTOGRAM_ENUMERATION("SomePrefix", 1, 5);
UMA_HISTOGRAM_ENUMERATION("SomePrefix.Foo", 2, 5);
UMA_HISTOGRAM_ENUMERATION("SomePrefix.Bar", 3, 5);
EXPECT_THAT(
tester.GetAllSamplesForPrefix("SomePrefix"),
UnorderedElementsAre(Pair("SomePrefix", BucketsAre(Bucket(1, 1))),
Pair("SomePrefix.Foo", BucketsAre(Bucket(2, 1))),
Pair("SomePrefix.Bar", BucketsAre(Bucket(3, 1)))));
}
TEST(HistogramTesterTest, TestGetAllSamplesForPrefixMultipleBuckets) {
HistogramTester tester;
UMA_HISTOGRAM_ENUMERATION("SomePrefix.Foo", 1, 5);
UMA_HISTOGRAM_ENUMERATION("SomePrefix.Foo", 1, 5);
UMA_HISTOGRAM_ENUMERATION("SomePrefix.Foo", 2, 5);
EXPECT_THAT(tester.GetAllSamplesForPrefix("SomePrefix"),
UnorderedElementsAre(Pair(
"SomePrefix.Foo", BucketsAre(Bucket(1, 2), Bucket(2, 1)))));
}
TEST(HistogramTesterTest, TestGetAllSamplesForPrefixIgnoresOtherHistograms) {
HistogramTester tester;
UMA_HISTOGRAM_ENUMERATION("SomePrefix.Foo", 1, 5);
UMA_HISTOGRAM_ENUMERATION("OtherPrefix.Foo", 2, 5);
EXPECT_THAT(
tester.GetAllSamplesForPrefix("SomePrefix"),
UnorderedElementsAre(Pair("SomePrefix.Foo", BucketsAre(Bucket(1, 1)))));
}
TEST(HistogramTesterTest, TestGetAllSamplesForPrefixNoSamples) {
HistogramTester tester;
EXPECT_THAT(tester.GetAllSamplesForPrefix("SomePrefix"), IsEmpty());
}
TEST(HistogramTesterTest, TestGetTotalSum) {
// Emit values twice, once before the tester creation and once after.
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 2);
HistogramTester tester;
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 3);
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 4);
EXPECT_EQ(7, tester.GetTotalSum(kHistogram4));
}
TEST(HistogramTesterTest, TestGetTotalCountsForPrefix) {
HistogramTester tester;
UMA_HISTOGRAM_ENUMERATION("Test1.Test2.Test3", 2, 5);
// Regression check for bug https://crbug.com/659977.
EXPECT_TRUE(tester.GetTotalCountsForPrefix("Test2.").empty());
EXPECT_EQ(1u, tester.GetTotalCountsForPrefix("Test1.").size());
}
TEST(HistogramTesterTest, TestGetAllChangedHistograms) {
// Emit multiple values, some before tester creation.
UMA_HISTOGRAM_COUNTS_100(kHistogram6, true);
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 4);
HistogramTester tester;
UMA_HISTOGRAM_COUNTS_100(kHistogram4, 3);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 2, 5);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 3, 5);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 4, 5);
UMA_HISTOGRAM_ENUMERATION(kHistogram5, 5, 5);
UMA_HISTOGRAM_ENUMERATION("Test1.Test2.Test3", 2, 5);
std::string results = tester.GetAllHistogramsRecorded();
EXPECT_EQ(std::string::npos, results.find("Histogram: Test1 recorded"));
EXPECT_NE(std::string::npos,
results.find("Histogram: Test4 recorded 1 new samples"));
EXPECT_NE(std::string::npos,
results.find("Histogram: Test5 recorded 4 new samples"));
EXPECT_NE(
std::string::npos,
results.find("Histogram: Test1.Test2.Test3 recorded 1 new samples"));
}
TEST(HistogramTesterTest, MissingHistogramMeansEmptyBuckets) {
// When a histogram hasn't been instantiated, expecting counts of zero should
// still succeed.
static const char kHistogram[] = "MissingHistogramMeansEmptyBucketsHistogram";
HistogramTester tester;
tester.ExpectBucketCount(kHistogram, 42, 0);
tester.ExpectTotalCount(kHistogram, 0);
EXPECT_TRUE(tester.GetAllSamples(kHistogram).empty());
EXPECT_EQ(0, tester.GetTotalSum(kHistogram));
EXPECT_EQ(0, tester.GetBucketCount(kHistogram, 42));
EXPECT_EQ(0,
tester.GetHistogramSamplesSinceCreation(kHistogram)->TotalCount());
}
TEST(HistogramTesterTest, BucketsAre) {
// Auxiliary functions for keeping the lines short.
auto a = [](std::vector<Bucket> b) { return b; };
auto b = [](base::Histogram::Sample32 min, base::Histogram::Count32 count) {
return Bucket(min, count);
};
using ::testing::Not;
EXPECT_THAT(a({}), BucketsAre());
EXPECT_THAT(a({}), BucketsAre(b(0, 0)));
EXPECT_THAT(a({}), BucketsAre(b(1, 0)));
EXPECT_THAT(a({}), BucketsAre(b(0, 0), b(1, 0)));
EXPECT_THAT(a({}), Not(BucketsAre(b(1, 1))));
EXPECT_THAT(a({b(1, 1)}), BucketsAre(b(1, 1)));
EXPECT_THAT(a({b(1, 1)}), BucketsAre(b(0, 0), b(1, 1)));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre()));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(1, 0))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(2, 1))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(2, 2))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0), b(1, 0))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0), b(1, 1), b(2, 2))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0), b(1, 0), b(2, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsAre(b(1, 1), b(2, 2)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsAre(b(0, 0), b(1, 1), b(2, 2)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre()));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(0, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(1, 1))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(2, 2))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(0, 0), b(1, 1))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(1, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(2, 1))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(0, 0), b(1, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}),
Not(BucketsAre(b(0, 0), b(1, 0), b(2, 0))));
}
TEST(HistogramTesterTest, BucketsInclude) {
// Auxiliary function for the "actual" values to shorten lines.
auto a = [](std::vector<Bucket> b) { return b; };
auto b = [](base::Histogram::Sample32 min, base::Histogram::Count32 count) {
return Bucket(min, count);
};
using ::testing::Not;
EXPECT_THAT(a({}), BucketsInclude());
EXPECT_THAT(a({}), BucketsInclude(b(0, 0)));
EXPECT_THAT(a({}), BucketsInclude(b(1, 0)));
EXPECT_THAT(a({}), BucketsInclude(b(0, 0), b(1, 0)));
EXPECT_THAT(a({}), Not(BucketsInclude(b(1, 1))));
EXPECT_THAT(a({b(1, 1)}), BucketsInclude());
EXPECT_THAT(a({b(1, 1)}), BucketsInclude(b(0, 0)));
EXPECT_THAT(a({b(1, 1)}), BucketsInclude(b(1, 1)));
EXPECT_THAT(a({b(1, 1)}), BucketsInclude(b(0, 0), b(1, 1)));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(1, 0))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(2, 1))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(2, 2))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(0, 0), b(1, 0))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(0, 0), b(1, 1), b(2, 2))));
EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(0, 0), b(1, 0), b(2, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude());
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(0, 0)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(1, 1)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(2, 2)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(0, 0), b(1, 1)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(1, 1), b(2, 2)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(0, 0), b(1, 1), b(2, 2)));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsInclude(b(1, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsInclude(b(2, 1))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsInclude(b(0, 0), b(1, 0))));
EXPECT_THAT(a({b(1, 1), b(2, 2)}),
Not(BucketsInclude(b(0, 0), b(1, 0), b(2, 0))));
}
} // namespace
} // namespace base
|
