From e999fa1ce568796aa3f0901a98d68c9540078719 Mon Sep 17 00:00:00 2001 From: boocmp Date: Sun, 20 Oct 2024 17:04:49 +0700 Subject: [PATCH] Added tests. --- .../ad_block_custom_resources_browsertest.cc | 218 ++++++++++++++++++ .../ad_block_service_browsertest.cc | 2 +- .../ad_block_service_browsertest.h | 2 +- .../brave_adblock_subpage.ts | 1 + .../brave_adblock_scriptlet_editor.html | 4 +- .../brave_adblock_scriptlet_editor.ts | 34 ++- .../brave_adblock_scriptlet_list.html | 8 +- .../brave_adblock_scriptlet_list.ts | 16 +- test/BUILD.gn | 1 + 9 files changed, 270 insertions(+), 16 deletions(-) create mode 100644 browser/brave_shields/ad_block_custom_resources_browsertest.cc diff --git a/browser/brave_shields/ad_block_custom_resources_browsertest.cc b/browser/brave_shields/ad_block_custom_resources_browsertest.cc new file mode 100644 index 000000000000..ae36928bb455 --- /dev/null +++ b/browser/brave_shields/ad_block_custom_resources_browsertest.cc @@ -0,0 +1,218 @@ +/* Copyright (c) 2024 The Brave Authors. All rights reserved. + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at https://mozilla.org/MPL/2.0/. */ + +#include "base/base64.h" +#include "base/test/scoped_feature_list.h" +#include "base/values.h" +#include "brave/browser/brave_browser_process.h" +#include "brave/browser/brave_shields/ad_block_service_browsertest.h" +#include "brave/browser/ui/webui/brave_settings_ui.h" +#include "brave/components/brave_shields/content/browser/ad_block_service.h" +#include "brave/components/brave_shields/core/browser/ad_block_custom_resource_provider.h" +#include "brave/components/brave_shields/core/common/features.h" +#include "chrome/browser/interstitials/security_interstitial_page_test_utils.h" +#include "content/public/test/browser_test.h" +#include "content/public/test/browser_test_utils.h" +#include "url/gurl.h" + +#if BUILDFLAG(IS_ANDROID) +#include "chrome/test/base/android/android_browser_test.h" +#else +#include "chrome/test/base/in_process_browser_test.h" +#endif + +namespace { + +void AwaitElement(content::WebContents* web_contents, + const std::string& root, + const std::string& id) { + constexpr const char kScript[] = R"js( + (async () => { + while (!window.testing[$1].getElementById($2)) { + await new Promise(r => setTimeout(r, 10)); + } + return true; + })(); + )js"; + EXPECT_TRUE( + content::EvalJs(web_contents, content::JsReplace(kScript, root, id)) + .ExtractBool()); +} + +bool ClickAddCustomScriptlet(content::WebContents* web_contents) { + AwaitElement(web_contents, "adblockScriptletList", "add-custom-scriptlet"); + return EvalJs(web_contents, + "window.testing.adblockScriptletList.getElementById('add-" + "custom-scriptlet').click()") + .value.is_none(); +} + +bool SetCustomScriptletValue(content::WebContents* web_contents, + const std::string& id, + const std::string& value) { + AwaitElement(web_contents, "adblockScriptletEditor", id); + constexpr const char kSetValue[] = R"js( + (function() { + const e = window.testing.adblockScriptletEditor.getElementById($1); + e.value = $2; + const event = new Event('input', {bubbles: true}); + event.simulated = true; + return e.dispatchEvent(event); + })(); + )js"; + return EvalJs(web_contents, content::JsReplace(kSetValue, id, value)) + .value.GetBool(); +} + +bool SetCustomScriptletName(content::WebContents* web_contents, + const std::string& name) { + return SetCustomScriptletValue(web_contents, "scriptlet-name", name); +} + +bool SetCustomScriptletContent(content::WebContents* web_contents, + const std::string& content) { + return SetCustomScriptletValue(web_contents, "scriptlet-content", content); +} + +std::string GetCustomScriptletValue(content::WebContents* web_contents, + const std::string& id) { + AwaitElement(web_contents, "adblockScriptletEditor", id); + return EvalJs(web_contents, + "window.testing.adblockScriptletEditor.getElementById('" + id + + "').value") + .value.GetString(); +} + +std::string GetCustomScriptletName(content::WebContents* web_contents) { + return GetCustomScriptletValue(web_contents, "scriptlet-name"); +} + +std::string GetCustomScriptletContent(content::WebContents* web_contents) { + return GetCustomScriptletValue(web_contents, "scriptlet-content"); +} + +bool ClickSaveCustomScriptlet(content::WebContents* web_contents) { + AwaitElement(web_contents, "adblockScriptletEditor", "save"); + return EvalJs(web_contents, + "window.testing.adblockScriptletEditor.getElementById('save')." + "click()") + .value.is_none(); +} + +bool ClickCustomScriplet(content::WebContents* web_contents, + const std::string& name, + const std::string& button) { + AwaitElement(web_contents, "adblockScriptletList", name); + constexpr const char kClick[] = R"js( + (function() { + const e = window.testing.adblockScriptletList.getElementById($1); + const b = e.querySelector($2); + b.click(); + })(); + )js"; + return EvalJs(web_contents, content::JsReplace(kClick, name, "#" + button)) + .value.is_none(); +} + +} // namespace + +class AdblockCustomResourcesTest : public AdBlockServiceTest { + public: + AdblockCustomResourcesTest() { + feature_list_.InitAndEnableFeature( + brave_shields::features::kCosmeticFilteringCustomScriptlets); + BraveSettingsUI::ShouldExposeElementsForTesting() = true; + } + + ~AdblockCustomResourcesTest() override { + BraveSettingsUI::ShouldExposeElementsForTesting() = true; + } + + void SaveCustomScriptlet(const std::string& name, const std::string& value) { + ASSERT_EQ(GURL("chrome://settings/shields/filters"), + web_contents()->GetLastCommittedURL()); + + ASSERT_TRUE(SetCustomScriptletContent(web_contents(), value)); + ASSERT_TRUE(SetCustomScriptletName(web_contents(), name)); + ASSERT_TRUE(ClickSaveCustomScriptlet(web_contents())); + } + + void CheckCustomScriptlet(const base::Value& custom_scriptlet, + const std::string& name, + const std::string& content) { + ASSERT_TRUE(custom_scriptlet.is_dict()); + EXPECT_EQ(name, *custom_scriptlet.GetDict().FindString("name")); + EXPECT_EQ(base::Base64Encode(content), + *custom_scriptlet.GetDict().FindString("content")); + EXPECT_EQ("application/javascript", + *custom_scriptlet.GetDict().FindStringByDottedPath("kind.mime")); + } + + private: + base::test::ScopedFeatureList feature_list_; +}; + +IN_PROC_BROWSER_TEST_F(AdblockCustomResourcesTest, AddEditRemoveScriptlet) { + NavigateToURL(GURL("brave://settings/shields/filters")); + + constexpr const char kContent[] = "window.test = 'custom-script'"; + + ASSERT_TRUE(ClickAddCustomScriptlet(web_contents())); + SaveCustomScriptlet("custom-script", kContent); + + auto* ad_block_service = g_brave_browser_process->ad_block_service(); + + { + const auto& custom_resources = + ad_block_service->custom_resource_provider()->GetCustomResources(); + ASSERT_TRUE(custom_resources.is_list()); + ASSERT_EQ(1u, custom_resources.GetList().size()); + CheckCustomScriptlet(custom_resources.GetList().front(), + "brave-custom-script.js", kContent); + } + + constexpr const char kEditedContent[] = "window.test = 'edited'"; + + ASSERT_TRUE( + ClickCustomScriplet(web_contents(), "brave-custom-script.js", "edit")); + + EXPECT_EQ("brave-custom-script.js", GetCustomScriptletName(web_contents())); + EXPECT_EQ(kContent, GetCustomScriptletContent(web_contents())); + SaveCustomScriptlet("custom-script-edited", kEditedContent); + { + const auto& custom_resources = + ad_block_service->custom_resource_provider()->GetCustomResources(); + ASSERT_TRUE(custom_resources.is_list()); + ASSERT_EQ(1u, custom_resources.GetList().size()); + CheckCustomScriptlet(custom_resources.GetList().front(), + "brave-custom-script-edited.js", kEditedContent); + } + + ASSERT_TRUE(ClickCustomScriplet(web_contents(), + "brave-custom-script-edited.js", "delete")); + { + const auto& custom_resources = + ad_block_service->custom_resource_provider()->GetCustomResources(); + ASSERT_TRUE(custom_resources.is_list()); + ASSERT_TRUE(custom_resources.GetList().empty()); + } +} + +IN_PROC_BROWSER_TEST_F(AdblockCustomResourcesTest, ExecCustomScriptlet) { + NavigateToURL(GURL("brave://settings/shields/filters")); + + constexpr const char kContent[] = "window.test = 'custom-script'"; + + ASSERT_TRUE(ClickAddCustomScriptlet(web_contents())); + SaveCustomScriptlet("custom-script", kContent); + + UpdateAdBlockInstanceWithRules("a.com##+js(brave-custom-script)"); + + GURL tab_url = + embedded_test_server()->GetURL("a.com", "/cosmetic_filtering.html"); + NavigateToURL(tab_url); + + EXPECT_EQ("custom-script", EvalJs(web_contents(), "window.test")); +} diff --git a/browser/brave_shields/ad_block_service_browsertest.cc b/browser/brave_shields/ad_block_service_browsertest.cc index 0ad15b6142a8..80600f7e3380 100644 --- a/browser/brave_shields/ad_block_service_browsertest.cc +++ b/browser/brave_shields/ad_block_service_browsertest.cc @@ -304,7 +304,7 @@ base::FilePath AdBlockServiceTest::GetTestDataDir() { return base::PathService::CheckedGet(brave::DIR_TEST_DATA); } -void AdBlockServiceTest::NavigateToURL(GURL url) { +void AdBlockServiceTest::NavigateToURL(const GURL& url) { content::NavigateToURLBlockUntilNavigationsComplete(web_contents(), url, 1, true); } diff --git a/browser/brave_shields/ad_block_service_browsertest.h b/browser/brave_shields/ad_block_service_browsertest.h index f5aa04122996..f33e1dda9118 100644 --- a/browser/brave_shields/ad_block_service_browsertest.h +++ b/browser/brave_shields/ad_block_service_browsertest.h @@ -53,7 +53,7 @@ class AdBlockServiceTest : public PlatformBrowserTest { void AssertTagExists(const std::string& tag, bool expected_exists) const; void InitEmbeddedTestServer(); base::FilePath GetTestDataDir(); - void NavigateToURL(GURL url); + void NavigateToURL(const GURL& url); void SetDefaultComponentIdAndBase64PublicKeyForTest(); void SetRegionalComponentIdAndBase64PublicKeyForTest(); void InstallComponent( diff --git a/browser/resources/settings/default_brave_shields_page/brave_adblock_subpage.ts b/browser/resources/settings/default_brave_shields_page/brave_adblock_subpage.ts index 773527887f50..fa75171a2ebf 100644 --- a/browser/resources/settings/default_brave_shields_page/brave_adblock_subpage.ts +++ b/browser/resources/settings/default_brave_shields_page/brave_adblock_subpage.ts @@ -9,6 +9,7 @@ import 'chrome://resources/cr_elements/cr_button/cr_button.js'; import 'chrome://resources/cr_elements/icons.html.js'; import './components/brave_adblock_subscribe_dropdown.js'; import './components/brave_adblock_editor.js'; +import './components/brave_adblock_scriptlet_list.js'; import {PrefsMixin} from '/shared/settings/prefs/prefs_mixin.js'; import {I18nMixin} from 'chrome://resources/cr_elements/i18n_mixin.js'; diff --git a/browser/resources/settings/default_brave_shields_page/components/brave_adblock_scriptlet_editor.html b/browser/resources/settings/default_brave_shields_page/components/brave_adblock_scriptlet_editor.html index f50c568fc443..7729afcb5a79 100644 --- a/browser/resources/settings/default_brave_shields_page/components/brave_adblock_scriptlet_editor.html +++ b/browser/resources/settings/default_brave_shields_page/components/brave_adblock_scriptlet_editor.html @@ -1,4 +1,4 @@ -