1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chromeos/ash/components/browser_context_helper/browser_context_helper.h"
#include <memory>
#include <utility>
#include "ash/constants/ash_features.h"
#include "base/files/file_path.h"
#include "base/test/scoped_feature_list.h"
#include "chromeos/ash/components/browser_context_helper/annotated_account_id.h"
#include "chromeos/ash/components/browser_context_helper/browser_context_types.h"
#include "chromeos/ash/components/browser_context_helper/fake_browser_context_helper_delegate.h"
#include "components/account_id/account_id.h"
#include "components/prefs/testing_pref_service.h"
#include "components/user_manager/fake_user_manager.h"
#include "components/user_manager/scoped_user_manager.h"
#include "components/user_manager/test_helper.h"
#include "components/user_manager/user_manager.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/test_browser_context.h"
#include "google_apis/gaia/gaia_id.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace ash {
namespace {
class BrowserContextHelperTest : public testing::Test {
public:
BrowserContextHelperTest() = default;
~BrowserContextHelperTest() override = default;
private:
// Sets up fake UI thread, required by TestBrowserContext.
content::BrowserTaskEnvironment env_;
};
// Parameterized for UseAnnotatedAccountId.
class BrowserContextHelperAccountIdTest
: public BrowserContextHelperTest,
public ::testing::WithParamInterface<bool> {
public:
void SetUp() override {
if (GetParam()) {
feature_list_.InitAndEnableFeature(ash::features::kUseAnnotatedAccountId);
} else {
feature_list_.InitAndDisableFeature(
ash::features::kUseAnnotatedAccountId);
}
}
private:
base::test::ScopedFeatureList feature_list_;
};
} // namespace
TEST_F(BrowserContextHelperTest, GetUserIdHashFromBrowserContext) {
// If nullptr is passed, returns an error.
EXPECT_EQ("", BrowserContextHelper::GetUserIdHashFromBrowserContext(nullptr));
constexpr struct {
const char* expect;
const char* path;
} kTestData[] = {
// Regular case. Use relative path, as temporary directory is created
// there.
{"abcde123456", "home/chronos/u-abcde123456"},
// Special case for legacy path.
{"user", "home/chronos/user"},
// Special case for testing profile.
{"test-user", "home/chronos/test-user"},
// Error case. Data directory must start with "u-".
{"", "abcde123456"},
};
for (const auto& test_case : kTestData) {
content::TestBrowserContext context(base::FilePath(test_case.path));
EXPECT_EQ(test_case.expect,
BrowserContextHelper::GetUserIdHashFromBrowserContext(&context));
}
}
TEST_P(BrowserContextHelperAccountIdTest, GetBrowserContextByAccountId) {
// Set up BrowserContextHelper instance.
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// Set up UserManager.
TestingPrefServiceSimple local_state;
user_manager::UserManagerImpl::RegisterPrefs(local_state.registry());
user_manager::TypedScopedUserManager<user_manager::FakeUserManager>
fake_user_manager(
std::make_unique<user_manager::FakeUserManager>(&local_state));
// Set up a User and its BrowserContext instance.
const AccountId account_id =
AccountId::FromUserEmailGaiaId("test@test", GaiaId("fakegaia"));
const std::string username_hash =
user_manager::TestHelper::GetFakeUsernameHash(account_id);
fake_user_manager->AddGaiaUser(account_id, user_manager::UserType::kRegular);
fake_user_manager->UserLoggedIn(account_id, username_hash);
content::BrowserContext* browser_context = delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append("u-" + username_hash),
/*is_off_the_record=*/false);
AnnotatedAccountId::Set(browser_context, account_id,
/*for_test=*/false);
fake_user_manager->OnUserProfileCreated(account_id, /*prefs=*/nullptr);
// BrowserContext instance corresponding to the account_id should be returned.
EXPECT_EQ(browser_context, helper.GetBrowserContextByAccountId(account_id));
// It returns nullptr, if User instance corresponding to account_id is not
// found.
EXPECT_FALSE(helper.GetBrowserContextByAccountId(
AccountId::FromUserEmail("notfound@test")));
fake_user_manager->OnUserProfileWillBeDestroyed(account_id);
}
TEST_P(BrowserContextHelperAccountIdTest, GetBrowserContextByUser) {
// Set up BrowserContextHelper instance.
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// Set up UserManager.
TestingPrefServiceSimple local_state;
user_manager::UserManagerImpl::RegisterPrefs(local_state.registry());
user_manager::TypedScopedUserManager<user_manager::FakeUserManager>
fake_user_manager(
std::make_unique<user_manager::FakeUserManager>(&local_state));
// Set up a User and its BrowserContext instance.
const AccountId account_id =
AccountId::FromUserEmailGaiaId("test@test", GaiaId("fakegaia"));
const std::string username_hash =
user_manager::TestHelper::GetFakeUsernameHash(account_id);
const user_manager::User* user = fake_user_manager->AddGaiaUser(
account_id, user_manager::UserType::kRegular);
fake_user_manager->UserLoggedIn(account_id, username_hash);
content::BrowserContext* browser_context = delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append("u-" + username_hash),
/*is_off_the_record=*/false);
AnnotatedAccountId::Set(browser_context, account_id,
/*for_test=*/false);
// Before User is marked that its Profile is created, GetBrowserContextByUser
// should return nullptr.
EXPECT_FALSE(helper.GetBrowserContextByUser(user));
// Mark User as if Profile is created.
fake_user_manager->OnUserProfileCreated(account_id, /*prefs=*/nullptr);
// Then the appropriate BrowserContext instance should be returned.
EXPECT_EQ(browser_context, helper.GetBrowserContextByUser(user));
fake_user_manager->OnUserProfileWillBeDestroyed(account_id);
}
TEST_P(BrowserContextHelperAccountIdTest, GetBrowserContextByUser_Guest) {
// Set up BrowserContextHelper instance.
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// Set up UserManager.
TestingPrefServiceSimple local_state;
user_manager::UserManagerImpl::RegisterPrefs(local_state.registry());
user_manager::TypedScopedUserManager<user_manager::FakeUserManager>
fake_user_manager(
std::make_unique<user_manager::FakeUserManager>(&local_state));
// Set up a User and its BrowserContext instance.
const user_manager::User* user = fake_user_manager->AddGuestUser();
const AccountId& account_id = user->GetAccountId();
const std::string username_hash =
user_manager::TestHelper::GetFakeUsernameHash(account_id);
fake_user_manager->UserLoggedIn(account_id, username_hash);
auto* browser_context = delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append("u-" + username_hash),
/*is_off_the_record=*/false);
AnnotatedAccountId::Set(browser_context, account_id,
/*for_test=*/false);
content::BrowserContext* otr_browser_context =
delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append("u-" + username_hash),
/*is_off_the_record=*/true);
fake_user_manager->OnUserProfileCreated(account_id, /*prefs=*/nullptr);
// Off the record instance should be returned.
EXPECT_EQ(otr_browser_context, helper.GetBrowserContextByUser(user));
fake_user_manager->OnUserProfileWillBeDestroyed(account_id);
}
TEST_P(BrowserContextHelperAccountIdTest, GetUserByBrowserContext) {
// Set up BrowserContextHelper instance.
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// Set up UserManager.
TestingPrefServiceSimple local_state;
user_manager::UserManagerImpl::RegisterPrefs(local_state.registry());
user_manager::TypedScopedUserManager<user_manager::FakeUserManager>
fake_user_manager(
std::make_unique<user_manager::FakeUserManager>(&local_state));
const AccountId account_id =
AccountId::FromUserEmailGaiaId("test@test", GaiaId("fakegaia"));
const std::string username_hash =
user_manager::TestHelper::GetFakeUsernameHash(account_id);
const user_manager::User* user = fake_user_manager->AddGaiaUser(
account_id, user_manager::UserType::kRegular);
fake_user_manager->UserLoggedIn(account_id, username_hash);
content::BrowserContext* browser_context = delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append("u-" + username_hash),
/*is_off_the_record=*/false);
AnnotatedAccountId::Set(browser_context, account_id,
/*for_test=*/false);
fake_user_manager->OnUserProfileCreated(account_id, /*prefs=*/nullptr);
EXPECT_EQ(user, helper.GetUserByBrowserContext(browser_context));
// Special browser_context.
content::BrowserContext* signin_browser_context =
delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append(kSigninBrowserContextBaseName),
/*is_off_the_record=*/false);
EXPECT_FALSE(helper.GetUserByBrowserContext(signin_browser_context));
// Returns nullptr for unknown browser context.
content::BrowserContext* unknown_browser_context =
delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append("unknown@user"),
/*is_off_the_record=*/false);
AnnotatedAccountId::Set(unknown_browser_context,
AccountId::FromUserEmail("unknown@test"),
/*for_test=*/false);
EXPECT_FALSE(helper.GetUserByBrowserContext(unknown_browser_context));
fake_user_manager->OnUserProfileWillBeDestroyed(account_id);
}
INSTANTIATE_TEST_SUITE_P(All,
BrowserContextHelperAccountIdTest,
::testing::Bool());
TEST_F(BrowserContextHelperTest, GetUserBrowserContextDirName) {
constexpr struct {
const char* expect;
const char* user_id_hash;
} kTestData[] = {
// Regular case.
{"u-abcde123456", "abcde123456"},
// Special case for the legacy path.
{"user", "user"},
// Special case for testing.
{"test-user", "test-user"},
};
for (const auto& test_case : kTestData) {
EXPECT_EQ(test_case.expect,
BrowserContextHelper::GetUserBrowserContextDirName(
test_case.user_id_hash));
}
}
TEST_F(BrowserContextHelperTest, GetBrowserContextPathByUserIdHash) {
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// u- prefix is expected. See GetUserBrowserContextDirName for details.
EXPECT_EQ(delegate_ptr->GetUserDataDir()->Append("u-0123456789"),
helper.GetBrowserContextPathByUserIdHash("0123456789"));
// Special use name case.
EXPECT_EQ(delegate_ptr->GetUserDataDir()->Append("user"),
helper.GetBrowserContextPathByUserIdHash("user"));
EXPECT_EQ(delegate_ptr->GetUserDataDir()->Append("test-user"),
helper.GetBrowserContextPathByUserIdHash("test-user"));
}
TEST_F(BrowserContextHelperTest, GetSigninBrowserContext) {
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// If not yet loaded, GetSigninBrowserContext() should return nullptr.
EXPECT_FALSE(helper.GetSigninBrowserContext());
// Load the signin browser context.
delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append(kSigninBrowserContextBaseName),
/*is_off_the_record=*/false);
// Then it should start returning the instance.
auto* signin_browser_context = helper.GetSigninBrowserContext();
ASSERT_TRUE(signin_browser_context);
EXPECT_TRUE(IsSigninBrowserContext(signin_browser_context));
EXPECT_TRUE(signin_browser_context->IsOffTheRecord());
}
TEST_F(BrowserContextHelperTest, DeprecatedGetOrCreateSigninBrowserContext) {
BrowserContextHelper helper(
std::make_unique<FakeBrowserContextHelperDelegate>());
// DeprecatedGetOrCreateSigninBrowserContext() should create the instance,
// if it is not yet.
auto* signin_browser_context =
helper.DeprecatedGetOrCreateSigninBrowserContext();
ASSERT_TRUE(signin_browser_context);
// Other than that, it should work in the same way with
// GetSigninBrowserContext().
EXPECT_EQ(helper.GetSigninBrowserContext(), signin_browser_context);
}
TEST_F(BrowserContextHelperTest, GetLockScreenBrowserContext) {
auto delegate = std::make_unique<FakeBrowserContextHelperDelegate>();
auto* delegate_ptr = delegate.get();
BrowserContextHelper helper(std::move(delegate));
// If not yet loaded, GetLockScreenBrowserContext() should return nullptr.
EXPECT_FALSE(helper.GetLockScreenBrowserContext());
// Load the lock screen browser context.
delegate_ptr->CreateBrowserContext(
delegate_ptr->GetUserDataDir()->Append(kLockScreenBrowserContextBaseName),
/*is_off_the_record=*/false);
// Then it should start returning the instance.
auto* lock_screen_browser_context = helper.GetLockScreenBrowserContext();
ASSERT_TRUE(lock_screen_browser_context);
EXPECT_TRUE(IsLockScreenBrowserContext(lock_screen_browser_context));
EXPECT_TRUE(lock_screen_browser_context->IsOffTheRecord());
}
} // namespace ash
|