File: test_helper.h

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (91 lines) | stat: -rw-r--r-- 3,431 bytes parent folder | download | duplicates (3)
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
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_USER_MANAGER_TEST_HELPER_H_
#define COMPONENTS_USER_MANAGER_TEST_HELPER_H_

#include <string_view>

#include "base/memory/raw_ref.h"
#include "components/user_manager/user_type.h"

class AccountId;
class PrefService;

namespace user_manager {

class User;
class UserManager;

// Utilities to set up UserManager related environment.
class TestHelper {
 public:
  // Records the `account_id` as a persisted user to the given `local_state`.
  // `local_state` must be properly set up, specifically it needs UserManager
  // related registration.
  // In most cases, this registration needs to be done before UserManager
  // is created. Specifically, for browser_tests, SetUpLocalStatePrefService()
  // is a recommended function to call this.
  static void RegisterPersistedUser(PrefService& local_state,
                                    const AccountId& account_id);

  // Similar to RegisterPersistedUser, records `account_id` as a persisted
  // child user.
  static void RegisterPersistedChildUser(PrefService& local_state,
                                         const AccountId& account_id);

  // Records the `user_id` as a Kiosk app user to the given `local_state`.
  static void RegisterKioskAppUser(PrefService& local_state,
                                   std::string_view user_id);

  // Records the `user_id` as a Web-Kiosk app user to the given `local_state`.
  static void RegisterWebKioskAppUser(PrefService& local_state,
                                      std::string_view user_id);

  // Records the `user_id` as a Public Account user to the given `local_state`.
  static void RegisterPublicAccountUser(PrefService& local_state,
                                        std::string_view user_id);

  // Returns the fake username hash for testing.
  // Valid AccountId must be used, otherwise CHECKed.
  static std::string GetFakeUsernameHash(const AccountId& account_id);

  // `user_manager` must outlive the instance of the TestHelper.
  explicit TestHelper(UserManager* user_manager);
  ~TestHelper();

  // Creates and adds a regular (persisted) user, and returns it.
  // On failure, returns nullptr.
  [[nodiscard]] User* AddRegularUser(const AccountId& account_id);

  // Creates and adds a child user, and returns it.
  [[nodiscard]] User* AddChildUser(const AccountId& account_id);

  // Creates and adds a guest user, and returns it.
  // On failure, returns nullptr.
  [[nodiscard]] User* AddGuestUser();

  // Creates and adds a new PublicAccount user, and returns it.
  // On failure, returns nullptr.
  [[nodiscard]] User* AddPublicAccountUser(std::string_view user_id);

  // Creates and adds a new Kiosk user, and returns it.
  // On failure, returns nullptr.
  [[nodiscard]] User* AddKioskAppUser(std::string_view user_id);

  // Creates and adds a new web Kiosk user, and returns it.
  // On failure, returns nullptr.
  [[nodiscard]] User* AddWebKioskAppUser(std::string_view user_id);

 private:
  User* AddUserInternal(const AccountId& account_id, UserType user_type);
  User* AddDeviceLocalAccountUserInternal(std::string_view user_id,
                                          UserType user_type);

  raw_ref<UserManager> user_manager_;
};

}  // namespace user_manager

#endif  // COMPONENTS_USER_MANAGER_TEST_HELPER_H_