-
Notifications
You must be signed in to change notification settings - Fork 408
/
UserAgentTests.swift
452 lines (391 loc) · 21.9 KB
/
UserAgentTests.swift
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
//
// UserAgentTests.swift
// UnitTests
//
// Copyright © 2020 DuckDuckGo. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import WebKit
import XCTest
import BrowserServicesKit
@testable import Core
// swiftlint:disable file_length type_body_length
final class UserAgentTests: XCTestCase {
private struct DefaultAgent {
// swiftlint:disable line_length
static let mobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148"
static let tablet = "Mozilla/5.0 (iPad; CPU OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148"
static let oldWebkitVersionMobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.14 (KHTML, like Gecko) Mobile/15E148"
static let newWebkitVersionMobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.16 (KHTML, like Gecko) Mobile/15E148"
static let sameWebkitVersionMobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148"
}
private struct ExpectedAgent {
// Based on DefaultAgent values
static let mobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.4 Mobile/15E148 DuckDuckGo/7 Safari/605.1.15"
static let tablet = "Mozilla/5.0 (iPad; CPU OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.4 Mobile/15E148 DuckDuckGo/7 Safari/605.1.15"
static let desktop = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.4 DuckDuckGo/7 Safari/605.1.15"
static let oldWebkitVersionMobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.14 (KHTML, like Gecko) Version/12.4 Mobile/15E148 DuckDuckGo/7 Safari/605.1.14"
static let newWebkitVersionMobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 DuckDuckGo/7 Safari/604.1"
static let sameWebkitVersionMobile = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 DuckDuckGo/7 Safari/604.1"
static let mobileNoApplication = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.4 Mobile/15E148 Safari/605.1.15"
// Based on fallback constants in UserAgent
static let mobileFallback = "Mozilla/5.0 (iPhone; CPU iPhone OS 13_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.5 Mobile/15E148 DuckDuckGo/7 Safari/605.1.15"
static let desktopFallback = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.5 DuckDuckGo/7 Safari/605.1.15"
static let mobileFixed = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 DuckDuckGo/7 Safari/604.1"
static let tabletFixed = "Mozilla/5.0 (iPad; CPU OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 DuckDuckGo/7 Safari/604.1"
static let desktopFixed = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 DuckDuckGo/7 Safari/605.1.15"
static let mobileClosest = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1"
static let tabletClosest = "Mozilla/5.0 (iPad; CPU OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1"
static let desktopClosest = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Safari/605.1.15"
// swiftlint:enable line_length
}
private struct Constants {
static let url = URL(string: "http://example.com/index.html")
static let noAppUrl = URL(string: "http://cvs.com/index.html")
static let noAppSubdomainUrl = URL(string: "http://subdomain.cvs.com/index.html")
static let ddgFixedUrl = URL(string: "http://test2.com/index.html")
static let ddgDefaultUrl = URL(string: "http://test3.com/index.html")
}
let testConfig = """
{
"features": {
"customUserAgent": {
"state": "enabled",
"settings": {
"omitApplicationSites": [
{
"domain": "cvs.com",
"reason": "Site reports browser not supported"
}
]
},
"exceptions": []
}
},
"unprotectedTemporary": []
}
""".data(using: .utf8)!
private var privacyConfig: PrivacyConfiguration!
override func setUp() {
super.setUp()
let mockEmbeddedData = MockEmbeddedDataProvider(data: testConfig, etag: "test")
let mockProtectionStore = MockDomainsProtectionStore()
let manager = PrivacyConfigurationManager(fetchedETag: nil,
fetchedData: nil,
embeddedDataProvider: mockEmbeddedData,
localProtection: mockProtectionStore,
internalUserDecider: DefaultInternalUserDecider())
privacyConfig = manager.privacyConfig
}
func testWhenMobileUaAndDektopFalseThenMobileAgentCreatedWithApplicationAndSafariSuffix() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
XCTAssertEqual(ExpectedAgent.mobile, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: privacyConfig))
}
func testWhenMobileUaAndDektopTrueThenDesktopAgentCreatedWithApplicationAndSafariSuffix() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
XCTAssertEqual(ExpectedAgent.desktop, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: privacyConfig))
}
func testWhenTabletUaAndDektopFalseThenTabletAgentCreatedWithApplicationAndSafariSuffix() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
XCTAssertEqual(ExpectedAgent.tablet, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: privacyConfig))
}
func testWhenTabletUaAndDektopTrueThenDesktopAgentCreatedWithApplicationAndSafariSuffix() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
XCTAssertEqual(ExpectedAgent.desktop, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: privacyConfig))
}
func testWhenNoUaAndDesktopFalseThenFallbackMobileAgentIsUsed() {
let testee = UserAgent()
XCTAssertEqual(ExpectedAgent.mobileFallback, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: privacyConfig))
}
func testWhenNoUaAndDesktopTrueThenFallbackDesktopAgentIsUsed() {
let testee = UserAgent()
XCTAssertEqual(ExpectedAgent.desktopFallback, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: privacyConfig))
}
func testWhenDomainDoesNotSupportApplicationComponentThenApplicationIsOmittedFromUa() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
XCTAssertEqual(ExpectedAgent.mobileNoApplication, testee.agent(forUrl: Constants.noAppUrl, isDesktop: false, privacyConfig: privacyConfig))
}
func testWhenSubdomainDoesNotSupportApplicationComponentThenApplicationIsOmittedFromUa() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
XCTAssertEqual(ExpectedAgent.mobileNoApplication,
testee.agent(forUrl: Constants.noAppSubdomainUrl, isDesktop: false, privacyConfig: privacyConfig))
}
func testWhenCustomUserAgentIsDisabledThenApplicationIsOmittedFromUa() {
let disabledConfig = """
{
"features": {
"customUserAgent": {
"state": "disabled",
"settings": {
"omitApplicationSites": [
{
"domain": "cvs.com",
"reason": "Site breakage"
}
]
},
"exceptions": []
}
},
"unprotectedTemporary": []
}
""".data(using: .utf8)!
let mockEmbeddedData = MockEmbeddedDataProvider(data: disabledConfig, etag: "test")
let mockProtectionStore = MockDomainsProtectionStore()
let manager = PrivacyConfigurationManager(fetchedETag: nil,
fetchedData: nil,
embeddedDataProvider: mockEmbeddedData,
localProtection: mockProtectionStore,
internalUserDecider: DefaultInternalUserDecider())
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
XCTAssertEqual(ExpectedAgent.mobileNoApplication, testee.agent(forUrl: Constants.url, isDesktop: false,
privacyConfig: manager.privacyConfig))
}
/// Experimental config
func makePrivacyConfig(from rawConfig: Data) -> PrivacyConfiguration {
let mockEmbeddedData = MockEmbeddedDataProvider(data: rawConfig, etag: "test")
let mockProtectionStore = MockDomainsProtectionStore()
let manager = PrivacyConfigurationManager(fetchedETag: nil,
fetchedData: nil,
embeddedDataProvider: mockEmbeddedData,
localProtection: mockProtectionStore,
internalUserDecider: DefaultInternalUserDecider())
return manager.privacyConfig
}
let ddgConfig = """
{
"features": {
"customUserAgent": {
"defaultPolicy": "ddg",
"state": "enabled",
"settings": {
"omitApplicationSites": [
{
"domain": "cvs.com",
"reason": "Site reports browser not supported"
}
],
"ddgFixedSites": [
{
"domain": "test2.com"
}
]
},
"exceptions": []
}
},
"unprotectedTemporary": []
}
""".data(using: .utf8)!
func testWhenMobileUaAndDesktopFalseAndDomainSupportsFixedUAThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: ddgConfig)
XCTAssertEqual(ExpectedAgent.mobileFixed, testee.agent(forUrl: Constants.ddgFixedUrl, isDesktop: false, privacyConfig: config))
}
func testWhenMobileUaAndDesktopTrueAndDomainSupportsFixedUAThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: ddgConfig)
XCTAssertEqual(ExpectedAgent.desktopFixed, testee.agent(forUrl: Constants.ddgFixedUrl, isDesktop: true, privacyConfig: config))
}
func testWhenTabletUaAndDesktopFalseAndDomainSupportsFixedUAThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
let config = makePrivacyConfig(from: ddgConfig)
XCTAssertEqual(ExpectedAgent.tabletFixed, testee.agent(forUrl: Constants.ddgFixedUrl, isDesktop: false, privacyConfig: config))
}
func testWhenTabletUaAndDesktopTrueAndDomainSupportsFixedUAThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
let config = makePrivacyConfig(from: ddgConfig)
XCTAssertEqual(ExpectedAgent.desktopFixed, testee.agent(forUrl: Constants.ddgFixedUrl, isDesktop: true, privacyConfig: config))
}
let ddgFixedConfig = """
{
"features": {
"customUserAgent": {
"state": "enabled",
"settings": {
"defaultPolicy": "ddgFixed",
"omitApplicationSites": [
{
"domain": "cvs.com",
"reason": "Site reports browser not supported"
}
],
"ddgDefaultSites": [
{
"domain": "test3.com"
}
]
},
"exceptions": []
}
},
"unprotectedTemporary": []
}
""".data(using: .utf8)!
func testWhenMobileUaAndDesktopFalseAndDefaultPolicyFixedThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.mobileFixed, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenMobileUaAndDesktopTrueAndDefaultPolicyFixedThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.desktopFixed, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: config))
}
func testWhenTabletUaAndDesktopFalseAndDefaultPolicyFixedThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.tabletFixed, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenTabletUaAndDesktopTrueAndDefaultPolicyFixedThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.desktopFixed, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: config))
}
func testWhenDefaultPolicyFixedAndDomainIsOnDefaultListThenDefaultAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.mobile, testee.agent(forUrl: Constants.ddgDefaultUrl, isDesktop: false, privacyConfig: config))
}
let closestConfig = """
{
"features": {
"customUserAgent": {
"state": "enabled",
"settings": {
"defaultPolicy": "closest",
"omitApplicationSites": [
{
"domain": "cvs.com",
"reason": "Site reports browser not supported"
}
],
"ddgFixedSites": [
{
"domain": "test2.com"
}
],
"ddgDefaultSites": [
{
"domain": "test3.com"
}
]
},
"exceptions": []
}
},
"unprotectedTemporary": []
}
""".data(using: .utf8)!
func testWhenMobileUaAndDesktopFalseAndDefaultPolicyClosestThenClosestMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: closestConfig)
XCTAssertEqual(ExpectedAgent.mobileClosest, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenMobileUaAndDesktopTrueAndDefaultPolicyClosestThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: closestConfig)
XCTAssertEqual(ExpectedAgent.desktopClosest, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: config))
}
func testWhenTabletUaAndDesktopFalseAndDefaultPolicyClosestThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
let config = makePrivacyConfig(from: closestConfig)
XCTAssertEqual(ExpectedAgent.tabletClosest, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenTabletUaAndDesktopTrueAndDefaultPolicyClosestThenFixedMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.tablet)
let config = makePrivacyConfig(from: closestConfig)
XCTAssertEqual(ExpectedAgent.desktopClosest, testee.agent(forUrl: Constants.url, isDesktop: true, privacyConfig: config))
}
func testWhenDefaultPolicyClosestAndDomainIsOnDefaultListThenDefaultAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: closestConfig)
XCTAssertEqual(ExpectedAgent.mobile, testee.agent(forUrl: Constants.ddgDefaultUrl, isDesktop: false, privacyConfig: config))
}
func testWhenDefaultPolicyClosestAndDomainIsOnFixedListThenFixedAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.mobile)
let config = makePrivacyConfig(from: closestConfig)
XCTAssertEqual(ExpectedAgent.mobileFixed, testee.agent(forUrl: Constants.ddgFixedUrl, isDesktop: false, privacyConfig: config))
}
let configWithVersions = """
{
"features": {
"customUserAgent": {
"state": "enabled",
"settings": {
"defaultPolicy": "ddg",
"omitApplicationSites": [
{
"domain": "cvs.com",
"reason": "Site reports browser not supported"
}
],
"closestUserAgent": {
"versions": ["350", "360"]
},
"ddgFixedUserAgent": {
"versions": ["351", "361"]
}
},
"exceptions": []
}
},
"unprotectedTemporary": []
}
""".data(using: .utf8)!
func testWhenAtbDoesNotMatchVersionFromConfigThenDefaultUAIsUsed() {
let statisticsStore = MockStatisticsStore()
statisticsStore.atb = "v300-1"
let testee = UserAgent(defaultAgent: DefaultAgent.mobile, statistics: statisticsStore)
let config = makePrivacyConfig(from: configWithVersions)
XCTAssertEqual(ExpectedAgent.mobile, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenAtbMatchesVersionInClosestUserAgentThenClosestUAIsUsed() {
let statisticsStore = MockStatisticsStore()
statisticsStore.atb = "v360-1"
let testee = UserAgent(defaultAgent: DefaultAgent.mobile, statistics: statisticsStore)
let config = makePrivacyConfig(from: configWithVersions)
XCTAssertEqual(ExpectedAgent.mobileClosest, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenAtbMatchesVersionInDDGFixedUserAgentThenDDGFixedUAIsUsed() {
let statisticsStore = MockStatisticsStore()
statisticsStore.atb = "v361-1"
let testee = UserAgent(defaultAgent: DefaultAgent.mobile, statistics: statisticsStore)
let config = makePrivacyConfig(from: configWithVersions)
XCTAssertEqual(ExpectedAgent.mobileFixed, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenAtbWithoutDayComponentMatchesVersionInDDGFixedUserAgentThenDDGFixedUAIsUsed() {
let statisticsStore = MockStatisticsStore()
statisticsStore.atb = "v361"
let testee = UserAgent(defaultAgent: DefaultAgent.mobile, statistics: statisticsStore)
let config = makePrivacyConfig(from: configWithVersions)
XCTAssertEqual(ExpectedAgent.mobileFixed, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenOldWebKitVersionThenDefaultMobileAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.oldWebkitVersionMobile)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.oldWebkitVersionMobile, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenNewerWebKitVersionThenFixedAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.newWebkitVersionMobile)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.newWebkitVersionMobile, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
func testWhenSameWebKitVersionThenFixedAgentUsed() {
let testee = UserAgent(defaultAgent: DefaultAgent.sameWebkitVersionMobile)
let config = makePrivacyConfig(from: ddgFixedConfig)
XCTAssertEqual(ExpectedAgent.sameWebkitVersionMobile, testee.agent(forUrl: Constants.url, isDesktop: false, privacyConfig: config))
}
}
// swiftlint:enable file_length type_body_length