mozilla-central/mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/StorageControllerTest.kt (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
* Any copyright is dedicated to the Public Domain.
package org.mozilla.geckoview.test
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.filters.MediumTest
import org.hamcrest.Matchers.* // ktlint-disable no-wildcard-imports
import org.junit.Test
import org.junit.runner.RunWith
import org.mozilla.geckoview.ContentBlocking.CookieBannerMode.COOKIE_BANNER_MODE_DISABLED
import org.mozilla.geckoview.ContentBlocking.CookieBannerMode.COOKIE_BANNER_MODE_REJECT
import org.mozilla.geckoview.ContentBlocking.CookieBannerMode.COOKIE_BANNER_MODE_REJECT_OR_ACCEPT
import org.mozilla.geckoview.GeckoSessionSettings
import org.mozilla.geckoview.StorageController
@RunWith(AndroidJUnit4::class)
@MediumTest
class StorageControllerTest : BaseSessionTest() {
private val storageController
get() = sessionRule.runtime.storageController
@Test fun clearData() {
mainSession.loadUri("https://example.com")
sessionRule.waitForPageStop()
mainSession.evaluateJS(
"""
localStorage.setItem('ctx', 'test');
document.cookie = 'ctx=test';
""",
)
var localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
var cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearData(
StorageController.ClearFlags.ALL,
),
)
localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("null"),
)
}
@Test fun clearDataFlags() {
mainSession.loadUri("https://example.com")
sessionRule.waitForPageStop()
mainSession.evaluateJS(
"""
localStorage.setItem('ctx', 'test');
document.cookie = 'ctx=test';
""",
)
var localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
var cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearData(
StorageController.ClearFlags.COOKIES,
),
)
localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
// With LSNG disabled, storage is also cleared when cookies are,
// see bug 1592752.
if (sessionRule.getPrefs("dom.storage.enable_unsupported_legacy_implementation")[0] as Boolean == false) {
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
} else {
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
}
assertThat(
"Cookie value should match",
cookie,
equalTo("null"),
)
mainSession.evaluateJS(
"""
document.cookie = 'ctx=test';
""",
)
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearData(
StorageController.ClearFlags.DOM_STORAGES,
),
)
localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
mainSession.evaluateJS(
"""
localStorage.setItem('ctx', 'test');
""",
)
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearData(
StorageController.ClearFlags.SITE_DATA,
),
)
localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("null"),
)
}
@Test fun clearDataFromHost() {
mainSession.loadUri("https://example.com")
sessionRule.waitForPageStop()
mainSession.evaluateJS(
"""
localStorage.setItem('ctx', 'test');
document.cookie = 'ctx=test';
""",
)
var localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
var cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearDataFromHost(
"test.com",
StorageController.ClearFlags.ALL,
),
)
localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearDataFromHost(
"example.com",
StorageController.ClearFlags.ALL,
),
)
localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("null"),
)
}
@Test fun clearDataFromBaseDomain() {
var domains = arrayOf("example.com", "test1.example.com")
// Set site data for both root domain and subdomain.
for (domain in domains) {
mainSession.loadUri("https://" + domain)
sessionRule.waitForPageStop()
mainSession.evaluateJS(
"""
localStorage.setItem('ctx', 'test');
document.cookie = 'ctx=test';
""",
)
var localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
var cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
}
// Clear data for an unrelated domain. The test data should still be
// set.
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearDataFromBaseDomain(
"test.com",
StorageController.ClearFlags.ALL,
),
)
for (domain in domains) {
mainSession.loadUri("https://" + domain)
sessionRule.waitForPageStop()
var localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
var cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("test"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("ctx=test"),
)
}
// Finally, clear the test data by base domain. This should clear both,
// the root domain and the subdomain.
sessionRule.waitForResult(
sessionRule.runtime.storageController.clearDataFromBaseDomain(
"example.com",
StorageController.ClearFlags.ALL,
),
)
for (domain in domains) {
mainSession.loadUri("https://" + domain)
sessionRule.waitForPageStop()
var localStorage = mainSession.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
var cookie = mainSession.evaluateJS(
"""
document.cookie || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
assertThat(
"Cookie value should match",
cookie,
equalTo("null"),
)
}
}
private fun testSessionContext(baseSettings: GeckoSessionSettings) {
val session1 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(baseSettings)
.contextId("1")
.build(),
)
session1.loadUri("https://example.com")
session1.waitForPageStop()
session1.evaluateJS(
"""
localStorage.setItem('ctx', '1');
""",
)
var localStorage = session1.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("1"),
)
session1.reload()
session1.waitForPageStop()
localStorage = session1.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("1"),
)
val session2 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(baseSettings)
.contextId("2")
.build(),
)
session2.loadUri("https://example.com")
session2.waitForPageStop()
localStorage = session2.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should be null",
localStorage,
equalTo("null"),
)
session2.evaluateJS(
"""
localStorage.setItem('ctx', '2');
""",
)
localStorage = session2.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("2"),
)
session1.loadUri("https://example.com")
session1.waitForPageStop()
localStorage = session1.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("1"),
)
val session3 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(baseSettings)
.contextId("2")
.build(),
)
session3.loadUri("https://example.com")
session3.waitForPageStop()
localStorage = session3.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("2"),
)
}
@Test fun sessionContext() {
testSessionContext(mainSession.settings)
}
@Test fun sessionContextPrivateMode() {
testSessionContext(
GeckoSessionSettings.Builder(mainSession.settings)
.usePrivateMode(true)
.build(),
)
}
@Test fun clearDataForSessionContext() {
val session1 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("1")
.build(),
)
session1.loadUri("https://example.com")
session1.waitForPageStop()
session1.evaluateJS(
"""
localStorage.setItem('ctx', '1');
""",
)
var localStorage = session1.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("1"),
)
session1.close()
val session2 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("2")
.build(),
)
session2.loadUri("https://example.com")
session2.waitForPageStop()
session2.evaluateJS(
"""
localStorage.setItem('ctx', '2');
""",
)
localStorage = session2.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("2"),
)
session2.close()
sessionRule.runtime.storageController.clearDataForSessionContext("1")
val session3 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("1")
.build(),
)
session3.loadUri("https://example.com")
session3.waitForPageStop()
localStorage = session3.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("null"),
)
val session4 = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("2")
.build(),
)
session4.loadUri("https://example.com")
session4.waitForPageStop()
localStorage = session4.evaluateJS(
"""
localStorage.getItem('ctx') || 'null'
""",
) as String
assertThat(
"Local storage value should match",
localStorage,
equalTo("2"),
)
}
@Test fun setCookieBannerModeForDomain() {
val contentBlocking = sessionRule.runtime.settings.contentBlocking
contentBlocking.cookieBannerMode = COOKIE_BANNER_MODE_REJECT
val session = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("1")
.build(),
)
session.loadUri("https://example.com")
session.waitForPageStop()
var mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
false,
),
)
assertThat(
"Cookie banner mode should match",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT),
)
sessionRule.waitForResult(
storageController.setCookieBannerModeForDomain(
COOKIE_BANNER_MODE_REJECT_OR_ACCEPT,
false,
),
)
mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
false,
),
)
assertThat(
"Cookie banner mode should match",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT_OR_ACCEPT),
)
}
@Test
fun setCookieBannerModeAndPersistInPrivateBrowsingForDomain() {
val contentBlocking = sessionRule.runtime.settings.contentBlocking
contentBlocking.cookieBannerMode = COOKIE_BANNER_MODE_REJECT
val session = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("1")
.usePrivateMode(true)
.build(),
)
session.loadUri("https://example.com")
session.waitForPageStop()
var mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
true,
),
)
assertThat(
"Cookie banner mode should match",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT),
)
sessionRule.waitForResult(
storageController.setCookieBannerModeAndPersistInPrivateBrowsingForDomain(
COOKIE_BANNER_MODE_REJECT_OR_ACCEPT,
),
)
mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
true,
),
)
assertThat(
"Cookie banner mode should match",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT_OR_ACCEPT),
)
session.close()
mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
true,
),
)
assertThat(
"Cookie banner mode should match",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT_OR_ACCEPT),
)
}
@Test
fun getCookieBannerModeForDomain() {
val contentBlocking = sessionRule.runtime.settings.contentBlocking
contentBlocking.cookieBannerMode = COOKIE_BANNER_MODE_DISABLED
val session = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("1")
.build(),
)
session.loadUri("https://example.com")
session.waitForPageStop()
try {
val mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
false,
),
)
assertThat(
"Cookie banner mode should match",
mode,
equalTo(COOKIE_BANNER_MODE_DISABLED),
)
} catch (e: Exception) {
assertThat(
"Cookie banner mode should match",
e.message,
containsString("The cookie banner handling service is not available"),
)
}
}
@Test fun removeCookieBannerModeForDomain() {
val contentBlocking = sessionRule.runtime.settings.contentBlocking
contentBlocking.cookieBannerModePrivateBrowsing = COOKIE_BANNER_MODE_REJECT
sessionRule.setPrefsUntilTestEnd(mapOf("cookiebanners.service.mode.privateBrowsing" to COOKIE_BANNER_MODE_REJECT))
val session = sessionRule.createOpenSession(
GeckoSessionSettings.Builder(mainSession.settings)
.contextId("1")
.build(),
)
session.loadUri("https://example.com")
session.waitForPageStop()
sessionRule.waitForResult(
storageController.setCookieBannerModeForDomain(
COOKIE_BANNER_MODE_REJECT_OR_ACCEPT,
true,
),
)
var mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
true,
),
)
assertThat(
"Cookie banner mode should match $COOKIE_BANNER_MODE_REJECT_OR_ACCEPT but it is $mode",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT_OR_ACCEPT),
)
sessionRule.waitForResult(
storageController.removeCookieBannerModeForDomain(
true,
),
)
mode = sessionRule.waitForResult(
storageController.getCookieBannerModeForDomain(
true,
),
)
assertThat(
"Cookie banner mode should match $COOKIE_BANNER_MODE_REJECT but it is $mode",
mode,
equalTo(COOKIE_BANNER_MODE_REJECT),
)
}
}