chrome/test/base/testing_profile_manager.cc

// Copyright 2012 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/test/base/testing_profile_manager.h"

#include <stddef.h>

#include <utility>

#include "base/feature_list.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_refptr.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/test_file_util.h"
#include "build/build_config.h"
#include "chrome/browser/browser_features.h"
#include "chrome/browser/profiles/profile_attributes_entry.h"
#include "chrome/browser/profiles/profile_attributes_storage.h"
#include "chrome/browser/profiles/profile_destroyer.h"
#include "chrome/common/chrome_constants.h"
#include "chrome/common/chrome_paths.h"
#include "chrome/test/base/fake_profile_manager.h"
#include "chrome/test/base/testing_browser_process.h"
#include "components/supervised_user/core/common/supervised_user_constants.h"
#include "components/sync_preferences/pref_service_syncable.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "testing/gtest/include/gtest/gtest.h"

#if BUILDFLAG(IS_CHROMEOS)
#include "chrome/browser/ash/profiles/profile_helper.h"
#include "chromeos/ash/components/browser_context_helper/browser_context_types.h"
#include "components/account_id/account_id.h"
#include "components/user_manager/fake_user_manager.h"
#endif

constexpr char kGuestProfileName[] = "$guest";
#if !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_ANDROID)
constexpr char kSystemProfileName[] = "System";
#endif  // !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_ANDROID)

namespace {

// Adaptor to build TestingProfile in CreateAndInitializeProfile().
std::unique_ptr<Profile> BuildTestingProfile(
    TestingProfile::Builder builder,
    const base::FilePath& profile_dir) {
  CHECK_EQ(builder.GetPath(), profile_dir);
  return builder.Build();
}

}  // namespace

TestingProfileManager::TestingProfileManager(TestingBrowserProcess* process)
    : called_set_up_(false),
      browser_process_(process),
      profile_manager_(nullptr) {}

TestingProfileManager::~TestingProfileManager() {
  ProfileDestroyer::DestroyPendingProfilesForShutdown();

  // Drop unowned references before destroying the object that owns them.
  profile_manager_ = nullptr;

  // Destroying this class also destroys the LocalState, so make sure the
  // associated ProfileManager is also destroyed.
  browser_process_->SetProfileManager(nullptr);
}

bool TestingProfileManager::SetUp(
    const base::FilePath& profiles_path,
    std::unique_ptr<ProfileManager> profile_manager) {
  SetUpInternal(profiles_path, std::move(profile_manager));
  return called_set_up_;
}

TestingProfile* TestingProfileManager::CreateTestingProfile(
    const std::string& profile_name,
    std::unique_ptr<sync_preferences::PrefServiceSyncable> prefs,
    const std::u16string& user_name,
    int avatar_id,
    TestingProfile::TestingFactories testing_factories,
    bool is_supervised_profile,
    std::optional<bool> is_new_profile,
    std::optional<std::unique_ptr<policy::PolicyService>> policy_service,
    scoped_refptr<network::SharedURLLoaderFactory> shared_url_loader_factory) {
  DCHECK(called_set_up_);

  base::FilePath profile_path = GetProfilePath(profile_name);

  // Create the profile and register it.
  TestingProfile::Builder builder;
  builder.SetDelegate(profile_manager_.get());
  builder.SetPath(profile_path);
  builder.SetPrefService(std::move(prefs));
  if (is_supervised_profile)
    builder.SetIsSupervisedProfile();
  builder.SetProfileName(profile_name);
  builder.SetIsNewProfile(is_new_profile.value_or(false));
  if (policy_service)
    builder.SetPolicyService(std::move(*policy_service));

  builder.AddTestingFactories(std::move(testing_factories));

  builder.SetSharedURLLoaderFactory(shared_url_loader_factory);

  auto* profile_ptr =
      static_cast<TestingProfile*>(profile_manager_->CreateAndInitializeProfile(
          profile_path,
          base::BindOnce(&BuildTestingProfile, std::move(builder))));

  // Update the user metadata.
  ProfileAttributesEntry* entry =
      profile_manager_->GetProfileAttributesStorage()
          .GetProfileAttributesWithPath(profile_path);
  DCHECK(entry);
  entry->SetAvatarIconIndex(avatar_id);
  entry->SetSupervisedUserId(is_supervised_profile
                                 ? ::supervised_user::kChildAccountSUID
                                 : std::string());
  entry->SetLocalProfileName(user_name, entry->IsUsingDefaultName());

  testing_profiles_.insert(std::make_pair(profile_name, profile_ptr));
  profile_observations_.AddObservation(profile_ptr);

#if BUILDFLAG(IS_CHROMEOS)
  if (!callback_.is_null()) {
    callback_.Run(profile_name, profile_ptr);
  }
#endif
  return profile_ptr;
}

