Add common code for extensions event filtering.

chrome/common/extensions/filtered_event_router_unittest.cc

Index: chrome/common/extensions/filtered_event_router_unittest.cc
diff --git a/chrome/common/extensions/filtered_event_router_unittest.cc b/chrome/common/extensions/filtered_event_router_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..b415d9f265dc5d520a9f9ae72c8b363b3eff088d
--- /dev/null
+++ b/chrome/common/extensions/filtered_event_router_unittest.cc
@@ -0,0 +1,178 @@
+// Copyright (c) 2012 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 "base/memory/scoped_ptr.h"
+#include "base/values.h"
+#include "chrome/common/extensions/event_filtering_info.h"
+#include "chrome/common/extensions/event_matcher.h"
+#include "chrome/common/extensions/filtered_event_router.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace extensions {
+
+class FilteredEventRouterUnittest : public testing::Test {
+ public:
+  virtual void SetUp() OVERRIDE {
+  }
+
+ protected:
+  scoped_ptr<base::Value> HostSuffixDict(const std::string& host_suffix) {
+    scoped_ptr<base::DictionaryValue> dict(new DictionaryValue());
+    dict->Set("hostSuffix", base::Value::CreateStringValue(host_suffix));
+    return scoped_ptr<base::Value>(dict.release());

[Matt Perry, 2012/05/15 20:42:59]

does dict.Pass() not work here?

[koz (OOO until 15th September), 2012/05/16 00:14:00]

No, because dict.Pass() will return a scoped_ptr<base::DictionaryValue> which
the compiler complains about.

+  }
+
+  scoped_ptr<base::ListValue> Singleton(scoped_ptr<base::Value> value) {

[battre, 2012/05/15 13:12:32]

Rename this to ListWithValue? My understanding of a singleton would be this:
http://en.wikipedia.org/wiki/Singleton_pattern

[koz (OOO until 15th September), 2012/05/16 00:14:00]

Done (ValueAsList okay?).

+    scoped_ptr<base::ListValue> result(new base::ListValue());
+    result->Append(value.release());
+    return result.Pass();
+  }
+
+  scoped_ptr<EventMatcher> AllURLs() {
+    scoped_ptr<EventMatcher> matcher(new EventMatcher());
+    // An empty host suffix always matches.
+    matcher->set_url_filters(Singleton(HostSuffixDict("")));

[battre, 2012/05/15 13:12:32]

I think from the extension API, AllURLs should be represented by an empty list.

[koz (OOO until 15th September), 2012/05/16 00:14:00]

Done.

+    return matcher.Pass();
+  }
+
+  scoped_ptr<EventMatcher> HostSuffixMatcher(const std::string& host_suffix) {
+    scoped_ptr<EventMatcher> event_matcher(new EventMatcher());
+    event_matcher->set_url_filters(Singleton(HostSuffixDict(host_suffix)));
+    return event_matcher.Pass();
+  }
+
+  EventFilteringInfo URLEvent(const std::string& url) {
+    EventFilteringInfo info;
+    info.SetURL(GURL(url));
+    return info;
+  }
+
+  FilteredEventRouter event_router_;
+};
+
+TEST_F(FilteredEventRouterUnittest, NoMatchersMatchIfEmpty) {
+  std::set<int> matches = event_router_.MatchEvent("some-event",
+                                                   EventFilteringInfo());
+  ASSERT_EQ(0u, matches.size());
+}
+
+TEST_F(FilteredEventRouterUnittest, AddingEventMatcherDoesntCrash) {
+  event_router_.AddEventMatcher("event1", AllURLs());
+}
+
+TEST_F(FilteredEventRouterUnittest,
+    DontMatchAgainstMatchersForDifferentEvents) {
+  event_router_.AddEventMatcher("event1", AllURLs());
+  std::set<int> matches = event_router_.MatchEvent("event2",
+                                                   EventFilteringInfo());
+  ASSERT_EQ(0u, matches.size());
+}
+
+TEST_F(FilteredEventRouterUnittest, DoMatchAgainstMatchersForSameEvent) {
+  int id = event_router_.AddEventMatcher("event1", AllURLs());
+  std::set<int> matches = event_router_.MatchEvent("event1",
+      URLEvent("http://www.google.com"));
+  ASSERT_EQ(1u, matches.size());
+  ASSERT_TRUE(matches.count(id) > 0);
+}
+
+TEST_F(FilteredEventRouterUnittest, DontMatchUnlessMatcherMatches) {
+  EventFilteringInfo info;
+  info.SetURL(GURL("http://www.yahoo.com"));
+  event_router_.AddEventMatcher("event1", HostSuffixMatcher("google.com"));
+  std::set<int> matches = event_router_.MatchEvent("event1", info);
+  ASSERT_TRUE(matches.empty());
+}
+
+TEST_F(FilteredEventRouterUnittest, RemovingAnEventMatcherStopsItMatching) {
+  int id = event_router_.AddEventMatcher("event1", AllURLs());
+  event_router_.RemoveEventMatcher(id);
+  std::set<int> matches = event_router_.MatchEvent("event1",
+                                                   EventFilteringInfo());
+  ASSERT_TRUE(matches.empty());
+}
+
+TEST_F(FilteredEventRouterUnittest, MultipleEventMatches) {
+  int id1 = event_router_.AddEventMatcher("event1", AllURLs());
+  int id2 = event_router_.AddEventMatcher("event1", AllURLs());
+  std::set<int> matches = event_router_.MatchEvent("event1",
+      URLEvent("http://www.google.com"));
+  ASSERT_EQ(2u, matches.size());
+  ASSERT_EQ(1u, matches.count(id1));
+  ASSERT_EQ(1u, matches.count(id2));
+}
+
+TEST_F(FilteredEventRouterUnittest, TestURLMatching) {
+  EventFilteringInfo info;
+  info.SetURL(GURL("http://www.google.com"));
+  int id = event_router_.AddEventMatcher("event1",
+                                         HostSuffixMatcher("google.com"));
+  std::set<int> matches = event_router_.MatchEvent("event1", info);
+  ASSERT_EQ(1u, matches.size());
+  ASSERT_EQ(1u, matches.count(id));
+}
+
+TEST_F(FilteredEventRouterUnittest, TestMultipleURLFiltersMatchOnAny) {
+  scoped_ptr<base::ListValue> filters(new base::ListValue());
+  filters->Append(HostSuffixDict("google.com").release());;
+  filters->Append(HostSuffixDict("yahoo.com").release());;
+
+  scoped_ptr<EventMatcher> matcher(new EventMatcher());
+  matcher->set_url_filters(filters.Pass());
+  int id = event_router_.AddEventMatcher("event1", matcher.Pass());
+
+  {
+    std::set<int> matches = event_router_.MatchEvent("event1",
+        URLEvent("http://www.google.com"));
+    ASSERT_EQ(1u, matches.size());
+    ASSERT_EQ(1u, matches.count(id));
+  }
+  {
+    std::set<int> matches = event_router_.MatchEvent("event1",
+        URLEvent("http://www.yahoo.com"));
+    ASSERT_EQ(1u, matches.size());
+    ASSERT_EQ(1u, matches.count(id));
+  }
+  {
+    std::set<int> matches = event_router_.MatchEvent("event1",
+        URLEvent("http://www.something-else.com"));
+    ASSERT_EQ(0u, matches.size());
+  }
+}
+
+TEST_F(FilteredEventRouterUnittest, TestStillMatchesAfterRemoval) {
+  int id1 = event_router_.AddEventMatcher("event1", AllURLs());
+  int id2 = event_router_.AddEventMatcher("event1", AllURLs());
+
+  event_router_.RemoveEventMatcher(id1);
+  {
+    std::set<int> matches = event_router_.MatchEvent("event1",
+        URLEvent("http://www.google.com"));
+    ASSERT_EQ(1u, matches.size());
+    ASSERT_EQ(1u, matches.count(id2));
+  }
+}
+
+TEST_F(FilteredEventRouterUnittest, TestGetMatcherCountForEvent) {
+  ASSERT_EQ(0, event_router_.GetMatcherCountForEvent("event1"));
+  int id1 = event_router_.AddEventMatcher("event1", AllURLs());
+  ASSERT_EQ(1, event_router_.GetMatcherCountForEvent("event1"));
+  int id2 = event_router_.AddEventMatcher("event1", AllURLs());
+  ASSERT_EQ(2, event_router_.GetMatcherCountForEvent("event1"));
+  event_router_.RemoveEventMatcher(id1);
+  ASSERT_EQ(1, event_router_.GetMatcherCountForEvent("event1"));
+  event_router_.RemoveEventMatcher(id2);
+  ASSERT_EQ(0, event_router_.GetMatcherCountForEvent("event1"));
+}
+
+TEST_F(FilteredEventRouterUnittest, RemoveEventMatcherReturnsEventName) {
+  int id1 = event_router_.AddEventMatcher("event1", AllURLs());
+  int id2 = event_router_.AddEventMatcher("event1", AllURLs());
+  int id3 = event_router_.AddEventMatcher("event2", AllURLs());
+
+  ASSERT_EQ("event1", event_router_.RemoveEventMatcher(id1));
+  ASSERT_EQ("event1", event_router_.RemoveEventMatcher(id2));
+  ASSERT_EQ("event2", event_router_.RemoveEventMatcher(id3));
+}
+}  // namespace extensions