chrome/browser/ui/extensions/controlled_home_dialog_controller_unittest.cc

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ui/extensions/controlled_home_dialog_controller.h"

#include "base/containers/contains.h"
#include "base/memory/raw_ptr.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/bind.h"
#include "base/values.h"
#include "build/build_config.h"
#include "chrome/browser/custom_handlers/protocol_handler_registry_factory.h"
#include "chrome/browser/extensions/extension_service.h"
#include "chrome/browser/extensions/extension_util.h"
#include "chrome/browser/extensions/extension_web_ui_override_registrar.h"
#include "chrome/browser/extensions/permissions/permissions_updater.h"
#include "chrome/browser/extensions/test_extension_system.h"
#include "chrome/browser/profiles/keep_alive/profile_keep_alive_types.h"
#include "chrome/browser/profiles/keep_alive/scoped_profile_keep_alive.h"
#include "chrome/test/base/browser_with_test_window_test.h"
#include "chrome/test/base/testing_profile.h"
#include "components/custom_handlers/simple_protocol_handler_registry_factory.h"
#include "components/proxy_config/proxy_config_pref_names.h"
#include "content/public/browser/storage_partition.h"
#include "extensions/browser/extension_prefs.h"
#include "extensions/browser/extension_registrar.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_system.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_builder.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace {

std::unique_ptr<KeyedService> BuildOverrideRegistrar(
    content::BrowserContext* context) {
  return std::make_unique<extensions::ExtensionWebUIOverrideRegistrar>(context);
}

}  // namespace

class ControlledHomeDialogControllerTest : public BrowserWithTestWindowTest {
 public:
  ControlledHomeDialogControllerTest() = default;
  ~ControlledHomeDialogControllerTest() override = default;

  // Loads an extension that overrides the home page of a user.
  scoped_refptr<const extensions::Extension> LoadExtensionOverridingHome(
      const std::string& name = "extension",
      extensions::mojom::ManifestLocation location =
          extensions::mojom::ManifestLocation::kInternal) {
    scoped_refptr<const extensions::Extension> extension =
        extensions::ExtensionBuilder(name)
            .SetLocation(location)
            .SetManifestKey(
                "chrome_settings_overrides",
                base::Value::Dict().Set("homepage", "http://www.google.com"))
            .Build();
    extensions::PermissionsUpdater(profile()).GrantActivePermissions(
        extension.get());
    extension_registrar()->AddExtension(extension);

    return extension;
  }

  // Returns true if the extension is enabled.
  bool IsExtensionEnabled(const extensions::ExtensionId& id) {
    return extension_registry_->enabled_extensions().GetByID(id);
  }

  // Returns true if the extension is disabled and has the specified
  // `disable_reason`.
  bool IsExtensionDisabled(
      const extensions::ExtensionId& id,
      extensions::disable_reason::DisableReason disable_reason) {
    return extension_registry_->disabled_extensions().GetByID(id) &&
           extension_prefs_->HasOnlyDisableReason(id, disable_reason);
  }

  // Returns true if the extension has been acknowledged by the user.
  bool IsExtensionAcknowledged(const extensions::ExtensionId& id) {
    bool was_acknowledged = false;
    return extension_prefs_->ReadPrefAsBoolean(
               id, ControlledHomeDialogController::kAcknowledgedPreference,
               &was_acknowledged) &&
           was_acknowledged;
  }

  // Acknowledges the extension in preferences.
  void AcknowledgeExtension(const extensions::ExtensionId& id) {
    extension_prefs_->UpdateExtensionPref(
        id, ControlledHomeDialogController::kAcknowledgedPreference,
        base::Value(true));
  }

  extensions::ExtensionRegistrar* extension_registrar() {
    return extension_registrar_.get();
  }

