File: quick_settings_footer_unittest.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (334 lines) | stat: -rw-r--r-- 11,076 bytes parent folder | download | duplicates (5)
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
// 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 "ash/system/unified/quick_settings_footer.h"

#include "ash/constants/ash_pref_names.h"
#include "ash/constants/quick_settings_catalogs.h"
#include "ash/public/cpp/ash_view_ids.h"
#include "ash/shell.h"
#include "ash/system/power/adaptive_charging_controller.h"
#include "ash/system/unified/power_button.h"
#include "ash/system/unified/unified_system_tray.h"
#include "ash/system/unified/unified_system_tray_bubble.h"
#include "ash/test/ash_test_base.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/run_until.h"
#include "components/user_manager/user_type.h"
#include "ui/views/test/views_test_utils.h"
#include "ui/views/view_utils.h"
#include "ui/views/widget/widget.h"

namespace ash {

// Tests for `QuickSettingsFooter`, which is inited with no user session to test
// from the non-logged-in state to the logged-in state.
class QuickSettingsFooterTest : public NoSessionAshTestBase {
 public:
  QuickSettingsFooterTest() = default;
  QuickSettingsFooterTest(const QuickSettingsFooterTest&) = delete;
  QuickSettingsFooterTest& operator=(const QuickSettingsFooterTest&) = delete;
  ~QuickSettingsFooterTest() override = default;

  void SetUp() override {
    NoSessionAshTestBase::SetUp();
    widget_ = CreateFramelessTestWidget();
    widget_->SetFullscreen(true);
  }

  void TearDown() override {
    widget_.reset();
    NoSessionAshTestBase::TearDown();
  }

 protected:
  void SetUpView() {
    GetPrimaryUnifiedSystemTray()->ShowBubble();
    footer_ = widget_->SetContentsView(std::make_unique<QuickSettingsFooter>(
        GetPrimaryUnifiedSystemTray()
            ->bubble()
            ->unified_system_tray_controller()));
  }

  PillButton* GetSignOutButton() { return footer_->sign_out_button_; }

  views::Button* GetSettingsButton() { return footer_->settings_button_; }

  views::View* GetBatteryButton() {
    return footer_->GetViewByID(VIEW_ID_QS_BATTERY_BUTTON);
  }

  PowerButton* GetPowerButton() {
    return static_cast<PowerButton*>(
        footer_->GetViewByID(VIEW_ID_QS_POWER_BUTTON));
  }

  views::View* GetUserAvatar() {
    return footer_->GetViewByID(VIEW_ID_QS_USER_AVATAR_BUTTON);
  }

  void LayoutFooter() { views::test::RunScheduledLayout(footer_); }

 private:
  std::unique_ptr<views::Widget> widget_;

