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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
base / metrics / histogram_unittest.cc [blame]
// Copyright 2012 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/metrics/histogram.h"
#include <limits.h>
#include <stddef.h>
#include <stdint.h>
#include <climits>
#include <memory>
#include <string>
#include <vector>
#include "base/lazy_instance.h"
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/metrics/bucket_ranges.h"
#include "base/metrics/dummy_histogram.h"
#include "base/metrics/histogram_macros.h"
#include "base/metrics/metrics_hashes.h"
#include "base/metrics/persistent_histogram_allocator.h"
#include "base/metrics/persistent_memory_allocator.h"
#include "base/metrics/record_histogram_checker.h"
#include "base/metrics/sample_vector.h"
#include "base/metrics/statistics_recorder.h"
#include "base/pickle.h"
#include "base/strings/stringprintf.h"
#include "base/test/gtest_util.h"
#include "base/time/time.h"
#include "base/values.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace base {
namespace {
const char kExpiredHistogramName[] = "ExpiredHistogram";
// Test implementation of RecordHistogramChecker interface.
class TestRecordHistogramChecker : public RecordHistogramChecker {
public:
~TestRecordHistogramChecker() override = default;
// RecordHistogramChecker:
bool ShouldRecord(uint32_t histogram_hash) const override {
return histogram_hash != HashMetricNameAs32Bits(kExpiredHistogramName);
}
};
} // namespace
// Test parameter indicates if a persistent memory allocator should be used
// for histogram allocation. False will allocate histograms from the process
// heap.
class HistogramTest : public testing::TestWithParam<bool> {
public:
HistogramTest(const HistogramTest&) = delete;
HistogramTest& operator=(const HistogramTest&) = delete;
protected:
using CountAndBucketData = base::Histogram::CountAndBucketData;
const int32_t kAllocatorMemorySize = 8 << 20; // 8 MiB
HistogramTest() : use_persistent_histogram_allocator_(GetParam()) {}
void SetUp() override {
if (use_persistent_histogram_allocator_)
CreatePersistentHistogramAllocator();
// Each test will have a clean state (no Histogram / BucketRanges
// registered).
InitializeStatisticsRecorder();
}
void TearDown() override {
if (allocator_) {
ASSERT_FALSE(allocator_->IsFull());
ASSERT_FALSE(allocator_->IsCorrupt());
}
UninitializeStatisticsRecorder();
DestroyPersistentHistogramAllocator();
}
void InitializeStatisticsRecorder() {
DCHECK(!statistics_recorder_);
statistics_recorder_ = StatisticsRecorder::CreateTemporaryForTesting();
}
void UninitializeStatisticsRecorder() { statistics_recorder_.reset(); }
void CreatePersistentHistogramAllocator() {
GlobalHistogramAllocator::CreateWithLocalMemory(kAllocatorMemorySize, 0,
"HistogramAllocatorTest");
allocator_ = GlobalHistogramAllocator::Get()->memory_allocator();
}
void DestroyPersistentHistogramAllocator() {
allocator_ = nullptr;
GlobalHistogramAllocator::ReleaseForTesting();
}
std::unique_ptr<SampleVector> SnapshotAllSamples(Histogram* h) {
return h->SnapshotAllSamples();
}
CountAndBucketData GetCountAndBucketData(Histogram* histogram) {
// A simple wrapper around |GetCountAndBucketData| to make it visible for
// testing.
return histogram->GetCountAndBucketData();
}
const bool use_persistent_histogram_allocator_;
std::unique_ptr<StatisticsRecorder> statistics_recorder_;
std::unique_ptr<char[]> allocator_memory_;
raw_ptr<PersistentMemoryAllocator> allocator_ = nullptr;
};
// Run all HistogramTest cases with both heap and persistent memory.
INSTANTIATE_TEST_SUITE_P(HeapAndPersistent, HistogramTest, testing::Bool());
// Check for basic syntax and use.
TEST_P(HistogramTest, BasicTest) {
// Try basic construction
HistogramBase* histogram = Histogram::FactoryGet("TestHistogram", 1, 1000, 10,
HistogramBase::kNoFlags);
EXPECT_TRUE(histogram);
HistogramBase* linear_histogram = LinearHistogram::FactoryGet(
"TestLinearHistogram", 1, 1000, 10, HistogramBase::kNoFlags);
EXPECT_TRUE(linear_histogram);
std::vector<int> custom_ranges;
custom_ranges.push_back(1);
custom_ranges.push_back(5);
HistogramBase* custom_histogram = CustomHistogram::FactoryGet(
"TestCustomHistogram", custom_ranges, HistogramBase::kNoFlags);
EXPECT_TRUE(custom_histogram);
// Macros that create histograms have an internal static variable which will
// continue to point to those from the very first run of this method even
// during subsequent runs.
static bool already_run = false;
if (already_run)
return;
already_run = true;
// Use standard macros (but with fixed samples)
LOCAL_HISTOGRAM_TIMES("Test2Histogram", Days(1));
LOCAL_HISTOGRAM_COUNTS("Test3Histogram", 30);
LOCAL_HISTOGRAM_ENUMERATION("Test6Histogram", 129, 130);
}
// Check that the macro correctly matches histograms by name and records their
// data together.
TEST_P(HistogramTest, NameMatchTest) {
// Macros that create histograms have an internal static variable which will
// continue to point to those from the very first run of this method even
// during subsequent runs.
static bool already_run = false;
if (already_run)
return;
already_run = true;
LOCAL_HISTOGRAM_PERCENTAGE("DuplicatedHistogram", 10);
LOCAL_HISTOGRAM_PERCENTAGE("DuplicatedHistogram", 10);
HistogramBase* histogram = LinearHistogram::FactoryGet(
"DuplicatedHistogram", 1, 101, 102, HistogramBase::kNoFlags);
std::unique_ptr<HistogramSamples> samples = histogram->SnapshotSamples();
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(2, samples->GetCount(10));
}
// Check that delta calculations work correctly.
TEST_P(HistogramTest, DeltaTest) {
HistogramBase* histogram = Histogram::FactoryGet("DeltaHistogram", 1, 64, 8,
HistogramBase::kNoFlags);
histogram->Add(1);
histogram->Add(10);
histogram->Add(50);
std::unique_ptr<HistogramSamples> samples = histogram->SnapshotDelta();
EXPECT_EQ(3, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(10));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(61, samples->sum());
samples = histogram->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(0, samples->sum());
histogram->Add(10);
histogram->Add(10);
samples = histogram->SnapshotDelta();
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(2, samples->GetCount(10));
EXPECT_EQ(20, samples->sum());
samples = histogram->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(0, samples->sum());
// Verify that the logged samples contain everything emitted.
samples = histogram->SnapshotSamples();
EXPECT_EQ(5, samples->TotalCount());
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(3, samples->GetCount(10));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(81, samples->sum());
}
// Check that delta calculations work correctly with SnapshotUnloggedSamples()
// and MarkSamplesAsLogged().
TEST_P(HistogramTest, UnloggedSamplesTest) {
HistogramBase* histogram = Histogram::FactoryGet("DeltaHistogram", 1, 64, 8,
HistogramBase::kNoFlags);
histogram->Add(1);
histogram->Add(10);
histogram->Add(50);
std::unique_ptr<HistogramSamples> samples =
histogram->SnapshotUnloggedSamples();
EXPECT_EQ(3, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(10));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(61, samples->sum());
// Snapshot unlogged samples again, which would be the same as above.
samples = histogram->SnapshotUnloggedSamples();
EXPECT_EQ(3, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(10));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(61, samples->sum());
// Verify that marking the samples as logged works correctly, and that
// SnapshotDelta() will not pick up the samples.
histogram->MarkSamplesAsLogged(*samples);
samples = histogram->SnapshotUnloggedSamples();
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(0, samples->sum());
samples = histogram->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(0, samples->sum());
// Similarly, verify that SnapshotDelta() marks the samples as logged.
histogram->Add(1);
histogram->Add(10);
histogram->Add(50);
samples = histogram->SnapshotDelta();
EXPECT_EQ(3, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(10));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(61, samples->sum());
samples = histogram->SnapshotUnloggedSamples();
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(0, samples->sum());
// Verify that the logged samples contain everything emitted.
samples = histogram->SnapshotSamples();
EXPECT_EQ(6, samples->TotalCount());
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
EXPECT_EQ(2, samples->GetCount(1));
EXPECT_EQ(2, samples->GetCount(10));
EXPECT_EQ(2, samples->GetCount(50));
EXPECT_EQ(122, samples->sum());
}
// Check that final-delta calculations work correctly.
TEST_P(HistogramTest, FinalDeltaTest) {
HistogramBase* histogram = Histogram::FactoryGet("FinalDeltaHistogram", 1, 64,
8, HistogramBase::kNoFlags);
histogram->Add(1);
histogram->Add(10);
histogram->Add(50);
std::unique_ptr<HistogramSamples> samples = histogram->SnapshotDelta();
EXPECT_EQ(3, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(10));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
histogram->Add(2);
histogram->Add(50);
samples = histogram->SnapshotFinalDelta();
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(2));
EXPECT_EQ(1, samples->GetCount(50));
EXPECT_EQ(samples->TotalCount(), samples->redundant_count());
}
// Check that IsDefinitelyEmpty() works with the results of SnapshotDelta().
TEST_P(HistogramTest, IsDefinitelyEmpty_SnapshotDelta) {
HistogramBase* histogram = Histogram::FactoryGet("DeltaHistogram", 1, 64, 8,
HistogramBase::kNoFlags);
// No samples initially.
EXPECT_TRUE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
// Verify when |histogram| is using SingleSample.
histogram->Add(1);
EXPECT_FALSE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
EXPECT_TRUE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
histogram->Add(10);
histogram->Add(10);
EXPECT_FALSE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
EXPECT_TRUE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
// Verify when |histogram| uses a counts array instead of SingleSample.
histogram->Add(1);
histogram->Add(50);
EXPECT_FALSE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
EXPECT_TRUE(histogram->SnapshotDelta()->IsDefinitelyEmpty());
}
TEST_P(HistogramTest, ExponentialRangesTest) {
// Check that we got a nice exponential when there was enough room.
BucketRanges ranges(9);
Histogram::InitializeBucketRanges(1, 64, &ranges);
EXPECT_EQ(0, ranges.range(0));
int power_of_2 = 1;
for (int i = 1; i < 8; i++) {
EXPECT_EQ(power_of_2, ranges.range(i));
power_of_2 *= 2;
}
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges.range(8));
// Check the corresponding Histogram will use the correct ranges.
Histogram* histogram = static_cast<Histogram*>(
Histogram::FactoryGet("Histogram", 1, 64, 8, HistogramBase::kNoFlags));
EXPECT_TRUE(ranges.Equals(histogram->bucket_ranges()));
// When bucket count is limited, exponential ranges will partially look like
// linear.
BucketRanges ranges2(16);
Histogram::InitializeBucketRanges(1, 32, &ranges2);
EXPECT_EQ(0, ranges2.range(0));
EXPECT_EQ(1, ranges2.range(1));
EXPECT_EQ(2, ranges2.range(2));
EXPECT_EQ(3, ranges2.range(3));
EXPECT_EQ(4, ranges2.range(4));
EXPECT_EQ(5, ranges2.range(5));
EXPECT_EQ(6, ranges2.range(6));
EXPECT_EQ(7, ranges2.range(7));
EXPECT_EQ(9, ranges2.range(8));
EXPECT_EQ(11, ranges2.range(9));
EXPECT_EQ(14, ranges2.range(10));
EXPECT_EQ(17, ranges2.range(11));
EXPECT_EQ(21, ranges2.range(12));
EXPECT_EQ(26, ranges2.range(13));
EXPECT_EQ(32, ranges2.range(14));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges2.range(15));
// Check the corresponding Histogram will use the correct ranges.
Histogram* histogram2 = static_cast<Histogram*>(
Histogram::FactoryGet("Histogram2", 1, 32, 15, HistogramBase::kNoFlags));
EXPECT_TRUE(ranges2.Equals(histogram2->bucket_ranges()));
}
TEST_P(HistogramTest, LinearRangesTest) {
BucketRanges ranges(9);
LinearHistogram::InitializeBucketRanges(1, 7, &ranges);
// Gets a nice linear set of bucket ranges.
for (int i = 0; i < 8; i++)
EXPECT_EQ(i, ranges.range(i));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges.range(8));
// The correspoding LinearHistogram should use the correct ranges.
Histogram* histogram = static_cast<Histogram*>(
LinearHistogram::FactoryGet("Linear", 1, 7, 8, HistogramBase::kNoFlags));
EXPECT_TRUE(ranges.Equals(histogram->bucket_ranges()));
// Linear ranges are not divisible.
BucketRanges ranges2(6);
LinearHistogram::InitializeBucketRanges(1, 6, &ranges2);
EXPECT_EQ(0, ranges2.range(0));
EXPECT_EQ(1, ranges2.range(1));
EXPECT_EQ(3, ranges2.range(2));
EXPECT_EQ(4, ranges2.range(3));
EXPECT_EQ(6, ranges2.range(4));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges2.range(5));
// The correspoding LinearHistogram should use the correct ranges.
Histogram* histogram2 = static_cast<Histogram*>(
LinearHistogram::FactoryGet("Linear2", 1, 6, 5, HistogramBase::kNoFlags));
EXPECT_TRUE(ranges2.Equals(histogram2->bucket_ranges()));
}
TEST_P(HistogramTest, SingleValueEnumerationHistogram) {
// Make sure its possible to construct a linear histogram with only the two
// required outlier buckets (underflow and overflow).
HistogramBase* histogram = LinearHistogram::FactoryGet(
"SingleValueEnum", 1, 1, 2, HistogramBase::kNoFlags);
EXPECT_TRUE(histogram);
// Make sure the macros work properly. This can only be run when
// there is no persistent allocator which can be discarded and leave
// dangling pointers.
if (!use_persistent_histogram_allocator_) {
enum EnumWithMax {
kSomething = 0,
kMaxValue = kSomething,
};
UMA_HISTOGRAM_ENUMERATION("h1", kSomething);
}
}
TEST_P(HistogramTest, ArrayToCustomEnumRangesTest) {
const HistogramBase::Sample ranges[3] = {5, 10, 20};
std::vector<HistogramBase::Sample> ranges_vec =
CustomHistogram::ArrayToCustomEnumRanges(ranges);
ASSERT_EQ(6u, ranges_vec.size());
EXPECT_EQ(5, ranges_vec[0]);
EXPECT_EQ(6, ranges_vec[1]);
EXPECT_EQ(10, ranges_vec[2]);
EXPECT_EQ(11, ranges_vec[3]);
EXPECT_EQ(20, ranges_vec[4]);
EXPECT_EQ(21, ranges_vec[5]);
}
TEST_P(HistogramTest, CustomHistogramTest) {
// A well prepared custom ranges.
std::vector<HistogramBase::Sample> custom_ranges;
custom_ranges.push_back(1);
custom_ranges.push_back(2);
Histogram* histogram = static_cast<Histogram*>(CustomHistogram::FactoryGet(
"TestCustomHistogram1", custom_ranges, HistogramBase::kNoFlags));
const BucketRanges* ranges = histogram->bucket_ranges();
ASSERT_EQ(4u, ranges->size());
EXPECT_EQ(0, ranges->range(0)); // Auto added.
EXPECT_EQ(1, ranges->range(1));
EXPECT_EQ(2, ranges->range(2));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges->range(3)); // Auto added.
// A unordered custom ranges.
custom_ranges.clear();
custom_ranges.push_back(2);
custom_ranges.push_back(1);
histogram = static_cast<Histogram*>(CustomHistogram::FactoryGet(
"TestCustomHistogram2", custom_ranges, HistogramBase::kNoFlags));
ranges = histogram->bucket_ranges();
ASSERT_EQ(4u, ranges->size());
EXPECT_EQ(0, ranges->range(0));
EXPECT_EQ(1, ranges->range(1));
EXPECT_EQ(2, ranges->range(2));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges->range(3));
// A custom ranges with duplicated values.
custom_ranges.clear();
custom_ranges.push_back(4);
custom_ranges.push_back(1);
custom_ranges.push_back(4);
histogram = static_cast<Histogram*>(CustomHistogram::FactoryGet(
"TestCustomHistogram3", custom_ranges, HistogramBase::kNoFlags));
ranges = histogram->bucket_ranges();
ASSERT_EQ(4u, ranges->size());
EXPECT_EQ(0, ranges->range(0));
EXPECT_EQ(1, ranges->range(1));
EXPECT_EQ(4, ranges->range(2));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges->range(3));
}
TEST_P(HistogramTest, CustomHistogramWithOnly2Buckets) {
// This test exploits the fact that the CustomHistogram can have 2 buckets,
// while the base class Histogram is *supposed* to have at least 3 buckets.
// We should probably change the restriction on the base class (or not inherit
// the base class!).
std::vector<HistogramBase::Sample> custom_ranges;
custom_ranges.push_back(4);
Histogram* histogram = static_cast<Histogram*>(CustomHistogram::FactoryGet(
"2BucketsCustomHistogram", custom_ranges, HistogramBase::kNoFlags));
const BucketRanges* ranges = histogram->bucket_ranges();
ASSERT_EQ(3u, ranges->size());
EXPECT_EQ(0, ranges->range(0));
EXPECT_EQ(4, ranges->range(1));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges->range(2));
}
TEST_P(HistogramTest, AddCountTest) {
const size_t kBucketCount = 50;
Histogram* histogram = static_cast<Histogram*>(Histogram::FactoryGet(
"AddCountHistogram", 10, 100, kBucketCount, HistogramBase::kNoFlags));
histogram->AddCount(20, 15);
histogram->AddCount(30, 14);
std::unique_ptr<HistogramSamples> samples = histogram->SnapshotSamples();
EXPECT_EQ(29, samples->TotalCount());
EXPECT_EQ(15, samples->GetCount(20));
EXPECT_EQ(14, samples->GetCount(30));
histogram->AddCount(20, 25);
histogram->AddCount(30, 24);
std::unique_ptr<HistogramSamples> samples2 = histogram->SnapshotSamples();
EXPECT_EQ(78, samples2->TotalCount());
EXPECT_EQ(40, samples2->GetCount(20));
EXPECT_EQ(38, samples2->GetCount(30));
}
TEST_P(HistogramTest, AddCount_LargeValuesDontOverflow) {
const size_t kBucketCount = 50;
Histogram* histogram = static_cast<Histogram*>(
Histogram::FactoryGet("AddCountHistogram", 10, 1000000000, kBucketCount,
HistogramBase::kNoFlags));
histogram->AddCount(200000000, 15);
histogram->AddCount(300000000, 14);
std::unique_ptr<HistogramSamples> samples = histogram->SnapshotSamples();
EXPECT_EQ(29, samples->TotalCount());
EXPECT_EQ(15, samples->GetCount(200000000));
EXPECT_EQ(14, samples->GetCount(300000000));
histogram->AddCount(200000000, 25);
histogram->AddCount(300000000, 24);
std::unique_ptr<HistogramSamples> samples2 = histogram->SnapshotSamples();
EXPECT_EQ(78, samples2->TotalCount());
EXPECT_EQ(40, samples2->GetCount(200000000));
EXPECT_EQ(38, samples2->GetCount(300000000));
EXPECT_EQ(19400000000LL, samples2->sum());
}
// Some metrics are designed so that they are guaranteed not to overflow between
// snapshots, but could overflow over a long-running session.
// Make sure that counts returned by Histogram::SnapshotDelta do not overflow
// even when a total count (returned by Histogram::SnapshotSample) does.
TEST_P(HistogramTest, AddCount_LargeCountsDontOverflow) {
const size_t kBucketCount = 10;
Histogram* histogram = static_cast<Histogram*>(Histogram::FactoryGet(
"AddCountHistogram", 10, 50, kBucketCount, HistogramBase::kNoFlags));
const int count = (1 << 30) - 1;
// Repeat N times to make sure that there is no internal value overflow.
for (int i = 0; i < 10; ++i) {
histogram->AddCount(42, count);
std::unique_ptr<HistogramSamples> samples = histogram->SnapshotDelta();
EXPECT_EQ(count, samples->TotalCount());
EXPECT_EQ(count, samples->GetCount(42));
}
}
// Make sure histogram handles out-of-bounds data gracefully.
TEST_P(HistogramTest, BoundsTest) {
const size_t kBucketCount = 50;
Histogram* histogram = static_cast<Histogram*>(Histogram::FactoryGet(
"Bounded", 10, 100, kBucketCount, HistogramBase::kNoFlags));
// Put two samples "out of bounds" above and below.
histogram->Add(5);
histogram->Add(-50);
histogram->Add(100);
histogram->Add(10000);
// Verify they landed in the underflow, and overflow buckets.
std::unique_ptr<SampleVector> samples = histogram->SnapshotAllSamples();
EXPECT_EQ(2, samples->GetCountAtIndex(0));
EXPECT_EQ(0, samples->GetCountAtIndex(1));
size_t array_size = histogram->bucket_count();
EXPECT_EQ(kBucketCount, array_size);
EXPECT_EQ(0, samples->GetCountAtIndex(array_size - 2));
EXPECT_EQ(2, samples->GetCountAtIndex(array_size - 1));
std::vector<int> custom_ranges;
custom_ranges.push_back(10);
custom_ranges.push_back(50);
custom_ranges.push_back(100);
Histogram* test_custom_histogram = static_cast<Histogram*>(
CustomHistogram::FactoryGet("TestCustomRangeBoundedHistogram",
custom_ranges, HistogramBase::kNoFlags));
// Put two samples "out of bounds" above and below.
test_custom_histogram->Add(5);
test_custom_histogram->Add(-50);
test_custom_histogram->Add(100);
test_custom_histogram->Add(1000);
test_custom_histogram->Add(INT_MAX);
// Verify they landed in the underflow, and overflow buckets.
std::unique_ptr<SampleVector> custom_samples =
test_custom_histogram->SnapshotAllSamples();
EXPECT_EQ(2, custom_samples->GetCountAtIndex(0));
EXPECT_EQ(0, custom_samples->GetCountAtIndex(1));
size_t bucket_count = test_custom_histogram->bucket_count();
EXPECT_EQ(0, custom_samples->GetCountAtIndex(bucket_count - 2));
EXPECT_EQ(3, custom_samples->GetCountAtIndex(bucket_count - 1));
}
// Check to be sure samples land as expected is "correct" buckets.
TEST_P(HistogramTest, BucketPlacementTest) {
Histogram* histogram = static_cast<Histogram*>(
Histogram::FactoryGet("Histogram", 1, 64, 8, HistogramBase::kNoFlags));
// Add i+1 samples to the i'th bucket.
histogram->Add(0);
int power_of_2 = 1;
for (int i = 1; i < 8; i++) {
for (int j = 0; j <= i; j++)
histogram->Add(power_of_2);
power_of_2 *= 2;
}
// Check to see that the bucket counts reflect our additions.
std::unique_ptr<SampleVector> samples = histogram->SnapshotAllSamples();
for (int i = 0; i < 8; i++)
EXPECT_EQ(i + 1, samples->GetCountAtIndex(i));
}
TEST_P(HistogramTest, CorruptSampleCounts) {
// The internal code creates histograms via macros and thus keeps static
// pointers to them. If those pointers are to persistent memory which will
// be free'd then any following calls to that code will crash with a
// segmentation violation.
if (use_persistent_histogram_allocator_)
return;
Histogram* histogram = static_cast<Histogram*>(
Histogram::FactoryGet("Histogram", 1, 64, 8, HistogramBase::kNoFlags));
// Add some samples.
histogram->Add(20);
histogram->Add(40);
std::unique_ptr<SampleVector> snapshot = histogram->SnapshotAllSamples();
EXPECT_EQ(HistogramBase::NO_INCONSISTENCIES,
histogram->FindCorruption(*snapshot));
EXPECT_EQ(2, snapshot->redundant_count());
EXPECT_EQ(2, snapshot->TotalCount());
// Sample count won't match redundant count.
snapshot->counts().value()[3u] += 100;
EXPECT_EQ(HistogramBase::COUNT_LOW_ERROR,
histogram->FindCorruption(*snapshot));
snapshot->counts().value()[2u] -= 200;
EXPECT_EQ(HistogramBase::COUNT_HIGH_ERROR,
histogram->FindCorruption(*snapshot));
// But we can't spot a corruption if it is compensated for.
snapshot->counts().value()[1u] += 100;
EXPECT_EQ(HistogramBase::NO_INCONSISTENCIES,
histogram->FindCorruption(*snapshot));
}
TEST_P(HistogramTest, CorruptBucketBounds) {
Histogram* histogram = static_cast<Histogram*>(
Histogram::FactoryGet("Histogram", 1, 64, 8, HistogramBase::kNoFlags));
std::unique_ptr<HistogramSamples> snapshot = histogram->SnapshotSamples();
EXPECT_EQ(HistogramBase::NO_INCONSISTENCIES,
histogram->FindCorruption(*snapshot));
BucketRanges* bucket_ranges =
const_cast<BucketRanges*>(histogram->bucket_ranges());
HistogramBase::Sample tmp = bucket_ranges->range(1);
bucket_ranges->set_range(1, bucket_ranges->range(2));
bucket_ranges->set_range(2, tmp);
EXPECT_EQ(
HistogramBase::BUCKET_ORDER_ERROR | HistogramBase::RANGE_CHECKSUM_ERROR,
histogram->FindCorruption(*snapshot));
bucket_ranges->set_range(2, bucket_ranges->range(1));
bucket_ranges->set_range(1, tmp);
EXPECT_EQ(0U, histogram->FindCorruption(*snapshot));
// Show that two simple changes don't offset each other
bucket_ranges->set_range(3, bucket_ranges->range(3) + 1);
EXPECT_EQ(HistogramBase::RANGE_CHECKSUM_ERROR,
histogram->FindCorruption(*snapshot));
bucket_ranges->set_range(4, bucket_ranges->range(4) - 1);
EXPECT_EQ(HistogramBase::RANGE_CHECKSUM_ERROR,
histogram->FindCorruption(*snapshot));
// Repair histogram so that destructor won't DCHECK().
bucket_ranges->set_range(3, bucket_ranges->range(3) - 1);
bucket_ranges->set_range(4, bucket_ranges->range(4) + 1);
}
TEST_P(HistogramTest, HistogramSerializeInfo) {
Histogram* histogram = static_cast<Histogram*>(Histogram::FactoryGet(
"Histogram", 1, 64, 8, HistogramBase::kIPCSerializationSourceFlag));
Pickle pickle;
histogram->SerializeInfo(&pickle);
PickleIterator iter(pickle);
int type;
EXPECT_TRUE(iter.ReadInt(&type));
EXPECT_EQ(HISTOGRAM, type);
std::string name;
EXPECT_TRUE(iter.ReadString(&name));
EXPECT_EQ("Histogram", name);
int flag;
EXPECT_TRUE(iter.ReadInt(&flag));
EXPECT_EQ(HistogramBase::kIPCSerializationSourceFlag,
flag & ~HistogramBase::kIsPersistent);
int min;
EXPECT_TRUE(iter.ReadInt(&min));
EXPECT_EQ(1, min);
int max;
EXPECT_TRUE(iter.ReadInt(&max));
EXPECT_EQ(64, max);
uint32_t bucket_count;
EXPECT_TRUE(iter.ReadUInt32(&bucket_count));
EXPECT_EQ(8u, bucket_count);
uint32_t checksum;
EXPECT_TRUE(iter.ReadUInt32(&checksum));
EXPECT_EQ(histogram->bucket_ranges()->checksum(), checksum);
// No more data in the pickle.
EXPECT_FALSE(iter.SkipBytes(1));
}
TEST_P(HistogramTest, CustomHistogramSerializeInfo) {
std::vector<int> custom_ranges;
custom_ranges.push_back(10);
custom_ranges.push_back(100);
HistogramBase* custom_histogram =
CustomHistogram::FactoryGet("TestCustomRangeBoundedHistogram",
custom_ranges, HistogramBase::kNoFlags);
Pickle pickle;
custom_histogram->SerializeInfo(&pickle);
// Validate the pickle.
PickleIterator iter(pickle);
int i;
std::string s;
uint32_t bucket_count;
uint32_t ui32;
EXPECT_TRUE(iter.ReadInt(&i) && iter.ReadString(&s) && iter.ReadInt(&i) &&
iter.ReadInt(&i) && iter.ReadInt(&i) &&
iter.ReadUInt32(&bucket_count) && iter.ReadUInt32(&ui32));
EXPECT_EQ(3u, bucket_count);
int range;
EXPECT_TRUE(iter.ReadInt(&range));
EXPECT_EQ(10, range);
EXPECT_TRUE(iter.ReadInt(&range));
EXPECT_EQ(100, range);
// No more data in the pickle.
EXPECT_FALSE(iter.SkipBytes(1));
}
TEST_P(HistogramTest, BadConstruction) {
HistogramBase* histogram = Histogram::FactoryGet("BadConstruction", 0, 100, 8,
HistogramBase::kNoFlags);
EXPECT_TRUE(histogram->HasConstructionArguments(1, 100, 8));
// Try to get the same histogram name with different arguments.
HistogramBase* bad_histogram = Histogram::FactoryGet(
"BadConstruction", 0, 100, 7, HistogramBase::kNoFlags);
EXPECT_EQ(DummyHistogram::GetInstance(), bad_histogram);
bad_histogram = Histogram::FactoryGet("BadConstruction", 0, 99, 8,
HistogramBase::kNoFlags);
EXPECT_EQ(DummyHistogram::GetInstance(), bad_histogram);
HistogramBase* linear_histogram = LinearHistogram::FactoryGet(
"BadConstructionLinear", 0, 100, 8, HistogramBase::kNoFlags);
EXPECT_TRUE(linear_histogram->HasConstructionArguments(1, 100, 8));
// Try to get the same histogram name with different arguments.
bad_histogram = LinearHistogram::FactoryGet("BadConstructionLinear", 0, 100,
7, HistogramBase::kNoFlags);
EXPECT_EQ(DummyHistogram::GetInstance(), bad_histogram);
bad_histogram = LinearHistogram::FactoryGet("BadConstructionLinear", 10, 100,
8, HistogramBase::kNoFlags);
EXPECT_EQ(DummyHistogram::GetInstance(), bad_histogram);
}
TEST_P(HistogramTest, FactoryTime) {
const int kTestCreateCount = 1 << 14; // Must be power-of-2.
const int kTestLookupCount = 100000;
const int kTestAddCount = 1000000;
// Create all histogram names in advance for accurate timing below.
std::vector<std::string> histogram_names;
for (int i = 0; i < kTestCreateCount; ++i) {
histogram_names.push_back(
StringPrintf("TestHistogram.%d", i % kTestCreateCount));
}
// Calculate cost of creating histograms.
TimeTicks create_start = TimeTicks::Now();
for (int i = 0; i < kTestCreateCount; ++i) {
Histogram::FactoryGet(histogram_names[i], 1, 100, 10,
HistogramBase::kNoFlags);
}
TimeDelta create_ticks = TimeTicks::Now() - create_start;
int64_t create_ms = create_ticks.InMilliseconds();
VLOG(1) << kTestCreateCount << " histogram creations took " << create_ms
<< "ms or about " << (create_ms * 1000000) / kTestCreateCount
<< "ns each.";
// Calculate cost of looking up existing histograms.
TimeTicks lookup_start = TimeTicks::Now();
for (int i = 0; i < kTestLookupCount; ++i) {
// 6007 is co-prime with kTestCreateCount and so will do lookups in an
// order less likely to be cacheable (but still hit them all) should the
// underlying storage use the exact histogram name as the key.
const int i_mult = 6007;
static_assert(i_mult < INT_MAX / kTestCreateCount, "Multiplier too big");
int index = (i * i_mult) & (kTestCreateCount - 1);
Histogram::FactoryGet(histogram_names[index], 1, 100, 10,
HistogramBase::kNoFlags);
}
TimeDelta lookup_ticks = TimeTicks::Now() - lookup_start;
int64_t lookup_ms = lookup_ticks.InMilliseconds();
VLOG(1) << kTestLookupCount << " histogram lookups took " << lookup_ms
<< "ms or about " << (lookup_ms * 1000000) / kTestLookupCount
<< "ns each.";
// Calculate cost of accessing histograms.
HistogramBase* histogram = Histogram::FactoryGet(histogram_names[0], 1, 100,
10, HistogramBase::kNoFlags);
ASSERT_TRUE(histogram);
TimeTicks add_start = TimeTicks::Now();
for (int i = 0; i < kTestAddCount; ++i)
histogram->Add(i & 127);
TimeDelta add_ticks = TimeTicks::Now() - add_start;
int64_t add_ms = add_ticks.InMilliseconds();
VLOG(1) << kTestAddCount << " histogram adds took " << add_ms
<< "ms or about " << (add_ms * 1000000) / kTestAddCount << "ns each.";
}
TEST_P(HistogramTest, ScaledLinearHistogram) {
ScaledLinearHistogram scaled("SLH", 1, 5, 6, 100, HistogramBase::kNoFlags);
scaled.AddScaledCount(0, 1);
scaled.AddScaledCount(1, 49);
scaled.AddScaledCount(2, 50);
scaled.AddScaledCount(3, 101);
scaled.AddScaledCount(4, 160);
scaled.AddScaledCount(5, 130);
scaled.AddScaledCount(6, 140);
std::unique_ptr<SampleVector> samples =
SnapshotAllSamples(static_cast<Histogram*>(scaled.histogram()));
EXPECT_EQ(0, samples->GetCountAtIndex(0));
EXPECT_EQ(0, samples->GetCountAtIndex(1));
EXPECT_EQ(1, samples->GetCountAtIndex(2));
EXPECT_EQ(1, samples->GetCountAtIndex(3));
EXPECT_EQ(2, samples->GetCountAtIndex(4));
EXPECT_EQ(3, samples->GetCountAtIndex(5));
// Make sure the macros compile properly. This can only be run when
// there is no persistent allocator which can be discarded and leave
// dangling pointers.
if (!use_persistent_histogram_allocator_) {
enum EnumWithMax {
kA = 0,
kB = 1,
kC = 2,
kMaxValue = kC,
};
UMA_HISTOGRAM_SCALED_EXACT_LINEAR("h1", 1, 5000, 5, 100);
UMA_HISTOGRAM_SCALED_ENUMERATION("h2", kB, 5000, 100);
}
}
TEST_P(HistogramTest, ScaledLinearHistogramWithOverflowCount) {
ScaledLinearHistogram scaled("SLH", 1, 2, 3, 100, HistogramBase::kNoFlags);
scaled.AddScaledCount(0, 1);
scaled.AddScaledCount(1, 101);
scaled.AddScaledCount(2, std::numeric_limits<int64_t>::max());
std::unique_ptr<SampleVector> samples =
SnapshotAllSamples(static_cast<Histogram*>(scaled.histogram()));
EXPECT_EQ(0, samples->GetCountAtIndex(0));
EXPECT_EQ(1, samples->GetCountAtIndex(1));
EXPECT_EQ(std::numeric_limits<int>::max(), samples->GetCountAtIndex(2));
}
// For Histogram, LinearHistogram and CustomHistogram, the minimum for a
// declared range is 1, while the maximum is (HistogramBase::kSampleType_MAX -
// 1). But we accept ranges exceeding those limits, and silently clamped to
// those limits. This is for backwards compatibility.
TEST(HistogramDeathTest, BadRangesTest) {
HistogramBase* histogram =
Histogram::FactoryGet("BadRanges", 0, HistogramBase::kSampleType_MAX, 8,
HistogramBase::kNoFlags);
EXPECT_TRUE(histogram->HasConstructionArguments(
1, HistogramBase::kSampleType_MAX - 1, 8));
HistogramBase* linear_histogram = LinearHistogram::FactoryGet(
"BadRangesLinear", 0, HistogramBase::kSampleType_MAX, 8,
HistogramBase::kNoFlags);
EXPECT_TRUE(linear_histogram->HasConstructionArguments(
1, HistogramBase::kSampleType_MAX - 1, 8));
std::vector<int> custom_ranges;
custom_ranges.push_back(0);
custom_ranges.push_back(5);
Histogram* custom_histogram =
static_cast<Histogram*>(CustomHistogram::FactoryGet(
"BadRangesCustom", custom_ranges, HistogramBase::kNoFlags));
const BucketRanges* ranges = custom_histogram->bucket_ranges();
ASSERT_EQ(3u, ranges->size());
EXPECT_EQ(0, ranges->range(0));
EXPECT_EQ(5, ranges->range(1));
EXPECT_EQ(HistogramBase::kSampleType_MAX, ranges->range(2));
// CustomHistogram does not accepts kSampleType_MAX as range.
custom_ranges.push_back(HistogramBase::kSampleType_MAX);
EXPECT_DEATH_IF_SUPPORTED(
CustomHistogram::FactoryGet("BadRangesCustom2", custom_ranges,
HistogramBase::kNoFlags),
"");
// CustomHistogram needs at least 1 valid range.
custom_ranges.clear();
custom_ranges.push_back(0);
EXPECT_DEATH_IF_SUPPORTED(
CustomHistogram::FactoryGet("BadRangesCustom3", custom_ranges,
HistogramBase::kNoFlags),
"");
}
TEST_P(HistogramTest, ExpiredHistogramTest) {
auto record_checker = std::make_unique<TestRecordHistogramChecker>();
StatisticsRecorder::SetRecordChecker(std::move(record_checker));
HistogramBase* expired = Histogram::FactoryGet(kExpiredHistogramName, 1, 1000,
10, HistogramBase::kNoFlags);
ASSERT_TRUE(expired);
expired->Add(5);
expired->Add(500);
auto samples = expired->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
HistogramBase* linear_expired = LinearHistogram::FactoryGet(
kExpiredHistogramName, 1, 1000, 10, HistogramBase::kNoFlags);
ASSERT_TRUE(linear_expired);
linear_expired->Add(5);
linear_expired->Add(500);
samples = linear_expired->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
ScaledLinearHistogram scaled_linear_expired(kExpiredHistogramName, 1, 5, 6,
100, HistogramBase::kNoFlags);
scaled_linear_expired.AddScaledCount(0, 1);
scaled_linear_expired.AddScaledCount(1, 49);
samples = scaled_linear_expired.histogram()->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
std::vector<int> custom_ranges;
custom_ranges.push_back(1);
custom_ranges.push_back(5);
HistogramBase* custom_expired = CustomHistogram::FactoryGet(
kExpiredHistogramName, custom_ranges, HistogramBase::kNoFlags);
ASSERT_TRUE(custom_expired);
custom_expired->Add(2);
custom_expired->Add(4);
samples = custom_expired->SnapshotDelta();
EXPECT_EQ(0, samples->TotalCount());
HistogramBase* valid = Histogram::FactoryGet("ValidHistogram", 1, 1000, 10,
HistogramBase::kNoFlags);
ASSERT_TRUE(valid);
valid->Add(5);
valid->Add(500);
samples = valid->SnapshotDelta();
EXPECT_EQ(2, samples->TotalCount());
HistogramBase* linear_valid = LinearHistogram::FactoryGet(
"LinearHistogram", 1, 1000, 10, HistogramBase::kNoFlags);
ASSERT_TRUE(linear_valid);
linear_valid->Add(5);
linear_valid->Add(500);
samples = linear_valid->SnapshotDelta();
EXPECT_EQ(2, samples->TotalCount());
HistogramBase* custom_valid = CustomHistogram::FactoryGet(
"CustomHistogram", custom_ranges, HistogramBase::kNoFlags);
ASSERT_TRUE(custom_valid);
custom_valid->Add(2);
custom_valid->Add(4);
samples = custom_valid->SnapshotDelta();
EXPECT_EQ(2, samples->TotalCount());
}
TEST_P(HistogramTest, CheckGetCountAndBucketData) {
const size_t kBucketCount = 50;
Histogram* histogram = static_cast<Histogram*>(Histogram::FactoryGet(
"AddCountHistogram", 10, 100, kBucketCount, HistogramBase::kNoFlags));
// Add samples in reverse order and make sure the output is in correct order.
histogram->AddCount(/*sample=*/30, /*value=*/14);
histogram->AddCount(/*sample=*/20, /*value=*/15);
histogram->AddCount(/*sample=*/20, /*value=*/15);
histogram->AddCount(/*sample=*/30, /*value=*/14);
const CountAndBucketData count_and_data_bucket =
GetCountAndBucketData(histogram);
EXPECT_EQ(58, count_and_data_bucket.count);
EXPECT_EQ(1440, count_and_data_bucket.sum);
const base::Value::List& buckets_list = count_and_data_bucket.buckets;
ASSERT_EQ(2u, buckets_list.size());
// Check the first bucket.
const base::Value::Dict* bucket1 = buckets_list[0].GetIfDict();
ASSERT_TRUE(bucket1 != nullptr);
EXPECT_EQ(bucket1->FindInt("low"), std::optional<int>(20));
EXPECT_EQ(bucket1->FindInt("high"), std::optional<int>(21));
EXPECT_EQ(bucket1->FindInt("count"), std::optional<int>(30));
// Check the second bucket.
const base::Value::Dict* bucket2 = buckets_list[1].GetIfDict();
ASSERT_TRUE(bucket2 != nullptr);
EXPECT_EQ(bucket2->FindInt("low"), std::optional<int>(30));
EXPECT_EQ(bucket2->FindInt("high"), std::optional<int>(31));
EXPECT_EQ(bucket2->FindInt("count"), std::optional<int>(28));
}
TEST_P(HistogramTest, WriteAscii) {
HistogramBase* histogram =
LinearHistogram::FactoryGet("AsciiOut", /*minimum=*/1, /*maximum=*/10,
/*bucket_count=*/5, HistogramBase::kNoFlags);
histogram->AddCount(/*sample=*/4, /*value=*/5);
std::string output;
histogram->WriteAscii(&output);
const char kOutputFormatRe[] =
R"(Histogram: AsciiOut recorded 5 samples, mean = 4\.0.*\n)"
R"(0 \.\.\. \n)"
R"(4 -+O \s* \(5 = 100\.0%\) \{0\.0%\}\n)"
R"(7 \.\.\. \n)";
EXPECT_THAT(output, testing::MatchesRegex(kOutputFormatRe));
}
TEST_P(HistogramTest, ToGraphDict) {
HistogramBase* histogram =
LinearHistogram::FactoryGet("HTMLOut", /*minimum=*/1, /*maximum=*/10,
/*bucket_count=*/5, HistogramBase::kNoFlags);
histogram->AddCount(/*sample=*/4, /*value=*/5);
base::Value::Dict output = histogram->ToGraphDict();
const std::string* header = output.FindString("header");
const std::string* body = output.FindString("body");
const char kOutputHeaderFormatRe[] =
R"(Histogram: HTMLOut recorded 5 samples, mean = 4\.0.*)";
const char kOutputBodyFormatRe[] =
R"(0 \.\.\. \n)"
R"(4 -+O \s* \(5 = 100\.0%\) \{0\.0%\}\n)"
R"(7 \.\.\. \n)";
EXPECT_THAT(*header, testing::MatchesRegex(kOutputHeaderFormatRe));
EXPECT_THAT(*body, testing::MatchesRegex(kOutputBodyFormatRe));
}
// Tests ToGraphDict() returns deterministic length size and normalizes to
// scale.
TEST_P(HistogramTest, ToGraphDictNormalize) {
int count_bucket_1 = 80;
int value_bucket_1 = 4;
int count_bucket_2 = 40;
int value_bucket_2 = 5;
HistogramBase* histogram =
LinearHistogram::FactoryGet("AsciiOut", /*minimum=*/1, /*maximum=*/100,
/*bucket_count=*/80, HistogramBase::kNoFlags);
histogram->AddCount(/*value=*/value_bucket_1, /*count=*/count_bucket_1);
histogram->AddCount(/*value=*/value_bucket_2, /*count=*/count_bucket_2);
base::Value::Dict output = histogram->ToGraphDict();
std::string* header = output.FindString("header");
std::string* body = output.FindString("body");
const char kOutputHeaderFormatRe[] =
R"(Histogram: AsciiOut recorded 120 samples, mean = 4\.3.*)";
const char kOutputBodyFormatRe[] =
R"(0 \.\.\. \n)"
R"(4 ---------------------------------------------------)"
R"(---------------------O \(80 = 66\.7%\) \{0\.0%\}\n)"
R"(5 ----------------)"
R"(--------------------O \s* \(40 = 33\.3%\) \{66\.7%\}\n)"
R"(6 \.\.\. \n)";
EXPECT_THAT(*header, testing::MatchesRegex(kOutputHeaderFormatRe));
EXPECT_THAT(*body, testing::MatchesRegex(kOutputBodyFormatRe));
}
} // namespace base