extensions/browser/api/declarative/rules_registry_unittest.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "extensions/browser/api/declarative/rules_registry.h"
   6
   7 #include <algorithm>
   8
   9 #include "base/message_loop/message_loop.h"
  10 #include "base/values.h"
  11 #include "content/public/test/test_browser_thread.h"
  12 #include "extensions/browser/api/declarative/rules_registry_service.h"
  13 #include "extensions/browser/api/declarative/test_rules_registry.h"
  14 #include "extensions/browser/api_test_utils.h"
  15 #include "extensions/common/extension.h"
  16 #include "extensions/common/extension_builder.h"
  17 #include "testing/gtest/include/gtest/gtest.h"
  18
  19 namespace {
  20 const char kExtensionId[] = "foobar";
  21 const char kRuleId[] = "foo";
  22 const int key = extensions::RulesRegistryService::kDefaultRulesRegistryID;
  23 }  // namespace
  24
  25 namespace extensions {
  26
  27 using api_test_utils::ParseDictionary;
  28
  29 TEST(RulesRegistryTest, FillOptionalIdentifiers) {
  30   base::MessageLoopForUI message_loop;
  31   content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
  32
  33   std::string error;
  34   scoped_refptr<RulesRegistry> registry =
  35       new TestRulesRegistry(content::BrowserThread::UI, "" /*event_name*/, key);
  36
  37   // Add rules and check that their identifiers are filled and unique.
  38
  39   std::vector<linked_ptr<api::events::Rule>> add_rules;
  40   add_rules.push_back(make_linked_ptr(new api::events::Rule));
  41   add_rules.push_back(make_linked_ptr(new api::events::Rule));
  42   error = registry->AddRules(kExtensionId, add_rules);
  43   EXPECT_TRUE(error.empty()) << error;
  44
  45   std::vector<linked_ptr<api::events::Rule>> get_rules;
  46   registry->GetAllRules(kExtensionId, &get_rules);
  47
  48   ASSERT_EQ(2u, get_rules.size());
  49
  50   ASSERT_TRUE(get_rules[0]->id.get());
  51   EXPECT_NE("", *get_rules[0]->id);
  52
  53   ASSERT_TRUE(get_rules[1]->id.get());
  54   EXPECT_NE("", *get_rules[1]->id);
  55
  56   EXPECT_NE(*get_rules[0]->id, *get_rules[1]->id);
  57
  58   EXPECT_EQ(1u /*extensions*/ + 2u /*rules*/,
  59             registry->GetNumberOfUsedRuleIdentifiersForTesting());
  60
  61   // Check that we cannot add a new rule with the same ID.
  62
  63   std::vector<linked_ptr<api::events::Rule>> add_rules_2;
  64   add_rules_2.push_back(make_linked_ptr(new api::events::Rule));
  65   add_rules_2[0]->id.reset(new std::string(*get_rules[0]->id));
  66   error = registry->AddRules(kExtensionId, add_rules_2);
  67   EXPECT_FALSE(error.empty());
  68
  69   std::vector<linked_ptr<api::events::Rule>> get_rules_2;
  70   registry->GetAllRules(kExtensionId, &get_rules_2);
  71   ASSERT_EQ(2u, get_rules_2.size());
  72   EXPECT_EQ(1u /*extensions*/ + 2u /*rules*/,
  73             registry->GetNumberOfUsedRuleIdentifiersForTesting());
  74
  75   // Check that we can register the old rule IDs once they were unregistered.
  76
  77   std::vector<std::string> remove_rules_3;
  78   remove_rules_3.push_back(*get_rules[0]->id);
  79   error = registry->RemoveRules(kExtensionId, remove_rules_3);
  80   EXPECT_TRUE(error.empty()) << error;
  81
  82   EXPECT_EQ(1u /*extensions*/ + 1u /*rules*/,
  83             registry->GetNumberOfUsedRuleIdentifiersForTesting());
  84
  85   std::vector<linked_ptr<api::events::Rule>> get_rules_3a;
  86   registry->GetAllRules(kExtensionId, &get_rules_3a);
  87   ASSERT_EQ(1u, get_rules_3a.size());
  88
  89   std::vector<linked_ptr<api::events::Rule>> add_rules_3;
  90   add_rules_3.push_back(make_linked_ptr(new api::events::Rule));
  91   add_rules_3[0]->id.reset(new std::string(*get_rules[0]->id));
  92   error = registry->AddRules(kExtensionId, add_rules_3);
  93   EXPECT_TRUE(error.empty()) << error;
  94   EXPECT_EQ(1u /*extensions*/ + 2u /*rules*/,
  95             registry->GetNumberOfUsedRuleIdentifiersForTesting());
  96
  97   std::vector<linked_ptr<api::events::Rule>> get_rules_3b;
  98   registry->GetAllRules(kExtensionId, &get_rules_3b);
  99   ASSERT_EQ(2u, get_rules_3b.size());
 100
 101   // Check that we can register a rule with an ID that is not modified.
 102
 103   error = registry->RemoveAllRules(kExtensionId);
 104   EXPECT_TRUE(error.empty()) << error;
 105   EXPECT_EQ(0u /*extensions*/ + 0u /*rules*/,
 106             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 107
 108   std::vector<linked_ptr<api::events::Rule>> get_rules_4a;
 109   registry->GetAllRules(kExtensionId, &get_rules_4a);
 110   ASSERT_TRUE(get_rules_4a.empty());
 111
 112   std::vector<linked_ptr<api::events::Rule>> add_rules_4;
 113   add_rules_4.push_back(make_linked_ptr(new api::events::Rule));
 114   add_rules_4[0]->id.reset(new std::string(kRuleId));
 115   error = registry->AddRules(kExtensionId, add_rules_4);
 116   EXPECT_TRUE(error.empty()) << error;
 117
 118   EXPECT_EQ(1u /*extensions*/ + 1u /*rules*/,
 119             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 120
 121   std::vector<linked_ptr<api::events::Rule>> get_rules_4b;
 122   registry->GetAllRules(kExtensionId, &get_rules_4b);
 123
 124   ASSERT_EQ(1u, get_rules_4b.size());
 125
 126   ASSERT_TRUE(get_rules_4b[0]->id.get());
 127   EXPECT_EQ(kRuleId, *get_rules_4b[0]->id);
 128
 129   // Create extension
 130   scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
 131       "{"
 132       "  \"name\": \"Test\","
 133       "  \"version\": \"1\""
 134       "}");
 135   scoped_refptr<Extension> extension = ExtensionBuilder()
 136                                            .SetManifest(manifest.Pass())
 137                                            .SetID(kExtensionId)
 138                                            .Build();
 139   registry->OnExtensionUninstalled(extension.get());
 140   EXPECT_EQ(0u /*extensions*/ + 0u /*rules*/,
 141             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 142
 143   // Make sure that deletion traits of registry are executed.
 144   registry = NULL;
 145   message_loop.RunUntilIdle();
 146 }
 147
 148 TEST(RulesRegistryTest, FillOptionalPriority) {
 149   base::MessageLoopForUI message_loop;
 150   content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
 151
 152   std::string error;
 153   scoped_refptr<RulesRegistry> registry =
 154       new TestRulesRegistry(content::BrowserThread::UI, "" /*event_name*/, key);
 155
 156   // Add rules and check that their priorities are filled if they are empty.
 157
 158   std::vector<linked_ptr<api::events::Rule>> add_rules;
 159   add_rules.push_back(make_linked_ptr(new api::events::Rule));
 160   add_rules[0]->priority.reset(new int(2));
 161   add_rules.push_back(make_linked_ptr(new api::events::Rule));
 162   error = registry->AddRules(kExtensionId, add_rules);
 163   EXPECT_TRUE(error.empty()) << error;
 164
 165   std::vector<linked_ptr<api::events::Rule>> get_rules;
 166   registry->GetAllRules(kExtensionId, &get_rules);
 167
 168   ASSERT_EQ(2u, get_rules.size());
 169
 170   ASSERT_TRUE(get_rules[0]->priority.get());
 171   ASSERT_TRUE(get_rules[1]->priority.get());
 172
 173   // Verify the precondition so that the following EXPECT_EQ statements work.
 174   EXPECT_GT(RulesRegistry::DEFAULT_PRIORITY, 2);
 175   EXPECT_EQ(2, std::min(*get_rules[0]->priority, *get_rules[1]->priority));
 176   EXPECT_EQ(RulesRegistry::DEFAULT_PRIORITY,
 177             std::max(*get_rules[0]->priority, *get_rules[1]->priority));
 178
 179   // Make sure that deletion traits of registry are executed.
 180   registry = NULL;
 181   message_loop.RunUntilIdle();
 182 }
 183
 184 // Test verifies 2 rules defined in the manifest appear in the registry.
 185 TEST(RulesRegistryTest, TwoRulesInManifest) {
 186   base::MessageLoopForUI message_loop;
 187   content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
 188
 189   // Create extension
 190   scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
 191       "{"
 192       "  \"name\": \"Test\","
 193       "  \"version\": \"1\","
 194       "  \"event_rules\": ["
 195       "    {"
 196       "      \"id\": \"000\","
 197       "      \"priority\": 200,"
 198       "      \"tags\": [\"tagged\"],"
 199       "      \"event\": \"declarativeContent.onPageChanged\","
 200       "      \"actions\": [{"
 201       "        \"type\": \"declarativeContent.ShowPageAction\""
 202       "      }],"
 203       "      \"conditions\" : [{"
 204       "        \"css\": [\"video\"],"
 205       "        \"type\" : \"declarativeContent.PageStateMatcher\""
 206       "      }]"
 207       "    },"
 208       "    {"
 209       "      \"event\": \"declarativeContent.onPageChanged\","
 210       "      \"actions\": [{"
 211       "        \"type\": \"declarativeContent.ShowPageAction\""
 212       "      }],"
 213       "      \"conditions\" : [{"
 214       "        \"css\": [\"input[type='password']\"],"
 215       "        \"type\" : \"declarativeContent.PageStateMatcher\""
 216       "      }]"
 217       "    }"
 218       "  ]"
 219       "}");
 220   scoped_refptr<Extension> extension = ExtensionBuilder()
 221                                            .SetManifest(manifest.Pass())
 222                                            .SetID(kExtensionId)
 223                                            .Build();
 224
 225   scoped_refptr<RulesRegistry> registry = new TestRulesRegistry(
 226       content::BrowserThread::UI, "declarativeContent.onPageChanged", key);
 227   // Simulate what RulesRegistryService would do on extension load.
 228   registry->OnExtensionLoaded(extension.get());
 229
 230   std::vector<linked_ptr<api::events::Rule>> get_rules;
 231   registry->GetAllRules(kExtensionId, &get_rules);
 232
 233   ASSERT_EQ(2u, get_rules.size());
 234   scoped_ptr<base::DictionaryValue> expected_rule_0 = ParseDictionary(
 235       "{"
 236       "  \"id\": \"000\","
 237       "  \"priority\": 200,"
 238       "  \"tags\": [\"tagged\"],"
 239       "  \"actions\": [{"
 240       "    \"instanceType\": \"declarativeContent.ShowPageAction\""
 241       "  }],"
 242       "  \"conditions\" : [{"
 243       "    \"css\": [\"video\"],"
 244       "    \"instanceType\" : \"declarativeContent.PageStateMatcher\""
 245       "  }]"
 246       "}");
 247   EXPECT_TRUE(expected_rule_0->Equals(get_rules[0]->ToValue().get()));
 248
 249   scoped_ptr<base::DictionaryValue> expected_rule_1 = ParseDictionary(
 250       "{"
 251       "  \"id\": \"_0_\","
 252       "  \"priority\": 100,"
 253       "  \"actions\": [{"
 254       "    \"instanceType\": \"declarativeContent.ShowPageAction\""
 255       "  }],"
 256       "  \"conditions\" : [{"
 257       "    \"css\": [\"input[type='password']\"],"
 258       "    \"instanceType\" : \"declarativeContent.PageStateMatcher\""
 259       "  }]"
 260       "}");
 261   EXPECT_TRUE(expected_rule_1->Equals(get_rules[1]->ToValue().get()));
 262 }
 263
 264 // Tests verifies that rules defined in the manifest cannot be deleted but
 265 // programmatically added rules still can be deleted.
 266 TEST(RulesRegistryTest, DeleteRuleInManifest) {
 267   base::MessageLoopForUI message_loop;
 268   content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
 269
 270   // Create extension
 271   scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
 272       "{"
 273       "  \"name\": \"Test\","
 274       "  \"version\": \"1\","
 275       "  \"event_rules\": [{"
 276       "    \"id\":  \"manifest_rule_0\","
 277       "    \"event\": \"declarativeContent.onPageChanged\","
 278       "    \"actions\": [{"
 279       "      \"type\": \"declarativeContent.ShowPageAction\""
 280       "    }],"
 281       "    \"conditions\" : [{"
 282       "      \"css\": [\"video\"],"
 283       "      \"type\" : \"declarativeContent.PageStateMatcher\""
 284       "    }]"
 285       "  }]"
 286       "}");
 287   scoped_refptr<Extension> extension = ExtensionBuilder()
 288                                            .SetManifest(manifest.Pass())
 289                                            .SetID(kExtensionId)
 290                                            .Build();
 291
 292   scoped_refptr<RulesRegistry> registry = new TestRulesRegistry(
 293       content::BrowserThread::UI, "declarativeContent.onPageChanged", key);
 294   // Simulate what RulesRegistryService would do on extension load.
 295   registry->OnExtensionLoaded(extension.get());
 296   // Add some extra rules outside of the manifest.
 297   std::vector<linked_ptr<api::events::Rule>> add_rules;
 298   linked_ptr<api::events::Rule> rule_1 = make_linked_ptr(new api::events::Rule);
 299   rule_1->id.reset(new std::string("rule_1"));
 300   linked_ptr<api::events::Rule> rule_2 = make_linked_ptr(new api::events::Rule);
 301   rule_2->id.reset(new std::string("rule_2"));
 302   add_rules.push_back(rule_1);
 303   add_rules.push_back(rule_2);
 304   registry->AddRules(kExtensionId, add_rules);
 305
 306   std::vector<linked_ptr<api::events::Rule>> get_rules;
 307   registry->GetAllRules(kExtensionId, &get_rules);
 308   ASSERT_EQ(3u, get_rules.size());
 309   EXPECT_EQ("manifest_rule_0", *(get_rules[0]->id));
 310   EXPECT_EQ("rule_1", *(get_rules[1]->id));
 311   EXPECT_EQ("rule_2", *(get_rules[2]->id));
 312
 313   // Remove a rule from outside the manifest.
 314   std::vector<std::string> remove_ids;
 315   remove_ids.push_back("rule_1");
 316   EXPECT_TRUE(registry->RemoveRules(kExtensionId, remove_ids).empty());
 317   get_rules.clear();
 318   registry->GetAllRules(kExtensionId, &get_rules);
 319   EXPECT_EQ(2u, get_rules.size());
 320   EXPECT_EQ("manifest_rule_0", *(get_rules[0]->id));
 321   EXPECT_EQ("rule_2", *(get_rules[1]->id));
 322
 323   // Attempt to remove rule in manifest.
 324   remove_ids.clear();
 325   remove_ids.push_back("manifest_rule_0");
 326   EXPECT_FALSE(registry->RemoveRules(kExtensionId, remove_ids).empty());
 327   get_rules.clear();
 328   registry->GetAllRules(kExtensionId, &get_rules);
 329   ASSERT_EQ(2u, get_rules.size());
 330   EXPECT_EQ("manifest_rule_0", *(get_rules[0]->id));
 331   EXPECT_EQ("rule_2", *(get_rules[1]->id));
 332
 333   // Remove all rules.
 334   registry->RemoveAllRules(kExtensionId);
 335   get_rules.clear();
 336   registry->GetAllRules(kExtensionId, &get_rules);
 337   ASSERT_EQ(1u, get_rules.size());
 338   EXPECT_EQ("manifest_rule_0", *(get_rules[0]->id));
 339 }
 340
 341 }  // namespace extensions