TestingProfile* TestingProfileManager::CreateTestingProfile(
    const std::string& name,
    TestingProfile::TestingFactories testing_factories,
    scoped_refptr<network::SharedURLLoaderFactory> shared_url_loader_factory) {
  DCHECK(called_set_up_);
  return CreateTestingProfile(
      name, std::unique_ptr<sync_preferences::PrefServiceSyncable>(),
      base::UTF8ToUTF16(name), /*avatar_id=*/0, std::move(testing_factories),
      /*is_supervised_profile=*/false, /*is_new_profile=*/std::nullopt,
      /*policy_service=*/std::nullopt, shared_url_loader_factory);
}

TestingProfile* TestingProfileManager::CreateGuestProfile(
    std::optional<TestingProfile::Builder> builder) {
  DCHECK(called_set_up_);
  if (!builder) {
    builder = TestingProfile::Builder();
  }
  builder->SetGuestSession();
  builder->SetPath(ProfileManager::GetGuestProfilePath());
  builder->SetProfileName(kGuestProfileName);
  builder->SetDelegate(profile_manager_.get());

  // Add the guest profile to the profile manager, but not to the attributes
  // storage.
  auto* profile_ptr =
      static_cast<TestingProfile*>(profile_manager_->CreateAndInitializeProfile(
          ProfileManager::GetGuestProfilePath(),
          base::BindOnce(&BuildTestingProfile, std::move(*builder))));

  // Set up a profile with an off the record profile.
  TestingProfile::Builder off_the_record_builder;
  off_the_record_builder.SetGuestSession();
  off_the_record_builder.BuildIncognito(profile_ptr);

  testing_profiles_.insert(std::make_pair(kGuestProfileName, profile_ptr));
  profile_observations_.AddObservation(profile_ptr);

#if BUILDFLAG(IS_CHROMEOS)
  if (!callback_.is_null()) {
    callback_.Run(kGuestProfileName, profile_ptr);
  }
#endif
  return profile_ptr;
}

#if !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_ANDROID)
TestingProfile* TestingProfileManager::CreateSystemProfile() {
  DCHECK(called_set_up_);

  // Create the profile and register it.
  TestingProfile::Builder builder;
  builder.SetDelegate(profile_manager_.get());
  builder.SetPath(ProfileManager::GetSystemProfilePath());
  builder.SetProfileName(kSystemProfileName);

  // Add the system profile to the profile manager, but not to the attributes
  // storage.
  auto* profile_ptr =
      static_cast<TestingProfile*>(profile_manager_->CreateAndInitializeProfile(
          ProfileManager::GetSystemProfilePath(),
          base::BindOnce(&BuildTestingProfile, std::move(builder))));

  testing_profiles_.insert(std::make_pair(kSystemProfileName, profile_ptr));
  profile_observations_.AddObservation(profile_ptr);

  return profile_ptr;
}
#endif  // !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_ANDROID)

void TestingProfileManager::DeleteTestingProfile(const std::string& name) {
  DCHECK(called_set_up_);

  auto it = testing_profiles_.find(name);
  if (it == testing_profiles_.end()) {
    // Profile was already deleted, probably due to the
    // DestroyProfileOnBrowserClose flag.
    DCHECK(
        base::FeatureList::IsEnabled(features::kDestroyProfileOnBrowserClose));
    return;
  }

  TestingProfile* profile = it->second;

  profile_manager_->GetProfileAttributesStorage().RemoveProfile(
      profile->GetPath());
  profile_manager_->profiles_info_.erase(profile->GetPath());
}

