blob: f56566ed726cd506b2cfa905b7a164ade4f1807e [file] [log] [blame]
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/accessibility/dump_accessibility_browsertest_base.h"
#include <set>
#include <string>
#include <vector>
#include "base/command_line.h"
#include "base/files/file_util.h"
#include "base/path_service.h"
#include "base/strings/escape.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/scoped_command_line.h"
#include "base/threading/thread_restrictions.h"
#include "base/threading/thread_task_runner_handle.h"
#include "build/build_config.h"
#include "content/browser/accessibility/browser_accessibility.h"
#include "content/browser/accessibility/browser_accessibility_manager.h"
#include "content/browser/accessibility/browser_accessibility_state_impl.h"
#include "content/browser/renderer_host/render_widget_host_view_child_frame.h"
#include "content/public/browser/ax_inspect_factory.h"
#include "content/public/common/content_features.h"
#include "content/public/common/content_paths.h"
#include "content/public/common/content_switches.h"
#include "content/public/common/url_constants.h"
#include "content/public/test/accessibility_notification_waiter.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/content_browser_test_utils.h"
#include "content/public/test/test_utils.h"
#include "content/shell/browser/shell.h"
#include "content/test/content_browser_test_utils_internal.h"
#include "net/dns/mock_host_resolver.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "third_party/blink/public/common/frame/frame_owner_element_type.h"
#include "ui/accessibility/accessibility_features.h"
#include "ui/accessibility/ax_node.h"
#include "ui/accessibility/ax_role_properties.h"
#include "ui/base/ui_base_features.h"
namespace content {
namespace {
bool ShouldHaveChildTree(const ui::AXNode& node) {
const ui::AXNodeData& data = node.data();
if (data.GetRestriction() == ax::mojom::Restriction::kDisabled) {
DCHECK(!data.HasStringAttribute(ax::mojom::StringAttribute::kChildTreeId));
return false; // A disabled child tree owner won't have a child tree.
}
if (node.IsInvisibleOrIgnored())
return false;
// If has a child tree owner role or a child tree id, then expect some
// child tree content. In some cases IsChildTreeOwner(role) will be false,
// if an ARIA role was used, e.g. <iframe role="region">.
return ui::IsChildTreeOwner(node.GetRole()) ||
data.HasStringAttribute(ax::mojom::StringAttribute::kChildTreeId);
}
bool AccessibilityTreeContainsAllChildTrees(const ui::AXNode& node) {
size_t num_children = node.GetChildCountCrossingTreeBoundary();
if (!num_children) {
// No children. All content is contained unless there is supposed to be
// a child tree for this node.
return !ShouldHaveChildTree(node);
}
for (size_t i = 0; i < num_children; i++) {
if (!AccessibilityTreeContainsAllChildTrees(
*node.GetChildAtIndexCrossingTreeBoundary(i))) {
return false;
}
}
return true;
}
bool IsLoadedDocWithUrl(const BrowserAccessibility* node,
const std::string& url) {
return node->GetRole() == ax::mojom::Role::kRootWebArea &&
node->GetStringAttribute(ax::mojom::StringAttribute::kUrl) == url &&
node->manager()->GetTreeData().loaded &&
node->GetData().relative_bounds.bounds.width() > 0 &&
node->GetData().relative_bounds.bounds.height() > 0;
}
// Recursively searches accessibility nodes in the subtree of |node| that
// represent a fully loaded web document with the given |url|. If less than
// |num_expected| occurrences are found, it returns the remainder. Otherwise,
// it stops searching when reaching |num_expected| occurrences, and returns 0.
unsigned SearchLoadedDocsWithUrlInAccessibilityTree(
const BrowserAccessibility* node,
const std::string& url,
unsigned num_expected) {
if (!num_expected)
return 0;
if (IsLoadedDocWithUrl(node, url)) {
num_expected -= 1;
if (!num_expected)
return 0;
}
for (const auto* child : node->AllChildren()) {
num_expected =
SearchLoadedDocsWithUrlInAccessibilityTree(child, url, num_expected);
if (!num_expected)
return 0;
}
return num_expected;
}
} // namespace
using ui::AXPropertyFilter;
using ui::AXTreeFormatter;
// DumpAccessibilityTestBase
DumpAccessibilityTestBase::DumpAccessibilityTestBase()
: enable_accessibility_after_navigating_(false), test_helper_(GetParam()) {}
DumpAccessibilityTestBase::~DumpAccessibilityTestBase() {}
void DumpAccessibilityTestBase::SetUpCommandLine(
base::CommandLine* command_line) {
IsolateAllSitesForTesting(command_line);
// Each test pass may require custom command-line setup.
test_helper_.SetUpCommandLine(command_line);
}
void DumpAccessibilityTestBase::SetUpOnMainThread() {
host_resolver()->AddRule("*", "127.0.0.1");
SetupCrossSiteRedirector(embedded_test_server());
ASSERT_TRUE(embedded_test_server()->Start());
}
void DumpAccessibilityTestBase::SetUp() {
std::vector<base::test::FeatureRef> enabled_features;
std::vector<base::test::FeatureRef> disabled_features;
ChooseFeatures(&enabled_features, &disabled_features);
scoped_feature_list_.InitWithFeatures(enabled_features, disabled_features);
// The <input type="color"> popup tested in
// AccessibilityInputColorWithPopupOpen requires the ability to read pixels
// from a Canvas, so we need to be able to produce pixel output.
EnablePixelOutput();
ContentBrowserTest::SetUp();
}
void DumpAccessibilityTestBase::SignalRunTestOnMainThread(int) {
LOG(INFO) << "\n\nFinal accessibility tree upon the test termination:\n"
<< DumpUnfilteredAccessibilityTreeAsString();
}
void DumpAccessibilityTestBase::ChooseFeatures(
std::vector<base::test::FeatureRef>* enabled_features,
std::vector<base::test::FeatureRef>* disabled_features) {
// For the best test coverage during development of this feature, enable the
// code that expposes document markers on AXInlineTextBox objects and the
// corresponding code in AXPosition on the browser that collects those
// markers.
enabled_features->emplace_back(features::kUseAXPositionForDocumentMarkers);
enabled_features->emplace_back(blink::features::kPortals);
}
std::string DumpAccessibilityTestBase::DumpTreeAsString() const {
std::unique_ptr<AXTreeFormatter> formatter(CreateFormatter());
formatter->SetPropertyFilters(scenario_.property_filters,
AXTreeFormatter::kFiltersDefaultSet);
formatter->SetNodeFilters(scenario_.node_filters);
std::string actual_contents =
formatter->Format(GetRootAccessibilityNode(GetWebContents()));
return base::EscapeNonASCII(actual_contents);
}
std::string
DumpAccessibilityTestBase::DumpUnfilteredAccessibilityTreeAsString() {
std::unique_ptr<AXTreeFormatter> formatter(CreateFormatter());
formatter->SetPropertyFilters({{"*", AXPropertyFilter::ALLOW}});
formatter->set_show_ids(true);
return formatter->Format(GetRootAccessibilityNode(GetWebContents()));
}
void DumpAccessibilityTestBase::RunTest(
const base::FilePath file_path,
const char* file_dir,
const base::FilePath::StringType& expectations_qualifier) {
RunTestForPlatform(file_path, file_dir, expectations_qualifier);
}
// TODO(accessibility) Consider renaming these things to
// WaitForAccessibiltiyClean(), Action::kRequestAccessibilityCleanNotification,
// Event::kAccessibilityClean, etc. because this can be used multiple times
// per test.
// TODO(accessibility) A potential test flakiness fix would be to
// WaitForEndOfTest on all descendant documents. This currently only
// ensures a clean state for the root document. However, the code in
// RenderAccessibilityImpl would not be able to perfectly check all child
// documents because some frames are remote, aka in another process. This does
// not appear to be necessary for our current tests. It may be necessary if we
// end up with <portal> or <iframe> tests that have more complex content.
void DumpAccessibilityTestBase::WaitForEndOfTest() const {
// To make sure we've handled all accessibility events, add a sentinel by
// calling SignalEndOfTest and waiting for a kEndOfTest event in response.
AccessibilityNotificationWaiter waiter(GetWebContents(), ui::kAXModeComplete,
ax::mojom::Event::kEndOfTest);
GetManager()->SignalEndOfTest();
ASSERT_TRUE(waiter.WaitForNotification());
}
void DumpAccessibilityTestBase::PerformAndWaitForDefaultActions() {
// Only perform actions the first call, as they are only allowed once per
// test, e.g. only perform the action once if this is script is executed
// multiple times.
if (has_performed_default_actions_)
return;
has_performed_default_actions_ = true;
// Perform default action on any elements specified by the test.
for (const auto& str : scenario_.default_action_on) {
// TODO(accessibility) Consider waiting for kEndOfTest instead (but change
// the name to something more like kAccessibilityClean).
AccessibilityNotificationWaiter waiter(
GetWebContents(), ui::kAXModeComplete, ax::mojom::Event::kClicked);
BrowserAccessibility* action_element;
// TODO(accessibility) base/strings/string_split.h might be cleaner here.
size_t parent_node_delimiter_index = str.find(",");
if (parent_node_delimiter_index != std::string::npos) {
auto node_name = str.substr(0, parent_node_delimiter_index);
auto parent_node_name = str.substr(parent_node_delimiter_index + 1);
BrowserAccessibility* parent_node = FindNode(parent_node_name);
DCHECK(parent_node) << "Parent node name provided but not found";
action_element = FindNode(node_name, parent_node);
} else {
action_element = FindNode(str);
}
ui::AXActionData action_data;
action_data.action = ax::mojom::Action::kDoDefault;
action_element->AccessibilityPerformAction(action_data);
ASSERT_TRUE(waiter.WaitForNotification());
}
}
void DumpAccessibilityTestBase::WaitForExpectedText() {
// If the original page has a @WAIT-FOR directive, don't break until
// the text we're waiting for appears in the full text dump of the
// accessibility tree, either.
for (;;) {
VLOG(1) << "Top of WaitForExpectedText() loop";
// Check to see if the @WAIT-FOR text has appeared yet.
bool all_wait_for_strings_found = true;
std::string tree_dump = DumpUnfilteredAccessibilityTreeAsString();
for (const auto& str : scenario_.wait_for) {
if (tree_dump.find(str) == std::string::npos) {
VLOG(1) << "Still waiting on this text to be found: " << str;
all_wait_for_strings_found = false;
break;
}
}
// If the @WAIT-FOR text has appeared, we're done.
if (all_wait_for_strings_found)
break;
// Block until the next accessibility notification in any frame.
VLOG(1) << "Waiting until the next accessibility event";
AccessibilityNotificationWaiter accessibility_waiter(
GetWebContents(), ui::kAXModeComplete, ax::mojom::Event::kNone);
ASSERT_TRUE(accessibility_waiter.WaitForNotification());
}
}
void DumpAccessibilityTestBase::WaitForFinalTreeContents() {
// If @DEFAULT-ACTION-ON:[name] is used, perform the action and wait until it
// is complete.
PerformAndWaitForDefaultActions();
// Wait for expected text from @WAIT-FOR.
WaitForExpectedText();
// Wait until all accessibility events and dirty objects have been processed.
WaitForEndOfTest();
}
void DumpAccessibilityTestBase::RunTestForPlatform(
const base::FilePath file_path,
const char* file_dir,
const base::FilePath::StringType& expectations_qualifier) {
// Disable the "hot tracked" state (set when the mouse is hovering over
// an object) because it makes test output change based on the mouse position.
BrowserAccessibilityStateImpl::GetInstance()
->set_disable_hot_tracking_for_testing(true);
// Normally some accessibility events that would be fired are suppressed or
// delayed, depending on what has focus or the type of event. For testing,
// we want all events to fire immediately to make tests predictable and not
// flaky.
BrowserAccessibilityManager::NeverSuppressOrDelayEventsForTesting();
// Enable the behavior whereby all focused nodes will be exposed to the
// platform accessibility layer. This behavior is currently disabled in
// production code, but is enabled in tests so that it could be tested
// thoroughly before it is turned on for all code.
// TODO(nektar): Turn this on in a followup patch.
// ui::AXTree::SetFocusedNodeShouldNeverBeIgnored();
EXPECT_TRUE(NavigateToURL(shell(), GURL(url::kAboutBlankURL)));
absl::optional<ui::AXInspectScenario> scenario =
test_helper_.ParseScenario(file_path, DefaultFilters());
if (!scenario) {
ADD_FAILURE()
<< "Failed to process a testing file. The file might not exist: "
<< file_path.LossyDisplayName();
return;
}
scenario_ = std::move(*scenario);
absl::optional<std::vector<std::string>> expected_lines;
// Get expectation lines from expectation file if any.
base::FilePath expected_file =
test_helper_.GetExpectationFilePath(file_path, expectations_qualifier);
if (!expected_file.empty())
expected_lines = test_helper_.LoadExpectationFile(expected_file);
// Get the test URL.
GURL url(embedded_test_server()->GetURL(
"a.test",
"/" + std::string(file_dir) + "/" + file_path.BaseName().MaybeAsASCII()));
WebContentsImpl* web_contents = GetWebContents();
if (enable_accessibility_after_navigating_ &&
web_contents->GetAccessibilityMode().is_mode_off()) {
// Load the url, then enable accessibility.
EXPECT_TRUE(NavigateToURL(shell(), url));
AccessibilityNotificationWaiter accessibility_waiter(
web_contents, ui::kAXModeComplete, ax::mojom::Event::kNone);
ASSERT_TRUE(accessibility_waiter.WaitForNotification());
} else {
// Enable accessibility, then load the test html and wait for the
// "load complete" AX event.
AccessibilityNotificationWaiter accessibility_waiter(
web_contents, ui::kAXModeComplete, ax::mojom::Event::kLoadComplete);
EXPECT_TRUE(NavigateToURL(shell(), url));
// TODO(https://crbug.com/1332468): Investigate why this does not return
// true.
ASSERT_TRUE(accessibility_waiter.WaitForNotification());
}
WaitForAllFramesLoaded();
// Call the subclass to dump the output.
std::vector<std::string> actual_lines = Dump();
// Execute and wait for specified string
for (const auto& function_name : scenario_.execute) {
DLOG(INFO) << "executing: " << function_name;
base::Value result = ExecuteScriptAndGetValue(
web_contents->GetPrimaryMainFrame(), function_name);
const std::string& str = result.is_string() ? result.GetString() : "";
// If no string is specified, do not wait.
bool wait_for_string = str != "";
while (wait_for_string) {
// Loop until specified string is found.
std::string tree_dump = DumpUnfilteredAccessibilityTreeAsString();
if (tree_dump.find(str) != std::string::npos) {
wait_for_string = false;
// Append an additional dump if the specified string was found.
std::vector<std::string> additional_dump = Dump();
actual_lines.emplace_back("=== Start Continuation ===");
actual_lines.insert(actual_lines.end(), additional_dump.begin(),
additional_dump.end());
break;
}
// Block until the next accessibility notification in any frame.
VLOG(1) << "Still waiting on this text to be found: " << str;
VLOG(1) << "Waiting until the next accessibility event";
// TODO(aleventhal) Try waiting for kEndOfTest to make sure all events
// after code execution are captured.
AccessibilityNotificationWaiter accessibility_waiter(
web_contents, ui::AXMode(), ax::mojom::Event::kNone);
ASSERT_TRUE(accessibility_waiter.WaitForNotification());
}
}
// No expected lines indicate the test is marked to skip the expectations
// checks or it has no expectation file. If we reach this point, then it means
// no crashes during the test run and we can consider the test as succeeding.
if (!expected_lines) {
EXPECT_TRUE(true);
return;
}
// Validate against the expectation file.
bool matches_expectation = test_helper_.ValidateAgainstExpectation(
file_path, expected_file, actual_lines, *expected_lines);
EXPECT_TRUE(matches_expectation);
if (!matches_expectation)
OnDiffFailed();
}
std::map<std::string, unsigned> DumpAccessibilityTestBase::CollectAllFrameUrls(
const std::vector<std::string>& skip_urls) {
std::map<std::string, unsigned> all_frame_urls;
// Get the url of every frame in the frame tree.
for (FrameTreeNode* node : GetWebContents()->GetPrimaryFrameTree().Nodes()) {
// Ignore about:blank urls because of the case where a parent frame A
// has a child iframe B and it writes to the document using
// contentDocument.open() on the child frame B.
//
// In this scenario, B's contentWindow.location.href matches A's url,
// but B's url in the browser frame tree is still "about:blank".
//
// We also ignore frame tree nodes created for portals in the outer
// WebContents as the node doesn't have a url set.
std::string url = node->current_url().spec();
// sometimes we expect a url to never load, in these cases, don't wait.
bool skip_url = false;
for (std::string no_load_url : skip_urls) {
if (url.find(no_load_url) != std::string::npos) {
skip_url = true;
break;
}
}
if (!skip_url && url != url::kAboutBlankURL && !url.empty() &&
node->frame_owner_element_type() !=
blink::FrameOwnerElementType::kPortal) {
all_frame_urls[url] += 1;
}
}
return all_frame_urls;
}
void DumpAccessibilityTestBase::WaitForAllFramesLoaded() {
// Wait for the accessibility tree to fully load for all frames,
// by searching for the WEB_AREA node in the accessibility tree
// with the url of each frame in our frame tree. If all frames
// haven't loaded yet, set up a listener for accessibility events
// on any frame and block until the next one is received.
WebContentsImpl* web_contents = GetWebContents();
for (;;) {
VLOG(1) << "Top of WaitForAllFramesLoaded() loop";
RenderFrameHostImpl* main_frame =
static_cast<RenderFrameHostImpl*>(web_contents->GetPrimaryMainFrame());
BrowserAccessibilityManager* manager =
main_frame->browser_accessibility_manager();
if (manager) {
BrowserAccessibility* accessibility_root =
manager->GetBrowserAccessibilityRoot();
// Check to see if all frames have loaded. If not, we invoke
// WaitForEndOfTest to listen for a kEndOfTest signal which will be
// fired for each loaded child tree.
if (!AccessibilityTreeContainsAllChildTrees(
*accessibility_root->node())) {
WaitForEndOfTest();
continue;
}
bool all_frames_loaded = true;
// A test may change the url for a frame, for example by setting
// window.location.href, so collect the current list of urls.
const std::map<std::string, unsigned> all_frame_urls =
CollectAllFrameUrls(scenario_.no_load_expected);
for (const auto& [url, num_expected] : all_frame_urls) {
if (unsigned num_remaining = SearchLoadedDocsWithUrlInAccessibilityTree(
accessibility_root, url, num_expected)) {
VLOG(1) << "Still waiting on " << num_remaining
<< " frame(s) to load: " << url;
all_frames_loaded = false;
break;
}
}
// If all frames have loaded, we're done.
if (all_frames_loaded)
break;
}
// Block until the next accessibility notification in any frame.
VLOG(1) << "Waiting until the next accessibility event";
AccessibilityNotificationWaiter accessibility_waiter(
web_contents, ui::kAXModeComplete, ax::mojom::Event::kNone);
ASSERT_TRUE(accessibility_waiter.WaitForNotification());
}
}
BrowserAccessibility* DumpAccessibilityTestBase::FindNode(
const std::string& name,
BrowserAccessibility* search_root) const {
if (!search_root)
search_root = GetManager()->GetBrowserAccessibilityRoot();
CHECK(search_root);
BrowserAccessibility* node = FindNodeInSubtree(*search_root, name);
return node;
}
BrowserAccessibilityManager* DumpAccessibilityTestBase::GetManager() const {
return GetWebContents()->GetRootBrowserAccessibilityManager();
}
WebContentsImpl* DumpAccessibilityTestBase::GetWebContents() const {
return static_cast<WebContentsImpl*>(shell()->web_contents());
}
std::unique_ptr<AXTreeFormatter> DumpAccessibilityTestBase::CreateFormatter()
const {
return AXInspectFactory::CreateFormatter(GetParam());
}
std::pair<base::Value, std::vector<std::string>>
DumpAccessibilityTestBase::CaptureEvents(InvokeAction invoke_action) {
// Create a new Event Recorder for the run.
BrowserAccessibilityManager* manager = GetManager();
ui::AXTreeSelector selector(manager->GetBrowserAccessibilityRoot()
->GetTargetForNativeAccessibilityEvent());
std::unique_ptr<ui::AXEventRecorder> event_recorder =
AXInspectFactory::CreateRecorder(GetParam(), manager,
base::GetCurrentProcId(), selector);
event_recorder->SetOnlyWebEvents(true);
event_recorder->ListenToEvents(base::BindRepeating(
&DumpAccessibilityTestBase::OnEventRecorded, base::Unretained(this)));
LOG(INFO) << "-------------- Start listening to events --------------";
// If @DEFAULT-ACTION-ON:[name] is used, perform the action and wait until
// it is complete.
PerformAndWaitForDefaultActions();
// Create a waiter that waits for any one accessibility event.
// This will ensure that after calling the go() function, we
// block until we've received an accessibility event generated as
// a result of this function.
AccessibilityNotificationWaiter waiter(GetWebContents(), ui::kAXModeComplete,
ax::mojom::Event::kNone);
// Run any script, e.g. go().
// If an action was performed, we already waited for the kClicked event in
// PerformAndWaitForDefaultActions(), which means the action is already
// completed.
base::Value action_result = std::move(invoke_action).Run();
// Wait for at least one event. This may unblock either when |waiter|
// observes either an ax::mojom::Event or ui::AXEventGenerator::Event, or
// when |event_recorder| records a platform event.
// TODO(https://crbug.com/1332468): Investigate why this does not return
// true.
EXPECT_TRUE(waiter.WaitForNotification());
// More than one accessibility event could have been generated.
// To make sure we've received all accessibility events, add a
// sentinel by calling SignalEndOfTest and waiting for a kEndOfTest
// event in response.
WaitForEndOfTest();
event_recorder->WaitForDoneRecording();
LOG(INFO) << "-------------- Stop listening to events --------------";
// Dump the event logs, running them through any filters specified
// in the HTML file.
std::vector<std::string> event_logs = event_recorder->GetEventLogs();
// Sort the logs so that results are predictable. There are too many
// nondeterministic things that affect the exact order of events fired,
// so these tests shouldn't be used to make assertions about event order.
std::sort(event_logs.begin(), event_logs.end());
return std::make_pair(std::move(action_result), std::move(event_logs));
}
BrowserAccessibility* DumpAccessibilityTestBase::FindNodeInSubtree(
BrowserAccessibility& node,
const std::string& name) const {
if (node.GetStringAttribute(ax::mojom::StringAttribute::kName) == name)
return &node;
for (unsigned int i = 0; i < node.PlatformChildCount(); ++i) {
BrowserAccessibility* result =
FindNodeInSubtree(*node.PlatformGetChild(i), name);
if (result)
return result;
}
return nullptr;
}
bool DumpAccessibilityTestBase::HasHtmlAttribute(
BrowserAccessibility& node,
const char* attr,
const std::string& value) const {
std::string result;
if (node.GetHtmlAttribute(attr, &result))
return result == value;
if (base::EqualsCaseInsensitiveASCII(attr, "class"))
return node.GetStringAttribute(ax::mojom::StringAttribute::kClassName) ==
value;
return false;
}
BrowserAccessibility* DumpAccessibilityTestBase::FindNodeByHTMLAttribute(
const char* attr,
const std::string& value) const {
BrowserAccessibility* root = GetManager()->GetBrowserAccessibilityRoot();
CHECK(root);
return FindNodeByHTMLAttributeInSubtree(*root, attr, value);
}
BrowserAccessibility*
DumpAccessibilityTestBase::FindNodeByHTMLAttributeInSubtree(
BrowserAccessibility& node,
const char* attr,
const std::string& value) const {
if (HasHtmlAttribute(node, attr, value))
return &node;
for (unsigned int i = 0; i < node.PlatformChildCount(); ++i) {
if (BrowserAccessibility* result = FindNodeByHTMLAttributeInSubtree(
*node.PlatformGetChild(i), attr, value))
return result;
}
return nullptr;
}
void DumpAccessibilityTestBase::UseHttpsTestServer() {
https_test_server_ = std::make_unique<net::EmbeddedTestServer>(
net::EmbeddedTestServer::TYPE_HTTPS);
https_test_server_.get()->AddDefaultHandlers(GetTestDataFilePath());
https_test_server_.get()->SetSSLConfig(
net::EmbeddedTestServer::CERT_TEST_NAMES);
}
} // namespace content