blob: e2accf33bee6a1aed8dfd4b17b4276b12dc60fff [file] [log] [blame]
// Copyright 2017 The Chromium 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 <stdint.h>
#include <memory>
#include <string>
#include "ash/public/cpp/session/session_controller_client.h"
#include "ash/public/cpp/session/session_types.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/optional.h"
#include "base/token.h"
#include "components/user_manager/user_type.h"
namespace views {
class Widget;
class AccountId;
class PrefService;
namespace ash {
enum class AddUserSessionPolicy;
class SessionControllerImpl;
class TestPrefServiceProvider;
// Implement SessionControllerClient to simulate chrome behavior
// in tests. This breaks the ash/chrome dependency to allow testing ash code in
// isolation. Note that tests that have an instance of SessionControllerClient
// should NOT use this, i.e. tests that run BrowserMain to have chrome's
// SessionControllerClient created, e.g. InProcessBrowserTest based tests. On
// the other hand, tests code in chrome can use this class as long as it does
// not run BrowserMain, e.g. testing::Test based test.
class TestSessionControllerClient : public ash::SessionControllerClient {
TestSessionControllerClient(SessionControllerImpl* controller,
TestPrefServiceProvider* prefs_provider);
~TestSessionControllerClient() override;
static void DisableAutomaticallyProvideSigninPref();
// Initialize using existing info in |controller| and set as its client.
void InitializeAndSetClient();
// Sets up the default state of SessionController.
void Reset();
void set_use_lower_case_user_id(bool value) {
use_lower_case_user_id_ = value;
int request_sign_out_count() const { return request_sign_out_count_; }
// Helpers to set SessionController state.
void SetCanLockScreen(bool can_lock);
void SetShouldLockScreenAutomatically(bool should_lock);
void SetAddUserSessionPolicy(AddUserSessionPolicy policy);
void SetSessionState(session_manager::SessionState state);
void SetIsRunningInAppMode(bool app_mode);
void SetIsDemoSession();
// Creates the |count| pre-defined user sessions. The users are named by
// numbers using "user%d@tray" template. The first user is set as active user
// to be consistent with crash-and-restore scenario. Note that existing user
// sessions prior this call will be removed without sending out notifications.
void CreatePredefinedUserSessions(int count);
// Adds a user session from a given display email. The display email will be
// canonicalized and used to construct an AccountId. |enable_settings| sets
// whether web UI settings are allowed. If |provide_pref_service| is true,
// eagerly inject a PrefService for this user. |is_new_profile| indicates
// whether the user has a newly created profile on the device.
void AddUserSession(
const std::string& display_email,
user_manager::UserType user_type = user_manager::USER_TYPE_REGULAR,
bool enable_settings = true,
bool provide_pref_service = true,
bool is_new_profile = false,
const base::Optional<base::Token>& service_instance_group =
// Creates a test PrefService and associates it with the user.
void ProvidePrefServiceForUser(const AccountId& account_id);
// Synchronously lock screen by requesting screen lock and waiting for the
// request to complete.
void LockScreen();
// Simulates screen unlocking. It is virtual so that test cases can override
// it. The default implementation sets the session state of SessionController
// to be ACTIVE.
virtual void UnlockScreen();
// Spins message loop to finish pending lock screen request if any.
void FlushForTest();
// Use |pref_service| for sign-in profile pref service.
void SetSigninScreenPrefService(std::unique_ptr<PrefService> pref_service);
// Use |pref_service| for the user identified by |account_id|.
void SetUserPrefService(const AccountId& account_id,
std::unique_ptr<PrefService> pref_service);
// ash::SessionControllerClient:
void RequestLockScreen() override;
void RequestSignOut() override;
void SwitchActiveUser(const AccountId& account_id) override;
void CycleActiveUser(CycleUserDirection direction) override;
void ShowMultiProfileLogin() override;
void EmitAshInitialized() override;
PrefService* GetSigninScreenPrefService() override;
PrefService* GetUserPrefService(const AccountId& account_id) override;
void DoSwitchUser(const AccountId& account_id, bool switch_user);
SessionControllerImpl* const controller_;
TestPrefServiceProvider* const prefs_provider_;
int fake_session_id_ = 0;
SessionInfo session_info_;
bool use_lower_case_user_id_ = true;
int request_sign_out_count_ = 0;
std::unique_ptr<views::Widget> multi_profile_login_widget_;
base::WeakPtrFactory<TestSessionControllerClient> weak_ptr_factory_{this};
} // namespace ash