 private:
  void SetUp() override {
    BrowserWithTestWindowTest::SetUp();
    // Prevent the Profile from getting deleted before TearDown() is complete,
    // since WaitForStorageCleanup() relies on an active Profile. See the
    // DestroyProfileOnBrowserClose flag.
    profile_keep_alive_ = std::make_unique<ScopedProfileKeepAlive>(
        profile(), ProfileKeepAliveOrigin::kBrowserWindow);

    // The two lines of magical incantation required to get the extension
    // service to work inside a unit test and access the extension prefs.
    static_cast<extensions::TestExtensionSystem*>(
        extensions::ExtensionSystem::Get(profile()))
        ->CreateExtensionService(base::CommandLine::ForCurrentProcess(),
                                 base::FilePath(), false);

    // Set up the rest of the necessary systems.
    extensions::ExtensionSystem::Get(profile())->extension_service()->Init();

    extensions::ExtensionWebUIOverrideRegistrar::GetFactoryInstance()
        ->SetTestingFactory(profile(),
                            base::BindRepeating(&BuildOverrideRegistrar));
    extensions::ExtensionWebUIOverrideRegistrar::GetFactoryInstance()->Get(
        profile());

    extension_prefs_ = extensions::ExtensionPrefs::Get(profile());
    extension_registrar_ = extensions::ExtensionRegistrar::Get(profile());
    extension_registry_ = extensions::ExtensionRegistry::Get(profile());
  }

  void TearDown() override {
    extension_prefs_ = nullptr;
    extension_registrar_ = nullptr;
    extension_registry_ = nullptr;
    WaitForStorageCleanup();
    // Clean up global state for the delegates. Since profiles are stored in
    // global variables, they can be shared between tests and cause
    // unpredictable behavior.
    ControlledHomeDialogController::ClearProfileSetForTesting();
    profile_keep_alive_.reset();
    BrowserWithTestWindowTest::TearDown();
  }

  TestingProfile::TestingFactories GetTestingFactories() override {
    // Use SimpleProtocolHandlerRegistryFactory to prevent OS integration during
    // the protocol registration process.
    return TestingProfile::TestingFactories{TestingProfile::TestingFactory{
        ProtocolHandlerRegistryFactory::GetInstance(),
        custom_handlers::SimpleProtocolHandlerRegistryFactory::
            GetDefaultFactory()}};
  }

  void WaitForStorageCleanup() {
    content::StoragePartition* partition =
        profile()->GetDefaultStoragePartition();
    if (partition) {
      partition->WaitForDeletionTasksForTesting();
    }
  }

  base::AutoReset<bool> ignore_learn_more_{
      ControlledHomeDialogController::IgnoreLearnMoreForTesting()};
  raw_ptr<extensions::ExtensionPrefs> extension_prefs_;
  raw_ptr<extensions::ExtensionRegistrar> extension_registrar_;
  raw_ptr<extensions::ExtensionRegistry> extension_registry_;
  std::unique_ptr<base::CommandLine> command_line_;
  std::unique_ptr<ScopedProfileKeepAlive> profile_keep_alive_;
};

// Though the test harness should compile on all platforms, the behavior for
// extensions to override the home page is limited to mac and windows.
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
TEST_F(ControlledHomeDialogControllerTest,
       ClickingExecuteDisablesTheExtension) {
  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome();
  ASSERT_TRUE(extension);

  ASSERT_TRUE(browser());
  ASSERT_TRUE(profile());

  auto dialog_controller =
      std::make_unique<ControlledHomeDialogController>(browser());
  EXPECT_TRUE(dialog_controller->ShouldShow());
  EXPECT_EQ(extension, dialog_controller->extension_for_testing());

  dialog_controller->PendingShow();
  dialog_controller->OnBubbleShown();

  dialog_controller->OnBubbleClosed(
      ControlledHomeDialogControllerInterface::CLOSE_EXECUTE);

  EXPECT_TRUE(IsExtensionDisabled(
      extension->id(), extensions::disable_reason::DISABLE_USER_ACTION));
  // Since the extension was disabled, it shouldn't be acknowledged in
  // preferences.
  EXPECT_FALSE(IsExtensionAcknowledged(extension->id()));
}

