Create a mechanism define declarative rules via the extension manifest.

extensions/browser/api/declarative/rules_registry_unittest.cc

 // 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 "extensions/browser/api/declarative/rules_registry.h"
 
 #include <algorithm>
 
 #include "base/message_loop/message_loop.h"
+#include "base/values.h"
 #include "content/public/test/test_browser_thread.h"
 #include "extensions/browser/api/declarative/rules_registry_service.h"
 #include "extensions/browser/api/declarative/test_rules_registry.h"
+#include "extensions/browser/api_test_utils.h"
+#include "extensions/common/extension.h"
+#include "extensions/common/extension_builder.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 const char kExtensionId[] = "foobar";
 const char kRuleId[] = "foo";
 const int key = extensions::RulesRegistryService::kDefaultRulesRegistryID;
 }  // namespace
 
 namespace extensions {
 
+using api_test_utils::ParseDictionary;
+
 TEST(RulesRegistryTest, FillOptionalIdentifiers) {
   base::MessageLoopForUI message_loop;
   content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
 
   std::string error;
   scoped_refptr<RulesRegistry> registry =
       new TestRulesRegistry(content::BrowserThread::UI, "" /*event_name*/, key);
 
   // Add rules and check that their identifiers are filled and unique.
 
   std::vector<linked_ptr<RulesRegistry::Rule> > add_rules;
   add_rules.push_back(make_linked_ptr(new RulesRegistry::Rule));
   add_rules.push_back(make_linked_ptr(new RulesRegistry::Rule));
-  error = registry->AddRules(kExtensionId, add_rules);
+  error = registry->AddRules(kExtensionId, add_rules, false);
   EXPECT_TRUE(error.empty()) << error;
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules;
   registry->GetAllRules(kExtensionId, &get_rules);
 
   ASSERT_EQ(2u, get_rules.size());
 
   ASSERT_TRUE(get_rules[0]->id.get());
   EXPECT_NE("", *get_rules[0]->id);
 
   ASSERT_TRUE(get_rules[1]->id.get());
   EXPECT_NE("", *get_rules[1]->id);
 
   EXPECT_NE(*get_rules[0]->id, *get_rules[1]->id);
 
   EXPECT_EQ(1u /*extensions*/ + 2u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   // Check that we cannot add a new rule with the same ID.
 
   std::vector<linked_ptr<RulesRegistry::Rule> > add_rules_2;
   add_rules_2.push_back(make_linked_ptr(new RulesRegistry::Rule));
   add_rules_2[0]->id.reset(new std::string(*get_rules[0]->id));
-  error = registry->AddRules(kExtensionId, add_rules_2);
+  error = registry->AddRules(kExtensionId, add_rules_2, false);
   EXPECT_FALSE(error.empty());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules_2;
   registry->GetAllRules(kExtensionId, &get_rules_2);
   ASSERT_EQ(2u, get_rules_2.size());
   EXPECT_EQ(1u /*extensions*/ + 2u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   // Check that we can register the old rule IDs once they were unregistered.
 
   std::vector<std::string> remove_rules_3;
   remove_rules_3.push_back(*get_rules[0]->id);
   error = registry->RemoveRules(kExtensionId, remove_rules_3);
   EXPECT_TRUE(error.empty()) << error;
 
   EXPECT_EQ(1u /*extensions*/ + 1u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules_3a;
   registry->GetAllRules(kExtensionId, &get_rules_3a);
   ASSERT_EQ(1u, get_rules_3a.size());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > add_rules_3;
   add_rules_3.push_back(make_linked_ptr(new RulesRegistry::Rule));
   add_rules_3[0]->id.reset(new std::string(*get_rules[0]->id));
-  error = registry->AddRules(kExtensionId, add_rules_3);
+  error = registry->AddRules(kExtensionId, add_rules_3, false);
   EXPECT_TRUE(error.empty()) << error;
   EXPECT_EQ(1u /*extensions*/ + 2u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules_3b;
   registry->GetAllRules(kExtensionId, &get_rules_3b);
   ASSERT_EQ(2u, get_rules_3b.size());
 
   // Check that we can register a rule with an ID that is not modified.
 
   error = registry->RemoveAllRules(kExtensionId);
   EXPECT_TRUE(error.empty()) << error;
   EXPECT_EQ(0u /*extensions*/ + 0u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules_4a;
   registry->GetAllRules(kExtensionId, &get_rules_4a);
   ASSERT_TRUE(get_rules_4a.empty());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > add_rules_4;
   add_rules_4.push_back(make_linked_ptr(new RulesRegistry::Rule));
   add_rules_4[0]->id.reset(new std::string(kRuleId));
-  error = registry->AddRules(kExtensionId, add_rules_4);
+  error = registry->AddRules(kExtensionId, add_rules_4, false);
   EXPECT_TRUE(error.empty()) << error;
 
   EXPECT_EQ(1u /*extensions*/ + 1u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules_4b;
   registry->GetAllRules(kExtensionId, &get_rules_4b);
 
   ASSERT_EQ(1u, get_rules_4b.size());
 
   ASSERT_TRUE(get_rules_4b[0]->id.get());
   EXPECT_EQ(kRuleId, *get_rules_4b[0]->id);
 
-  registry->OnExtensionUninstalled(kExtensionId);
+  // Create extension
+  scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
+      "{"
+      "  \"name\": \"Test\","
+      "  \"version\": \"1\""
+      "}");
+  scoped_refptr<Extension> extension = ExtensionBuilder()
+                                           .SetManifest(manifest.Pass())
+                                           .SetID(kExtensionId)
+                                           .Build();
+  registry->OnExtensionUninstalled(extension.get());
   EXPECT_EQ(0u /*extensions*/ + 0u /*rules*/,
             registry->GetNumberOfUsedRuleIdentifiersForTesting());
 
   // Make sure that deletion traits of registry are executed.
   registry = NULL;
   message_loop.RunUntilIdle();
 }
 
 TEST(RulesRegistryTest, FillOptionalPriority) {
   base::MessageLoopForUI message_loop;
   content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
 
   std::string error;
   scoped_refptr<RulesRegistry> registry =
       new TestRulesRegistry(content::BrowserThread::UI, "" /*event_name*/, key);
 
   // Add rules and check that their priorities are filled if they are empty.
 
   std::vector<linked_ptr<RulesRegistry::Rule> > add_rules;
   add_rules.push_back(make_linked_ptr(new RulesRegistry::Rule));
   add_rules[0]->priority.reset(new int(2));
   add_rules.push_back(make_linked_ptr(new RulesRegistry::Rule));
-  error = registry->AddRules(kExtensionId, add_rules);
+  error = registry->AddRules(kExtensionId, add_rules, false);
   EXPECT_TRUE(error.empty()) << error;
 
   std::vector<linked_ptr<RulesRegistry::Rule> > get_rules;
   registry->GetAllRules(kExtensionId, &get_rules);
 
   ASSERT_EQ(2u, get_rules.size());
 
   ASSERT_TRUE(get_rules[0]->priority.get());
   ASSERT_TRUE(get_rules[1]->priority.get());
 
   // Verify the precondition so that the following EXPECT_EQ statements work.
   EXPECT_GT(RulesRegistry::DEFAULT_PRIORITY, 2);
   EXPECT_EQ(2, std::min(*get_rules[0]->priority, *get_rules[1]->priority));
   EXPECT_EQ(RulesRegistry::DEFAULT_PRIORITY,
             std::max(*get_rules[0]->priority, *get_rules[1]->priority));
 
   // Make sure that deletion traits of registry are executed.
   registry = NULL;
   message_loop.RunUntilIdle();
 }
 
+// Test verifies 2 rules defined in the manifest appear in the registry.
+TEST(RulesRegistryTest, TwoRulesInManifest) {
+  base::MessageLoopForUI message_loop;
+  content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
+
+  // Create extension
+  scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
+      "{"
+      "  \"name\": \"Test\","
+      "  \"version\": \"1\","
+      "  \"event_rules\": ["
+      "    {"
+      "      \"event\": \"declarativeContent.onPageChanged\","
+      "      \"actions\": [{"
+      "        \"type\": \"declarativeContent.ShowPageAction\""
+      "      }],"
+      "      \"conditions\" : [{"
+      "        \"css\": [\"video\"],"
+      "        \"type\" : \"declarativeContent.PageStateMatcher\""
+      "      }]"
+      "    },"
+      "    {"
+      "      \"event\": \"declarativeContent.onPageChanged\","
+      "      \"actions\": [{"
+      "        \"type\": \"declarativeContent.ShowPageAction\""
+      "      }],"
+      "      \"conditions\" : [{"
+      "        \"css\": [\"input[type='password']\"],"
+      "        \"type\" : \"declarativeContent.PageStateMatcher\""
+      "      }]"

[not at google - send to devlin, 2015/06/05 16:16:14]

It would be worth also setting an ID and tags on one of these to make sure those
get propagated, too.

[danduong, 2015/06/05 21:35:07]

Done.

+      "    }"
+      "  ]"
+      "}");
+  scoped_refptr<Extension> extension = ExtensionBuilder()
+                                           .SetManifest(manifest.Pass())
+                                           .SetID(kExtensionId)
+                                           .Build();
+
+  scoped_refptr<RulesRegistry> registry = new TestRulesRegistry(
+      content::BrowserThread::UI, "declarativeContent.onPageChanged", key);
+  // Simulate what RulesRegistryService would do on extension load.
+  registry->OnExtensionLoaded(extension.get());
+
+  std::vector<linked_ptr<RulesRegistry::Rule>> get_rules;
+  registry->GetAllRules(kExtensionId, &get_rules);
+
+  ASSERT_EQ(2u, get_rules.size());
+  scoped_ptr<base::DictionaryValue> expected_rule_0 = ParseDictionary(
+      "{"
+      "  \"id\": \"_0_\","
+      "  \"priority\": 100,"
+      "  \"actions\": [{"
+      "    \"instanceType\": \"declarativeContent.ShowPageAction\""
+      "  }],"
+      "  \"conditions\" : [{"
+      "    \"css\": [\"video\"],"
+      "    \"instanceType\" : \"declarativeContent.PageStateMatcher\""
+      "  }]"
+      "}");
+  EXPECT_TRUE(expected_rule_0->Equals(get_rules[0]->ToValue().get()));
+
+  scoped_ptr<base::DictionaryValue> expected_rule_1 = ParseDictionary(
+      "{"
+      "  \"id\": \"_1_\","
+      "  \"priority\": 100,"
+      "  \"actions\": [{"
+      "    \"instanceType\": \"declarativeContent.ShowPageAction\""
+      "  }],"
+      "  \"conditions\" : [{"
+      "    \"css\": [\"input[type='password']\"],"
+      "    \"instanceType\" : \"declarativeContent.PageStateMatcher\""
+      "  }]"
+      "}");
+  EXPECT_TRUE(expected_rule_1->Equals(get_rules[1]->ToValue().get()));
+}
+
+// Tests verifies that rules defined in the manifest cannot be deleted but
+// programmatically added rules still can be deleted.
+TEST(RulesRegistryTest, DeleteRuleInManifest) {
+  base::MessageLoopForUI message_loop;
+  content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
+
+  // Create extension
+  scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
+      "{"
+      "  \"name\": \"Test\","
+      "  \"version\": \"1\","
+      "  \"event_rules\": [{"
+      "    \"event\": \"declarativeContent.onPageChanged\","
+      "    \"actions\": [{"
+      "      \"type\": \"declarativeContent.ShowPageAction\""
+      "    }],"
+      "    \"conditions\" : [{"
+      "      \"css\": [\"video\"],"
+      "      \"type\" : \"declarativeContent.PageStateMatcher\""
+      "    }]"
+      "  }]"
+      "}");
+  scoped_refptr<Extension> extension = ExtensionBuilder()
+                                           .SetManifest(manifest.Pass())
+                                           .SetID(kExtensionId)
+                                           .Build();
+
+  scoped_refptr<RulesRegistry> registry = new TestRulesRegistry(
+      content::BrowserThread::UI, "declarativeContent.onPageChanged", key);
+  // Simulate what RulesRegistryService would do on extension load.
+  registry->OnExtensionLoaded(extension.get());
+  // Add some extra rules outside of the manifest.
+  std::vector<linked_ptr<RulesRegistry::Rule>> add_rules;
+  add_rules.push_back(make_linked_ptr(new RulesRegistry::Rule));
+  add_rules.push_back(make_linked_ptr(new RulesRegistry::Rule));
+  registry->AddRules(kExtensionId, add_rules, false);
+
+  std::vector<linked_ptr<RulesRegistry::Rule>> get_rules;
+  registry->GetAllRules(kExtensionId, &get_rules);
+  EXPECT_EQ(3u, get_rules.size());
+
+  // Remove a rule from outside the manifest.
+  std::vector<std::string> remove_ids;
+  remove_ids.push_back(*(get_rules[1]->id));
+  EXPECT_TRUE(registry->RemoveRules(kExtensionId, remove_ids).empty());
+  get_rules.clear();
+  registry->GetAllRules(kExtensionId, &get_rules);
+  EXPECT_EQ(2u, get_rules.size());
+
+  // Attempt to remove rule in manifest.
+  remove_ids.clear();
+  remove_ids.push_back(*(get_rules[0]->id));
+  EXPECT_FALSE(registry->RemoveRules(kExtensionId, remove_ids).empty());
+  get_rules.clear();
+  registry->GetAllRules(kExtensionId, &get_rules);
+  EXPECT_EQ(2u, get_rules.size());
+
+  // Remove all rules.

[not at google - send to devlin, 2015/06/05 16:16:14]

Why does removing all rules also remove the ones from the manifest? It seems
like you shouldn't be able to remove them.

[danduong, 2015/06/05 21:35:07]

Good catch. Some reason I thought this was internal-only for uninstall. I made
it so that it only removes that during uninstall.

+  registry->RemoveAllRules(kExtensionId);
+  get_rules.clear();
+  registry->GetAllRules(kExtensionId, &get_rules);
+  EXPECT_EQ(0u, get_rules.size());
+}
+
+// Tests what happens when there are 2 bad rule definitions and 1 good
+// definition in the manifest. Only the valid rule should be added to the
+// registry.
+TEST(RulesRegistryTest, TwoBadRulesOneGoodInManifest) {
+  base::MessageLoopForUI message_loop;
+  content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
+
+  // Create extension
+  scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
+      "{"
+      "  \"name\": \"Test\","
+      "  \"version\": \"1\","
+      "  \"event_rules\": ["
+      "    {"
+      "      \"event\": \"declarativeContent.onPageChanged\","
+      "      \"actions\": [{"
+      "        \"type\": \"declarativeContent.ShowPageAction\""
+      "      }],"
+      "      \"conditions\" : [{"
+      "        \"css\": [\"video\"],"
+      "        \"type\" : \"declarativeContent.PageStateMatcher\""
+      "      }]"
+      "    },"
+      "    {"
+      "      \"actions\": [{"
+      "        \"type\": \"declarativeContent.ShowPageAction\""
+      "      }],"
+      "      \"conditions\" : [{"
+      "        \"css\": [\"video\"],"
+      "        \"type\" : \"declarativeContent.PageStateMatcher\""
+      "      }]"
+      "    },"
+      "    {"
+      "      \"event\": \"declarativeContent.onPageChanged\","
+      "      \"actions\": [{"
+      "        \"type\": \"declarativeContent.ShowPageAction\""
+      "      }],"
+      "      \"conditions\" : [{}]"
+      "    }"
+      "  ]"
+      "}");
+  scoped_refptr<Extension> extension = ExtensionBuilder()
+                                           .SetManifest(manifest.Pass())
+                                           .SetID(kExtensionId)
+                                           .Build();
+
+  scoped_refptr<RulesRegistry> registry = new TestRulesRegistry(
+      content::BrowserThread::UI, "declarativeContent.onPageChanged", key);
+  // Simulate what RulesRegistryService would do on extension load.
+  registry->OnExtensionLoaded(extension.get());
+
+  std::vector<linked_ptr<RulesRegistry::Rule>> get_rules;
+  registry->GetAllRules(kExtensionId, &get_rules);
+
+  ASSERT_EQ(1u, get_rules.size());
+  scoped_ptr<base::DictionaryValue> expected_rule_0 = ParseDictionary(
+      "{"
+      "  \"id\": \"_0_\","
+      "  \"priority\": 100,"
+      "  \"actions\": [{"
+      "    \"instanceType\": \"declarativeContent.ShowPageAction\""
+      "  }],"
+      "  \"conditions\" : [{"
+      "    \"css\": [\"video\"],"
+      "    \"instanceType\" : \"declarativeContent.PageStateMatcher\""
+      "  }]"
+      "}");
+  EXPECT_TRUE(expected_rule_0->Equals(get_rules[0]->ToValue().get()));
+}
+
+// Tests what happens when no rules are properly defined in the manifest. This
+// should result in no crash/additions.
+TEST(RulesRegistryTest, NoValidRulesInManifest) {
+  base::MessageLoopForUI message_loop;
+  content::TestBrowserThread thread(content::BrowserThread::UI, &message_loop);
+
+  // Create extension
+  scoped_ptr<base::DictionaryValue> manifest = ParseDictionary(
+      "{"
+      "  \"name\": \"Test\","
+      "  \"version\": \"1\","
+      "  \"event_rules\": {}"
+      "}");
+  scoped_refptr<Extension> extension = ExtensionBuilder()
+                                           .SetManifest(manifest.Pass())
+                                           .SetID(kExtensionId)
+                                           .Build();
+
+  scoped_refptr<RulesRegistry> registry = new TestRulesRegistry(
+      content::BrowserThread::UI, "declarativeContent.onPageChanged", key);
+  // Simulate what RulesRegistryService would do on extension load.
+  registry->OnExtensionLoaded(extension.get());
+
+  std::vector<linked_ptr<RulesRegistry::Rule>> get_rules;
+  registry->GetAllRules(kExtensionId, &get_rules);
+
+  EXPECT_EQ(0u, get_rules.size());
+}
+
 }  // namespace extensions