  // Owned by `widget_`.
  raw_ptr<QuickSettingsFooter, DanglingUntriaged> footer_;
};

// Tests that all buttons are with the correct view id, catalog name and UMA
// tracking.
TEST_F(QuickSettingsFooterTest, ButtonNamesAndUMA) {
  auto primary = SimulateUserLogin(kRegularUserLoginInfo);
  SimulateUserLogin({"user1@tray"});
  SwitchActiveUser(primary);
  SetUpView();

  // The number of view id should be the number of catalog name -1, since
  // `QsButtonCatalogName` has an extra `kUnknown` type.
  EXPECT_EQ(VIEW_ID_QS_MAX - VIEW_ID_QS_MIN,
            static_cast<int>(QsButtonCatalogName::kMaxValue) - 1);

  // No metrics logged before clicking on any buttons.
  auto histogram_tester = std::make_unique<base::HistogramTester>();
  histogram_tester->ExpectTotalCount("Ash.QuickSettings.Button.Activated",
                                     /*count=*/0);

  // All buttons are visible and with the corresponding id.
  EXPECT_TRUE(GetSettingsButton()->GetVisible());
  EXPECT_EQ(VIEW_ID_QS_SETTINGS_BUTTON, GetSettingsButton()->GetID());

  EXPECT_TRUE(GetPowerButton()->GetVisible());
  EXPECT_EQ(VIEW_ID_QS_POWER_BUTTON, GetPowerButton()->GetID());

  ASSERT_TRUE(GetUserAvatar());
  EXPECT_TRUE(GetUserAvatar()->GetVisible());
  EXPECT_EQ(VIEW_ID_QS_USER_AVATAR_BUTTON, GetUserAvatar()->GetID());

  EXPECT_TRUE(GetBatteryButton()->GetVisible());
  EXPECT_EQ(VIEW_ID_QS_BATTERY_BUTTON, GetBatteryButton()->GetID());

  // Test the UMA tracking.
  LeftClickOn(GetPowerButton());

  histogram_tester->ExpectTotalCount("Ash.QuickSettings.Button.Activated",
                                     /*count=*/1);
  histogram_tester->ExpectBucketCount("Ash.QuickSettings.Button.Activated",
                                      QsButtonCatalogName::kPowerButton,
                                      /*expected_count=*/1);

  // Close the power button menu.
  PressAndReleaseKey(ui::VKEY_ESCAPE);

  LeftClickOn(GetBatteryButton());
  histogram_tester->ExpectTotalCount("Ash.QuickSettings.Button.Activated",
                                     /*count=*/2);
  histogram_tester->ExpectBucketCount("Ash.QuickSettings.Button.Activated",
                                      QsButtonCatalogName::kBatteryButton,
                                      /*expected_count=*/1);
}

// Settings button and avatar button are hidden before login.
TEST_F(QuickSettingsFooterTest, ButtonStatesNotLoggedIn) {
  SetUpView();

  EXPECT_FALSE(GetUserAvatar());
  EXPECT_FALSE(GetSettingsButton());
  EXPECT_TRUE(GetPowerButton()->GetVisible());
  EXPECT_TRUE(GetBatteryButton()->GetVisible());
  EXPECT_FALSE(GetSignOutButton());
}

// All buttons are shown after login.
TEST_F(QuickSettingsFooterTest, ButtonStatesLoggedIn) {
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUpView();

  EXPECT_FALSE(GetSignOutButton());

  ASSERT_TRUE(GetSettingsButton());
  EXPECT_TRUE(GetSettingsButton()->GetVisible());

  ASSERT_TRUE(GetPowerButton());
  EXPECT_TRUE(GetPowerButton()->GetVisible());

  ASSERT_TRUE(GetBatteryButton());
  EXPECT_TRUE(GetBatteryButton()->GetVisible());

  // No sign-out button because there is only one account on the device.
  EXPECT_FALSE(GetSignOutButton());

  // No user avatar button because only one user is signed in.
  EXPECT_FALSE(GetUserAvatar());
}

// Settings button is hidden at the lock screen.
TEST_F(QuickSettingsFooterTest, ButtonStatesLockScreen) {
  BlockUserSession(BLOCKED_BY_LOCK_SCREEN);
  SetUpView();

  EXPECT_FALSE(GetSettingsButton());
  ASSERT_TRUE(GetPowerButton());
  EXPECT_TRUE(GetPowerButton()->GetVisible());
  ASSERT_TRUE(GetBatteryButton());
  EXPECT_TRUE(GetBatteryButton()->GetVisible());

  // No user avatar button because we are in the lock screen.
  EXPECT_FALSE(GetUserAvatar());
}

// Settings button and lock button are hidden when adding a second
// multiprofile user.
TEST_F(QuickSettingsFooterTest, ButtonStatesAddingUser) {
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUserAddingScreenRunning(true);
  SetUpView();

  ASSERT_FALSE(GetUserAvatar());
  ASSERT_FALSE(GetSignOutButton());
  EXPECT_EQ(nullptr, GetSettingsButton());
  ASSERT_TRUE(GetPowerButton());
  EXPECT_TRUE(GetPowerButton()->GetVisible());
  ASSERT_TRUE(GetBatteryButton());
  EXPECT_TRUE(GetBatteryButton()->GetVisible());
}

TEST_F(QuickSettingsFooterTest, ButtonStatesGuestMode) {
  SimulateGuestLogin();
  SetUpView();

  ASSERT_TRUE(GetSettingsButton());
  EXPECT_TRUE(GetSettingsButton()->GetVisible());

  ASSERT_TRUE(GetPowerButton());
  EXPECT_TRUE(GetPowerButton()->GetVisible());

  ASSERT_TRUE(GetBatteryButton());
  EXPECT_TRUE(GetBatteryButton()->GetVisible());

  ASSERT_TRUE(GetSignOutButton());
  EXPECT_TRUE(GetSignOutButton()->GetVisible());
  EXPECT_EQ(u"Exit guest", GetSignOutButton()->GetText());
}

TEST_F(QuickSettingsFooterTest, ButtonStatesPublicAccount) {
  SimulateUserLogin(
      {"foo@example.com", user_manager::UserType::kPublicAccount});
  SetUpView();

  ASSERT_TRUE(GetSettingsButton());
  EXPECT_TRUE(GetSettingsButton()->GetVisible());

  ASSERT_TRUE(GetPowerButton());
  EXPECT_TRUE(GetPowerButton()->GetVisible());

  ASSERT_TRUE(GetBatteryButton());
  EXPECT_TRUE(GetBatteryButton()->GetVisible());

  ASSERT_TRUE(GetSignOutButton());
  EXPECT_TRUE(GetSignOutButton()->GetVisible());
  EXPECT_EQ(u"Exit session", GetSignOutButton()->GetText());

  EXPECT_FALSE(GetUserAvatar());
}

TEST_F(QuickSettingsFooterTest, SignOutShowsWithMultipleAccounts) {
  GetSessionControllerClient()->set_existing_users_count(2);
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUpView();

  ASSERT_TRUE(GetSignOutButton());
  EXPECT_TRUE(GetSignOutButton()->GetVisible());
  EXPECT_EQ(u"Sign out", GetSignOutButton()->GetText());

  // Although there are two accounts, only one is logged in so do not show the
  // user avatar.
  EXPECT_FALSE(GetUserAvatar());
}

TEST_F(QuickSettingsFooterTest, SignOutButtonRecordsUmaAndSignsOut) {
  GetSessionControllerClient()->set_existing_users_count(2);
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUpView();

  base::HistogramTester histogram_tester;
  LeftClickOn(GetSignOutButton());

  histogram_tester.ExpectTotalCount("Ash.QuickSettings.Button.Activated",
                                    /*expected_count=*/1);
  histogram_tester.ExpectBucketCount("Ash.QuickSettings.Button.Activated",
                                     QsButtonCatalogName::kSignOutButton,
                                     /*expected_count=*/1);

  EXPECT_TRUE(base::test::RunUntil([&]() {
    return GetSessionControllerClient()->request_sign_out_count() == 1;
  }));
}

// Settings button is disabled when kSettingsIconDisabled is set.
TEST_F(QuickSettingsFooterTest, DisableSettingsIconPolicy) {
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUpView();
  EXPECT_EQ(views::Button::STATE_NORMAL, GetSettingsButton()->GetState());

  local_state()->SetBoolean(prefs::kOsSettingsEnabled, false);
  EXPECT_EQ(views::Button::STATE_DISABLED, GetSettingsButton()->GetState());

  local_state()->SetBoolean(prefs::kOsSettingsEnabled, true);
  EXPECT_EQ(views::Button::STATE_NORMAL, GetSettingsButton()->GetState());
}

// Tests different battery states.
TEST_F(QuickSettingsFooterTest, BatteryButtonState) {
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUpView();

  const bool use_smart_charging_ui =
      ash::features::IsAdaptiveChargingEnabled() &&
      Shell::Get()
          ->adaptive_charging_controller()
          ->is_adaptive_delaying_charge();

  if (use_smart_charging_ui) {
    EXPECT_TRUE(views::IsViewClass<QsBatteryIconView>(GetBatteryButton()));
  } else {
    EXPECT_TRUE(views::IsViewClass<QsBatteryLabelView>(GetBatteryButton()));
  }
}

// The following tests will ensure that the entire Widget root view is properly
// laid out. The `LayoutFooter()` method will call
// `Widget::LayoutRootViewIfNecessary()`.
//
// Try to layout buttons before login.
TEST_F(QuickSettingsFooterTest, ButtonLayoutNotLoggedIn) {
  SetUpView();
  LayoutFooter();
}

// Try to layout buttons after login.
TEST_F(QuickSettingsFooterTest, ButtonLayoutLoggedIn) {
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUpView();
  LayoutFooter();
}

// Try to layout buttons at the lock screen.
TEST_F(QuickSettingsFooterTest, ButtonLayoutLockScreen) {
  BlockUserSession(BLOCKED_BY_LOCK_SCREEN);
  SetUpView();
  LayoutFooter();
}

// Try to layout buttons when adding a second multiprofile user.
TEST_F(QuickSettingsFooterTest, ButtonLayoutAddingUser) {
  SimulateUserLogin(kRegularUserLoginInfo);
  SetUserAddingScreenRunning(true);
  SetUpView();
  LayoutFooter();
}

}  // namespace ash