void TestingProfileManager::DeleteAllTestingProfiles() {
  DCHECK(called_set_up_);

  ProfileAttributesStorage& storage =
      profile_manager_->GetProfileAttributesStorage();
  for (auto& name_profile_pair : testing_profiles_) {
    TestingProfile* profile = name_profile_pair.second;
    if (profile->IsGuestSession() || profile->IsSystemProfile()) {
      // Guest and System profiles aren't added to Storage.
      continue;
    }
    storage.RemoveProfile(profile->GetPath());
  }
  profile_manager_->profiles_info_.clear();
}


void TestingProfileManager::DeleteGuestProfile() {
  DCHECK(called_set_up_);

  auto it = testing_profiles_.find(kGuestProfileName);
  CHECK(it != testing_profiles_.end());

  profile_manager_->profiles_info_.erase(ProfileManager::GetGuestProfilePath());
}

#if !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_ANDROID)
void TestingProfileManager::DeleteSystemProfile() {
  DCHECK(called_set_up_);

  auto it = testing_profiles_.find(kSystemProfileName);
  CHECK(it != testing_profiles_.end());

  profile_manager_->profiles_info_.erase(
      ProfileManager::GetSystemProfilePath());
}
#endif  // !BUILDFLAG(IS_CHROMEOS) && !BUILDFLAG(IS_ANDROID)

void TestingProfileManager::DeleteProfileAttributesStorage() {
  profile_manager_->profile_attributes_storage_.reset(nullptr);
}

base::FilePath TestingProfileManager::GetProfilePath(
    const std::string& profile_name) {
  // Create a path for the profile based on the name.
  base::FilePath profile_path(profiles_path_);
#if BUILDFLAG(IS_CHROMEOS)
  if (ash::IsUserBrowserContextBaseName(base::FilePath(profile_name))) {
    const std::string fake_email =
        profile_name.find('@') == std::string::npos
            ? base::ToLowerASCII(profile_name) + "@test"
            : profile_name;
    profile_path =
        profile_path.Append(ash::ProfileHelper::Get()->GetUserProfileDir(
            user_manager::FakeUserManager::GetFakeUsernameHash(
                AccountId::FromUserEmail(fake_email))));
  } else {
    profile_path = profile_path.AppendASCII(profile_name);
  }
#else
  profile_path = profile_path.AppendASCII(profile_name);
#endif
  return profile_path;
}

const base::FilePath& TestingProfileManager::profiles_dir() {
  DCHECK(called_set_up_);
  return profiles_path_;
}

ProfileManager* TestingProfileManager::profile_manager() {
  DCHECK(called_set_up_);
  return profile_manager_;
}

ProfileAttributesStorage* TestingProfileManager::profile_attributes_storage() {
  DCHECK(called_set_up_);
  return &profile_manager_->GetProfileAttributesStorage();
}

void TestingProfileManager::OnProfileWillBeDestroyed(Profile* profile) {
  testing_profiles_.erase(profile->GetProfileUserName());
  profile_observations_.RemoveObservation(profile);
}

void TestingProfileManager::SetUpInternal(
    const base::FilePath& profiles_path,
    std::unique_ptr<ProfileManager> profile_manager) {
  ASSERT_FALSE(browser_process_->profile_manager())
      << "ProfileManager already exists";

  // Set up the directory for profiles.
  if (profiles_path.empty()) {
    // ScopedPathOverride below calls MakeAbsoluteFilePath before setting the
    // path, so do the same here to make sure the path returned for
    // DIR_USER_DATA and the paths used for profiles actually match.
    profiles_path_ = base::MakeAbsoluteFilePath(
        base::CreateUniqueTempDirectoryScopedToTest());
  } else {
    profiles_path_ = profiles_path;
  }
  user_data_dir_override_ = std::make_unique<base::ScopedPathOverride>(
      chrome::DIR_USER_DATA, profiles_path_);

  auto profile_manager_unique =
      profile_manager ? std::move(profile_manager)
                      : std::make_unique<FakeProfileManager>(profiles_path_);
  profile_manager_ = profile_manager_unique.get();
  browser_process_->SetProfileManager(std::move(profile_manager_unique));

  profile_manager_->GetProfileAttributesStorage()
      .set_disable_avatar_download_for_testing(true);
  called_set_up_ = true;
}