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 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/extensions/menu_manager.h"
#include <memory>
#include <utility>
#include <vector>
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/json/json_reader.h"
#include "base/run_loop.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/single_thread_task_runner.h"
#include "base/values.h"
#include "chrome/browser/extensions/extension_menu_icon_loader.h"
#include "chrome/browser/extensions/menu_manager_test_observer.h"
#include "chrome/browser/extensions/test_extension_menu_icon_loader.h"
#include "chrome/browser/extensions/test_extension_prefs.h"
#include "chrome/browser/extensions/test_extension_system.h"
#include "chrome/common/chrome_paths.h"
#include "chrome/common/extensions/api/context_menus.h"
#include "chrome/test/base/testing_profile.h"
#include "components/prefs/pref_service.h"
#include "components/sync_preferences/pref_service_syncable.h"
#include "content/public/browser/context_menu_params.h"
#include "content/public/test/browser_task_environment.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/event_router_factory.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_system.h"
#include "extensions/browser/state_store.h"
#include "extensions/browser/state_store_test_observer.h"
#include "extensions/browser/unloaded_extension_reason.h"
#include "extensions/common/extension.h"
#include "extensions/common/manifest_constants.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/mojom/context_menu/context_menu.mojom.h"
using testing::_;
using testing::AtLeast;
using testing::DeleteArg;
using testing::InSequence;
using testing::Return;
using testing::SaveArg;
namespace extensions {
namespace context_menus = api::context_menus;
// Base class for tests.
class MenuManagerTest : public testing::Test {
public:
MenuManagerTest()
: profile_(new TestingProfile()),
manager_(profile_.get(),
ExtensionSystem::Get(profile_.get())->state_store()),
prefs_(base::SingleThreadTaskRunner::GetCurrentDefault()),
next_id_(1) {}
MenuManagerTest(const MenuManagerTest&) = delete;
MenuManagerTest& operator=(const MenuManagerTest&) = delete;
void TearDown() override {
prefs_.pref_service()->CommitPendingWrite();
base::RunLoop().RunUntilIdle();
}
// Returns a test item.
std::unique_ptr<MenuItem> CreateTestItem(const Extension* extension,
bool incognito = false) {
MenuItem::Type type = MenuItem::NORMAL;
MenuItem::ContextList contexts(MenuItem::ALL);
const MenuItem::ExtensionKey key(extension->id());
MenuItem::Id id(incognito, key);
id.uid = next_id_++;
return std::make_unique<MenuItem>(id, "test", false, true, true, type,
contexts);
}
// Returns a test item with the given string ID.
std::unique_ptr<MenuItem> CreateTestItemWithID(const Extension* extension,
const std::string& string_id) {
MenuItem::Type type = MenuItem::NORMAL;
MenuItem::ContextList contexts(MenuItem::ALL);
const MenuItem::ExtensionKey key(extension->id());
MenuItem::Id id(false, key);
id.string_uid = string_id;
return std::make_unique<MenuItem>(id, "test", false, true, true, type,
contexts);
}
std::unique_ptr<MenuItem> CreateTestItemForWebView(
const Extension* extension,
int webview_embedder_process_id,
int webview_embedder_frame_id,
int webview_instance_id,
const std::string& string_id) {
MenuItem::Type type = MenuItem::NORMAL;
MenuItem::ContextList contexts(MenuItem::ALL);
std::string extension_id = extension ? extension->id() : "";
const MenuItem::ExtensionKey key(extension_id, webview_embedder_process_id,
webview_embedder_frame_id,
webview_instance_id);
MenuItem::Id id(false, key);
if (string_id.empty()) {
id.uid = next_id_++;
} else {
id.string_uid = string_id;
}
return std::make_unique<MenuItem>(id, "test", false, true, true, type,
contexts);
}
// Creates and returns a test Extension. The caller does *not* own the return
// value.
const Extension* AddExtension(const std::string& name) {
scoped_refptr<Extension> extension = prefs_.AddExtension(name);
extensions_.push_back(extension);
return extension.get();
}
protected:
content::BrowserTaskEnvironment task_environment_;
std::unique_ptr<TestingProfile> profile_;
MenuManager manager_;
ExtensionList extensions_;
TestExtensionPrefs prefs_;
int next_id_;
};
// Tests adding, getting, and removing items.
TEST_F(MenuManagerTest, AddGetRemoveItems) {
const Extension* extension = AddExtension("test");
// Add a new item, make sure you can get it back.
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension);
ASSERT_TRUE(item1 != nullptr);
MenuItem* item1_ptr = item1.get();
ASSERT_TRUE(manager_.AddContextItem(extension, std::move(item1)));
ASSERT_EQ(item1_ptr, manager_.GetItemById(item1_ptr->id()));
const MenuItem::OwnedList* items =
manager_.MenuItems(item1_ptr->id().extension_key);
ASSERT_EQ(1u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
// Add a second item, make sure it comes back too.
std::unique_ptr<MenuItem> item2 = CreateTestItemWithID(extension, "id2");
MenuItem* item2_ptr = item2.get();
ASSERT_TRUE(manager_.AddContextItem(extension, std::move(item2)));
ASSERT_EQ(item2_ptr, manager_.GetItemById(item2_ptr->id()));
items = manager_.MenuItems(item2_ptr->id().extension_key);
ASSERT_EQ(2u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
ASSERT_EQ(item2_ptr, items->at(1).get());
// Try adding item 3, then removing it.
std::unique_ptr<MenuItem> item3 = CreateTestItem(extension);
MenuItem* item3_ptr = item3.get();
MenuItem::Id id3 = item3_ptr->id();
const MenuItem::ExtensionKey extension_key3(item3_ptr->id().extension_key);
ASSERT_TRUE(manager_.AddContextItem(extension, std::move(item3)));
ASSERT_EQ(item3_ptr, manager_.GetItemById(id3));
ASSERT_EQ(3u, manager_.MenuItems(extension_key3)->size());
ASSERT_TRUE(manager_.RemoveContextMenuItem(id3));
ASSERT_EQ(nullptr, manager_.GetItemById(id3));
ASSERT_EQ(2u, manager_.MenuItems(extension_key3)->size());
// Make sure removing a non-existent item returns false.
const MenuItem::ExtensionKey key(extension->id());
MenuItem::Id id(false, key);
id.uid = id3.uid + 50;
ASSERT_FALSE(manager_.RemoveContextMenuItem(id));
// Make sure adding an item with the same string ID returns false.
std::unique_ptr<MenuItem> item2too = CreateTestItemWithID(extension, "id2");
ASSERT_FALSE(manager_.AddContextItem(extension, std::move(item2too)));
// But the same string ID should not collide with another extension.
const Extension* extension2 = AddExtension("test2");
std::unique_ptr<MenuItem> item2other =
CreateTestItemWithID(extension2, "id2");
ASSERT_TRUE(manager_.AddContextItem(extension2, std::move(item2other)));
}
TEST_F(MenuManagerTest, AddGetRemoveItemsNoExtension) {
static constexpr int kFakeWebViewEmbedderPid = 1;
static constexpr int kFakeWebViewEmbedderFrameId = 1;
static constexpr int kFakeWebViewInstanceId = 1;
// Add a new item, make sure you can get it back.
std::unique_ptr<MenuItem> item1 = CreateTestItemForWebView(
/*extension=*/nullptr, kFakeWebViewEmbedderPid,
kFakeWebViewEmbedderFrameId, kFakeWebViewInstanceId,
/*string_id=*/"");
ASSERT_TRUE(item1 != nullptr);
MenuItem* item1_ptr = item1.get();
// Without an extension, the default icon loader will try to dereference a
// null Extension*. Therefore, set the TestExtensionMenuIconLoader here to
// avoid this since it will do nothing if Extension* is null.
manager_.SetMenuIconLoader(item1_ptr->id().extension_key,
std::make_unique<TestExtensionMenuIconLoader>());
ASSERT_TRUE(manager_.AddContextItem(/*extension=*/nullptr, std::move(item1)));
ASSERT_EQ(item1_ptr, manager_.GetItemById(item1_ptr->id()));
const MenuItem::OwnedList* items =
manager_.MenuItems(item1_ptr->id().extension_key);
ASSERT_EQ(1u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
// Add a second item, make sure it comes back too.
std::unique_ptr<MenuItem> item2 = CreateTestItemForWebView(
/*extension=*/nullptr, kFakeWebViewEmbedderPid,
kFakeWebViewEmbedderFrameId, kFakeWebViewInstanceId,
/*string_id=*/"id2");
MenuItem* item2_ptr = item2.get();
ASSERT_TRUE(manager_.AddContextItem(/*extension=*/nullptr, std::move(item2)));
ASSERT_EQ(item2_ptr, manager_.GetItemById(item2_ptr->id()));
items = manager_.MenuItems(item2_ptr->id().extension_key);
ASSERT_EQ(2u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
ASSERT_EQ(item2_ptr, items->at(1).get());
// Try adding item 3, then removing it.
std::unique_ptr<MenuItem> item3 = CreateTestItemForWebView(
/*extension=*/nullptr, kFakeWebViewEmbedderPid,
kFakeWebViewEmbedderFrameId, kFakeWebViewInstanceId,
/*string_id=*/"");
MenuItem* item3_ptr = item3.get();
MenuItem::Id id3 = item3_ptr->id();
const MenuItem::ExtensionKey extension_key3(item3_ptr->id().extension_key);
ASSERT_TRUE(manager_.AddContextItem(/*extension=*/nullptr, std::move(item3)));
ASSERT_EQ(item3_ptr, manager_.GetItemById(id3));
ASSERT_EQ(3u, manager_.MenuItems(extension_key3)->size());
ASSERT_TRUE(manager_.RemoveContextMenuItem(id3));
ASSERT_EQ(nullptr, manager_.GetItemById(id3));
ASSERT_EQ(2u, manager_.MenuItems(extension_key3)->size());
item3_ptr = nullptr;
// Make sure removing a non-existent item returns false.
const MenuItem::ExtensionKey key(/*extension_id=*/"", kFakeWebViewEmbedderPid,
kFakeWebViewEmbedderFrameId,
kFakeWebViewInstanceId);
MenuItem::Id id(false, key);
id.uid = id3.uid + 50;
ASSERT_FALSE(manager_.RemoveContextMenuItem(id));
// Make sure adding an item with the same string ID returns false.
std::unique_ptr<MenuItem> item2too = CreateTestItemForWebView(
/*extension=*/nullptr, kFakeWebViewEmbedderPid,
kFakeWebViewEmbedderFrameId, kFakeWebViewInstanceId,
/*string_id=*/"id2");
ASSERT_FALSE(
manager_.AddContextItem(/*extension=*/nullptr, std::move(item2too)));
// But the same string ID should not collide with another WebView instance.
static constexpr int kFakeWebViewEmbedderPid2 = 2;
std::unique_ptr<MenuItem> item2other = CreateTestItemForWebView(
/*extension=*/nullptr, kFakeWebViewEmbedderPid2,
kFakeWebViewEmbedderFrameId, kFakeWebViewInstanceId,
/*string_id=*/"id2");
// Use TestExtensionMenuIconLoader to avoid a null Extension* dereference.
manager_.SetMenuIconLoader(item2other->id().extension_key,
std::make_unique<TestExtensionMenuIconLoader>());
ASSERT_TRUE(
manager_.AddContextItem(/*extension=*/nullptr, std::move(item2other)));
item1_ptr = nullptr;
item2_ptr = nullptr;
}
// Test adding/removing child items.
TEST_F(MenuManagerTest, ChildFunctions) {
const Extension* extension1 = AddExtension("1111");
const Extension* extension2 = AddExtension("2222");
const Extension* extension3 = AddExtension("3333");
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension1);
MenuItem* item1_ptr = item1.get();
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension2);
MenuItem* item2_ptr = item2.get();
std::unique_ptr<MenuItem> item2_child =
CreateTestItemWithID(extension2, "2child");
MenuItem* item2_child_ptr = item2_child.get();
std::unique_ptr<MenuItem> item2_grandchild = CreateTestItem(extension2);
std::unique_ptr<MenuItem> item3 = CreateTestItem(extension3);
// Add in the first two items.
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item1)));
ASSERT_TRUE(manager_.AddContextItem(extension2, std::move(item2)));
MenuItem::Id id1 = item1_ptr->id();
MenuItem::Id id2 = item2_ptr->id();
// Try adding item3 as a child of item2 - this should fail because item3 has
// a different extension id.
ASSERT_FALSE(manager_.AddChildItem(id2, std::move(item3)));
// Add item2_child as a child of item2.
MenuItem::Id id2_child = item2_child->id();
ASSERT_TRUE(manager_.AddChildItem(id2, std::move(item2_child)));
ASSERT_EQ(1u, item2_ptr->children().size());
ASSERT_EQ(0u, item1_ptr->children().size());
ASSERT_EQ(item2_child_ptr, manager_.GetItemById(id2_child));
ASSERT_EQ(1u, manager_.MenuItems(item1_ptr->id().extension_key)->size());
ASSERT_EQ(item1_ptr,
manager_.MenuItems(item1_ptr->id().extension_key)->at(0).get());
// Add item2_grandchild as a child of item2_child, then remove it.
MenuItem::Id id2_grandchild = item2_grandchild->id();
ASSERT_TRUE(manager_.AddChildItem(id2_child, std::move(item2_grandchild)));
ASSERT_EQ(1u, item2_ptr->children().size());
ASSERT_EQ(1u, item2_child_ptr->children().size());
ASSERT_TRUE(manager_.RemoveContextMenuItem(id2_grandchild));
// We should only get 1 thing back when asking for item2's extension id, since
// it has a child item.
ASSERT_EQ(1u, manager_.MenuItems(item2_ptr->id().extension_key)->size());
ASSERT_EQ(item2_ptr,
manager_.MenuItems(item2_ptr->id().extension_key)->at(0).get());
// Remove child2_item.
ASSERT_TRUE(manager_.RemoveContextMenuItem(id2_child));
ASSERT_EQ(1u, manager_.MenuItems(item2_ptr->id().extension_key)->size());
ASSERT_EQ(item2_ptr,
manager_.MenuItems(item2_ptr->id().extension_key)->at(0).get());
ASSERT_EQ(0u, item2_ptr->children().size());
}
TEST_F(MenuManagerTest, PopulateFromValue) {
const Extension* extension = AddExtension("test");
std::string error;
bool incognito = true;
int type = MenuItem::CHECKBOX;
std::string title("TITLE");
bool checked = true;
bool visible = true;
bool enabled = true;
MenuItem::ContextList contexts;
contexts.Add(MenuItem::PAGE);
contexts.Add(MenuItem::SELECTION);
int contexts_value = contexts.ToValue().GetInt();
base::Value::List document_url_patterns;
document_url_patterns.Append("http://www.google.com/*");
document_url_patterns.Append("http://www.reddit.com/*");
base::Value::List target_url_patterns;
target_url_patterns.Append("http://www.yahoo.com/*");
target_url_patterns.Append("http://www.facebook.com/*");
base::Value::Dict value;
value.Set("incognito", incognito);
value.Set("string_uid", std::string());
value.Set("type", type);
value.Set("title", title);
value.Set("checked", checked);
value.Set("visible", visible);
value.Set("enabled", enabled);
value.Set("contexts", contexts_value);
URLPatternSet document_url_pattern_set;
document_url_pattern_set.Populate(document_url_patterns,
URLPattern::SCHEME_ALL, true, &error);
value.Set("document_url_patterns", std::move(document_url_patterns));
URLPatternSet target_url_pattern_set;
target_url_pattern_set.Populate(target_url_patterns, URLPattern::SCHEME_ALL,
true, &error);
value.Set("target_url_patterns", std::move(target_url_patterns));
std::unique_ptr<MenuItem> item(
MenuItem::Populate(extension->id(), value, &error));
ASSERT_TRUE(item.get());
EXPECT_EQ(extension->id(), item->extension_id());
EXPECT_EQ(incognito, item->incognito());
EXPECT_EQ(title, item->title());
EXPECT_EQ(checked, item->checked());
EXPECT_EQ(item->checked(), item->checked());
EXPECT_EQ(visible, item->visible());
EXPECT_EQ(enabled, item->enabled());
EXPECT_EQ(contexts, item->contexts());
EXPECT_EQ(document_url_pattern_set, item->document_url_patterns());
EXPECT_EQ(target_url_pattern_set, item->target_url_patterns());
}
// Tests that deleting a parent properly removes descendants.
TEST_F(MenuManagerTest, DeleteParent) {
const Extension* extension = AddExtension("1111");
// Set up 5 items to add.
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension);
std::unique_ptr<MenuItem> item3 = CreateTestItemWithID(extension, "id3");
std::unique_ptr<MenuItem> item4 = CreateTestItemWithID(extension, "id4");
std::unique_ptr<MenuItem> item5 = CreateTestItem(extension);
std::unique_ptr<MenuItem> item6 = CreateTestItem(extension);
MenuItem* item1_ptr = item1.get();
MenuItem* item2_ptr = item2.get();
MenuItem* item3_ptr = item3.get();
MenuItem* item4_ptr = item4.get();
MenuItem* item5_ptr = item5.get();
MenuItem* item6_ptr = item6.get();
MenuItem::Id item1_id = item1->id();
MenuItem::Id item2_id = item2->id();
MenuItem::Id item3_id = item3->id();
MenuItem::Id item4_id = item4->id();
MenuItem::Id item5_id = item5->id();
MenuItem::Id item6_id = item6->id();
const MenuItem::ExtensionKey key(extension->id());
// Add the items in the hierarchy
// item1 -> item2 -> item3 -> item4 -> item5 -> item6.
ASSERT_TRUE(manager_.AddContextItem(extension, std::move(item1)));
ASSERT_TRUE(manager_.AddChildItem(item1_id, std::move(item2)));
ASSERT_TRUE(manager_.AddChildItem(item2_id, std::move(item3)));
ASSERT_TRUE(manager_.AddChildItem(item3_id, std::move(item4)));
ASSERT_TRUE(manager_.AddChildItem(item4_id, std::move(item5)));
ASSERT_TRUE(manager_.AddChildItem(item5_id, std::move(item6)));
ASSERT_EQ(item1_ptr, manager_.GetItemById(item1_id));
ASSERT_EQ(item2_ptr, manager_.GetItemById(item2_id));
ASSERT_EQ(item3_ptr, manager_.GetItemById(item3_id));
ASSERT_EQ(item4_ptr, manager_.GetItemById(item4_id));
ASSERT_EQ(item5_ptr, manager_.GetItemById(item5_id));
ASSERT_EQ(item6_ptr, manager_.GetItemById(item6_id));
ASSERT_EQ(1u, manager_.MenuItems(key)->size());
ASSERT_EQ(6u, manager_.items_by_id_.size());
// Remove item6 (a leaf node).
ASSERT_TRUE(manager_.RemoveContextMenuItem(item6_id));
ASSERT_EQ(item1_ptr, manager_.GetItemById(item1_id));
ASSERT_EQ(item2_ptr, manager_.GetItemById(item2_id));
ASSERT_EQ(item3_ptr, manager_.GetItemById(item3_id));
ASSERT_EQ(item4_ptr, manager_.GetItemById(item4_id));
ASSERT_EQ(item5_ptr, manager_.GetItemById(item5_id));
ASSERT_EQ(nullptr, manager_.GetItemById(item6_id));
ASSERT_EQ(1u, manager_.MenuItems(key)->size());
ASSERT_EQ(5u, manager_.items_by_id_.size());
// Remove item4 and make sure item5 is gone as well.
ASSERT_TRUE(manager_.RemoveContextMenuItem(item4_id));
ASSERT_EQ(item1_ptr, manager_.GetItemById(item1_id));
ASSERT_EQ(item2_ptr, manager_.GetItemById(item2_id));
ASSERT_EQ(item3_ptr, manager_.GetItemById(item3_id));
ASSERT_EQ(nullptr, manager_.GetItemById(item4_id));
ASSERT_EQ(nullptr, manager_.GetItemById(item5_id));
ASSERT_EQ(1u, manager_.MenuItems(key)->size());
ASSERT_EQ(3u, manager_.items_by_id_.size());
// Now remove item1 and make sure item2 and item3 are gone as well.
ASSERT_TRUE(manager_.RemoveContextMenuItem(item1_id));
ASSERT_EQ(nullptr, manager_.MenuItems(key));
ASSERT_EQ(0u, manager_.items_by_id_.size());
ASSERT_EQ(nullptr, manager_.GetItemById(item1_id));
ASSERT_EQ(nullptr, manager_.GetItemById(item2_id));
ASSERT_EQ(nullptr, manager_.GetItemById(item3_id));
}
// Tests changing parents.
TEST_F(MenuManagerTest, ChangeParent) {
const Extension* extension1 = AddExtension("1111");
// First create two items and add them both to the manager.
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension1);
MenuItem* item1_ptr = item1.get();
MenuItem* item2_ptr = item2.get();
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item1)));
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item2)));
const MenuItem::OwnedList* items =
manager_.MenuItems(item1_ptr->id().extension_key);
ASSERT_EQ(2u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
ASSERT_EQ(item2_ptr, items->at(1).get());
// Now create a third item, initially add it as a child of item1, then move
// it to be a child of item2.
std::unique_ptr<MenuItem> item3 = CreateTestItem(extension1);
MenuItem* item3_ptr = item3.get();
ASSERT_TRUE(manager_.AddChildItem(item1_ptr->id(), std::move(item3)));
ASSERT_EQ(1u, item1_ptr->children().size());
ASSERT_EQ(item3_ptr, item1_ptr->children()[0].get());
ASSERT_TRUE(manager_.ChangeParent(item3_ptr->id(), &item2_ptr->id()));
ASSERT_EQ(0u, item1_ptr->children().size());
ASSERT_EQ(1u, item2_ptr->children().size());
ASSERT_EQ(item3_ptr, item2_ptr->children()[0].get());
// Move item2 to be a child of item1.
ASSERT_TRUE(manager_.ChangeParent(item2_ptr->id(), &item1_ptr->id()));
ASSERT_EQ(1u, item1_ptr->children().size());
ASSERT_EQ(item2_ptr, item1_ptr->children()[0].get());
ASSERT_EQ(1u, item2_ptr->children().size());
ASSERT_EQ(item3_ptr, item2_ptr->children()[0].get());
// Since item2 was a top-level item but is no longer, we should only have 1
// top-level item.
items = manager_.MenuItems(item1_ptr->id().extension_key);
ASSERT_EQ(1u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
// Move item3 back to being a child of item1, so it's now a sibling of item2.
ASSERT_TRUE(manager_.ChangeParent(item3_ptr->id(), &item1_ptr->id()));
ASSERT_EQ(2u, item1_ptr->children().size());
ASSERT_EQ(item2_ptr, item1_ptr->children()[0].get());
ASSERT_EQ(item3_ptr, item1_ptr->children()[1].get());
// Try switching item3 to be the parent of item1 - this should fail.
ASSERT_FALSE(manager_.ChangeParent(item1_ptr->id(), &item3_ptr->id()));
ASSERT_EQ(0u, item3_ptr->children().size());
ASSERT_EQ(2u, item1_ptr->children().size());
ASSERT_EQ(item2_ptr, item1_ptr->children()[0].get());
ASSERT_EQ(item3_ptr, item1_ptr->children()[1].get());
items = manager_.MenuItems(item1_ptr->id().extension_key);
ASSERT_EQ(1u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
// Move item2 to be a top-level item.
ASSERT_TRUE(manager_.ChangeParent(item2_ptr->id(), nullptr));
items = manager_.MenuItems(item1_ptr->id().extension_key);
ASSERT_EQ(2u, items->size());
ASSERT_EQ(item1_ptr, items->at(0).get());
ASSERT_EQ(item2_ptr, items->at(1).get());
ASSERT_EQ(1u, item1_ptr->children().size());
ASSERT_EQ(item3_ptr, item1_ptr->children()[0].get());
// Make sure you can't move a node to be a child of another extension's item.
const Extension* extension2 = AddExtension("2222");
std::unique_ptr<MenuItem> item4 = CreateTestItem(extension2);
MenuItem* item4_ptr = item4.get();
ASSERT_TRUE(manager_.AddContextItem(extension2, std::move(item4)));
ASSERT_FALSE(manager_.ChangeParent(item4_ptr->id(), &item1_ptr->id()));
ASSERT_FALSE(manager_.ChangeParent(item1_ptr->id(), &item4_ptr->id()));
// Make sure you can't make an item be its own parent.
ASSERT_FALSE(manager_.ChangeParent(item1_ptr->id(), &item1_ptr->id()));
}
// Tests that we properly remove an extension's menu item when that extension is
// unloaded.
TEST_F(MenuManagerTest, ExtensionUnloadRemovesMenuItems) {
// Create a test extension.
const Extension* extension1 = AddExtension("1111");
// Create an MenuItem and put it into the manager.
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension1);
MenuItem* item1_ptr = item1.get();
MenuItem::Id id1 = item1->id();
ASSERT_EQ(extension1->id(), item1->extension_id());
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item1)));
ASSERT_EQ(
1u, manager_.MenuItems(MenuItem::ExtensionKey(extension1->id()))->size());
// Create a menu item with a different extension id and add it to the manager.
const Extension* extension2 = AddExtension("2222");
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension2);
MenuItem* item2_ptr = item2.get();
ASSERT_NE(item1_ptr->extension_id(), item2->extension_id());
ASSERT_TRUE(manager_.AddContextItem(extension2, std::move(item2)));
// Notify that the extension was unloaded, and make sure the right item is
// gone.
ExtensionRegistry* registry = ExtensionRegistry::Get(profile_.get());
registry->TriggerOnUnloaded(extension1, UnloadedExtensionReason::DISABLE);
ASSERT_EQ(nullptr,
manager_.MenuItems(MenuItem::ExtensionKey(extension1->id())));
ASSERT_EQ(
1u, manager_.MenuItems(MenuItem::ExtensionKey(extension2->id()))->size());
ASSERT_TRUE(manager_.GetItemById(id1) == nullptr);
ASSERT_TRUE(manager_.GetItemById(item2_ptr->id()) != nullptr);
}
namespace {
// A mock message service for tests of MenuManager::ExecuteCommand.
class MockEventRouter : public EventRouter {
public:
explicit MockEventRouter(Profile* profile) : EventRouter(profile, nullptr) {}
MockEventRouter(const MockEventRouter&) = delete;
MockEventRouter& operator=(const MockEventRouter&) = delete;
MOCK_METHOD6(DispatchEventToExtensionMock,
void(const std::string& extension_id,
const std::string& event_name,
base::Value::List* event_args,
content::BrowserContext* source_context,
const GURL& event_url,
EventRouter::UserGestureState state));
void DispatchEventToExtension(const std::string& extension_id,
std::unique_ptr<Event> event) override {
DispatchEventToExtensionMock(
extension_id, event->event_name,
new base::Value::List(std::move(event->event_args)),
event->restrict_to_browser_context, event->event_url,
event->user_gesture);
}
};
// MockEventRouter factory function
std::unique_ptr<KeyedService> MockEventRouterFactoryFunction(
content::BrowserContext* context) {
return std::make_unique<MockEventRouter>(static_cast<Profile*>(context));
}
} // namespace
// Tests the RemoveAll functionality.
TEST_F(MenuManagerTest, RemoveAll) {
// Try removing all items for an extension id that doesn't have any items.
manager_.RemoveAllContextItems(MenuItem::ExtensionKey("CCCC"));
// Add 2 top-level and one child item for extension 1.
const Extension* extension1 = AddExtension("1111");
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item3 = CreateTestItem(extension1);
MenuItem* item1_ptr = item1.get();
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item1)));
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item2)));
ASSERT_TRUE(manager_.AddChildItem(item1_ptr->id(), std::move(item3)));
// Add one top-level item for extension 2.
const Extension* extension2 = AddExtension("2222");
std::unique_ptr<MenuItem> item4 = CreateTestItem(extension2);
ASSERT_TRUE(manager_.AddContextItem(extension2, std::move(item4)));
const MenuItem::ExtensionKey key1(extension1->id());
const MenuItem::ExtensionKey key2(extension2->id());
EXPECT_EQ(2u, manager_.MenuItems(key1)->size());
EXPECT_EQ(1u, manager_.MenuItems(key2)->size());
// Remove extension2's item.
manager_.RemoveAllContextItems(key2);
EXPECT_EQ(2u, manager_.MenuItems(key1)->size());
EXPECT_EQ(nullptr, manager_.MenuItems(key2));
// Remove extension1's items.
manager_.RemoveAllContextItems(key1);
EXPECT_EQ(nullptr, manager_.MenuItems(key1));
}
// Tests that removing all items one-by-one doesn't leave an entry around.
TEST_F(MenuManagerTest, RemoveOneByOne) {
// Add 2 test items.
const Extension* extension1 = AddExtension("1111");
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item3 = CreateTestItemWithID(extension1, "id3");
MenuItem::Id item1_id = item1->id();
MenuItem::Id item2_id = item2->id();
MenuItem::Id item3_id = item3->id();
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item1)));
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item2)));
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item3)));
ASSERT_FALSE(manager_.context_items_.empty());
manager_.RemoveContextMenuItem(item3_id);
manager_.RemoveContextMenuItem(item1_id);
manager_.RemoveContextMenuItem(item2_id);
ASSERT_TRUE(manager_.context_items_.empty());
}
TEST_F(MenuManagerTest, ExecuteCommand) {
TestingProfile profile;
MockEventRouter* mock_event_router = static_cast<MockEventRouter*>(
EventRouterFactory::GetInstance()->SetTestingFactoryAndUse(
&profile, base::BindRepeating(&MockEventRouterFactoryFunction)));
content::ContextMenuParams params;
params.media_type = blink::mojom::ContextMenuDataMediaType::kImage;
params.src_url = GURL("http://foo.bar/image.png");
params.page_url = GURL("http://foo.bar");
params.selection_text = u"Hello World";
params.is_editable = false;
const Extension* extension = AddExtension("test");
ExtensionRegistry::Get(profile_.get())->AddEnabled(extension);
std::unique_ptr<MenuItem> parent = CreateTestItem(extension);
std::unique_ptr<MenuItem> item = CreateTestItem(extension);
MenuItem* item_ptr = item.get();
MenuItem::Id parent_id = parent->id();
MenuItem::Id id = item->id();
ASSERT_TRUE(manager_.AddContextItem(extension, std::move(parent)));
ASSERT_TRUE(manager_.AddChildItem(parent_id, std::move(item)));
// Use the magic of googlemock to save a parameter to our mock's
// DispatchEventToExtension method into event_args.
base::Value::List* list = nullptr;
{
InSequence s;
EXPECT_CALL(*mock_event_router,
DispatchEventToExtensionMock(
item_ptr->extension_id(), MenuManager::kOnContextMenus, _,
&profile, GURL(), EventRouter::UserGestureState::kEnabled))
.Times(1)
.WillOnce(SaveArg<2>(&list));
EXPECT_CALL(
*mock_event_router,
DispatchEventToExtensionMock(
item_ptr->extension_id(), context_menus::OnClicked::kEventName, _,
&profile, GURL(), EventRouter::UserGestureState::kEnabled))
.Times(1)
.WillOnce(DeleteArg<2>());
}
manager_.ExecuteCommand(&profile, nullptr /* web_contents */,
nullptr /* render_frame_host */, params, id);
ASSERT_EQ(2u, list->size());
const base::Value& info = (*list)[0];
ASSERT_TRUE(info.is_dict());
const base::Value::Dict& info_dict = info.GetDict();
ASSERT_EQ(id.uid, info_dict.FindInt("menuItemId"));
ASSERT_EQ(parent_id.uid, info_dict.FindInt("parentMenuItemId"));
const std::string* tmp = info_dict.FindString("mediaType");
ASSERT_TRUE(tmp);
ASSERT_EQ("image", *tmp);
tmp = info_dict.FindString("srcUrl");
ASSERT_TRUE(tmp);
ASSERT_EQ(params.src_url.spec(), *tmp);
tmp = info_dict.FindString("pageUrl");
ASSERT_TRUE(tmp);
ASSERT_EQ(params.page_url.spec(), *tmp);
tmp = info_dict.FindString("selectionText");
ASSERT_TRUE(tmp);
ASSERT_EQ(params.selection_text, base::UTF8ToUTF16(*tmp));
std::optional<bool> editable = info_dict.FindBool("editable");
ASSERT_TRUE(editable.has_value());
ASSERT_EQ(params.is_editable, editable.value());
delete list;
}
// Test that there is always only one radio item selected.
TEST_F(MenuManagerTest, SanitizeRadioButtons) {
const Extension* extension = AddExtension("test");
// A single unchecked item should get checked.
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension);
MenuItem* item1_ptr = item1.get();
item1_ptr->set_type(MenuItem::RADIO);
item1_ptr->SetChecked(false);
ASSERT_FALSE(item1_ptr->checked());
manager_.AddContextItem(extension, std::move(item1));
ASSERT_TRUE(item1_ptr->checked());
// In a run of two unchecked items, the first should get selected.
item1_ptr->SetChecked(false);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension);
MenuItem* item2_ptr = item2.get();
item2_ptr->set_type(MenuItem::RADIO);
item2_ptr->SetChecked(false);
ASSERT_FALSE(item1_ptr->checked());
ASSERT_FALSE(item2_ptr->checked());
manager_.AddContextItem(extension, std::move(item2));
ASSERT_TRUE(item1_ptr->checked());
ASSERT_FALSE(item2_ptr->checked());
// If multiple items are checked and one of the items is updated to be
// checked, then all other items should be unchecked.
//
// Note, this case of multiple checked items (i.e. SetChecked() called more
// than once) followed by a call to ItemUpdated() would never happen in
// practice. In this hypothetical scenario, the item that was updated the
// latest via ItemUpdated() should remain checked.
//
// Begin with two items checked.
item1_ptr->SetChecked(true);
item2_ptr->SetChecked(true);
ASSERT_TRUE(item1_ptr->checked());
ASSERT_TRUE(item2_ptr->checked());
// Updating item1 to be checked should result in item2 being unchecked.
manager_.ItemUpdated(item1_ptr->id());
// Item 1 should be selected as it was updated the latest.
ASSERT_TRUE(item1_ptr->checked());
ASSERT_FALSE(item2_ptr->checked());
// If the checked item is removed, the new first item should get checked.
item1_ptr->SetChecked(false);
item2_ptr->SetChecked(true);
ASSERT_FALSE(item1_ptr->checked());
ASSERT_TRUE(item2_ptr->checked());
manager_.RemoveContextMenuItem(item2_ptr->id());
item2_ptr = nullptr;
ASSERT_TRUE(item1_ptr->checked());
// If a checked item is added to a run that already has a checked item,
// then the new item should get checked.
item1_ptr->SetChecked(true);
std::unique_ptr<MenuItem> new_item = CreateTestItem(extension);
MenuItem* new_item_ptr = new_item.get();
new_item_ptr->set_type(MenuItem::RADIO);
new_item_ptr->SetChecked(true);
ASSERT_TRUE(item1_ptr->checked());
ASSERT_TRUE(new_item_ptr->checked());
manager_.AddContextItem(extension, std::move(new_item));
ASSERT_FALSE(item1_ptr->checked());
ASSERT_TRUE(new_item_ptr->checked());
// Make sure that children are checked as well.
std::unique_ptr<MenuItem> parent = CreateTestItem(extension);
MenuItem* parent_ptr = parent.get();
manager_.AddContextItem(extension, std::move(parent));
std::unique_ptr<MenuItem> child1 = CreateTestItem(extension);
MenuItem* child1_ptr = child1.get();
child1_ptr->set_type(MenuItem::RADIO);
child1_ptr->SetChecked(false);
std::unique_ptr<MenuItem> child2 = CreateTestItem(extension);
MenuItem* child2_ptr = child2.get();
child2_ptr->set_type(MenuItem::RADIO);
child2_ptr->SetChecked(true);
ASSERT_FALSE(child1_ptr->checked());
ASSERT_TRUE(child2_ptr->checked());
manager_.AddChildItem(parent_ptr->id(), std::move(child1));
ASSERT_TRUE(child1_ptr->checked());
manager_.AddChildItem(parent_ptr->id(), std::move(child2));
ASSERT_FALSE(child1_ptr->checked());
ASSERT_TRUE(child2_ptr->checked());
// Removing the checked item from the children should cause the
// remaining child to be checked.
manager_.RemoveContextMenuItem(child2_ptr->id());
child2_ptr = nullptr;
ASSERT_TRUE(child1_ptr->checked());
// This should NOT cause |new_item| to be deselected because
// |parent| will be separating the two runs of radio items.
manager_.ChangeParent(child1_ptr->id(), nullptr);
ASSERT_TRUE(new_item_ptr->checked());
ASSERT_TRUE(child1_ptr->checked());
// Removing |parent| should cause only |child1| to be selected.
manager_.RemoveContextMenuItem(parent_ptr->id());
parent_ptr = nullptr;
ASSERT_FALSE(new_item_ptr->checked());
ASSERT_TRUE(child1_ptr->checked());
}
// If a context menu has multiple radio lists, then they should all be properly
// sanitized. More specifically, on initialization of the context menu, the
// first item of each list should be checked.
TEST_F(MenuManagerTest, SanitizeContextMenuWithMultipleRadioLists) {
const Extension* extension = AddExtension("test");
// Create a radio list with two radio buttons.
// Create first radio button.
std::unique_ptr<MenuItem> radio1 = CreateTestItem(extension);
MenuItem* radio1_ptr = radio1.get();
radio1_ptr->set_type(MenuItem::RADIO);
manager_.AddContextItem(extension, std::move(radio1));
// Create second radio button.
std::unique_ptr<MenuItem> radio2 = CreateTestItem(extension);
MenuItem* radio2_ptr = radio2.get();
radio2_ptr->set_type(MenuItem::RADIO);
manager_.AddContextItem(extension, std::move(radio2));
// Ensure that in the first radio list, only radio1 is checked.
ASSERT_TRUE(radio1_ptr->checked());
ASSERT_FALSE(radio2_ptr->checked());
// Add a normal item to separate the first radio list from the second radio
// list to created next.
std::unique_ptr<MenuItem> normal_item1 = CreateTestItem(extension);
normal_item1->set_type(MenuItem::NORMAL);
manager_.AddContextItem(extension, std::move(normal_item1));
// Create another radio list of two radio items.
// Create first radio button.
std::unique_ptr<MenuItem> radio3 = CreateTestItem(extension);
MenuItem* radio3_ptr = radio3.get();
radio3_ptr->set_type(MenuItem::RADIO);
manager_.AddContextItem(extension, std::move(radio3));
// Create second radio button.
std::unique_ptr<MenuItem> radio4 = CreateTestItem(extension);
MenuItem* radio4_ptr = radio4.get();
radio4_ptr->set_type(MenuItem::RADIO);
manager_.AddContextItem(extension, std::move(radio4));
// Ensure that in the second radio list, only radio3 is checked.
ASSERT_TRUE(radio3_ptr->checked());
ASSERT_FALSE(radio4_ptr->checked());
}
// Tests the RemoveAllIncognitoContextItems functionality.
TEST_F(MenuManagerTest, RemoveAllIncognito) {
const Extension* extension1 = AddExtension("1111");
// Add 2 top-level and one child item for extension 1
// with incognito 'true'.
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension1, true);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension1, true);
std::unique_ptr<MenuItem> item3 = CreateTestItem(extension1, true);
MenuItem::Id item1_id = item1->id();
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item1)));
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item2)));
ASSERT_TRUE(manager_.AddChildItem(item1_id, std::move(item3)));
// Add 2 top-level and one child item for extension 1
// with incognito 'false'.
std::unique_ptr<MenuItem> item4 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item5 = CreateTestItem(extension1);
std::unique_ptr<MenuItem> item6 = CreateTestItem(extension1);
MenuItem::Id item4_id = item4->id();
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item4)));
ASSERT_TRUE(manager_.AddContextItem(extension1, std::move(item5)));
ASSERT_TRUE(manager_.AddChildItem(item4_id, std::move(item6)));
// Add one top-level item for extension 2.
const Extension* extension2 = AddExtension("2222");
std::unique_ptr<MenuItem> item7 = CreateTestItem(extension2);
ASSERT_TRUE(manager_.AddContextItem(extension2, std::move(item7)));
const MenuItem::ExtensionKey key1(extension1->id());
const MenuItem::ExtensionKey key2(extension2->id());
EXPECT_EQ(4u, manager_.MenuItems(key1)->size());
EXPECT_EQ(1u, manager_.MenuItems(key2)->size());
// Remove all context menu items with incognito true.
manager_.RemoveAllIncognitoContextItems();
EXPECT_EQ(2u, manager_.MenuItems(key1)->size());
EXPECT_EQ(1u, manager_.MenuItems(key2)->size());
}
TEST_F(MenuManagerTest, SetMenuIconLoader) {
const Extension* extension = AddExtension("test");
MenuItem::ExtensionKey extension_key(extension->id());
auto menu_icon_loader = std::make_unique<TestExtensionMenuIconLoader>();
TestExtensionMenuIconLoader* extension_menu_icon_loader =
menu_icon_loader.get();
manager_.SetMenuIconLoader(extension_key, std::move(menu_icon_loader));
// Ensure that adding and removing the context menu item calls LoadIcon and
// RemoveIcon on TestExtensionMenuIconLoader.
{
std::unique_ptr<MenuItem> item = CreateTestItem(extension);
const MenuItem::Id& item_id = item->id();
manager_.AddContextItem(extension, std::move(item));
EXPECT_EQ(1, extension_menu_icon_loader->load_icon_calls());
manager_.RemoveContextMenuItem(item_id);
EXPECT_EQ(1, extension_menu_icon_loader->remove_icon_calls());
}
extension_menu_icon_loader->Reset();
// Ensure that adding two context menu items for the same extension only
// calls LoadIcon once and removing all context menu items calls RemoveIcon
// once.
{
std::unique_ptr<MenuItem> item1 = CreateTestItem(extension);
std::unique_ptr<MenuItem> item2 = CreateTestItem(extension);
manager_.AddContextItem(extension, std::move(item1));
manager_.AddContextItem(extension, std::move(item2));
EXPECT_EQ(1, extension_menu_icon_loader->load_icon_calls());
manager_.RemoveAllContextItems(extension_key);
EXPECT_EQ(1, extension_menu_icon_loader->remove_icon_calls());
}
}
// TODO(crbug.com/40732755): This should be unified with the existing
// version of this enum in ExtensionBrowserTest.
enum class ContextType {
// A non-persistent background page/JS based extension.
kEventPage,
// A Service Worker based extension.
kServiceWorker,
// An extension with a persistent background page.
kPersistentBackground,
};
class MenuManagerStorageTest : public MenuManagerTest,
public testing::WithParamInterface<ContextType> {
protected:
scoped_refptr<const Extension> AddEventPageExtension(
const std::string& name) {
base::Value::Dict dictionary;
TestExtensionPrefs::AddDefaultManifestKeys(name, dictionary);
base::Value::List value;
value.Append("background.js");
dictionary.SetByDottedPath(manifest_keys::kBackgroundScripts,
std::move(value));
dictionary.SetByDottedPath(manifest_keys::kBackgroundPersistent, false);
return prefs_.AddExtensionWithManifest(dictionary,
mojom::ManifestLocation::kInternal);
}
scoped_refptr<const Extension> AddServiceWorkerExtension(
const std::string& name) {
base::Value::Dict dictionary;
TestExtensionPrefs::AddDefaultManifestKeys(name, dictionary);
dictionary.SetByDottedPath(manifest_keys::kBackgroundServiceWorkerScript,
"background.js");
return prefs_.AddExtensionWithManifest(dictionary,
mojom::ManifestLocation::kInternal);
}
scoped_refptr<const Extension> CreateTestExtension() {
static constexpr char kName[] = "1111";
switch (GetParam()) {
case ContextType::kPersistentBackground:
return AddExtension(kName);
case ContextType::kEventPage:
return AddEventPageExtension(kName);
case ContextType::kServiceWorker:
return AddServiceWorkerExtension(kName);
}
}
bool IsPersistent() const {
return GetParam() == ContextType::kPersistentBackground;
}
void FlushStateStore() {
StateStore* state_store =
ExtensionSystem::Get(profile_.get())->state_store();
base::RunLoop run_loop;
state_store->FlushForTesting(run_loop.QuitWhenIdleClosure());
run_loop.Run();
}
};
INSTANTIATE_TEST_SUITE_P(PersistentBackground,
MenuManagerStorageTest,
::testing::Values(ContextType::kPersistentBackground));
INSTANTIATE_TEST_SUITE_P(EventPage,
MenuManagerStorageTest,
::testing::Values(ContextType::kEventPage));
INSTANTIATE_TEST_SUITE_P(ServiceWorker,
MenuManagerStorageTest,
::testing::Values(ContextType::kServiceWorker));
// Tests writing menus to and reading them from storage. Menus for
// persistent background page-based extensions are not written to or
// read from storage.
TEST_P(MenuManagerStorageTest, WriteToAndReadFromStorage) {
// Observe reads and writes from storage for the MenuManager.
MenuManagerTestObserver observer(&manager_);
// Observe writes to storage for the StateStore. Only for
// non-persistent background pages.
StateStoreTestObserver ss_observer(profile_.get());
scoped_refptr<const Extension> extension = CreateTestExtension();
ASSERT_TRUE(extension);
ExtensionRegistry::Get(profile_.get())->AddEnabled(extension);
const MenuItem::ExtensionKey extension_key(extension->id());
// Add 2 top-level and one child item for the extension.
std::unique_ptr<MenuItem> item1 =
CreateTestItemWithID(extension.get(), "id1");
std::unique_ptr<MenuItem> item2 =
CreateTestItemWithID(extension.get(), "id2");
std::unique_ptr<MenuItem> item3 =
CreateTestItemWithID(extension.get(), "id3");
MenuItem::Id item1_id = item1->id();
MenuItem::Id item2_id = item2->id();
MenuItem::Id item3_id = item3->id();
ASSERT_TRUE(manager_.AddContextItem(extension.get(), std::move(item1)));
ASSERT_TRUE(manager_.AddContextItem(extension.get(), std::move(item2)));
ASSERT_TRUE(manager_.AddChildItem(item1_id, std::move(item3)));
// Verify that a write did or did not occur. For the non-persistent
// cases, remove the menus so we can test that they are properly
// restored from storage.
manager_.WriteToStorage(extension.get(), extension_key);
if (IsPersistent()) {
EXPECT_FALSE(observer.will_write_for_extension(extension->id()));
} else {
ss_observer.WaitForExtensionAndKey(extension->id(), "context_menus");
EXPECT_TRUE(observer.will_write_for_extension(extension->id()));
manager_.RemoveAllContextItems(extension_key);
EXPECT_FALSE(manager_.GetItemById(item1_id));
EXPECT_FALSE(manager_.GetItemById(item2_id));
EXPECT_FALSE(manager_.GetItemById(item3_id));
}
// Call MenuManager::OnExtensionLoaded(), which is where
// MenuManager::ReadFromStorage() is called, then flush the
// pending tasks in the StateStore. After that, we can check
// if a read occurred.
manager_.OnExtensionLoaded(profile_.get(), extension.get());
FlushStateStore();
if (IsPersistent()) {
EXPECT_FALSE(observer.did_read_for_extension(extension->id()));
} else {
EXPECT_TRUE(observer.did_read_for_extension(extension->id()));
}
// Expect the items to exist, either because we never cleared them
// or because they were reloaded from the store.
EXPECT_TRUE(manager_.GetItemById(item1_id));
EXPECT_TRUE(manager_.GetItemById(item2_id));
EXPECT_TRUE(manager_.GetItemById(item3_id));
}
} // namespace extensions
|