Issue 4223 - Migrate some more of adblockplustests

test/filterListener.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 "use strict";
 
-let common = require("common");
-
-let {CSSRules} = require("cssRules");
-let {ElemHide} = require("elemHide");
-let {FilterListener} = require("filterListener");
-let {FilterStorage} = require("filterStorage");
-let {Subscription} = require("subscriptionClasses");
-let {Filter} = require("filterClasses");
-let {defaultMatcher} = require("matcher");
-let {SpecialSubscription} = require("subscriptionClasses");
-
+let {createSandbox} = require("./_common");
+let sandboxedRequire = null;
+
+let FilterStorage = null;
+let Subscription = null;
+let Filter = null;
+let defaultMatcher = null;
+let SpecialSubscription = null;
 
 exports.setUp = function(callback)
 {
-  common.prepareFilterComponents.call(this, true);
-  common.preparePrefs.call(this);
+  sandboxedRequire = createSandbox({
+    elemHide: ["filterByKey", "exceptions"],
+    cssRules: ["filters"]
+  });
+
+  // We need to require the filterListener module so that filter changes will be
+  // noticed, even though we don't directly use the module here.
+  sandboxedRequire("../lib/filterListener");
+
+  (
+    {FilterStorage} = sandboxedRequire("../lib/filterStorage"),
+    {Subscription, SpecialSubscription} = sandboxedRequire("../lib/subscriptionClasses"),
+    {Filter} = sandboxedRequire("../lib/filterClasses"),
+    {defaultMatcher} = sandboxedRequire("../lib/matcher")
+  );
 
   FilterStorage.addSubscription(Subscription.fromURL("~fl~"));
   FilterStorage.addSubscription(Subscription.fromURL("~wl~"));
   FilterStorage.addSubscription(Subscription.fromURL("~eh~"));
 
   Subscription.fromURL("~fl~").defaults = ["blocking"];
   Subscription.fromURL("~wl~").defaults = ["whitelist"];
   Subscription.fromURL("~eh~").defaults = ["elemhide"];
-
-  callback();
-};
-
-exports.tearDown = function(callback)
-{
-  common.restoreFilterComponents.call(this);
-  common.restorePrefs.call(this);
 
   callback();
 };
 
 function checkKnownFilters(test, text, expected)
 {
   let result = {};
   for (let type of ["blacklist", "whitelist"])
   {
     let matcher = defaultMatcher[type];
     let filters = [];
     for (let keyword in matcher.filterByKeyword)
     {
       let list = matcher.filterByKeyword[keyword];
       for (let i = 0; i < list.length; i++)
       {
         let filter = list[i];
         test.equal(matcher.getKeywordForFilter(filter), keyword,
                    "Keyword of filter " + filter.text);
         filters.push(filter.text);
       }
     }
     result[type] = filters;
   }
 
-  let ElemHideFilterByKey = ElemHide._getFilterByKey();
-  let ElemHideExceptions = ElemHide._getExceptions();
+  let elemHide = sandboxedRequire("../lib/elemHide");
   result.elemhide = [];
-  for (let key in ElemHideFilterByKey)
-    result.elemhide.push(ElemHideFilterByKey[key].text);
+  for (let key in elemHide.filterByKey)
+    result.elemhide.push(elemHide.filterByKey[key].text);
 
   result.elemhideexception = [];
-  for (let selector in ElemHideExceptions)
+  for (let selector in elemHide.exceptions)
   {
-    let list = ElemHideExceptions[selector];
+    let list = elemHide.exceptions[selector];
     for (let exception of list)
       result.elemhideexception.push(exception.text);
   }
 
-  let allCSSRules = CSSRules._getAllRules();
+  let cssRules = sandboxedRequire("../lib/cssRules");
   result.cssrule = [];
-  for (let filterText in allCSSRules)
+  for (let filterText in cssRules.filters)
     result.cssrule.push(filterText);
 
   let types = ["blacklist", "whitelist", "elemhide", "elemhideexception",
                "cssrule"];
   for (let type of types)
+  {
     if (!(type in expected))
       expected[type] = [];
+    else
+      expected[type].sort();
+    result[type].sort();
+  }
 
   test.deepEqual(result, expected, text);
 }
 
 exports.testAddingAndRemovingFilters = function(test)
 {
   let filter1 = Filter.fromText("filter1");
   let filter2 = Filter.fromText("@@filter2");
   let filter3 = Filter.fromText("#filter3");
   let filter4 = Filter.fromText("!filter4");
@@ skipping 78 matching lines @@
   let filter3 = Filter.fromText("#filter3");
   let filter4 = Filter.fromText("!filter4");
   let filter5 = Filter.fromText("#@#filter5");
   let filter6 = Filter.fromText("example.com##[-abp-properties='filter6']");
   let filter7 = Filter.fromText("example.com#@#[-abp-properties='filter7']");
 
   let subscription = Subscription.fromURL("http://test1/");
   subscription.filters = [filter1, filter2, filter3, filter4, filter5, filter6, filter7];
 
   FilterStorage.addSubscription(subscription);
   checkKnownFilters(test, "add subscription with filter1, @@filter2, #filter3, !filter4, #@#filter5, example.com##[-abp-properties='filter6'], example.com#@#[-abp-properties='filter7']", {blacklist: [filter1.text], elemhide: [filter3.text], elemhideexception: [filter5.text, filter7.text], cssrule: [filter6.text]});

[kzar, 2016/09/25 13:49:39]

This test and the two below it fail occasionally. I'm not sure why, but there
seems to be a race condition.

[kzar, 2016/09/29 15:53:09]

Still not got to the bottom of this.

[kzar, 2016/09/29 15:58:56]

Ah, was simply that the order varied! Fixed.

 
   filter2.disabled = false;
   checkKnownFilters(test, "enable @@filter2", {blacklist: [filter1.text], whitelist: [filter2.text], elemhide: [filter3.text], elemhideexception: [filter5.text, filter7.text], cssrule: [filter6.text]});
 
   FilterStorage.addFilter(filter1);
   checkKnownFilters(test, "add filter1", {blacklist: [filter1.text], whitelist: [filter2.text], elemhide: [filter3.text], elemhideexception: [filter5.text, filter7.text], cssrule: [filter6.text]});
 
   FilterStorage.updateSubscriptionFilters(subscription, [filter4]);
   checkKnownFilters(test, "change subscription filters to filter4", {blacklist: [filter1.text]});
 
@@ skipping 102 matching lines @@
   checkKnownFilters(test, "disable exception rules", {blacklist: [filter1.text, filter3.text], whitelist: [filter2.text]});
 
   FilterStorage.removeSubscription(subscription4);
   checkKnownFilters(test, "remove subscription from the list", {blacklist: [filter1.text]});
 
   subscription3.disabled = false;
   checkKnownFilters(test, "enable exception rules", {blacklist: [filter1.text], whitelist: [filter2.text]});
 
  test.done();
 };