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 30 matching lines @@
     {
       for (let filter of filters)
         combinedMatcher.add(Filter.fromText(filter));
 
       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);

[Thomas Greiner, 2015/10/01 16:12:04]

This line is now only run under the condition that `expected` is truthy which is
different from what it was before. Doesn't that cause issues?

[kzar, 2015/10/02 10:19:29]

Yes, well spotted, I don't like this logic at all. I have given it some more
thought and re-written it. Done.

-        if (expected)

[Thomas Greiner, 2015/10/01 16:12:05]

Detail: This if-statement is redundant.

[kzar, 2015/10/02 10:19:29]

Done.

-          expected = "@@" + expected;
-      }
+        expected = "@@" + expected;
     }
   }
 
   function cacheCheck(matcher, location, contentType, docDomain, thirdParty, expected)
   {
     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");
@@ skipping 92 matching lines @@
     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");
     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);

[Thomas Greiner, 2015/10/01 16:12:04]

Shouldn't this be "ELEMHIDE" instead of "IMAGE"?

-    checkMatch(["foo.com###bar"], "http://foo.com/bar", "IMAGE", "foo.com", false, null, true, null);

[Thomas Greiner, 2015/10/01 16:12:05]

From what I understand this should return a filter for foo.com that is specific
but the expected result is `null`.

[kzar, 2015/10/02 10:19:29]

I don't think these tests _can_ work for element hiding. I think this mistake
just masked the fact they weren't working. I've removed them.

+    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");
-    checkMatch(["/bar"], "http://foo.com/bar", "IMAGE", "foo.com", false, null, true, null);
   });
 
   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,~media"));
     matcher.add(Filter.fromText("cba$third-party"));
     matcher.add(Filter.fromText("cba$~third-party,~script"));
@@ skipping 14 matching lines @@
     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", "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", "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");
   });
 })();