Issue 698 - Added tests for $sitekey option

chrome/content/tests/regexpFilters_matching.js

 (function()
 {
   module("Matching of blocking filters", {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]

Here as well: given that the keys aren't actually being used, how about using
"foo+publickey" and "bar+publickey" instead?

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

Done.

-  };
-  
-  function beautifyKeys(str)
-  {
-    if (typeof str != "string")
-      return str;
-
-    return str.replace(publickeys.foo, "foo-publickey", "g")
-              .replace(publickeys.bar, "bar-publickey", "g");
-  }
 
   function testMatch(text, location, contentType, docDomain, thirdParty, sitekey, expected)
   {
     function testMatch_internal(text, location, contentType, docDomain, thirdParty, sitekey, expected)
     {
       let filter = Filter.fromText(text);
       let result = filter.matches(location, contentType, docDomain, thirdParty, sitekey);
-      equal(!!result, expected, '"' + beautifyKeys(text) + '".matches(' + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey ? beautifyKeys(sitekey) : "no-sitekey") + ")");
+      equal(!!result, expected, '"' + text + '".matches(' + location + ", " + contentType + ", " + docDomain + ", " + (thirdParty ? "third-party" : "first-party") + ", " + (sitekey || "no-sitekey") + ")");
     }
     testMatch_internal(text, location, contentType, docDomain, thirdParty, sitekey, expected);
     if (!/^@@/.test(text))
       testMatch_internal("@@" + text, location, contentType, docDomain, thirdParty, sitekey, expected);
   }
 
   test("Basic filters", function()
   {
     testMatch("abc", "http://abc/adf", "IMAGE", null, false, null, true);
     testMatch("abc", "http://ABC/adf", "IMAGE", null, false, null, true);
@@ skipping 248 matching lines @@
     testMatch("abc$domain=foo.com,image", "http://abc/def", "OBJECT", "foo.com", true, null, false);
     testMatch("abc$domain=foo.com,image", "http://abc/def", "OBJECT", "bar.com", true, null, false);
     testMatch("abc$domain=foo.com,~image", "http://abc/def", "IMAGE", "foo.com", true, null, false);
     testMatch("abc$domain=foo.com,~image", "http://abc/def", "IMAGE", "bar.com", true, null, false);
     testMatch("abc$domain=foo.com,~image", "http://abc/def", "OBJECT", "foo.com", true, null, true);
     testMatch("abc$domain=foo.com,~image", "http://abc/def", "OBJECT", "bar.com", true, null, false);
   });
 
   test("Sitekey restrictions", function()
   {
-    testMatch("abc$sitekey=" + publickeys.foo, "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, true);
-    testMatch("abc$sitekey=" + publickeys.foo, "http://abc/def", "IMAGE", "foo.com", true, null, false);

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

What about the scenario where the sitekey is present but doesn't match the one
specified in the filter?

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

Done.

-    testMatch("abc$sitekey=" + publickeys.foo + "|" + publickeys.bar, "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, true);
-    testMatch("abc$sitekey=" + publickeys.foo + "|" + publickeys.bar, "http://abc/def", "IMAGE", "foo.com", true, null, false);
-    testMatch("abc$sitekey=" + publickeys.bar + "|" + publickeys.foo, "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, true);
-    testMatch("abc$sitekey=" + publickeys.foo, "http://ccc/def", "IMAGE", "foo.com", true, publickeys.foo, false);
-    testMatch("abc$image,sitekey=" + publickeys.foo, "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, true);
-    testMatch("abc$image,sitekey=" + publickeys.foo, "http://abc/def", "OBJECT", "foo.com", true, publickeys.foo, false);
-    testMatch("abc$~image,sitekey=" + publickeys.foo, "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, false);
-    testMatch("abc$~image,sitekey=" + publickeys.foo, "http://abc/def", "OBJECT", "foo.com", true, publickeys.foo, true);
-    testMatch("abc$sitekey=" + publickeys.foo + ",image", "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, true);
-    testMatch("abc$sitekey=" + publickeys.foo + ",image", "http://abc/def", "OBJECT", "foo.com", true, publickeys.foo, false);
-    testMatch("abc$sitekey=" + publickeys.foo + ",~image", "http://abc/def", "IMAGE", "foo.com", true, publickeys.foo, false);
-    testMatch("abc$sitekey=" + publickeys.foo + ",~image", "http://abc/def", "OBJECT", "foo.com", true, publickeys.foo, true);

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

This should test how the sitekeys get along with domain options rather than type
options.

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

Done. Let me know if it makes sense to also include the tests with swapped
filter options because I left them out for now.

+    testMatch("abc$sitekey=foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, "foo-publickey", true);
+    testMatch("abc$sitekey=foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, null, false);
+    testMatch("abc$sitekey=foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, "bar-publickey", false);
+    testMatch("abc$sitekey=foo-publickey|bar-publickey", "http://abc/def", "IMAGE", "foo.com", true, "foo-publickey", true);
+    testMatch("abc$sitekey=foo-publickey|bar-publickey", "http://abc/def", "IMAGE", "foo.com", true, null, false);
+    testMatch("abc$sitekey=bar-publickey|foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, "foo-publickey", true);
+    testMatch("abc$sitekey=foo-publickey", "http://ccc/def", "IMAGE", "foo.com", true, "foo-publickey", false);
+    testMatch("abc$domain=foo.com,sitekey=foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, "foo-publickey", true);
+    testMatch("abc$domain=foo.com,sitekey=foo-publickey", "http://abc/def", "IMAGE", "bar.com", true, "foo-publickey", false);
+    testMatch("abc$domain=~foo.com,sitekey=foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, "foo-publickey", false);
+    testMatch("abc$domain=~foo.com,sitekey=foo-publickey", "http://abc/def", "IMAGE", "bar.com", true, "foo-publickey", true);
+    testMatch("abc$domain=bar.com,sitekey=foo-publickey", "http://abc/def", "IMAGE", "foo.com", true, "foo-publickey", false);
+    testMatch("abc$domain=bar.com,sitekey=foo-publickey", "http://abc/def", "IMAGE", "bar.com", true, "foo-publickey", true);

[Wladimir Palant, 2014/12/11 15:57:47]

Nit: the last two tests are redundant, they test the scenario "Domain specified
in filter along with sitekey and matches/doesn't match document domain" - this
was tested already, merely with foo.com and bar.com reversed.

   });
 
   test("Exception rules", function()
   {
     testMatch("@@test", "http://test/", "DOCUMENT", null, false, null, false);
     testMatch("@@http://test*", "http://test/", "DOCUMENT", null, false, null, true);
     testMatch("@@ftp://test*", "ftp://test/", "DOCUMENT", null, false, null, true);
     testMatch("@@test$document", "http://test/", "DOCUMENT", null, false, null, true);
     testMatch("@@test$document,image", "http://test/", "DOCUMENT", null, false, null, true);
     testMatch("@@test$~image", "http://test/", "DOCUMENT", null, false, null, false);
     testMatch("@@test$~image,document", "http://test/", "DOCUMENT", null, false, null, true);
     testMatch("@@test$document,~image", "http://test/", "DOCUMENT", null, false, null, true);
     testMatch("@@test$document,domain=foo.com", "http://test/", "DOCUMENT", "foo.com", false, null, true);
     testMatch("@@test$document,domain=foo.com", "http://test/", "DOCUMENT", "bar.com", false, null, false);
     testMatch("@@test$document,domain=~foo.com", "http://test/", "DOCUMENT", "foo.com", false, null, false);
     testMatch("@@test$document,domain=~foo.com", "http://test/", "DOCUMENT", "bar.com", false, null, true);
-    testMatch("@@test$document,sitekey=" + publickeys.foo, "http://test/", "DOCUMENT", "foo.com", false, publickeys.foo, true);
-    testMatch("@@test$document,sitekey=" + publickeys.foo, "http://test/", "DOCUMENT", "foo.com", false, null, false);
+    testMatch("@@test$document,sitekey=foo-publickey", "http://test/", "DOCUMENT", "foo.com", false, "foo-publickey", true);
+    testMatch("@@test$document,sitekey=foo-publickey", "http://test/", "DOCUMENT", "foo.com", false, null, false);
   });
 })();