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 347 348 349 350 351 352 353 354 355 356 357 358
|
// Copyright 2013 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/shelf/shelf_tooltip_manager.h"
#include <memory>
#include "ash/public/cpp/shelf_model.h"
#include "ash/public/cpp/test/test_shelf_item_delegate.h"
#include "ash/shelf/home_button.h"
#include "ash/shelf/shelf.h"
#include "ash/shelf/shelf_bubble.h"
#include "ash/shelf/shelf_view.h"
#include "ash/shelf/shelf_view_test_api.h"
#include "ash/shell.h"
#include "ash/test/ash_test_base.h"
#include "ash/wm/collision_detection/collision_detection_utils.h"
#include "ash/wm/desks/desk_button/desk_button.h"
#include "ash/wm/desks/desks_test_util.h"
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/test/scoped_feature_list.h"
#include "ui/events/event_constants.h"
#include "ui/events/test/event_generator.h"
#include "ui/views/bubble/bubble_dialog_delegate_view.h"
#include "ui/views/widget/widget.h"
namespace ash {
class ShelfTooltipManagerTest : public AshTestBase {
public:
ShelfTooltipManagerTest() = default;
ShelfTooltipManagerTest(const ShelfTooltipManagerTest&) = delete;
ShelfTooltipManagerTest& operator=(const ShelfTooltipManagerTest&) = delete;
~ShelfTooltipManagerTest() override = default;
void SetUp() override {
AshTestBase::SetUp();
shelf_view_ = GetPrimaryShelf()->GetShelfViewForTesting();
test_api_ = std::make_unique<ShelfViewTestAPI>(shelf_view_);
test_api_->SetAnimationDuration(base::Milliseconds(1));
test_api_->AddItem(TYPE_PINNED_APP);
test_api_->RunMessageLoopUntilAnimationsDone();
tooltip_manager_ = test_api_->tooltip_manager();
tooltip_manager_->set_timer_delay_for_test(0);
}
bool IsTimerRunning() { return tooltip_manager_->timer_.IsRunning(); }
views::Widget* GetTooltip() { return tooltip_manager_->bubble_->GetWidget(); }
void ShowTooltipForFirstAppIcon() {
EXPECT_GE(shelf_view_->number_of_visible_apps(), 1u);
tooltip_manager_->ShowTooltip(
shelf_view_->first_visible_button_for_testing());
}
protected:
raw_ptr<ShelfView, DanglingUntriaged | ExperimentalAsh> shelf_view_;
raw_ptr<ShelfTooltipManager, DanglingUntriaged | ExperimentalAsh>
tooltip_manager_;
std::unique_ptr<ShelfViewTestAPI> test_api_;
};
TEST_F(ShelfTooltipManagerTest, ShowTooltip) {
ShowTooltipForFirstAppIcon();
EXPECT_TRUE(tooltip_manager_->IsVisible());
EXPECT_FALSE(IsTimerRunning());
}
TEST_F(ShelfTooltipManagerTest, ShowTooltipWithDelay) {
// ShowTooltipWithDelay should start the timer instead of showing immediately.
tooltip_manager_->ShowTooltipWithDelay(
shelf_view_->first_visible_button_for_testing());
EXPECT_FALSE(tooltip_manager_->IsVisible());
EXPECT_TRUE(IsTimerRunning());
// TODO: Test that the delayed tooltip is shown, without flaky failures.
}
TEST_F(ShelfTooltipManagerTest, DoNotShowForInvalidView) {
// The manager should not show or start the timer for a null view.
tooltip_manager_->ShowTooltip(nullptr);
EXPECT_FALSE(tooltip_manager_->IsVisible());
tooltip_manager_->ShowTooltipWithDelay(nullptr);
EXPECT_FALSE(IsTimerRunning());
// The manager should not show or start the timer for a non-shelf view.
views::View view;
tooltip_manager_->ShowTooltip(&view);
EXPECT_FALSE(tooltip_manager_->IsVisible());
tooltip_manager_->ShowTooltipWithDelay(&view);
EXPECT_FALSE(IsTimerRunning());
// The manager should start the timer for a view on the shelf.
ShelfModel* model = shelf_view_->model();
ShelfItem item;
item.id = ShelfID("foo");
item.type = TYPE_PINNED_APP;
const int index =
model->Add(item, std::make_unique<TestShelfItemDelegate>(item.id));
ShelfViewTestAPI(GetPrimaryShelf()->GetShelfViewForTesting())
.RunMessageLoopUntilAnimationsDone();
// The index of a ShelfItem in the model should be the same as its index
// within the |shelf_view_|'s list of children.
tooltip_manager_->ShowTooltipWithDelay(shelf_view_->children().at(index));
EXPECT_TRUE(IsTimerRunning());
// Removing the view won't stop the timer, but the tooltip shouldn't be shown.
model->RemoveItemAt(index);
EXPECT_TRUE(IsTimerRunning());
base::RunLoop().RunUntilIdle();
EXPECT_FALSE(IsTimerRunning());
EXPECT_FALSE(tooltip_manager_->IsVisible());
}
TEST_F(ShelfTooltipManagerTest, HideWhenShelfIsHidden) {
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
// Create a full-screen window to hide the shelf.
std::unique_ptr<views::Widget> widget = CreateTestWidget();
widget->SetFullscreen(true);
// Once the shelf is hidden, the tooltip should be invisible.
ASSERT_EQ(SHELF_HIDDEN, GetPrimaryShelf()->GetVisibilityState());
EXPECT_FALSE(tooltip_manager_->IsVisible());
// Do not show the view if the shelf is hidden.
ShowTooltipForFirstAppIcon();
EXPECT_FALSE(tooltip_manager_->IsVisible());
// ShowTooltipWithDelay doesn't even start the timer for the hidden shelf.
tooltip_manager_->ShowTooltipWithDelay(
shelf_view_->first_visible_button_for_testing());
EXPECT_FALSE(IsTimerRunning());
}
TEST_F(ShelfTooltipManagerTest, HideWhenShelfIsAutoHideHidden) {
// Create a visible window so auto-hide behavior can actually hide the shelf.
std::unique_ptr<views::Widget> widget = CreateTestWidget();
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
GetPrimaryShelf()->SetAutoHideBehavior(ShelfAutoHideBehavior::kAlways);
GetPrimaryShelf()->UpdateAutoHideState();
ASSERT_EQ(ShelfAutoHideBehavior::kAlways,
GetPrimaryShelf()->auto_hide_behavior());
ASSERT_EQ(SHELF_AUTO_HIDE_HIDDEN, GetPrimaryShelf()->GetAutoHideState());
EXPECT_FALSE(tooltip_manager_->IsVisible());
// Do not show the view if the shelf is hidden.
ShowTooltipForFirstAppIcon();
EXPECT_FALSE(tooltip_manager_->IsVisible());
// ShowTooltipWithDelay doesn't even run the timer for the hidden shelf.
tooltip_manager_->ShowTooltipWithDelay(
shelf_view_->first_visible_button_for_testing());
EXPECT_FALSE(IsTimerRunning());
// Close the window to show the auto-hide shelf; tooltips should now show.
widget.reset();
GetPrimaryShelf()->UpdateAutoHideState();
ASSERT_EQ(ShelfAutoHideBehavior::kAlways,
GetPrimaryShelf()->auto_hide_behavior());
ASSERT_EQ(SHELF_AUTO_HIDE_SHOWN, GetPrimaryShelf()->GetAutoHideState());
// The tooltip should show for an auto-hide-shown shelf.
ShowTooltipForFirstAppIcon();
EXPECT_TRUE(tooltip_manager_->IsVisible());
// ShowTooltipWithDelay should run the timer for an auto-hide-shown shelf.
tooltip_manager_->ShowTooltipWithDelay(
shelf_view_->first_visible_button_for_testing());
EXPECT_TRUE(IsTimerRunning());
}
TEST_F(ShelfTooltipManagerTest, HideForEvents) {
ui::test::EventGenerator* generator = GetEventGenerator();
gfx::Rect shelf_bounds = shelf_view_->GetBoundsInScreen();
// Should hide if the mouse exits the shelf area.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->MoveMouseTo(shelf_bounds.CenterPoint());
generator->SendMouseExit();
EXPECT_FALSE(tooltip_manager_->IsVisible());
// Should hide if the mouse is pressed in the shelf area.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->MoveMouseTo(shelf_bounds.CenterPoint());
generator->PressLeftButton();
EXPECT_FALSE(tooltip_manager_->IsVisible());
generator->ReleaseLeftButton();
// Should hide for touch events in the shelf.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->set_current_screen_location(shelf_bounds.CenterPoint());
generator->PressTouch();
EXPECT_FALSE(tooltip_manager_->IsVisible());
// Should hide for gesture events in the shelf.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->GestureTapDownAndUp(shelf_bounds.CenterPoint());
EXPECT_FALSE(tooltip_manager_->IsVisible());
}
TEST_F(ShelfTooltipManagerTest, HideForExternalEvents) {
ui::test::EventGenerator* generator = GetEventGenerator();
// Should hide for touches outside the shelf.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->set_current_screen_location(gfx::Point());
generator->PressTouch();
EXPECT_FALSE(tooltip_manager_->IsVisible());
generator->ReleaseTouch();
// Should hide for touch events on the tooltip.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->set_current_screen_location(
GetTooltip()->GetWindowBoundsInScreen().CenterPoint());
generator->PressTouch();
EXPECT_FALSE(tooltip_manager_->IsVisible());
generator->ReleaseTouch();
// Should hide for gestures outside the shelf.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->GestureTapDownAndUp(gfx::Point());
EXPECT_FALSE(tooltip_manager_->IsVisible());
}
TEST_F(ShelfTooltipManagerTest, KeyEvents) {
ui::test::EventGenerator* generator = GetEventGenerator();
// Should hide when 'Esc' is pressed.
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
generator->PressKey(ui::VKEY_ESCAPE, ui::EF_NONE);
EXPECT_FALSE(tooltip_manager_->IsVisible());
}
TEST_F(ShelfTooltipManagerTest, ShelfTooltipDoesNotAffectPipWindow) {
ShowTooltipForFirstAppIcon();
EXPECT_TRUE(tooltip_manager_->IsVisible());
auto display = display::Screen::GetScreen()->GetPrimaryDisplay();
auto tooltip_bounds = GetTooltip()->GetWindowBoundsInScreen();
tooltip_bounds.Intersect(CollisionDetectionUtils::GetMovementArea(display));
EXPECT_FALSE(tooltip_bounds.IsEmpty());
EXPECT_EQ(tooltip_bounds,
CollisionDetectionUtils::GetRestingPosition(
display, tooltip_bounds,
CollisionDetectionUtils::RelativePriority::kPictureInPicture));
}
TEST_F(ShelfTooltipManagerTest, ShelfTooltipClosesIfScroll) {
ui::test::EventGenerator* generator = GetEventGenerator();
ShowTooltipForFirstAppIcon();
ASSERT_TRUE(tooltip_manager_->IsVisible());
gfx::Point cursor_position_in_screen =
display::Screen::GetScreen()->GetCursorScreenPoint();
generator->ScrollSequence(cursor_position_in_screen, base::TimeDelta(), 0, 3,
10, 1);
EXPECT_FALSE(tooltip_manager_->IsVisible());
}
namespace {
using ::testing::ValuesIn;
class ShelfTooltipManagerDeskButtonTest
: public ShelfTooltipManagerTest,
public ::testing::WithParamInterface<ShelfAlignment> {
public:
ShelfTooltipManagerDeskButtonTest() = default;
ShelfTooltipManagerDeskButtonTest(const ShelfTooltipManagerDeskButtonTest&) =
delete;
ShelfTooltipManagerDeskButtonTest& operator=(
const ShelfTooltipManagerDeskButtonTest&) = delete;
~ShelfTooltipManagerDeskButtonTest() override = default;
void SetUp() override {
scoped_feature_list_.InitAndEnableFeature(features::kDeskButton);
ShelfTooltipManagerTest::SetUp();
Shelf::ForWindow(Shell::GetPrimaryRootWindow())->SetAlignment(GetParam());
}
private:
base::test::ScopedFeatureList scoped_feature_list_;
};
INSTANTIATE_TEST_SUITE_P(All,
ShelfTooltipManagerDeskButtonTest,
ValuesIn({ShelfAlignment::kBottom,
ShelfAlignment::kLeft,
ShelfAlignment::kRight}));
} // namespace
// Verifies that tooltips for the desk button and its child views are correctly
// centered directly above their respective views, or if that position is out of
// the display then it verifies that they are still in bounds.
TEST_P(ShelfTooltipManagerDeskButtonTest, TooltipPositioning) {
NewDesk();
NewDesk();
DesksController* desks_controller = DesksController::Get();
DeskSwitchAnimationWaiter waiter;
desks_controller->ActivateDesk(desks_controller->desks()[1].get(),
DesksSwitchSource::kDeskButtonSwitchButton);
waiter.Wait();
auto validate_tooltip_bounds = [&](views::View* target_view) {
tooltip_manager_->ShowTooltip(target_view);
const gfx::Rect tooltip_bounds = GetTooltip()->GetWindowBoundsInScreen();
const gfx::Rect target_view_bounds = target_view->GetBoundsInScreen();
const gfx::Rect root_window_bounds =
Shell::Get()->GetPrimaryRootWindow()->bounds();
// These exceptions account for out of bounds adjustments for the tooltips
// on the left and right shelves.
const bool left_alignment_exception =
(GetParam() == ShelfAlignment::kLeft && tooltip_bounds.x() == 0 &&
tooltip_bounds.bottom() == target_view_bounds.y());
const bool right_alignment_exception =
(GetParam() == ShelfAlignment::kRight &&
tooltip_bounds.right() == root_window_bounds.right() &&
tooltip_bounds.bottom() == target_view_bounds.y());
if (left_alignment_exception || right_alignment_exception) {
return;
}
ASSERT_EQ(target_view_bounds.top_center(), tooltip_bounds.bottom_center());
};
auto* desk_button_view =
GetPrimaryShelf()->desk_button_widget()->GetDeskButton();
if (GetParam() != ShelfAlignment::kBottom) {
GetEventGenerator()->MoveMouseTo(
desk_button_view->GetBoundsInScreen().CenterPoint());
}
validate_tooltip_bounds(desk_button_view);
validate_tooltip_bounds(desk_button_view->prev_desk_button());
validate_tooltip_bounds(desk_button_view->next_desk_button());
}
} // namespace ash
|