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
|
// 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/safe_browsing/content/browser/triggers/ad_sampler_trigger.h"
#include "base/memory/scoped_refptr.h"
#include "base/strings/string_number_conversions.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/test_simple_task_runner.h"
#include "components/prefs/testing_pref_service.h"
#include "components/safe_browsing/content/browser/triggers/mock_trigger_manager.h"
#include "components/safe_browsing/content/browser/web_contents_key.h"
#include "components/safe_browsing/core/common/features.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/web_contents.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/navigation_simulator.h"
#include "content/public/test/test_renderer_host.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using content::NavigationSimulator;
using content::RenderFrameHost;
using content::RenderFrameHostTester;
using testing::_;
using testing::Return;
namespace safe_browsing {
namespace {
const char kAdUrl[] = "https://tpc.safeframe.googlesyndication.com/safeframe/1";
const char kNonAdUrl[] = "https://foo.com/";
const char kAdName[] = "google_ads_iframe_1";
const char kNonAdName[] = "foo";
} // namespace
class AdSamplerTriggerTest : public content::RenderViewHostTestHarness {
public:
AdSamplerTriggerTest() = default;
~AdSamplerTriggerTest() override = default;
void SetUp() override {
content::RenderViewHostTestHarness::SetUp();
// Enable any prefs required for the trigger to run.
safe_browsing::RegisterProfilePrefs(prefs_.registry());
prefs_.SetBoolean(prefs::kSafeBrowsingExtendedReportingOptInAllowed, true);
prefs_.SetBoolean(prefs::kSafeBrowsingScoutReportingEnabled, true);
}
void CreateTriggerWithFrequency(const size_t denominator) {
safe_browsing::AdSamplerTrigger::CreateForWebContents(
web_contents(), &trigger_manager_, &prefs_, nullptr, nullptr, nullptr);
safe_browsing::AdSamplerTrigger* ad_sampler =
safe_browsing::AdSamplerTrigger::FromWebContents(web_contents());
ad_sampler->SetSamplerFrequencyForTest(denominator);
// Give the trigger a test task runner that we can synchronize on.
ad_sampler->SetTaskRunnerForTest(task_runner_);
}
// Returns the final RenderFrameHost after navigation commits.
RenderFrameHost* NavigateFrame(const std::string& url,
RenderFrameHost* frame) {
return NavigationSimulator::NavigateAndCommitFromDocument(GURL(url), frame);
}
// Returns the final RenderFrameHost after navigation commits.
RenderFrameHost* NavigateMainFrame(const std::string& url) {
return NavigateFrame(url, web_contents()->GetPrimaryMainFrame());
}
// Returns the final RenderFrameHost after navigation commits.
RenderFrameHost* CreateAndNavigateSubFrame(const std::string& url,
const std::string& frame_name,
RenderFrameHost* parent) {
RenderFrameHost* subframe =
RenderFrameHostTester::For(parent)->AppendChild(frame_name);
return NavigateFrame(url, subframe);
}
void WaitForTaskRunnerIdle() {
task_runner_->RunUntilIdle();
base::RunLoop().RunUntilIdle();
}
WebContentsKey web_contents_key() {
return GetWebContentsKey(web_contents());
}
MockTriggerManager* get_trigger_manager() { return &trigger_manager_; }
base::HistogramTester* get_histograms() { return &histograms_; }
private:
TestingPrefServiceSimple prefs_;
MockTriggerManager trigger_manager_;
base::HistogramTester histograms_;
scoped_refptr<base::TestSimpleTaskRunner> task_runner_ =
base::MakeRefCounted<base::TestSimpleTaskRunner>();
};
TEST_F(AdSamplerTriggerTest, TriggerDisabledBySamplingFrequency) {
// Make sure the trigger doesn't fire when the sampling frequency is set to
// zero, which disables the trigger.
CreateTriggerWithFrequency(kAdSamplerFrequencyDisabled);
EXPECT_CALL(*get_trigger_manager(),
StartCollectingThreatDetails(_, _, _, _, _, _, _))
.Times(0);
EXPECT_CALL(*get_trigger_manager(),
FinishCollectingThreatDetails(_, _, _, _, _, _, _, _))
.Times(0);
// This page contains two ads - one identifiable by its URL, the other by the
// name of the frame.
RenderFrameHost* main_frame = NavigateMainFrame(kNonAdUrl);
CreateAndNavigateSubFrame(kAdUrl, kNonAdName, main_frame);
CreateAndNavigateSubFrame(kNonAdUrl, kAdName, main_frame);
// Three navigations (main frame, two subframes). One frame with no ads, and
// two skipped ad samples.
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
TRIGGER_CHECK, 3);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
NO_SAMPLE_NO_AD, 1);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
NO_SAMPLE_AD_SKIPPED_FOR_FREQUENCY, 2);
}
TEST_F(AdSamplerTriggerTest, PageWithNoAds) {
// Make sure the trigger doesn't fire when there are no ads on the page.
CreateTriggerWithFrequency(/*denominator=*/1);
EXPECT_CALL(*get_trigger_manager(),
StartCollectingThreatDetails(_, _, _, _, _, _, _))
.Times(0);
EXPECT_CALL(*get_trigger_manager(),
FinishCollectingThreatDetails(_, _, _, _, _, _, _, _))
.Times(0);
RenderFrameHost* main_frame = NavigateMainFrame(kNonAdUrl);
CreateAndNavigateSubFrame(kNonAdUrl, kNonAdName, main_frame);
CreateAndNavigateSubFrame(kNonAdUrl, kNonAdName, main_frame);
// Three navigations (main frame, two subframes), each with no ad.
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
TRIGGER_CHECK, 3);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
NO_SAMPLE_NO_AD, 3);
}
TEST_F(AdSamplerTriggerTest, PageWithMultipleAds) {
// Make sure the trigger fires when there are ads on the page. We expect
// one call for each ad detected.
CreateTriggerWithFrequency(/*denominator=*/1);
EXPECT_CALL(*get_trigger_manager(),
StartCollectingThreatDetails(TriggerType::AD_SAMPLE,
web_contents(), _, _, _, _, _))
.Times(2)
.WillRepeatedly(Return(true));
EXPECT_CALL(*get_trigger_manager(),
FinishCollectingThreatDetails(
TriggerType::AD_SAMPLE, web_contents_key(), _, _, _, _, _, _))
.Times(2)
.WillRepeatedly(Return(
MockTriggerManager::FinishCollectingThreatDetailsResult(true, true)));
// This page contains two ads - one identifiable by its URL, the other by the
// name of the frame.
RenderFrameHost* main_frame = NavigateMainFrame(kNonAdUrl);
CreateAndNavigateSubFrame(kAdUrl, kNonAdName, main_frame);
CreateAndNavigateSubFrame(kNonAdUrl, kAdName, main_frame);
// Wait for any posted tasks to finish.
WaitForTaskRunnerIdle();
// Three navigations (main frame, two subframes). Main frame with no ads, and
// two sampled ads
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
TRIGGER_CHECK, 3);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
NO_SAMPLE_NO_AD, 1);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
AD_SAMPLED, 2);
}
TEST_F(AdSamplerTriggerTest, ReportRejectedByTriggerManager) {
// If the trigger manager rejects the report, we don't try to finish/send the
// report.
CreateTriggerWithFrequency(/*denominator=*/1);
EXPECT_CALL(*get_trigger_manager(),
StartCollectingThreatDetails(TriggerType::AD_SAMPLE,
web_contents(), _, _, _, _, _))
.Times(1)
.WillOnce(Return(false));
EXPECT_CALL(*get_trigger_manager(),
FinishCollectingThreatDetails(
TriggerType::AD_SAMPLE, web_contents_key(), _, _, _, _, _, _))
.Times(0);
// One ad on the page, identified by its URL.
RenderFrameHost* main_frame = NavigateMainFrame(kNonAdUrl);
CreateAndNavigateSubFrame(kAdUrl, kNonAdName, main_frame);
CreateAndNavigateSubFrame(kNonAdUrl, kNonAdName, main_frame);
// Wait for any posted tasks to finish.
WaitForTaskRunnerIdle();
// Three navigations (main frame, two subframes). Two frames with no ads, and
// one ad rejected by trigger manager.
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
TRIGGER_CHECK, 3);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
NO_SAMPLE_NO_AD, 2);
get_histograms()->ExpectBucketCount(kAdSamplerTriggerActionMetricName,
NO_SAMPLE_COULD_NOT_START_REPORT, 1);
}
TEST(AdSamplerTriggerTestFinch, FrequencyDenominatorFeature) {
// Make sure that setting the frequency denominator via Finch params works as
// expected, and that the default frequency is used when no Finch config is
// given.
EXPECT_EQ(kAdSamplerDefaultFrequency,
AdSamplerTrigger::GetSamplerFrequencyDenominatorForTest());
const size_t kDenominatorInt = 12345;
base::FieldTrialParams feature_params;
feature_params[std::string(
safe_browsing::kAdSamplerFrequencyDenominatorParam)] =
base::NumberToString(kDenominatorInt);
base::test::ScopedFeatureList scoped_feature_list;
scoped_feature_list.InitAndEnableFeatureWithParameters(
safe_browsing::kAdSamplerTriggerFeature, feature_params);
EXPECT_EQ(kDenominatorInt,
AdSamplerTrigger::GetSamplerFrequencyDenominatorForTest());
}
} // namespace safe_browsing
|
