blob: 78765beaa0721cea5b530fb961eebd078f1bdb59 [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 "ui/accessibility/ax_tree.h"
#include <stddef.h>
#include <stdint.h>
#include <memory>
#include "base/strings/string_number_conversions.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/accessibility/ax_node.h"
#include "ui/accessibility/ax_serializable_tree.h"
#include "ui/accessibility/ax_tree_serializer.h"
namespace ui {
namespace {
class FakeAXTreeDelegate : public AXTreeDelegate {
public:
FakeAXTreeDelegate()
: tree_data_changed_(false),
root_changed_(false) {}
void OnNodeDataWillChange(AXTree* tree,
const AXNodeData& old_node_data,
const AXNodeData& new_node_data) override {}
void OnTreeDataChanged(AXTree* tree) override {
tree_data_changed_ = true;
}
void OnNodeWillBeDeleted(AXTree* tree, AXNode* node) override {
deleted_ids_.push_back(node->id());
}
void OnSubtreeWillBeDeleted(AXTree* tree, AXNode* node) override {
subtree_deleted_ids_.push_back(node->id());
}
void OnNodeWillBeReparented(AXTree* tree, AXNode* node) override {}
void OnSubtreeWillBeReparented(AXTree* tree, AXNode* node) override {}
void OnNodeCreated(AXTree* tree, AXNode* node) override {
created_ids_.push_back(node->id());
}
void OnNodeReparented(AXTree* tree, AXNode* node) override {}
void OnNodeChanged(AXTree* tree, AXNode* node) override {
changed_ids_.push_back(node->id());
}
void OnAtomicUpdateFinished(AXTree* tree,
bool root_changed,
const std::vector<Change>& changes) override {
root_changed_ = root_changed;
for (size_t i = 0; i < changes.size(); ++i) {
int id = changes[i].node->id();
switch (changes[i].type) {
case NODE_CREATED:
node_creation_finished_ids_.push_back(id);
break;
case SUBTREE_CREATED:
subtree_creation_finished_ids_.push_back(id);
break;
case NODE_REPARENTED:
node_reparented_finished_ids_.push_back(id);
break;
case SUBTREE_REPARENTED:
subtree_reparented_finished_ids_.push_back(id);
break;
case NODE_CHANGED:
change_finished_ids_.push_back(id);
break;
}
}
}
bool tree_data_changed() const { return tree_data_changed_; }
bool root_changed() const { return root_changed_; }
const std::vector<int32_t>& deleted_ids() { return deleted_ids_; }
const std::vector<int32_t>& subtree_deleted_ids() {
return subtree_deleted_ids_;
}
const std::vector<int32_t>& created_ids() { return created_ids_; }
const std::vector<int32_t>& node_creation_finished_ids() {
return node_creation_finished_ids_;
}
const std::vector<int32_t>& subtree_creation_finished_ids() {
return subtree_creation_finished_ids_;
}
const std::vector<int32_t>& node_reparented_finished_ids() {
return node_reparented_finished_ids_;
}
const std::vector<int32_t>& subtree_reparented_finished_ids() {
return subtree_reparented_finished_ids_;
}
const std::vector<int32_t>& change_finished_ids() {
return change_finished_ids_;
}
private:
bool tree_data_changed_;
bool root_changed_;
std::vector<int32_t> deleted_ids_;
std::vector<int32_t> subtree_deleted_ids_;
std::vector<int32_t> created_ids_;
std::vector<int32_t> changed_ids_;
std::vector<int32_t> node_creation_finished_ids_;
std::vector<int32_t> subtree_creation_finished_ids_;
std::vector<int32_t> node_reparented_finished_ids_;
std::vector<int32_t> subtree_reparented_finished_ids_;
std::vector<int32_t> change_finished_ids_;
};
} // namespace
TEST(AXTreeTest, SerializeSimpleAXTree) {
AXNodeData root;
root.id = 1;
root.role = AX_ROLE_DIALOG;
root.state = 1 << AX_STATE_FOCUSABLE;
root.location = gfx::RectF(0, 0, 800, 600);
root.child_ids.push_back(2);
root.child_ids.push_back(3);
AXNodeData button;
button.id = 2;
button.role = AX_ROLE_BUTTON;
button.state = 0;
button.location = gfx::RectF(20, 20, 200, 30);
AXNodeData checkbox;
checkbox.id = 3;
checkbox.role = AX_ROLE_CHECK_BOX;
checkbox.state = 0;
checkbox.location = gfx::RectF(20, 50, 200, 30);
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.push_back(root);
initial_state.nodes.push_back(button);
initial_state.nodes.push_back(checkbox);
initial_state.has_tree_data = true;
initial_state.tree_data.title = "Title";
AXSerializableTree src_tree(initial_state);
std::unique_ptr<AXTreeSource<const AXNode*, AXNodeData, AXTreeData>>
tree_source(src_tree.CreateTreeSource());
AXTreeSerializer<const AXNode*, AXNodeData, AXTreeData> serializer(
tree_source.get());
AXTreeUpdate update;
serializer.SerializeChanges(src_tree.root(), &update);
AXTree dst_tree;
ASSERT_TRUE(dst_tree.Unserialize(update));
const AXNode* root_node = dst_tree.root();
ASSERT_TRUE(root_node != NULL);
EXPECT_EQ(root.id, root_node->id());
EXPECT_EQ(root.role, root_node->data().role);
ASSERT_EQ(2, root_node->child_count());
const AXNode* button_node = root_node->ChildAtIndex(0);
EXPECT_EQ(button.id, button_node->id());
EXPECT_EQ(button.role, button_node->data().role);
const AXNode* checkbox_node = root_node->ChildAtIndex(1);
EXPECT_EQ(checkbox.id, checkbox_node->id());
EXPECT_EQ(checkbox.role, checkbox_node->data().role);
EXPECT_EQ(
"AXTree title=Title\n"
"id=1 dialog FOCUSABLE (0, 0)-(800, 600) child_ids=2,3\n"
" id=2 button (20, 20)-(200, 30)\n"
" id=3 checkBox (20, 50)-(200, 30)\n",
dst_tree.ToString());
}
TEST(AXTreeTest, SerializeAXTreeUpdate) {
AXNodeData list;
list.id = 3;
list.role = AX_ROLE_LIST;
list.state = 0;
list.child_ids.push_back(4);
list.child_ids.push_back(5);
list.child_ids.push_back(6);
AXNodeData list_item_2;
list_item_2.id = 5;
list_item_2.role = AX_ROLE_LIST_ITEM;
list_item_2.state = 0;
AXNodeData list_item_3;
list_item_3.id = 6;
list_item_3.role = AX_ROLE_LIST_ITEM;
list_item_3.state = 0;
AXNodeData button;
button.id = 7;
button.role = AX_ROLE_BUTTON;
button.state = 0;
AXTreeUpdate update;
update.root_id = 3;
update.nodes.push_back(list);
update.nodes.push_back(list_item_2);
update.nodes.push_back(list_item_3);
update.nodes.push_back(button);
EXPECT_EQ(
"AXTreeUpdate: root id 3\n"
"id=3 list (0, 0)-(0, 0) child_ids=4,5,6\n"
" id=5 listItem (0, 0)-(0, 0)\n"
" id=6 listItem (0, 0)-(0, 0)\n"
"id=7 button (0, 0)-(0, 0)\n",
update.ToString());
}
TEST(AXTreeTest, DeleteUnknownSubtreeFails) {
AXNodeData root;
root.id = 1;
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.push_back(root);
AXTree tree(initial_state);
// This should fail because we're asking it to delete
// a subtree rooted at id=2, which doesn't exist.
AXTreeUpdate update;
update.node_id_to_clear = 2;
update.nodes.resize(1);
update.nodes[0].id = 1;
EXPECT_FALSE(tree.Unserialize(update));
ASSERT_EQ("Bad node_id_to_clear: 2", tree.error());
}
TEST(AXTreeTest, LeaveOrphanedDeletedSubtreeFails) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(3);
initial_state.nodes[0].id = 1;
initial_state.nodes[0].child_ids.push_back(2);
initial_state.nodes[0].child_ids.push_back(3);
initial_state.nodes[1].id = 2;
initial_state.nodes[2].id = 3;
AXTree tree(initial_state);
// This should fail because we delete a subtree rooted at id=2
// but never update it.
AXTreeUpdate update;
update.node_id_to_clear = 2;
update.nodes.resize(1);
update.nodes[0].id = 3;
EXPECT_FALSE(tree.Unserialize(update));
ASSERT_EQ("Nodes left pending by the update: 2", tree.error());
}
TEST(AXTreeTest, LeaveOrphanedNewChildFails) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(1);
initial_state.nodes[0].id = 1;
AXTree tree(initial_state);
// This should fail because we add a new child to the root node
// but never update it.
AXTreeUpdate update;
update.nodes.resize(1);
update.nodes[0].id = 1;
update.nodes[0].child_ids.push_back(2);
EXPECT_FALSE(tree.Unserialize(update));
ASSERT_EQ("Nodes left pending by the update: 2", tree.error());
}
TEST(AXTreeTest, DuplicateChildIdFails) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(1);
initial_state.nodes[0].id = 1;
AXTree tree(initial_state);
// This should fail because a child id appears twice.
AXTreeUpdate update;
update.nodes.resize(2);
update.nodes[0].id = 1;
update.nodes[0].child_ids.push_back(2);
update.nodes[0].child_ids.push_back(2);
update.nodes[1].id = 2;
EXPECT_FALSE(tree.Unserialize(update));
ASSERT_EQ("Node 1 has duplicate child id 2", tree.error());
}
TEST(AXTreeTest, InvalidReparentingFails) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(3);
initial_state.nodes[0].id = 1;
initial_state.nodes[0].child_ids.push_back(2);
initial_state.nodes[1].id = 2;
initial_state.nodes[1].child_ids.push_back(3);
initial_state.nodes[2].id = 3;
AXTree tree(initial_state);
// This should fail because node 3 is reparented from node 2 to node 1
// without deleting node 1's subtree first.
AXTreeUpdate update;
update.nodes.resize(3);
update.nodes[0].id = 1;
update.nodes[0].child_ids.push_back(3);
update.nodes[0].child_ids.push_back(2);
update.nodes[1].id = 2;
update.nodes[2].id = 3;
EXPECT_FALSE(tree.Unserialize(update));
ASSERT_EQ("Node 3 reparented from 2 to 1", tree.error());
}
TEST(AXTreeTest, TreeDelegateIsCalled) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(2);
initial_state.nodes[0].id = 1;
initial_state.nodes[0].child_ids.push_back(2);
initial_state.nodes[1].id = 2;
AXTree tree(initial_state);
AXTreeUpdate update;
update.node_id_to_clear = 1;
update.root_id = 3;
update.nodes.resize(2);
update.nodes[0].id = 3;
update.nodes[0].child_ids.push_back(4);
update.nodes[1].id = 4;
FakeAXTreeDelegate fake_delegate;
tree.SetDelegate(&fake_delegate);
EXPECT_TRUE(tree.Unserialize(update));
ASSERT_EQ(2U, fake_delegate.deleted_ids().size());
EXPECT_EQ(1, fake_delegate.deleted_ids()[0]);
EXPECT_EQ(2, fake_delegate.deleted_ids()[1]);
ASSERT_EQ(1U, fake_delegate.subtree_deleted_ids().size());
EXPECT_EQ(1, fake_delegate.subtree_deleted_ids()[0]);
ASSERT_EQ(2U, fake_delegate.created_ids().size());
EXPECT_EQ(3, fake_delegate.created_ids()[0]);
EXPECT_EQ(4, fake_delegate.created_ids()[1]);
ASSERT_EQ(1U, fake_delegate.subtree_creation_finished_ids().size());
EXPECT_EQ(3, fake_delegate.subtree_creation_finished_ids()[0]);
ASSERT_EQ(1U, fake_delegate.node_creation_finished_ids().size());
EXPECT_EQ(4, fake_delegate.node_creation_finished_ids()[0]);
ASSERT_EQ(true, fake_delegate.root_changed());
tree.SetDelegate(NULL);
}
TEST(AXTreeTest, TreeDelegateIsCalledForTreeDataChanges) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(1);
initial_state.nodes[0].id = 1;
initial_state.has_tree_data = true;
initial_state.tree_data.title = "Initial";
AXTree tree(initial_state);
FakeAXTreeDelegate fake_delegate;
tree.SetDelegate(&fake_delegate);
// An empty update shouldn't change tree data.
AXTreeUpdate empty_update;
EXPECT_TRUE(tree.Unserialize(empty_update));
EXPECT_FALSE(fake_delegate.tree_data_changed());
EXPECT_EQ("Initial", tree.data().title);
// An update with tree data shouldn't change tree data if
// |has_tree_data| isn't set.
AXTreeUpdate ignored_tree_data_update;
ignored_tree_data_update.tree_data.title = "Ignore Me";
EXPECT_TRUE(tree.Unserialize(ignored_tree_data_update));
EXPECT_FALSE(fake_delegate.tree_data_changed());
EXPECT_EQ("Initial", tree.data().title);
// An update with |has_tree_data| set should update the tree data.
AXTreeUpdate tree_data_update;
tree_data_update.has_tree_data = true;
tree_data_update.tree_data.title = "New Title";
EXPECT_TRUE(tree.Unserialize(tree_data_update));
EXPECT_TRUE(fake_delegate.tree_data_changed());
EXPECT_EQ("New Title", tree.data().title);
tree.SetDelegate(NULL);
}
TEST(AXTreeTest, ReparentingDoesNotTriggerNodeCreated) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(3);
initial_state.nodes[0].id = 1;
initial_state.nodes[0].child_ids.push_back(2);
initial_state.nodes[1].id = 2;
initial_state.nodes[1].child_ids.push_back(3);
initial_state.nodes[2].id = 3;
FakeAXTreeDelegate fake_delegate;
AXTree tree(initial_state);
tree.SetDelegate(&fake_delegate);
AXTreeUpdate update;
update.nodes.resize(2);
update.node_id_to_clear = 2;
update.root_id = 1;
update.nodes[0].id = 1;
update.nodes[0].child_ids.push_back(3);
update.nodes[1].id = 3;
EXPECT_TRUE(tree.Unserialize(update)) << tree.error();
std::vector<int> created = fake_delegate.node_creation_finished_ids();
std::vector<int> subtree_reparented =
fake_delegate.subtree_reparented_finished_ids();
std::vector<int> node_reparented =
fake_delegate.node_reparented_finished_ids();
ASSERT_EQ(std::find(created.begin(), created.end(), 3), created.end());
ASSERT_NE(std::find(subtree_reparented.begin(), subtree_reparented.end(), 3),
subtree_reparented.end());
ASSERT_EQ(std::find(node_reparented.begin(), node_reparented.end(), 3),
node_reparented.end());
}
TEST(AXTreeTest, TreeDelegateIsNotCalledForReparenting) {
AXTreeUpdate initial_state;
initial_state.root_id = 1;
initial_state.nodes.resize(2);
initial_state.nodes[0].id = 1;
initial_state.nodes[0].child_ids.push_back(2);
initial_state.nodes[1].id = 2;
AXTree tree(initial_state);
AXTreeUpdate update;
update.node_id_to_clear = 1;
update.root_id = 2;
update.nodes.resize(2);
update.nodes[0].id = 2;
update.nodes[0].child_ids.push_back(4);
update.nodes[1].id = 4;
FakeAXTreeDelegate fake_delegate;
tree.SetDelegate(&fake_delegate);
EXPECT_TRUE(tree.Unserialize(update));
ASSERT_EQ(1U, fake_delegate.deleted_ids().size());
EXPECT_EQ(1, fake_delegate.deleted_ids()[0]);
ASSERT_EQ(1U, fake_delegate.subtree_deleted_ids().size());
EXPECT_EQ(1, fake_delegate.subtree_deleted_ids()[0]);
ASSERT_EQ(1U, fake_delegate.created_ids().size());
EXPECT_EQ(4, fake_delegate.created_ids()[0]);
ASSERT_EQ(0U, fake_delegate.subtree_creation_finished_ids().size());
ASSERT_EQ(1U, fake_delegate.node_creation_finished_ids().size());
EXPECT_EQ(4, fake_delegate.node_creation_finished_ids()[0]);
ASSERT_EQ(true, fake_delegate.root_changed());
tree.SetDelegate(NULL);
}
} // namespace ui