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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
|
// 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/test/ash_test_util.h"
#include <string>
#include <variant>
#include <vector>
#include "ash/frame/non_client_frame_view_ash.h"
#include "ash/public/cpp/shell_window_ids.h"
#include "ash/root_window_controller.h"
#include "ash/shell.h"
#include "ash/system/status_area_widget.h"
#include "ash/system/unified/unified_system_tray.h"
#include "base/auto_reset.h"
#include "base/check.h"
#include "base/containers/span.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "base/run_loop.h"
#include "base/scoped_observation.h"
#include "base/strings/string_view_util.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "chromeos/ui/frame/caption_buttons/frame_caption_button_container_view.h"
#include "chromeos/ui/frame/multitask_menu/multitask_menu.h"
#include "chromeos/ui/frame/multitask_menu/multitask_menu_metrics.h"
#include "ui/aura/client/aura_constants.h"
#include "ui/aura/window_observer.h"
#include "ui/compositor/layer.h"
#include "ui/events/test/event_generator.h"
#include "ui/gfx/codec/png_codec.h"
#include "ui/gfx/geometry/size.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_util.h"
#include "ui/snapshot/snapshot_aura.h"
#include "ui/views/controls/menu/menu_item_view.h"
#include "ui/views/view.h"
#include "ui/views/view_utils.h"
#include "ui/views/widget/any_widget_observer.h"
#include "ui/views/widget/widget.h"
namespace ash {
namespace {
// Helper functions ------------------------------------------------------------
void SnapshotCallback(base::RunLoop* run_loop,
gfx::Image* ret_image,
gfx::Image image) {
*ret_image = image;
run_loop->Quit();
}
// Returns the menu item view with `label` from the specified view.
views::MenuItemView* FindMenuItemWithLabelFromView(
views::View* search_root,
const std::u16string& label) {
// Check whether `search_root` is the target menu item view.
if (views::MenuItemView* const menu_item_view =
views::AsViewClass<views::MenuItemView>(search_root);
menu_item_view && menu_item_view->title() == label) {
return menu_item_view;
}
// Keep searching in children views.
for (views::View* const child : search_root->children()) {
if (views::MenuItemView* const found =
FindMenuItemWithLabelFromView(child, label)) {
return found;
}
}
return nullptr;
}
// Returns the menu item view with `label` from the specified window.
views::MenuItemView* FindMenuItemWithLabelFromWindow(
aura::Window* search_root,
const std::u16string& label) {
// If `search_root` is a window for widget, search the target menu item view
// in the view tree.
if (views::Widget* const root_widget =
views::Widget::GetWidgetForNativeWindow(search_root)) {
return FindMenuItemWithLabelFromView(root_widget->GetRootView(), label);
}
for (aura::Window* const child : search_root->children()) {
if (auto* found = FindMenuItemWithLabelFromWindow(child, label)) {
return found;
}
}
return nullptr;
}
// Returns a pointer to the `aura::Window` in the window tree associated with
// the specified `window` which has the specified `name`. In the event that no
// such `aura::Window` is found, `nullptr` is returned.
aura::Window* FindWindowWithName(aura::Window* window, std::string_view name) {
if (!window) {
return nullptr;
}
if (window->GetName() == name) {
return window;
}
for (aura::Window* const child : window->children()) {
if (aura::Window* found = FindWindowWithName(child, name)) {
return found;
}
}
return nullptr;
}
// MenuItemViewWithLabelWaiter -------------------------------------------------
class MenuItemViewWithLabelWaiter : public aura::WindowObserver {
public:
explicit MenuItemViewWithLabelWaiter(const std::u16string& label)
: label_(label),
menu_container_(Shell::GetContainer(Shell::GetPrimaryRootWindow(),
kShellWindowId_MenuContainer)) {
CHECK(menu_container_) << "The menu container is expected to exist.";
}
// Waits until the target menu item view is found. Returns the pointer to the
// target view.
views::MenuItemView* Wait() {
// Return early if the target view already exists.
if ((cached_target_view_ =
FindMenuItemWithLabelFromWindow(menu_container_, label_))) {
return cached_target_view_;
}
base::AutoReset<std::unique_ptr<base::RunLoop>> auto_reset(
&run_loop_, std::make_unique<base::RunLoop>());
// Start the observation on `menu_container_`. A new menu should add
// itself under `menu_container_`.
base::ScopedObservation<aura::Window, aura::WindowObserver> observation{
this};
observation.Observe(menu_container_);
run_loop_->Run();
CHECK(cached_target_view_);
return cached_target_view_;
}
private:
// aura::WindowObserver:
void OnWindowAdded(aura::Window* window) override {
// Menu items are built after the window is added. Therefore, check the
// target menu item in an asynchronous task.
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&MenuItemViewWithLabelWaiter::CacheTargetView,
weak_factory_.GetWeakPtr()));
}
void OnWindowDestroying(aura::Window* window) override {
CHECK(!run_loop_)
<< "The menu container was destroyed while we were waiting for "
"the target menu item.";
}
void CacheTargetView() {
if ((cached_target_view_ =
FindMenuItemWithLabelFromWindow(menu_container_, label_))) {
run_loop_->Quit();
}
}
const std::u16string label_;
const raw_ptr<aura::Window> menu_container_;
std::unique_ptr<base::RunLoop> run_loop_;
raw_ptr<views::MenuItemView> cached_target_view_ = nullptr;
base::WeakPtrFactory<MenuItemViewWithLabelWaiter> weak_factory_{this};
};
} // namespace
bool TakePrimaryDisplayScreenshotAndSave(const base::FilePath& file_path) {
// Return false if the file extension is not "png".
if (file_path.Extension() != ".png")
return false;
// Return false if `file_path`'s directory does not exist.
const base::FilePath directory_name = file_path.DirName();
if (!base::PathExists(directory_name))
return false;
base::RunLoop run_loop;
gfx::Image image;
ui::GrabWindowSnapshotAura(
Shell::Get()->GetPrimaryRootWindow(),
Shell::Get()->GetPrimaryRootWindow()->bounds(),
base::BindOnce(&SnapshotCallback, &run_loop, &image));
run_loop.Run();
auto data = image.As1xPNGBytes();
DCHECK_GT(data->size(), 0u);
return base::WriteFile(file_path, *data);
}
void GiveItSomeTimeForDebugging(base::TimeDelta time_duration) {
base::RunLoop run_loop;
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE, run_loop.QuitClosure(), time_duration);
run_loop.Run();
}
bool IsSystemTrayForRootWindowVisible(size_t root_window_index) {
aura::Window::Windows root_windows = Shell::GetAllRootWindows();
RootWindowController* controller =
RootWindowController::ForWindow(root_windows[root_window_index]);
return controller->GetStatusAreaWidget()->unified_system_tray()->GetVisible();
}
gfx::ImageSkia CreateSolidColorTestImage(const gfx::Size& image_size,
SkColor color) {
SkBitmap bitmap;
bitmap.allocN32Pixels(image_size.width(), image_size.height());
bitmap.eraseColor(color);
gfx::ImageSkia image = gfx::ImageSkia::CreateFrom1xBitmap(bitmap);
return image;
}
std::string CreateEncodedImageForTesting(const gfx::Size& size,
SkColor color,
data_decoder::mojom::ImageCodec codec,
gfx::ImageSkia* image_out) {
gfx::ImageSkia test_image = CreateSolidColorTestImage(size, color);
CHECK(!test_image.isNull());
if (image_out) {
*image_out = test_image;
}
std::optional<std::vector<uint8_t>> encoded_image;
switch (codec) {
case data_decoder::mojom::ImageCodec::kDefault:
encoded_image =
gfx::JPEG1xEncodedDataFromImage(gfx::Image(test_image), 100);
break;
case data_decoder::mojom::ImageCodec::kPng:
encoded_image = gfx::PNGCodec::EncodeBGRASkBitmap(
*test_image.bitmap(), /*discard_transparency=*/true);
break;
}
CHECK(encoded_image.has_value());
return std::string(base::as_string_view(encoded_image.value()));
}
void DecorateWindow(aura::Window* window,
const std::u16string& title,
SkColor color) {
auto* widget = views::Widget::GetWidgetForNativeWindow(window);
DCHECK(widget);
widget->client_view()->AddChildView(
views::Builder<views::View>()
.SetBackground(views::CreateRoundedRectBackground(color, 4.f))
.Build());
// Add a title and an app icon so that the header is fully stocked.
window->SetTitle(title);
SkBitmap bitmap;
bitmap.allocN32Pixels(1, 1);
bitmap.eraseColor(SK_ColorCYAN);
window->SetProperty(aura::client::kAppIconKey,
gfx::ImageSkia::CreateFrom1xBitmap(bitmap));
}
views::MenuItemView* WaitForMenuItemWithLabel(const std::u16string& label) {
return MenuItemViewWithLabelWaiter(label).Wait();
}
chromeos::MultitaskMenu* ShowAndWaitMultitaskMenuForWindow(
std::variant<aura::Window*, chromeos::FrameSizeButton*>
window_or_size_button,
chromeos::MultitaskMenuEntryType entry_type) {
// If a size button object is passed, use that. Otherwise retrieve it from the
// non client frame view ash.
chromeos::FrameSizeButton* size_button = nullptr;
if (std::holds_alternative<chromeos::FrameSizeButton*>(
window_or_size_button)) {
size_button = std::get<chromeos::FrameSizeButton*>(window_or_size_button);
} else {
aura::Window* window = std::get<aura::Window*>(window_or_size_button);
CHECK(window);
auto* frame_view = NonClientFrameViewAsh::Get(window);
if (!frame_view) {
return nullptr;
}
size_button = views::AsViewClass<chromeos::FrameSizeButton>(
frame_view->GetHeaderView()->caption_button_container()->size_button());
}
views::NamedWidgetShownWaiter waiter(
views::test::AnyWidgetTestPasskey{},
std::string("MultitaskMenuBubbleWidget"));
size_button->ShowMultitaskMenu(entry_type);
views::WidgetDelegate* delegate =
waiter.WaitIfNeededAndGet()->widget_delegate();
auto* multitask_menu =
static_cast<chromeos::MultitaskMenu*>(delegate->AsDialogDelegate());
return multitask_menu;
}
void SendKey(ui::KeyboardCode key_code,
ui::test::EventGenerator* event_generator,
int flags,
int count) {
for (int i = 0; i < count; ++i) {
event_generator->PressAndReleaseKey(key_code, flags);
}
}
ui::Layer* FindLayerWithName(ui::Layer* layer, std::string_view name) {
if (!layer) {
return nullptr;
}
if (layer->name() == name) {
return layer;
}
for (ui::Layer* child : layer->children()) {
if (ui::Layer* result = FindLayerWithName(child, name)) {
return result;
}
}
return nullptr;
}
ui::Layer* FindLayerWithName(views::View* view, std::string_view name) {
if (!view) {
return nullptr;
}
if (ui::Layer* layer = FindLayerWithName(view->layer(), name)) {
return layer;
}
for (views::View* child : view->children()) {
if (ui::Layer* layer = FindLayerWithName(child, name)) {
return layer;
}
}
return nullptr;
}
views::Widget* FindWidgetWithName(std::string_view name) {
for (aura::Window* const root_window : Shell::Get()->GetAllRootWindows()) {
if (aura::Window* const found = FindWindowWithName(root_window, name)) {
return views::Widget::GetWidgetForNativeView(found);
}
}
return nullptr;
}
views::Widget* FindWidgetWithNameAndWaitIfNeeded(const std::string& name) {
if (views::Widget* const found = FindWidgetWithName(name)) {
return found;
}
return views::NamedWidgetShownWaiter(views::test::AnyWidgetTestPasskey(),
name)
.WaitIfNeededAndGet();
}
} // namespace ash
|