Issue 616 - Add tests for $generichide and $genericblock

chrome/content/tests/matcher.js

 (function()
 {
   module("Filter matcher", {setup: prepareFilterComponents, teardown: restoreFilterComponents});
 
   function compareKeywords(text, expected)
   {
     for (let filter of [Filter.fromText(text), Filter.fromText("@@" + text)])
     {
       let matcher = new Matcher();
       let result = [];
@@ skipping 12 matching lines @@
       equal(result.join(", "), expected.join(", "), "Keyword candidates for " + filter.text);
     }
   }
 
   function checkMatch(filters, location, contentType, docDomain, thirdParty, sitekey, specificOnly, expected)
   {
     let matcher = new Matcher();
     for (let filter of filters)
       matcher.add(Filter.fromText(filter));
 
-    let result = matcher.matchesAny(location, contentType, docDomain, thirdParty, sitekey, specificOnly);
+    let result = matcher.matchesAny(location, RegExpFilter.typeMap[contentType], docDomain, thirdParty, sitekey, specificOnly);
     if (result)
       result = result.text;
 
     equal(result, expected, "match(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey || "no-sitekey") + ", " + (specificOnly ? "specificOnly" : "not-specificOnly") + ") with:\n" + filters.join("\n"));
 
     let combinedMatcher = new CombinedMatcher();
     for (let i = 0; i < 2; i++)
     {
       for (let filter of filters)
         combinedMatcher.add(Filter.fromText(filter));
 
-      let result = combinedMatcher.matchesAny(location, contentType, docDomain, thirdParty, sitekey, specificOnly);
+      let result = combinedMatcher.matchesAny(location, RegExpFilter.typeMap[contentType], docDomain, thirdParty, sitekey, specificOnly);
       if (result)
         result = result.text;
 
       equal(result, expected, "combinedMatch(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey || "no-sitekey") + ", " + (specificOnly ? "specificOnly" : "not-specificOnly") + ") with:\n" + filters.join("\n"));
 
+      // Generic whitelisting rules can match for specificOnly searches, so we
+      // can't easily know which rule will match for these whitelisting tests
+      if (specificOnly)
+        continue;
+
       // For next run: add whitelisting filters for filters that aren't already
+      filters = filters.map((text) => text.substr(0, 2) == "@@" ? text : "@@" + text);
       if (expected && expected.substr(0, 2) != "@@")
-      {
-        filters = filters.filter((text) => text.substr(0, 2) != "@@").map((text) => "@@" + text);
-        if (expected)
-          expected = "@@" + expected;
-      }
+        expected = "@@" + expected;
     }
   }
 
   function cacheCheck(matcher, location, contentType, docDomain, thirdParty, expected)
   {
-    let result = matcher.matchesAny(location, contentType, docDomain, thirdParty);
+    let result = matcher.matchesAny(location, RegExpFilter.typeMap[contentType], docDomain, thirdParty);
     if (result)
       result = result.text;
 
     equal(result, expected, "match(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ") with static filters");
   }
 
   test("Matcher class definitions", function()
   {
     equal(typeof Matcher, "function", "typeof Matcher");
     equal(typeof CombinedMatcher, "function", "typeof CombinedMatcher");
@@ skipping 17 matching lines @@
     compareKeywords("&asdf=1234|", ["asdf", "1234"]);
     compareKeywords("^foo%2Ebar^", ["foo%2ebar"]);
     compareKeywords("^aSdF^1234", ["asdf"]);
     compareKeywords("_asdf_1234_", ["asdf", "1234"]);
     compareKeywords("+asdf-1234=", ["asdf", "1234"]);
     compareKeywords("/123^ad2&ad&", ["123", "ad2"]);
     compareKeywords("/123^ad2&ad$script,domain=example.com", ["123", "ad2"]);
   });
 
   test("Filter matching", function()
   {

[kzar, 2015/03/19 11:03:22]

Most of this change is down to the addition of the new specificOnly parameter to
checkMatch.

     checkMatch([], "http://abc/def", "IMAGE", null, false, null, false, null);
     checkMatch(["abc"], "http://abc/def", "IMAGE", null, false, null, false, "abc");
     checkMatch(["abc", "ddd"], "http://abc/def", "IMAGE", null, false, null, false, "abc");
     checkMatch(["ddd", "abc"], "http://abc/def", "IMAGE", null, false, null, false, "abc");
     checkMatch(["ddd", "abd"], "http://abc/def", "IMAGE", null, false, null, false, null);
     checkMatch(["abc", "://abc/d"], "http://abc/def", "IMAGE", null, false, null, false, "://abc/d");
     checkMatch(["://abc/d", "abc"], "http://abc/def", "IMAGE", null, false, null, false, "://abc/d");
     checkMatch(["|http://"], "http://abc/def", "IMAGE", null, false, null, false, "|http://");
     checkMatch(["|http://abc"], "http://abc/def", "IMAGE", null, false, null, false, "|http://abc");
     checkMatch(["|abc"], "http://abc/def", "IMAGE", null, false, null, false, null);
@@ skipping 43 matching lines @@
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "bar.com", false, null, false, null);
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "baz.com", false, null, false, null);
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://ccc/def", "IMAGE", "baz.com", false, null, false, "ccc$domain=~foo.com|~bar.com");
     checkMatch(["abc$sitekey=foo-publickey", "abc$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "foo.com", false, "foo-publickey", false, "abc$sitekey=foo-publickey");
     checkMatch(["abc$sitekey=foo-publickey", "abc$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "bar.com", false, "bar-publickey", false, "abc$sitekey=bar-publickey");
     checkMatch(["abc$sitekey=foo-publickey", "cba$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "bar.com", false, "bar-publickey", false, null);
     checkMatch(["abc$sitekey=foo-publickey", "cba$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "baz.com", false, null, false, null);
     checkMatch(["abc$sitekey=foo-publickey,domain=foo.com", "abc$sitekey=bar-publickey,domain=bar.com"], "http://abc/def", "IMAGE", "foo.com", false, "foo-publickey", false, "abc$sitekey=foo-publickey,domain=foo.com");
     checkMatch(["abc$sitekey=foo-publickey,domain=foo.com", "abc$sitekey=bar-publickey,domain=bar.com"], "http://abc/def", "IMAGE", "foo.com", false, "bar-publickey", false, null);
     checkMatch(["abc$sitekey=foo-publickey,domain=foo.com", "abc$sitekey=bar-publickey,domain=bar.com"], "http://abc/def", "IMAGE", "bar.com", false, "foo-publickey", false, null);
     checkMatch(["abc$sitekey=foo-publickey,domain=foo.com", "abc$sitekey=bar-publickey,domain=bar.com"], "http://abc/def", "IMAGE", "bar.com", false, "bar-publickey", false, "abc$sitekey=bar-publickey,domain=bar.com");

[kzar, 2015/03/19 11:03:22]

The new tests are below.

-    checkMatch(["@@kzar.co.uk$generichide"], "http://kzar.co.uk/dave", "GENERICHIDE", "kzar.co.uk", false, null, false, "@@kzar.co.uk$generichide");
-    checkMatch(["@@kzar.co.uk$genericblock"], "http://kzar.co.uk/dave", "GENERICBLOCK", "kzar.co.uk", false, null, false, "@@kzar.co.uk$genericblock");
-    checkMatch(["@@foo.com$generichide"], "http://kzar.co.uk/dave", "GENERICHIDE", "kzar.co.uk", false, null, false, null);
-    checkMatch(["@@foo.com$genericblock"], "http://kzar.co.uk/dave", "GENERICBLOCK", "kzar.co.uk", false, null, false, null);
-    checkMatch(["###dave"], "http://kzar.co.uk/dave", "IMAGE", "kzar.co.uk", false, null, true, null);
-    checkMatch(["kzar.co.uk###dave"], "http://kzar.co.uk/dave", "IMAGE", "kzar.co.uk", false, null, true, null);
-    checkMatch(["/dave$domain=kzar.co.uk"], "http://kzar.co.uk/dave", "IMAGE", "kzar.co.uk", false, null, true, "/dave$domain=kzar.co.uk");
-    checkMatch(["/dave"], "http://kzar.co.uk/dave", "IMAGE", "kzar.co.uk", false, null, true, null);
+    checkMatch(["@@foo.com$generichide"], "http://foo.com/bar", "GENERICHIDE", "foo.com", false, null, false, "@@foo.com$generichide");
+    checkMatch(["@@foo.com$genericblock"], "http://foo.com/bar", "GENERICBLOCK", "foo.com", false, null, false, "@@foo.com$genericblock");
+    checkMatch(["@@bar.com$generichide"], "http://foo.com/bar", "GENERICHIDE", "foo.com", false, null, false, null);
+    checkMatch(["@@bar.com$genericblock"], "http://foo.com/bar", "GENERICBLOCK", "foo.com", false, null, false, null);
+    checkMatch(["/bar"], "http://foo.com/bar", "IMAGE", "foo.com", false, null, true, null);
+    checkMatch(["/bar$domain=foo.com"], "http://foo.com/bar", "IMAGE", "foo.com", false, null, true, "/bar$domain=foo.com");
   });
 
   test("Result cache checks", function()
   {
     let matcher = new CombinedMatcher();
     matcher.add(Filter.fromText("abc$image"));
     matcher.add(Filter.fromText("abc$script"));
-    matcher.add(Filter.fromText("abc$~image,~script,~document"));
+    matcher.add(Filter.fromText("abc$~image,~script,~media"));
     matcher.add(Filter.fromText("cba$third-party"));
     matcher.add(Filter.fromText("cba$~third-party,~script"));
     matcher.add(Filter.fromText("http://def$image"));
     matcher.add(Filter.fromText("http://def$script"));
-    matcher.add(Filter.fromText("http://def$~image,~script,~document"));
+    matcher.add(Filter.fromText("http://def$~image,~script,~media"));
     matcher.add(Filter.fromText("http://fed$third-party"));
     matcher.add(Filter.fromText("http://fed$~third-party,~script"));
 
     cacheCheck(matcher, "http://abc", "IMAGE", null, false, "abc$image");
     cacheCheck(matcher, "http://abc", "SCRIPT", null, false, "abc$script");
-    cacheCheck(matcher, "http://abc", "OTHER", null, false, "abc$~image,~script,~document");
+    cacheCheck(matcher, "http://abc", "OTHER", null, false, "abc$~image,~script,~media");
     cacheCheck(matcher, "http://cba", "IMAGE", null, false, "cba$~third-party,~script");
     cacheCheck(matcher, "http://cba", "IMAGE", null, true, "cba$third-party");
     cacheCheck(matcher, "http://def", "IMAGE", null, false, "http://def$image");
     cacheCheck(matcher, "http://def", "SCRIPT", null, false, "http://def$script");
-    cacheCheck(matcher, "http://def", "OTHER", null, false, "http://def$~image,~script,~document");
+    cacheCheck(matcher, "http://def", "OTHER", null, false, "http://def$~image,~script,~media");
     cacheCheck(matcher, "http://fed", "IMAGE", null, false, "http://fed$~third-party,~script");
     cacheCheck(matcher, "http://fed", "IMAGE", null, true, "http://fed$third-party");
-    cacheCheck(matcher, "http://abc_cba", "DOCUMENT", null, false, "cba$~third-party,~script");
-    cacheCheck(matcher, "http://abc_cba", "DOCUMENT", null, true, "cba$third-party");
+    cacheCheck(matcher, "http://abc_cba", "MEDIA", null, false, "cba$~third-party,~script");
+    cacheCheck(matcher, "http://abc_cba", "MEDIA", null, true, "cba$third-party");
     cacheCheck(matcher, "http://abc_cba", "SCRIPT", null, false, "abc$script");
-    cacheCheck(matcher, "http://def?http://fed", "DOCUMENT", null, false, "http://fed$~third-party,~script");
-    cacheCheck(matcher, "http://def?http://fed", "DOCUMENT", null, true, "http://fed$third-party");
+    cacheCheck(matcher, "http://def?http://fed", "MEDIA", null, false, "http://fed$~third-party,~script");
+    cacheCheck(matcher, "http://def?http://fed", "MEDIA", null, true, "http://fed$third-party");
     cacheCheck(matcher, "http://def?http://fed", "SCRIPT", null, false, "http://def$script");
   });
 })();