| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CHROME_TEST_BASE_UMA_HISTOGRAM_HELPER_H_ | 5 #ifndef CHROME_TEST_BASE_UMA_HISTOGRAM_HELPER_H_ |
| 6 #define CHROME_TEST_BASE_UMA_HISTOGRAM_HELPER_H_ | 6 #define CHROME_TEST_BASE_UMA_HISTOGRAM_HELPER_H_ |
| 7 | 7 |
| 8 #include "base/memory/linked_ptr.h" |
| 8 #include "base/metrics/histogram.h" | 9 #include "base/metrics/histogram.h" |
| 9 #include "base/metrics/histogram_base.h" | 10 #include "base/metrics/histogram_base.h" |
| 10 #include "base/metrics/histogram_samples.h" | 11 #include "base/metrics/histogram_samples.h" |
| 11 | 12 |
| 12 // UMAHistogramHelper provides a simple interface for examining UMA histograms. | 13 // UMAHistogramHelper provides a simple interface for examining UMA histograms. |
| 13 // Tests can use this interface to verify that UMA data is getting logged as | 14 // Tests can use this interface to verify that UMA data is getting logged as |
| 14 // intended. | 15 // intended. |
| 15 class UMAHistogramHelper { | 16 class UMAHistogramHelper { |
| 16 public: | 17 public: |
| 18 // UMAHistogramHelper should be created before the execution of the test case. |
| 17 UMAHistogramHelper(); | 19 UMAHistogramHelper(); |
| 18 | 20 |
| 21 ~UMAHistogramHelper(); |
| 22 |
| 23 // Parameters should be string literals of all histograms to snapshot. |
| 24 // Call this before executing the test code. This method can be called |
| 25 // multiple times. The existing snapshots are preserved, except when one of |
| 26 // the |histogram_names| was previously passed as a parameter, then a new |
| 27 // snapshot will replace the existing one. |
| 28 void PrepareSnapshot(const char* const histogram_names[], |
| 29 size_t num_histograms); |
| 30 |
| 19 // Each child process may have its own histogram data, make sure this data | 31 // Each child process may have its own histogram data, make sure this data |
| 20 // gets accumulated into the browser process before we examine the histograms. | 32 // gets accumulated into the browser process before we examine the histograms. |
| 21 void Fetch(); | 33 void Fetch(); |
| 22 | 34 |
| 23 // We know the exact number of samples in a bucket, and that no other bucket | 35 // We know the exact number of samples in a bucket, and that no other bucket |
| 24 // should have samples. | 36 // should have samples. If |PrepareSnapshot| was called for the histogram |
| 37 // named |name| then the |expected_count| is the diff from the snapshot. |
| 25 void ExpectUniqueSample(const std::string& name, | 38 void ExpectUniqueSample(const std::string& name, |
| 26 base::HistogramBase::Sample sample, | 39 base::HistogramBase::Sample sample, |
| 27 base::HistogramBase::Count expected_count); | 40 base::HistogramBase::Count expected_count); |
| 28 | 41 |
| 29 // We know the exact number of samples in a bucket, but other buckets may | 42 // We know the exact number of samples in a bucket, but other buckets may |
| 30 // have samples as well. | 43 // have samples as well. If |PrepareSnapshot| was called for histogram named |
| 44 // |name| then the |expected_count| is the diff from the snapshot. |
| 31 void ExpectBucketCount(const std::string& name, | 45 void ExpectBucketCount(const std::string& name, |
| 32 base::HistogramBase::Sample sample, | 46 base::HistogramBase::Sample sample, |
| 33 base::HistogramBase::Count expected_count); | 47 base::HistogramBase::Count expected_count); |
| 34 | 48 |
| 35 // We don't know the values of the samples, but we know how many there are. | 49 // We don't know the values of the samples, but we know how many there are. If |
| 50 // |PrepareSnapshot| was called for |name| histogram, then the |
| 51 // |count| is the diff from the snapshot. |
| 36 void ExpectTotalCount(const std::string& name, | 52 void ExpectTotalCount(const std::string& name, |
| 37 base::HistogramBase::Count count); | 53 base::HistogramBase::Count count); |
| 38 | 54 |
| 39 private: | 55 private: |
| 40 void FetchCallback(); | 56 void FetchCallback(); |
| 41 | 57 |
| 42 void CheckBucketCount(const std::string& name, | 58 void CheckBucketCount(const std::string& name, |
| 43 base::HistogramBase::Sample sample, | 59 base::HistogramBase::Sample sample, |
| 44 base::Histogram::Count expected_count, | 60 base::Histogram::Count expected_count, |
| 45 base::HistogramSamples& samples); | 61 base::HistogramSamples& samples); |
| 46 | 62 |
| 47 void CheckTotalCount(const std::string& name, | 63 void CheckTotalCount(const std::string& name, |
| 48 base::Histogram::Count expected_count, | 64 base::Histogram::Count expected_count, |
| 49 base::HistogramSamples& samples); | 65 base::HistogramSamples& samples); |
| 50 | 66 |
| 51 DISALLOW_COPY_AND_ASSIGN(UMAHistogramHelper); | 67 DISALLOW_COPY_AND_ASSIGN(UMAHistogramHelper); |
| 68 |
| 69 // The map from histogram names to their snapshots |
| 70 std::map<std::string, linked_ptr<base::HistogramSamples> > |
| 71 histogram_snapshots; |
| 52 }; | 72 }; |
| 53 | 73 |
| 54 #endif // CHROME_TEST_BASE_UMA_HISTOGRAM_HELPER_H_ | 74 #endif // CHROME_TEST_BASE_UMA_HISTOGRAM_HELPER_H_ |
| OLD | NEW |