Merge remote-tracking branch 'origin/upstream'main

Import b/312293934

1 files changed, 650 insertions, 0 deletions

diff --git a/tests/ceftests/preference_unittest.cc b/tests/ceftests/preference_unittest.cc
new file mode 100644
index 00000000..f04db957
--- /dev/null
+++ b/tests/ceftests/preference_unittest.cc
@@ -0,0 +1,650 @@
+// Copyright (c) 2015 The Chromium Embedded Framework Authors. All rights
+// reserved. Use of this source code is governed by a BSD-style license that
+// can be found in the LICENSE file.
+
+#include "include/base/cef_callback.h"
+#include "include/cef_request_context_handler.h"
+#include "include/cef_waitable_event.h"
+#include "include/wrapper/cef_closure_task.h"
+#include "tests/ceftests/test_handler.h"
+#include "tests/ceftests/test_util.h"
+#include "tests/gtest/include/gtest/gtest.h"
+#include "tests/shared/browser/client_app_browser.h"
+
+namespace {
+
+// Fully qualified preference names.
+const char kPrefTest[] = "test";
+const char kPrefTestBool[] = "test.bool";
+const char kPrefTestInt[] = "test.int";
+const char kPrefTestDouble[] = "test.double";
+const char kPrefTestString[] = "test.string";
+const char kPrefTestList[] = "test.list";
+const char kPrefTestDict[] = "test.dict";
+const char kPrefTestNoExist[] = "test.noexist";
+
+// Unqualified preference names.
+const char kPrefBool[] = "bool";
+const char kPrefInt[] = "int";
+const char kPrefDouble[] = "double";
+const char kPrefString[] = "string";
+const char kPrefList[] = "list";
+const char kPrefDict[] = "dict";
+
+std::string* PendingAction() {
+  static std::string str;
+  return &str;
+}
+
+CefRefPtr<CefValue> CreateBoolValue(bool value) {
+  auto val = CefValue::Create();
+  val->SetBool(value);
+  return val;
+}
+
+CefRefPtr<CefValue> CreateIntValue(int value) {
+  auto val = CefValue::Create();
+  val->SetInt(value);
+  return val;
+}
+
+CefRefPtr<CefValue> CreateDoubleValue(double value) {
+  auto val = CefValue::Create();
+  val->SetDouble(value);
+  return val;
+}
+
+CefRefPtr<CefValue> CreateStringValue(const std::string& value) {
+  auto val = CefValue::Create();
+  val->SetString(value);
+  return val;
+}
+
+CefRefPtr<CefValue> CreateListValue(CefRefPtr<CefListValue> value) {
+  auto val = CefValue::Create();
+  val->SetList(value);
+  return val;
+}
+
+CefRefPtr<CefValue> CreateDictionaryValue(CefRefPtr<CefDictionaryValue> value) {
+  auto val = CefValue::Create();
+  val->SetDictionary(value);
+  return val;
+}
+
+// Browser-side app delegate.
+class PreferenceBrowserTest : public client::ClientAppBrowser::Delegate {
+ public:
+  PreferenceBrowserTest() {}
+
+  void OnRegisterCustomPreferences(
+      CefRefPtr<client::ClientAppBrowser> app,
+      cef_preferences_type_t type,
+      CefRawPtr<CefPreferenceRegistrar> registrar) override {
+    // Register test preferences.
+    registrar->AddPreference(kPrefTestBool, CreateBoolValue(true));
+    registrar->AddPreference(kPrefTestInt, CreateIntValue(2));
+    registrar->AddPreference(kPrefTestDouble, CreateDoubleValue(5.0));
+    registrar->AddPreference(kPrefTestString, CreateStringValue("default"));
+    registrar->AddPreference(kPrefTestList,
+                             CreateListValue(CefListValue::Create()));
+    registrar->AddPreference(
+        kPrefTestDict, CreateDictionaryValue(CefDictionaryValue::Create()));
+  }
+
+ private:
+  IMPLEMENT_REFCOUNTING(PreferenceBrowserTest);
+};
+
+void ValidateReset(CefRefPtr<CefPreferenceManager> context, const char* name) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  CefString error;
+  EXPECT_TRUE(context->SetPreference(name, nullptr, error));
+  EXPECT_TRUE(error.empty());
+}
+
+void ValidateBool(CefRefPtr<CefPreferenceManager> context,
+                  bool set,
+                  bool expected,
+                  const char* name = kPrefTestBool) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_TRUE(context->SetPreference(name, CreateBoolValue(expected), error));
+    EXPECT_TRUE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_TRUE(value.get());
+  EXPECT_EQ(VTYPE_BOOL, value->GetType());
+  EXPECT_EQ(expected, value->GetBool()) << *PendingAction();
+}
+
+void ValidateInt(CefRefPtr<CefPreferenceManager> context,
+                 bool set,
+                 int expected,
+                 const char* name = kPrefTestInt) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_TRUE(context->SetPreference(name, CreateIntValue(expected), error));
+    EXPECT_TRUE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_TRUE(value.get());
+  EXPECT_EQ(VTYPE_INT, value->GetType());
+  EXPECT_EQ(expected, value->GetInt()) << *PendingAction();
+}
+
+void ValidateDouble(CefRefPtr<CefPreferenceManager> context,
+                    bool set,
+                    double expected,
+                    const char* name = kPrefTestDouble) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_TRUE(
+        context->SetPreference(name, CreateDoubleValue(expected), error));
+    EXPECT_TRUE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_TRUE(value.get());
+  EXPECT_EQ(VTYPE_DOUBLE, value->GetType());
+  EXPECT_EQ(expected, value->GetDouble()) << *PendingAction();
+}
+
+void ValidateString(CefRefPtr<CefPreferenceManager> context,
+                    bool set,
+                    const std::string& expected,
+                    const char* name = kPrefTestString) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_TRUE(
+        context->SetPreference(name, CreateStringValue(expected), error));
+    EXPECT_TRUE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_TRUE(value.get());
+  EXPECT_EQ(VTYPE_STRING, value->GetType());
+  EXPECT_STREQ(expected.c_str(), value->GetString().ToString().c_str())
+      << *PendingAction();
+}
+
+void ValidateList(CefRefPtr<CefPreferenceManager> context,
+                  bool set,
+                  CefRefPtr<CefListValue> expected,
+                  const char* name = kPrefTestList) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_TRUE(context->SetPreference(name, CreateListValue(expected), error));
+    EXPECT_TRUE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_TRUE(value.get());
+  EXPECT_EQ(VTYPE_LIST, value->GetType());
+  CefRefPtr<CefListValue> list_val = value->GetList();
+  EXPECT_TRUE(list_val);
+  TestListEqual(expected, list_val);
+}
+
+void ValidateDict(CefRefPtr<CefPreferenceManager> context,
+                  bool set,
+                  CefRefPtr<CefDictionaryValue> expected,
+                  const char* name = kPrefTestDict) {
+  EXPECT_TRUE(context->HasPreference(name));
+  EXPECT_TRUE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_TRUE(
+        context->SetPreference(name, CreateDictionaryValue(expected), error));
+    EXPECT_TRUE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_TRUE(value.get());
+  EXPECT_EQ(VTYPE_DICTIONARY, value->GetType());
+  CefRefPtr<CefDictionaryValue> dict_val = value->GetDictionary();
+  EXPECT_TRUE(dict_val);
+  TestDictionaryEqual(expected, dict_val);
+}
+
+void ValidateNoExist(CefRefPtr<CefPreferenceManager> context,
+                     bool set,
+                     const char* name = kPrefTestNoExist) {
+  EXPECT_FALSE(context->HasPreference(name));
+  EXPECT_FALSE(context->CanSetPreference(name));
+
+  if (set) {
+    CefString error;
+    EXPECT_FALSE(context->SetPreference(name, CreateBoolValue(false), error));
+    EXPECT_FALSE(error.empty());
+  }
+
+  auto value = context->GetPreference(name);
+  EXPECT_FALSE(value.get()) << *PendingAction();
+}
+
+void PopulateRootDefaults(CefRefPtr<CefDictionaryValue> val) {
+  // Should match the values in OnRegisterCustomPreferences.
+  val->SetBool(kPrefBool, true);
+  val->SetInt(kPrefInt, 2);
+  val->SetDouble(kPrefDouble, 5.0);
+  val->SetString(kPrefString, "default");
+  val->SetList(kPrefList, CefListValue::Create());
+  val->SetDictionary(kPrefDict, CefDictionaryValue::Create());
+}
+
+void ValidateRoot(CefRefPtr<CefDictionaryValue> root,
+                  CefRefPtr<CefDictionaryValue> expected,
+                  const char* name = kPrefTest) {
+  EXPECT_TRUE(root->HasKey(kPrefTest));
+  EXPECT_EQ(VTYPE_DICTIONARY, root->GetType(kPrefTest));
+
+  CefRefPtr<CefDictionaryValue> actual = root->GetDictionary(kPrefTest);
+  TestDictionaryEqual(expected, actual);
+}
+
+// Validate getting default values.
+void ValidateDefaults(CefRefPtr<CefPreferenceManager> context,
+                      bool reset,
+                      CefRefPtr<CefWaitableEvent> event) {
+  if (!CefCurrentlyOn(TID_UI)) {
+    CefPostTask(TID_UI,
+                base::BindOnce(ValidateDefaults, context, reset, event));
+    return;
+  }
+
+  if (reset) {
+    // Reset default values.
+    ValidateReset(context, kPrefTestBool);
+    ValidateReset(context, kPrefTestInt);
+    ValidateReset(context, kPrefTestDouble);
+    ValidateReset(context, kPrefTestString);
+    ValidateReset(context, kPrefTestList);
+    ValidateReset(context, kPrefTestDict);
+  }
+
+  // Test default values.
+  // Should match the values in CefBrowserPrefStore::CreateService.
+  ValidateBool(context, false, true);
+  ValidateInt(context, false, 2);
+  ValidateDouble(context, false, 5.0);
+  ValidateString(context, false, "default");
+  ValidateList(context, false, CefListValue::Create());
+  ValidateDict(context, false, CefDictionaryValue::Create());
+  ValidateNoExist(context, false);
+
+  // Expected value of the tests root.
+  CefRefPtr<CefDictionaryValue> expected = CefDictionaryValue::Create();
+  PopulateRootDefaults(expected);
+
+  // Test all preferences including defaults.
+  ValidateRoot(context->GetAllPreferences(true), expected);
+
+  // Test all preferences excluding defaults.
+  EXPECT_FALSE(context->GetAllPreferences(false)->HasKey(kPrefTest));
+
+  event->Signal();
+}
+
+void PopulateListValue(CefRefPtr<CefListValue> val) {
+  // Test list values.
+  val->SetInt(0, 54);
+  val->SetString(1, "foobar");
+  val->SetDouble(2, 99.7643);
+}
+
+void PopulateDictValue(CefRefPtr<CefDictionaryValue> val) {
+  // Test dictionary values.
+  val->SetString("key1", "some string");
+  val->SetBool("key2", false);
+
+  CefRefPtr<CefListValue> list_val = CefListValue::Create();
+  PopulateListValue(list_val);
+  val->SetList("key3", list_val);
+}
+
+void PopulateRootSet(CefRefPtr<CefDictionaryValue> val) {
+  CefRefPtr<CefListValue> list_val = CefListValue::Create();
+  CefRefPtr<CefDictionaryValue> dict_val = CefDictionaryValue::Create();
+
+  PopulateListValue(list_val);
+  PopulateDictValue(dict_val);
+
+  // Should match the values in ValidateSetGet and ValidateGet.
+  val->SetBool(kPrefBool, true);
+  val->SetInt(kPrefInt, 65);
+  val->SetDouble(kPrefDouble, 54.5443);
+  val->SetString(kPrefString, "My test string");
+  val->SetList(kPrefList, list_val);
+  val->SetDictionary(kPrefDict, dict_val);
+}
+
+// Validate getting and setting values.
+void ValidateSetGet(CefRefPtr<CefPreferenceManager> context,
+                    CefRefPtr<CefWaitableEvent> event) {
+  if (!CefCurrentlyOn(TID_UI)) {
+    CefPostTask(TID_UI, base::BindOnce(ValidateSetGet, context, event));
+    return;
+  }
+
+  CefRefPtr<CefListValue> list_val = CefListValue::Create();
+  CefRefPtr<CefDictionaryValue> dict_val = CefDictionaryValue::Create();
+
+  PopulateListValue(list_val);
+  PopulateDictValue(dict_val);
+
+  // Test setting/getting values.
+  // Should match the values in PopulateRootSet and ValidateGet.
+  ValidateBool(context, true, true);
+  ValidateInt(context, true, 65);
+  ValidateDouble(context, true, 54.5443);
+  ValidateString(context, true, "My test string");
+  ValidateList(context, true, list_val);
+  ValidateDict(context, true, dict_val);
+  ValidateNoExist(context, true);
+
+  // Expected value of the tests root.
+  CefRefPtr<CefDictionaryValue> expected = CefDictionaryValue::Create();
+  PopulateRootSet(expected);
+
+  // Validate all preferences including defaults.
+  ValidateRoot(context->GetAllPreferences(true), expected);
+
+  // Validate all preferences excluding defaults.
+  ValidateRoot(context->GetAllPreferences(false), expected);
+
+  event->Signal();
+}
+
+// Validate getting values.
+void ValidateGet(CefRefPtr<CefPreferenceManager> context,
+                 CefRefPtr<CefWaitableEvent> event) {
+  if (!CefCurrentlyOn(TID_UI)) {
+    CefPostTask(TID_UI, base::BindOnce(ValidateGet, context, event));
+    return;
+  }
+
+  CefRefPtr<CefListValue> list_val = CefListValue::Create();
+  CefRefPtr<CefDictionaryValue> dict_val = CefDictionaryValue::Create();
+
+  PopulateListValue(list_val);
+  PopulateDictValue(dict_val);
+
+  // Test getting values.
+  // Should match the values in PopulateRootSet and ValidateSetGet.
+  ValidateBool(context, false, true);
+  ValidateInt(context, false, 65);
+  ValidateDouble(context, false, 54.5443);
+  ValidateString(context, false, "My test string");
+  ValidateList(context, false, list_val);
+  ValidateDict(context, false, dict_val);
+  ValidateNoExist(context, false);
+
+  // Expected value of the tests root.
+  CefRefPtr<CefDictionaryValue> expected = CefDictionaryValue::Create();
+  PopulateRootSet(expected);
+
+  // Validate all preferences including defaults.
+  ValidateRoot(context->GetAllPreferences(true), expected);
+
+  // Validate all preferences excluding defaults.
+  ValidateRoot(context->GetAllPreferences(false), expected);
+
+  event->Signal();
+}
+
+// No-op implementation.
+class TestRequestContextHandler : public CefRequestContextHandler {
+ public:
+  TestRequestContextHandler() {}
+  explicit TestRequestContextHandler(CefRefPtr<CefWaitableEvent> event)
+      : event_(event) {}
+
+  void OnRequestContextInitialized(
+      CefRefPtr<CefRequestContext> context) override {
+    if (event_) {
+      event_->Signal();
+      event_ = nullptr;
+    }
+  }
+
+ private:
+  CefRefPtr<CefWaitableEvent> event_;
+
+  IMPLEMENT_REFCOUNTING(TestRequestContextHandler);
+};
+
+}  // namespace
+
+// Verify default preference values on the global state.
+TEST(PreferenceTest, GlobalDefaults) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  auto context = CefPreferenceManager::GetGlobalPreferenceManager();
+  EXPECT_TRUE(context.get());
+
+  ValidateDefaults(context, false, event);
+  event->Wait();
+}
+
+// Verify setting/getting preference values on the global state.
+TEST(PreferenceTest, GlobalSetGet) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  auto context = CefPreferenceManager::GetGlobalPreferenceManager();
+  EXPECT_TRUE(context.get());
+
+  ValidateSetGet(context, event);
+  event->Wait();
+
+  // Reset to the default values.
+  ValidateDefaults(context, true, event);
+  event->Wait();
+}
+
+// Verify default preference values on the global request context.
+TEST(PreferenceTest, RequestContextGlobalDefaults) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  CefRefPtr<CefRequestContext> context = CefRequestContext::GetGlobalContext();
+  EXPECT_TRUE(context.get());
+
+  ValidateDefaults(context, false, event);
+  event->Wait();
+}
+
+// Verify setting/getting preference values on the global request context.
+TEST(PreferenceTest, RequestContextGlobalSetGet) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  CefRefPtr<CefRequestContext> context = CefRequestContext::GetGlobalContext();
+  EXPECT_TRUE(context.get());
+
+  ValidateSetGet(context, event);
+  event->Wait();
+
+  // Reset to the default values.
+  ValidateDefaults(context, true, event);
+  event->Wait();
+}
+
+// Verify setting/getting preference values on shared global request contexts.
+TEST(PreferenceTest, RequestContextGlobalSetGetShared) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  CefRefPtr<CefRequestContext> context = CefRequestContext::GetGlobalContext();
+  EXPECT_TRUE(context.get());
+
+  // Sharing storage.
+  CefRefPtr<CefRequestContext> context2 =
+      CefRequestContext::CreateContext(context, nullptr);
+  EXPECT_TRUE(context2.get());
+
+  // Sharing storage.
+  CefRefPtr<CefRequestContext> context3 =
+      CefRequestContext::CreateContext(context, new TestRequestContextHandler);
+  EXPECT_TRUE(context3.get());
+
+  // Unassociated context.
+  CefRequestContextSettings settings;
+  CefRefPtr<CefRequestContext> context4 = CefRequestContext::CreateContext(
+      settings, new TestRequestContextHandler(event));
+  EXPECT_TRUE(context4.get());
+  // Wait for the context to be fully initialized.
+  event->Wait();
+
+  // Set/get the values on the first context.
+  *PendingAction() = "Set/get the values on the first context";
+  ValidateSetGet(context, event);
+  event->Wait();
+
+  // Get the values from the 2nd and 3rd contexts. They should be the same.
+  *PendingAction() = "Get the values from the 2nd context.";
+  ValidateGet(context2, event);
+  event->Wait();
+  *PendingAction() = "Get the values from the 3rd context.";
+  ValidateGet(context3, event);
+  event->Wait();
+
+  // Get the values from the 4th context.
+  *PendingAction() = "Get the values from the 4th context.";
+  if (IsChromeRuntimeEnabled()) {
+    // With the Chrome runtime, prefs set via an incognito profile will become
+    // an overlay on top of the global (parent) profile. The incognito profile
+    // shares the prefs in this case because they were set via the global
+    // profile.
+    ValidateGet(context4, event);
+  } else {
+    // They should be at the default.
+    ValidateDefaults(context4, false, event);
+  }
+  event->Wait();
+
+  // Reset to the default values.
+  *PendingAction() = "Reset to the default values.";
+  ValidateDefaults(context, true, event);
+  event->Wait();
+}
+
+// Verify default preference values on a custom request context.
+TEST(PreferenceTest, RequestContextCustomDefaults) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  CefRequestContextSettings settings;
+  CefRefPtr<CefRequestContext> context = CefRequestContext::CreateContext(
+      settings, new TestRequestContextHandler(event));
+  EXPECT_TRUE(context.get());
+  // Wait for the context to be fully initialized.
+  event->Wait();
+
+  ValidateDefaults(context, false, event);
+  event->Wait();
+}
+
+// Verify setting/getting preference values on a custom request context.
+TEST(PreferenceTest, RequestContextCustomSetGet) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  CefRequestContextSettings settings;
+  CefRefPtr<CefRequestContext> context = CefRequestContext::CreateContext(
+      settings, new TestRequestContextHandler(event));
+  EXPECT_TRUE(context.get());
+  // Wait for the context to be fully initialized.
+  event->Wait();
+
+  ValidateSetGet(context, event);
+  event->Wait();
+
+  // Reset to the default values.
+  ValidateDefaults(context, true, event);
+  event->Wait();
+}
+
+// Verify setting/getting preference values on shared custom request contexts.
+TEST(PreferenceTest, RequestContextCustomSetGetShared) {
+  CefRefPtr<CefWaitableEvent> event =
+      CefWaitableEvent::CreateWaitableEvent(true, false);
+
+  CefRequestContextSettings settings;
+  CefRefPtr<CefRequestContext> context = CefRequestContext::CreateContext(
+      settings, new TestRequestContextHandler(event));
+  EXPECT_TRUE(context.get());
+  // Wait for the context to be fully initialized.
+  event->Wait();
+
+  // Sharing storage.
+  CefRefPtr<CefRequestContext> context2 =
+      CefRequestContext::CreateContext(context, nullptr);
+  EXPECT_TRUE(context2.get());
+
+  // Sharing storage.
+  CefRefPtr<CefRequestContext> context3 =
+      CefRequestContext::CreateContext(context, new TestRequestContextHandler);
+  EXPECT_TRUE(context3.get());
+
+  // Unassociated context.
+  CefRefPtr<CefRequestContext> context4 = CefRequestContext::CreateContext(
+      settings, new TestRequestContextHandler(event));
+  EXPECT_TRUE(context4.get());
+  // Wait for the context to be fully initialized.
+  event->Wait();
+
+  // Set/get the values on the first context.
+  *PendingAction() = "Set/get the values on the first context";
+  ValidateSetGet(context, event);
+  event->Wait();
+
+  // Get the values from the 2nd and 3d contexts. They should be the same.
+  *PendingAction() = "Get the values from the 2nd context.";
+  ValidateGet(context2, event);
+  event->Wait();
+  *PendingAction() = "Get the values from the 3rd context.";
+  ValidateGet(context3, event);
+  event->Wait();
+
+  // Get the values from the 4th context. They should be at the default.
+  // This works with the Chrome runtime because the preference changes only
+  // exist in the other incognito profile's overlay.
+  *PendingAction() = "Get the values from the 4th context.";
+  ValidateDefaults(context4, false, event);
+  event->Wait();
+
+  // Reset to the default values.
+  *PendingAction() = "Reset to the default values.";
+  ValidateDefaults(context, true, event);
+  event->Wait();
+}
+
+// Entry point for creating preference browser test objects.
+// Called from client_app_delegates.cc.
+void CreatePreferenceBrowserTests(
+    client::ClientAppBrowser::DelegateSet& delegates) {
+  delegates.insert(new PreferenceBrowserTest);
+}