histogram_tester_unittest.cc 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "base/test/metrics/histogram_tester.h"
  5. #include <memory>
  6. #include <string>
  7. #include "base/metrics/histogram_macros.h"
  8. #include "base/metrics/histogram_samples.h"
  9. #include "testing/gmock/include/gmock/gmock.h"
  10. #include "testing/gtest/include/gtest/gtest-spi.h"
  11. #include "testing/gtest/include/gtest/gtest.h"
  12. using ::testing::ElementsAre;
  13. using ::testing::IsEmpty;
  14. namespace {
  15. const char kHistogram1[] = "Test1";
  16. const char kHistogram2[] = "Test2";
  17. const char kHistogram3[] = "Test3";
  18. const char kHistogram4[] = "Test4";
  19. const char kHistogram5[] = "Test5";
  20. const char kHistogram6[] = "Test6";
  21. } // namespace
  22. namespace base {
  23. typedef testing::Test HistogramTesterTest;
  24. TEST_F(HistogramTesterTest, Scope) {
  25. // Record a histogram before the creation of the recorder.
  26. UMA_HISTOGRAM_BOOLEAN(kHistogram1, true);
  27. HistogramTester tester;
  28. // Verify that no histogram is recorded.
  29. tester.ExpectTotalCount(kHistogram1, 0);
  30. // Record a histogram after the creation of the recorder.
  31. UMA_HISTOGRAM_BOOLEAN(kHistogram1, true);
  32. // Verify that one histogram is recorded.
  33. std::unique_ptr<HistogramSamples> samples(
  34. tester.GetHistogramSamplesSinceCreation(kHistogram1));
  35. EXPECT_TRUE(samples);
  36. EXPECT_EQ(1, samples->TotalCount());
  37. }
  38. TEST_F(HistogramTesterTest, GetHistogramSamplesSinceCreationNotNull) {
  39. // Chose the histogram name uniquely, to ensure nothing was recorded for it so
  40. // far.
  41. static const char kHistogram[] =
  42. "GetHistogramSamplesSinceCreationNotNullHistogram";
  43. HistogramTester tester;
  44. // Verify that the returned samples are empty but not null.
  45. std::unique_ptr<HistogramSamples> samples(
  46. tester.GetHistogramSamplesSinceCreation(kHistogram1));
  47. EXPECT_TRUE(samples);
  48. tester.ExpectTotalCount(kHistogram, 0);
  49. }
  50. TEST_F(HistogramTesterTest, TestUniqueSample) {
  51. HistogramTester tester;
  52. // Emit '2' three times.
  53. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  54. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  55. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  56. tester.ExpectUniqueSample(kHistogram2, 2, 3);
  57. tester.ExpectUniqueTimeSample(kHistogram2, base::Milliseconds(2), 3);
  58. }
  59. // Verify that the expectation is violated if the bucket contains an incorrect
  60. // number of samples.
  61. TEST_F(HistogramTesterTest, TestUniqueSample_TooManySamplesInActualBucket) {
  62. auto failing_code = [] {
  63. HistogramTester tester;
  64. // Emit '2' four times.
  65. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  66. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  67. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  68. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  69. // Expect exactly three samples in bucket 2. This is supposed to fail.
  70. tester.ExpectUniqueSample(kHistogram2, 2, 3);
  71. };
  72. EXPECT_NONFATAL_FAILURE(failing_code(),
  73. "Histogram \"Test2\" did not meet its expectations.");
  74. }
  75. // Verify that the expectation is violated if the bucket contains the correct
  76. // number of samples but another bucket contains extra samples.
  77. TEST_F(HistogramTesterTest, TestUniqueSample_OneExtraSampleInWrongBucket) {
  78. auto failing_code = [] {
  79. HistogramTester tester;
  80. // Emit '2' three times.
  81. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  82. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  83. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 2);
  84. // Emit one unexpected '3'.
  85. UMA_HISTOGRAM_COUNTS_100(kHistogram2, 3);
  86. // Expect exactly three samples in bucket 2. This is supposed to fail.
  87. tester.ExpectUniqueSample(kHistogram2, 2, 3);
  88. };
  89. EXPECT_NONFATAL_FAILURE(failing_code(),
  90. "Histogram \"Test2\" did not meet its expectations.");
  91. }
  92. TEST_F(HistogramTesterTest, TestBucketsSample) {
  93. HistogramTester tester;
  94. UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
  95. UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
  96. UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
  97. UMA_HISTOGRAM_COUNTS_100(kHistogram3, 2);
  98. UMA_HISTOGRAM_COUNTS_100(kHistogram3, 3);
  99. tester.ExpectBucketCount(kHistogram3, 2, 4);
  100. tester.ExpectBucketCount(kHistogram3, 3, 1);
  101. tester.ExpectTotalCount(kHistogram3, 5);
  102. }
  103. TEST_F(HistogramTesterTest, TestBucketsSampleWithScope) {
  104. // Emit values twice, once before the tester creation and once after.
  105. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 2);
  106. HistogramTester tester;
  107. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 3);
  108. tester.ExpectBucketCount(kHistogram4, 2, 0);
  109. tester.ExpectBucketCount(kHistogram4, 3, 1);
  110. tester.ExpectTotalCount(kHistogram4, 1);
  111. }
  112. TEST_F(HistogramTesterTest, TestGetAllSamples) {
  113. HistogramTester tester;
  114. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 2, 5);
  115. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 3, 5);
  116. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 3, 5);
  117. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 5, 5);
  118. EXPECT_THAT(tester.GetAllSamples(kHistogram5),
  119. ElementsAre(Bucket(2, 1), Bucket(3, 2), Bucket(5, 1)));
  120. }
  121. TEST_F(HistogramTesterTest, TestGetAllSamples_NoSamples) {
  122. HistogramTester tester;
  123. EXPECT_THAT(tester.GetAllSamples(kHistogram5), IsEmpty());
  124. }
  125. TEST_F(HistogramTesterTest, TestGetTotalSum) {
  126. // Emit values twice, once before the tester creation and once after.
  127. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 2);
  128. HistogramTester tester;
  129. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 3);
  130. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 4);
  131. EXPECT_EQ(7, tester.GetTotalSum(kHistogram4));
  132. }
  133. TEST_F(HistogramTesterTest, TestGetTotalCountsForPrefix) {
  134. HistogramTester tester;
  135. UMA_HISTOGRAM_ENUMERATION("Test1.Test2.Test3", 2, 5);
  136. // Regression check for bug https://crbug.com/659977.
  137. EXPECT_TRUE(tester.GetTotalCountsForPrefix("Test2.").empty());
  138. EXPECT_EQ(1u, tester.GetTotalCountsForPrefix("Test1.").size());
  139. }
  140. TEST_F(HistogramTesterTest, TestGetAllChangedHistograms) {
  141. // Emit multiple values, some before tester creation.
  142. UMA_HISTOGRAM_COUNTS_100(kHistogram6, true);
  143. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 4);
  144. HistogramTester tester;
  145. UMA_HISTOGRAM_COUNTS_100(kHistogram4, 3);
  146. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 2, 5);
  147. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 3, 5);
  148. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 4, 5);
  149. UMA_HISTOGRAM_ENUMERATION(kHistogram5, 5, 5);
  150. UMA_HISTOGRAM_ENUMERATION("Test1.Test2.Test3", 2, 5);
  151. std::string results = tester.GetAllHistogramsRecorded();
  152. EXPECT_EQ(std::string::npos, results.find("Histogram: Test1 recorded"));
  153. EXPECT_NE(std::string::npos,
  154. results.find("Histogram: Test4 recorded 1 new samples"));
  155. EXPECT_NE(std::string::npos,
  156. results.find("Histogram: Test5 recorded 4 new samples"));
  157. EXPECT_NE(
  158. std::string::npos,
  159. results.find("Histogram: Test1.Test2.Test3 recorded 1 new samples"));
  160. }
  161. TEST_F(HistogramTesterTest, MissingHistogramMeansEmptyBuckets) {
  162. // When a histogram hasn't been instantiated, expecting counts of zero should
  163. // still succeed.
  164. static const char kHistogram[] = "MissingHistogramMeansEmptyBucketsHistogram";
  165. HistogramTester tester;
  166. tester.ExpectBucketCount(kHistogram, 42, 0);
  167. tester.ExpectTotalCount(kHistogram, 0);
  168. EXPECT_TRUE(tester.GetAllSamples(kHistogram).empty());
  169. EXPECT_EQ(0, tester.GetTotalSum(kHistogram));
  170. EXPECT_EQ(0, tester.GetBucketCount(kHistogram, 42));
  171. EXPECT_EQ(0,
  172. tester.GetHistogramSamplesSinceCreation(kHistogram)->TotalCount());
  173. }
  174. TEST_F(HistogramTesterTest, BucketsAre) {
  175. // Auxiliary functions for keeping the lines short.
  176. auto a = [](std::vector<Bucket> b) { return b; };
  177. auto b = [](base::Histogram::Sample min, base::Histogram::Count count) {
  178. return Bucket(min, count);
  179. };
  180. using ::testing::Not;
  181. EXPECT_THAT(a({}), BucketsAre());
  182. EXPECT_THAT(a({}), BucketsAre(b(0, 0)));
  183. EXPECT_THAT(a({}), BucketsAre(b(1, 0)));
  184. EXPECT_THAT(a({}), BucketsAre(b(0, 0), b(1, 0)));
  185. EXPECT_THAT(a({}), Not(BucketsAre(b(1, 1))));
  186. EXPECT_THAT(a({b(1, 1)}), BucketsAre(b(1, 1)));
  187. EXPECT_THAT(a({b(1, 1)}), BucketsAre(b(0, 0), b(1, 1)));
  188. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre()));
  189. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0))));
  190. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(1, 0))));
  191. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(2, 1))));
  192. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(2, 2))));
  193. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0), b(1, 0))));
  194. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0), b(1, 1), b(2, 2))));
  195. EXPECT_THAT(a({b(1, 1)}), Not(BucketsAre(b(0, 0), b(1, 0), b(2, 0))));
  196. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsAre(b(1, 1), b(2, 2)));
  197. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsAre(b(0, 0), b(1, 1), b(2, 2)));
  198. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre()));
  199. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(0, 0))));
  200. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(1, 1))));
  201. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(2, 2))));
  202. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(0, 0), b(1, 1))));
  203. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(1, 0))));
  204. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(2, 1))));
  205. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsAre(b(0, 0), b(1, 0))));
  206. EXPECT_THAT(a({b(1, 1), b(2, 2)}),
  207. Not(BucketsAre(b(0, 0), b(1, 0), b(2, 0))));
  208. }
  209. TEST_F(HistogramTesterTest, BucketsInclude) {
  210. // Auxiliary function for the "actual" values to shorten lines.
  211. auto a = [](std::vector<Bucket> b) { return b; };
  212. auto b = [](base::Histogram::Sample min, base::Histogram::Count count) {
  213. return Bucket(min, count);
  214. };
  215. using ::testing::Not;
  216. EXPECT_THAT(a({}), BucketsInclude());
  217. EXPECT_THAT(a({}), BucketsInclude(b(0, 0)));
  218. EXPECT_THAT(a({}), BucketsInclude(b(1, 0)));
  219. EXPECT_THAT(a({}), BucketsInclude(b(0, 0), b(1, 0)));
  220. EXPECT_THAT(a({}), Not(BucketsInclude(b(1, 1))));
  221. EXPECT_THAT(a({b(1, 1)}), BucketsInclude());
  222. EXPECT_THAT(a({b(1, 1)}), BucketsInclude(b(0, 0)));
  223. EXPECT_THAT(a({b(1, 1)}), BucketsInclude(b(1, 1)));
  224. EXPECT_THAT(a({b(1, 1)}), BucketsInclude(b(0, 0), b(1, 1)));
  225. EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(1, 0))));
  226. EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(2, 1))));
  227. EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(2, 2))));
  228. EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(0, 0), b(1, 0))));
  229. EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(0, 0), b(1, 1), b(2, 2))));
  230. EXPECT_THAT(a({b(1, 1)}), Not(BucketsInclude(b(0, 0), b(1, 0), b(2, 0))));
  231. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude());
  232. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(0, 0)));
  233. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(1, 1)));
  234. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(2, 2)));
  235. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(0, 0), b(1, 1)));
  236. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(1, 1), b(2, 2)));
  237. EXPECT_THAT(a({b(1, 1), b(2, 2)}), BucketsInclude(b(0, 0), b(1, 1), b(2, 2)));
  238. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsInclude(b(1, 0))));
  239. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsInclude(b(2, 1))));
  240. EXPECT_THAT(a({b(1, 1), b(2, 2)}), Not(BucketsInclude(b(0, 0), b(1, 0))));
  241. EXPECT_THAT(a({b(1, 1), b(2, 2)}),
  242. Not(BucketsInclude(b(0, 0), b(1, 0), b(2, 0))));
  243. }
  244. } // namespace base