Issue 698 - Added tests for $sitekey option

chrome/content/tests/matcher.js

 (function()
 {
   module("Filter matcher", {setup: prepareFilterComponents, teardown: restoreFilterComponents});
-
-  let publickeys = {
-    /*
-    -----BEGIN RSA PRIVATE KEY-----
-    MIIBOgIBAAJBANLNgMGCl6kc3QE/73/ESBsuhzCNQWApqWS1nKVWf+RjDTiF80LD
-    2TiTdQhlW9mlWsDDbttsDlEcCmPVz6H3OUMCAwEAAQJBALo/ZSYTqsl4ve7vvTwG
-    gKq7ZihIdV1wEcDwELGoBiESo87zl//7q2q9/7VE3dB3Qp6uZMLtxVvXzF8bh074
-    OuECIQDzzenwgPVMtg6OjMtZBAB95oKaTzd+x/8JienKW4edEQIhAN1Y+vlB/waB
-    miRjGMrsOQDHhUbxyL6NXaPfxYlosYETAiBg0M9qgztl+BH1x7FkqvMrC+OnNXf7
-    L552gj7F7ez/kQIgOBNhyaHxlNlijpNYZZhAvLTPS/DXFYdE0M5RAgW26mcCIDrR
-    fi2xaM2NqJQCmyshtNmDxW2FCrtrQn1n0211WCEe
-    -----END RSA PRIVATE KEY-----
-    */
-    foo: "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANLNgMGCl6kc3QE/73/ESBsuhzCNQWApqWS1nKVWf+RjDTiF80LD2TiTdQhlW9mlWsDDbttsDlEcCmPVz6H3OUMCAwEAAQ",
-    /*
-    -----BEGIN RSA PRIVATE KEY-----
-    MIIBOgIBAAJBALlKJGIBHYU3rIWyGmiwUgK1BUUomSBgLzSngoE7gBc7mqgCsEbj
-    f9EJ5AvQIM1x7MhVsD5djpqHLcjiQlZFXfECAwEAAQJABEK7MXG7HwwXsH9W8h9T
-    03IcK+nyE3eCvmA3tQcMO/x93imcBdNiz7ev09wGIPDN3Kmauf70/QnjebuDSV9A
-    XQIhAN57+YUwDdGccxqZyj+wRuU5pA1rltIDBQByBLRGd6YjAiEA1TPE2PdWrSsp
-    S6VZoRPWIEebfH/ufWZEFfYKDwP9qtsCIEk3JSr2YGXNhXeIiq0g1oPSzzD3af+c
-    rMWzv+aPlgpfAiAvtSLiTg6GN3dJJxn0UmUC2iMv68ypIN4xb9n2XDVCKwIhAJkd
-    evN4qUcg1kCeQ4LZ5F4WUus+4kd2+Y1nnYQbOrE9
-    -----END RSA PRIVATE KEY-----
-    */
-    bar: "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBALlKJGIBHYU3rIWyGmiwUgK1BUUomSBgLzSngoE7gBc7mqgCsEbjf9EJ5AvQIM1x7MhVsD5djpqHLcjiQlZFXfECAwEAAQ"
-  };

[Wladimir Palant, 2014/09/10 21:55:06]

Given that no signatures are being verified here and the keys are being used
merely as opaque strings: why not actually use "foo+publickey" and
"bar+publickey" instead and drop the beautification? That will simplify the
tests as well, these can simply hardcode the keys instead of referring to the
global object.

[Thomas Greiner, 2014/12/11 14:33:55]

Done. That was a leftover from my previous approach in which the verification
was in the matcher.

-  
-  function beautifyKeys(str)
-  {
-    if (typeof str != "string")
-      return str;
-
-    return str.replace(publickeys.foo, "foo-publickey", "g")
-              .replace(publickeys.bar, "bar-publickey", "g");
-  }
 
   function compareKeywords(text, expected)
   {
     for (let filter of [Filter.fromText(text), Filter.fromText("@@" + text)])
     {
       let matcher = new Matcher();
       let result = [];
       for (let dummy of expected)
       {
         keyword = matcher.findKeyword(filter);
@@ skipping 13 matching lines @@
   function checkMatch(filters, location, contentType, docDomain, thirdParty, sitekey, expected)
   {
     let matcher = new Matcher();
     for (let filter of filters)
       matcher.add(Filter.fromText(filter));
 
     let result = matcher.matchesAny(location, contentType, docDomain, thirdParty, sitekey);
     if (result)
       result = result.text;
 
-    equal(beautifyKeys(result), beautifyKeys(expected), "match(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey ? beautifyKeys(sitekey) : "no-sitekey") + ") with:\n" + beautifyKeys(filters.join("\n")));
+    equal(result, expected, "match(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey || "no-sitekey") + ") 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);
       if (result)
         result = result.text;
 
-      equal(beautifyKeys(result), beautifyKeys(expected), "combinedMatch(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey ? beautifyKeys(sitekey) : "no-sitekey") + ") with:\n" + beautifyKeys(filters.join("\n")));
+      equal(result, expected, "combinedMatch(" + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey || "no-sitekey") + ") with:\n" + filters.join("\n"));
 
       // For next run: add whitelisting filters
       filters = filters.map((text) => "@@" + text);
       if (expected)
         expected = "@@" + expected;
     }
   }
 
   function cacheCheck(matcher, location, contentType, docDomain, thirdParty, expected)
   {
@@ skipping 85 matching lines @@
     checkMatch(["//abc/def", "abc$image", "abc$~image"], "http://abc/def", "IMAGE", null, false, null, "//abc/def");
     checkMatch(["abc$image", "abc$~image", "//abc/def$image"], "http://abc/def", "IMAGE", null, false, null, "//abc/def$image");
     checkMatch(["abc$image", "abc$~image", "//abc/def$script"], "http://abc/def", "IMAGE", null, false, null, "abc$image");
     checkMatch(["abc$domain=foo.com", "abc$domain=bar.com", "abc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "foo.com", false, null, "abc$domain=foo.com");
     checkMatch(["abc$domain=foo.com", "abc$domain=bar.com", "abc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "bar.com", false, null, "abc$domain=bar.com");
     checkMatch(["abc$domain=foo.com", "abc$domain=bar.com", "abc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "baz.com", false, null, "abc$domain=~foo.com|~bar.com");
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "foo.com", false, null, "abc$domain=foo.com");
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "bar.com", false, null, null);
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://abc/def", "IMAGE", "baz.com", false, null, null);
     checkMatch(["abc$domain=foo.com", "cba$domain=bar.com", "ccc$domain=~foo.com|~bar.com"], "http://ccc/def", "IMAGE", "baz.com", false, null, "ccc$domain=~foo.com|~bar.com");
-    checkMatch(["abc$sitekey=" + publickeys.foo, "abc$sitekey=" + publickeys.bar], "http://abc/def", "IMAGE", "foo.com", false, publickeys.foo, "abc$sitekey=" + publickeys.foo);
-    checkMatch(["abc$sitekey=" + publickeys.foo, "abc$sitekey=" + publickeys.bar], "http://abc/def", "IMAGE", "bar.com", false, publickeys.bar, "abc$sitekey=" + publickeys.bar);
-    checkMatch(["abc$sitekey=" + publickeys.foo, "cba$sitekey=" + publickeys.bar], "http://abc/def", "IMAGE", "bar.com", false, publickeys.bar, null);
-    checkMatch(["abc$sitekey=" + publickeys.foo, "cba$sitekey=" + publickeys.bar], "http://abc/def", "IMAGE", "baz.com", false, null, null);

[Wladimir Palant, 2014/09/10 21:55:06]

Please test the scenarios where the filter combines sitekey and domain options.

[Thomas Greiner, 2014/12/11 14:33:55]

Done.

+    checkMatch(["abc$sitekey=foo-publickey", "abc$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "foo.com", false, "foo-publickey", "abc$sitekey=foo-publickey");
+    checkMatch(["abc$sitekey=foo-publickey", "abc$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "bar.com", false, "bar-publickey", "abc$sitekey=bar-publickey");
+    checkMatch(["abc$sitekey=foo-publickey", "cba$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "bar.com", false, "bar-publickey", null);
+    checkMatch(["abc$sitekey=foo-publickey", "cba$sitekey=bar-publickey"], "http://abc/def", "IMAGE", "baz.com", false, null, 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", "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", 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", 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", "abc$sitekey=bar-publickey,domain=bar.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("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", "DOCUMENT", null, false, "cba$~third-party,~script");
     cacheCheck(matcher, "http://abc_cba", "DOCUMENT", 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", "SCRIPT", null, false, "http://def$script");
   });
 })();