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
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/metrics/single_sample_metrics_factory_impl.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/metrics/dummy_histogram.h"
#include "base/run_loop.h"
#include "base/test/gtest_util.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/threading/thread.h"
#include "components/metrics/single_sample_metrics.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace metrics {
namespace {
const base::HistogramBase::Sample kMin = 1;
const base::HistogramBase::Sample kMax = 10;
const uint32_t kBucketCount = 10;
const char kMetricName[] = "Single.Sample.Metric";
class SingleSampleMetricsFactoryImplTest : public testing::Test {
public:
SingleSampleMetricsFactoryImplTest() : thread_("TestThread") {
InitializeSingleSampleMetricsFactory(
base::BindRepeating(&SingleSampleMetricsFactoryImplTest::CreateProvider,
base::Unretained(this)));
factory_ = static_cast<SingleSampleMetricsFactoryImpl*>(
base::SingleSampleMetricsFactory::Get());
}
SingleSampleMetricsFactoryImplTest(
const SingleSampleMetricsFactoryImplTest&) = delete;
SingleSampleMetricsFactoryImplTest& operator=(
const SingleSampleMetricsFactoryImplTest&) = delete;
~SingleSampleMetricsFactoryImplTest() override {
factory_->DestroyProviderForTesting();
factory_ = nullptr;
if (thread_.IsRunning())
ShutdownThread();
base::SingleSampleMetricsFactory::DeleteFactoryForTesting();
}
protected:
void StartThread() { ASSERT_TRUE(thread_.Start()); }
void ShutdownThread() {
thread_.task_runner()->PostTask(
FROM_HERE,
base::BindOnce(
&SingleSampleMetricsFactoryImpl::DestroyProviderForTesting,
base::Unretained(factory_)));
thread_.Stop();
}
void CreateProvider(
mojo::PendingReceiver<mojom::SingleSampleMetricsProvider> receiver) {
CreateSingleSampleMetricsProvider(std::move(receiver));
provider_count_++;
}
std::unique_ptr<base::SingleSampleMetric> CreateMetricOnThread() {
std::unique_ptr<base::SingleSampleMetric> metric;
base::RunLoop run_loop;
thread_.task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(
&SingleSampleMetricsFactoryImplTest::CreateAndStoreMetric,
base::Unretained(this), &metric),
run_loop.QuitClosure());
run_loop.Run();
return metric;
}
void CreateAndStoreMetric(std::unique_ptr<base::SingleSampleMetric>* metric) {
*metric = factory_->CreateCustomCountsMetric(kMetricName, kMin, kMax,
kBucketCount);
}
base::test::SingleThreadTaskEnvironment task_environment_;
raw_ptr<SingleSampleMetricsFactoryImpl> factory_;
base::Thread thread_;
size_t provider_count_ = 0;
};
} // namespace
TEST_F(SingleSampleMetricsFactoryImplTest, SingleProvider) {
std::unique_ptr<base::SingleSampleMetric> metric1 =
factory_->CreateCustomCountsMetric(kMetricName, kMin, kMax, kBucketCount);
std::unique_ptr<base::SingleSampleMetric> metric2 =
factory_->CreateCustomCountsMetric(kMetricName, kMin, kMax, kBucketCount);
// Verify that only a single provider is created for multiple metrics.
base::RunLoop().RunUntilIdle();
EXPECT_EQ(1u, provider_count_);
}
TEST_F(SingleSampleMetricsFactoryImplTest, DoesNothing) {
base::HistogramTester tester;
std::unique_ptr<base::SingleSampleMetric> metric =
factory_->CreateCustomCountsMetric(kMetricName, kMin, kMax, kBucketCount);
metric.reset();
// Verify that no sample is recorded if SetSample() is never called.
base::RunLoop().RunUntilIdle();
tester.ExpectTotalCount(kMetricName, 0);
}
TEST_F(SingleSampleMetricsFactoryImplTest, DefaultSingleSampleMetricWithValue) {
base::HistogramTester tester;
std::unique_ptr<base::SingleSampleMetric> metric =
factory_->CreateCustomCountsMetric(kMetricName, kMin, kMax, kBucketCount);
const base::HistogramBase::Sample kLastSample = 9;
metric->SetSample(1);
metric->SetSample(3);
metric->SetSample(5);
metric->SetSample(kLastSample);
metric.reset();
// Verify only the last sample sent to SetSample() is recorded.
base::RunLoop().RunUntilIdle();
tester.ExpectUniqueSample(kMetricName, kLastSample, 1);
// Verify construction implicitly by requesting a histogram with the same
// parameters; this test relies on the fact that histogram objects are unique
// per name. Different parameters will result in a Dummy histogram returned.
EXPECT_EQ(base::DummyHistogram::GetInstance(),
base::Histogram::FactoryGet(kMetricName, 1, 3, 3,
base::HistogramBase::kNoFlags));
EXPECT_NE(base::DummyHistogram::GetInstance(),
base::Histogram::FactoryGet(
kMetricName, kMin, kMax, kBucketCount,
base::HistogramBase::kUmaTargetedHistogramFlag));
}
TEST_F(SingleSampleMetricsFactoryImplTest, MultithreadedMetrics) {
// Allow EXPECT_DCHECK_DEATH for multiple threads.
// https://github.com/google/googletest/blob/main/docs/advanced.md#death-tests-and-threads
testing::FLAGS_gtest_death_test_style = "threadsafe";
base::HistogramTester tester;
std::unique_ptr<base::SingleSampleMetric> metric =
factory_->CreateCustomCountsMetric(kMetricName, kMin, kMax, kBucketCount);
EXPECT_EQ(1u, provider_count_);
StartThread();
std::unique_ptr<base::SingleSampleMetric> threaded_metric =
CreateMetricOnThread();
ASSERT_TRUE(threaded_metric);
// A second provider should be created to handle requests on our new thread.
EXPECT_EQ(2u, provider_count_);
// Calls from the wrong thread should DCHECK.
EXPECT_DCHECK_DEATH(threaded_metric->SetSample(5));
EXPECT_DCHECK_DEATH(threaded_metric.reset());
// Test that samples are set on each thread correctly.
const base::HistogramBase::Sample kSample = 7;
{
metric->SetSample(kSample);
base::RunLoop run_loop;
thread_.task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(&base::SingleSampleMetric::SetSample,
base::Unretained(threaded_metric.get()), kSample),
run_loop.QuitClosure());
run_loop.Run();
}
// Release metrics and shutdown thread to ensure destruction completes.
thread_.task_runner()->DeleteSoon(FROM_HERE, threaded_metric.release());
ShutdownThread();
metric.reset();
base::RunLoop().RunUntilIdle();
tester.ExpectUniqueSample(kMetricName, kSample, 2);
}
} // namespace metrics
|