TEST_F(ControlledHomeDialogControllerTest,
       ClickingDismissAcknowledgesTheExtension) {
  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome();
  ASSERT_TRUE(extension);

  auto dialog_controller =
      std::make_unique<ControlledHomeDialogController>(browser());
  EXPECT_TRUE(dialog_controller->ShouldShow());
  EXPECT_EQ(extension, dialog_controller->extension_for_testing());

  dialog_controller->PendingShow();
  dialog_controller->OnBubbleShown();

  dialog_controller->OnBubbleClosed(
      ControlledHomeDialogControllerInterface::CLOSE_DISMISS_USER_ACTION);

  // The extension should remain enabled and be acknowledged.
  EXPECT_TRUE(IsExtensionEnabled(extension->id()));
  EXPECT_TRUE(IsExtensionAcknowledged(extension->id()));
}

TEST_F(ControlledHomeDialogControllerTest,
       DismissByDeactivationDoesNotDisableOrAcknowledge) {
  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome();
  ASSERT_TRUE(extension);

  {
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    EXPECT_TRUE(dialog_controller->ShouldShow());
    EXPECT_EQ(extension, dialog_controller->extension_for_testing());

    dialog_controller->PendingShow();
    dialog_controller->OnBubbleShown();

    dialog_controller->OnBubbleClosed(
        ControlledHomeDialogControllerInterface::CLOSE_DISMISS_DEACTIVATION);
  }

  // The extension should remain enabled but *shouldn't* be acknowledged.
  EXPECT_TRUE(IsExtensionEnabled(extension->id()));
  EXPECT_FALSE(IsExtensionAcknowledged(extension->id()));

  {
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    // Even though the extension hasn't been acknowledged, we shouldn't show the
    // bubble twice in the same session.
    EXPECT_FALSE(dialog_controller->ShouldShow());
  }
}

TEST_F(ControlledHomeDialogControllerTest,
       ClickingLearnMoreAcknowledgesTheExtension) {
  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome();
  ASSERT_TRUE(extension);

  auto dialog_controller =
      std::make_unique<ControlledHomeDialogController>(browser());
  EXPECT_TRUE(dialog_controller->ShouldShow());
  EXPECT_EQ(extension, dialog_controller->extension_for_testing());

  dialog_controller->PendingShow();
  dialog_controller->OnBubbleShown();

  dialog_controller->OnBubbleClosed(
      ControlledHomeDialogControllerInterface::CLOSE_LEARN_MORE);

  EXPECT_TRUE(IsExtensionEnabled(extension->id()));
  EXPECT_TRUE(IsExtensionAcknowledged(extension->id()));
}

TEST_F(ControlledHomeDialogControllerTest,
       BubbleShouldntShowIfExtensionAcknowledged) {
  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome();
  ASSERT_TRUE(extension);

  AcknowledgeExtension(extension->id());

  auto dialog_controller =
      std::make_unique<ControlledHomeDialogController>(browser());
  EXPECT_FALSE(dialog_controller->ShouldShow());
}

TEST_F(ControlledHomeDialogControllerTest, LongExtensionNameIsTruncated) {
  const std::u16string long_name =
      u"This extension name should be longer than our truncation threshold "
      "to test that the bubble can handle long names";
  const std::u16string truncated_name =
      extensions::util::GetFixupExtensionNameForUIDisplay(long_name);
  ASSERT_LT(truncated_name.size(), long_name.size());

  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome(base::UTF16ToUTF8(long_name));
  ASSERT_TRUE(extension);

  auto dialog_controller =
      std::make_unique<ControlledHomeDialogController>(browser());
  EXPECT_TRUE(dialog_controller->ShouldShow());

  std::u16string bubble_text = dialog_controller->GetBodyText();

  EXPECT_FALSE(base::Contains(bubble_text, long_name));
  EXPECT_TRUE(base::Contains(bubble_text, truncated_name));
}

