blob: ac6c20d8ee96b02b82425695cb765d9ced9f8d0b [file] [log] [blame]
// Copyright 2013 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 "content/test/accessibility_browser_test_utils.h"
#include "base/bind.h"
#include "base/logging.h"
#include "base/no_destructor.h"
#include "base/run_loop.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "content/browser/accessibility/browser_accessibility_manager.h"
#include "content/browser/frame_host/render_frame_host_impl.h"
#include "content/browser/renderer_host/render_widget_host_view_base.h"
#include "content/browser/web_contents/web_contents_impl.h"
#include "content/public/browser/web_contents.h"
#include "content/public/common/url_constants.h"
#include "content/public/test/test_utils.h"
#include "ui/accessibility/ax_node.h"
namespace content {
AccessibilityNotificationWaiter::AccessibilityNotificationWaiter(
WebContents* web_contents)
: WebContentsObserver(web_contents),
event_to_wait_for_(ax::mojom::Event::kNone),
generated_event_to_wait_for_(base::nullopt),
loop_runner_(std::make_unique<base::RunLoop>()),
weak_factory_(this) {
RenderFrameHostChanged(nullptr, web_contents->GetMainFrame());
}
AccessibilityNotificationWaiter::AccessibilityNotificationWaiter(
WebContents* web_contents,
ui::AXMode accessibility_mode,
ax::mojom::Event event_type)
: WebContentsObserver(web_contents),
event_to_wait_for_(event_type),
generated_event_to_wait_for_(base::nullopt),
loop_runner_(std::make_unique<base::RunLoop>()),
weak_factory_(this) {
RenderFrameHostChanged(nullptr, web_contents->GetMainFrame());
static_cast<WebContentsImpl*>(web_contents)
->AddAccessibilityMode(accessibility_mode);
}
AccessibilityNotificationWaiter::AccessibilityNotificationWaiter(
RenderFrameHostImpl* frame_host,
ax::mojom::Event event_type)
: event_to_wait_for_(event_type),
generated_event_to_wait_for_(base::nullopt),
loop_runner_(std::make_unique<base::RunLoop>()),
weak_factory_(this) {
RenderFrameHostChanged(nullptr, frame_host);
}
AccessibilityNotificationWaiter::AccessibilityNotificationWaiter(
WebContents* web_contents,
ui::AXMode accessibility_mode,
ui::AXEventGenerator::Event event_type)
: WebContentsObserver(web_contents),
event_to_wait_for_(base::nullopt),
generated_event_to_wait_for_(event_type),
loop_runner_(std::make_unique<base::RunLoop>()),
weak_factory_(this) {
RenderFrameHostChanged(nullptr, web_contents->GetMainFrame());
static_cast<WebContentsImpl*>(web_contents)
->AddAccessibilityMode(accessibility_mode);
}
AccessibilityNotificationWaiter::AccessibilityNotificationWaiter(
RenderFrameHostImpl* frame_host,
ui::AXEventGenerator::Event event_type)
: event_to_wait_for_(base::nullopt),
generated_event_to_wait_for_(event_type),
loop_runner_(std::make_unique<base::RunLoop>()),
weak_factory_(this) {
RenderFrameHostChanged(nullptr, frame_host);
}
AccessibilityNotificationWaiter::~AccessibilityNotificationWaiter() {}
void AccessibilityNotificationWaiter::ListenToAdditionalFrame(
RenderFrameHostImpl* frame_host) {
if (event_to_wait_for_)
BindOnAccessibilityEvent(frame_host);
if (generated_event_to_wait_for_)
BindOnGeneratedEvent(frame_host);
}
void AccessibilityNotificationWaiter::WaitForNotification() {
loop_runner_->Run();
// Each loop runner can only be called once. Create a new one in case
// the caller wants to call this again to wait for the next notification.
loop_runner_ = std::make_unique<base::RunLoop>();
}
void AccessibilityNotificationWaiter::WaitForNotificationWithTimeout(
base::TimeDelta timeout) {
base::OneShotTimer quit_timer;
quit_timer.Start(FROM_HERE, timeout, loop_runner_->QuitWhenIdleClosure());
WaitForNotification();
}
const ui::AXTree& AccessibilityNotificationWaiter::GetAXTree() const {
static base::NoDestructor<ui::AXTree> empty_tree;
const ui::AXTree* tree = frame_host_->GetAXTreeForTesting();
return tree ? *tree : *empty_tree;
}
void AccessibilityNotificationWaiter::BindOnAccessibilityEvent(
RenderFrameHostImpl* frame_host) {
frame_host->SetAccessibilityCallbackForTesting(base::BindRepeating(
&AccessibilityNotificationWaiter::OnAccessibilityEvent,
weak_factory_.GetWeakPtr()));
}
void AccessibilityNotificationWaiter::OnAccessibilityEvent(
RenderFrameHostImpl* rfhi,
ax::mojom::Event event_type,
int event_target_id) {
if (IsAboutBlank())
return;
LOG(INFO) << "OnAccessibilityEvent " << event_type;
if (event_to_wait_for_ == ax::mojom::Event::kNone ||
event_to_wait_for_ == event_type) {
event_target_id_ = event_target_id;
event_render_frame_host_ = rfhi;
loop_runner_->Quit();
}
}
void AccessibilityNotificationWaiter::BindOnGeneratedEvent(
RenderFrameHostImpl* frame_host) {
if (auto* manager = frame_host->GetOrCreateBrowserAccessibilityManager()) {
manager->SetGeneratedEventCallbackForTesting(
base::BindRepeating(&AccessibilityNotificationWaiter::OnGeneratedEvent,
weak_factory_.GetWeakPtr()));
}
}
void AccessibilityNotificationWaiter::OnGeneratedEvent(
BrowserAccessibilityDelegate* delegate,
ui::AXEventGenerator::Event event,
int event_target_id) {
if (IsAboutBlank())
return;
if (generated_event_to_wait_for_ == event) {
event_target_id_ = event_target_id;
event_render_frame_host_ = static_cast<RenderFrameHostImpl*>(delegate);
loop_runner_->Quit();
}
}
bool AccessibilityNotificationWaiter::IsAboutBlank() {
// Skip any accessibility notifications related to "about:blank",
// to avoid a possible race condition between the test beginning
// listening for accessibility events and "about:blank" loading.
return GetAXTree().data().url == url::kAboutBlankURL;
}
// WebContentsObserver override:
void AccessibilityNotificationWaiter::RenderFrameHostChanged(
RenderFrameHost* old_host,
RenderFrameHost* new_host) {
if (frame_host_ != old_host)
return;
frame_host_ = static_cast<RenderFrameHostImpl*>(new_host);
ListenToAdditionalFrame(frame_host_);
}
} // namespace content