TEST_F(ControlledHomeDialogControllerTest,
       ExecutingOnOneExtensionDoesntAffectAnotherExtension) {
  scoped_refptr<const extensions::Extension> extension1 =
      LoadExtensionOverridingHome("ext1");
  scoped_refptr<const extensions::Extension> extension2 =
      LoadExtensionOverridingHome("ext2");
  ASSERT_TRUE(extension1);
  ASSERT_TRUE(extension2);

  {
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    EXPECT_TRUE(dialog_controller->ShouldShow());
    // The most-recently-installed extension should control the home page
    // (`extension2`).
    EXPECT_EQ(extension2, dialog_controller->extension_for_testing());

    dialog_controller->PendingShow();
    dialog_controller->OnBubbleShown();

    // Close the bubble with the "execute" action.
    dialog_controller->OnBubbleClosed(
        ControlledHomeDialogControllerInterface::CLOSE_EXECUTE);

    EXPECT_TRUE(IsExtensionDisabled(
        extension2->id(), extensions::disable_reason::DISABLE_USER_ACTION));
    EXPECT_TRUE(IsExtensionEnabled(extension1->id()));
    EXPECT_FALSE(IsExtensionAcknowledged(extension2->id()));
    EXPECT_FALSE(IsExtensionAcknowledged(extension1->id()));
  }

  {
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    // Since `extension2` was removed, we shouldn't have acknowledged either
    // extension and we can re-show the bubble if the homepage is controlled
    // by another extension.
    EXPECT_TRUE(dialog_controller->ShouldShow());
    EXPECT_EQ(extension1, dialog_controller->extension_for_testing());
  }
}

TEST_F(ControlledHomeDialogControllerTest,
       AcknowledgingOneExtensionDoesntAffectAnother) {
  scoped_refptr<const extensions::Extension> extension1 =
      LoadExtensionOverridingHome("ext1");
  scoped_refptr<const extensions::Extension> extension2 =
      LoadExtensionOverridingHome("ext2");
  ASSERT_TRUE(extension1);
  ASSERT_TRUE(extension2);

  {
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    EXPECT_TRUE(dialog_controller->ShouldShow());
    EXPECT_EQ(extension2, dialog_controller->extension_for_testing());

    dialog_controller->PendingShow();
    dialog_controller->OnBubbleShown();

    // Dismiss the bubble; this acknowledges the extension.
    dialog_controller->OnBubbleClosed(
        ControlledHomeDialogControllerInterface::CLOSE_DISMISS_USER_ACTION);

    EXPECT_TRUE(IsExtensionEnabled(extension2->id()));
    EXPECT_TRUE(IsExtensionAcknowledged(extension2->id()));

    EXPECT_TRUE(IsExtensionEnabled(extension1->id()));
    EXPECT_FALSE(IsExtensionAcknowledged(extension1->id()));
  }

  {
    // The bubble shouldn't want to show (the extension that controls the home
    // page was acknowledged).
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    EXPECT_FALSE(dialog_controller->ShouldShow());
  }

  // Disable the extension that was acknowledged.
  extension_registrar()->DisableExtension(
      extension2->id(), {extensions::disable_reason::DISABLE_USER_ACTION});

  {
    auto dialog_controller =
        std::make_unique<ControlledHomeDialogController>(browser());
    // Now a new extension controls the home page, so we should re-show the
    // bubble.
    EXPECT_TRUE(dialog_controller->ShouldShow());
    EXPECT_EQ(extension1, dialog_controller->extension_for_testing());
  }
}

TEST_F(ControlledHomeDialogControllerTest,
       PolicyExtensionsRequirePolicyIndicators) {
  scoped_refptr<const extensions::Extension> extension =
      LoadExtensionOverridingHome(
          "ext", extensions::mojom::ManifestLocation::kExternalPolicy);
  ASSERT_TRUE(extension);

  auto dialog_controller =
      std::make_unique<ControlledHomeDialogController>(browser());
  // We still show the bubble for policy-installed extensions, but it should
  // have a policy decoration.
  EXPECT_TRUE(dialog_controller->ShouldShow());

  EXPECT_EQ(u"", dialog_controller->GetActionButtonText());
  EXPECT_TRUE(dialog_controller->IsPolicyIndicationNeeded());
}
#endif