Issue 4223 - Adapt synchronizer tests to work in adblockpluscore repository

test/synchronizer.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
@@ skipping 61 matching lines @@
       }
     },
 
     cancel: function()
     {
       this.nextExecution = -1;
     }
   };
 
   let requests = [];
   function XMLHttpRequest()

[kzar, 2016/10/05 11:36:51]

Seems kind of wasteful to define XMLHttpRequest and some of this other stuff
inside setUp for every test?

[Wladimir Palant, 2016/10/05 12:12:51]

Not really - we want a clean environment for every test. But the code is quite
massive and unstructured indeed, the next change is going to move it into
_common.js.

[kzar, 2016/10/05 12:18:16]

Fair enough.

   {
     this._host = "http://example.com";
     this._loadHandlers = [];
     this._errorHandlers = [];
   };
   XMLHttpRequest.prototype =
   {
     _path: null,
     _data: null,
     _queryString: null,
@@ skipping 250 matching lines @@
 }
 
 let initialDelay = 1 / 60;
 
 exports.testOneSubscriptionDownloads = function(test)
 {
   let subscription = Subscription.fromURL("http://example.com/subscription");
   FilterStorage.addSubscription(subscription);
 
   let requests = [];
   this.registerHandler("/subscription", metadata =>

[kzar, 2016/10/05 11:36:51]

I guess we could avoid declaring all the module variables at the top like `let
Filter = null;` too if we assigned them to the `this` Object from the setUp
functions. I didn't realise that was an option before, not sure if it's worth
changing that everywhere now however.

[Wladimir Palant, 2016/10/05 12:12:51]

Not during the initial migration - the fewer changes the better. But we should
definitely consider better options that avoid having global variables.

   {
     requests.push([this.getTimeOffset(), metadata.method, metadata.path]);
     return [Cr.NS_OK, 200, "[Adblock]\n! ExPiREs: 1day\nfoo\nbar"];
   });
 
   this.runScheduledTasks(50).then(() =>
   {
     test.deepEqual(requests, [
       [0 + initialDelay, "GET", "/subscription"],
       [24 + initialDelay, "GET", "/subscription"],
@@ skipping 29 matching lines @@
       [0 + initialDelay, "GET", "/subscription1"],
       [2 + initialDelay, "GET", "/subscription2"],
       [24 + initialDelay, "GET", "/subscription1"],
       [26 + initialDelay, "GET", "/subscription2"],
       [48 + initialDelay, "GET", "/subscription1"],
       [50 + initialDelay, "GET", "/subscription2"],
     ], "Requests after 55 hours");
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
-exports.testSubscriptionHeaders = function(test)
-{
-  let currentTest;
-  let subscription = Subscription.fromURL("http://example.com/subscription");
-  FilterStorage.addSubscription(subscription);
-
-  this.registerHandler("/subscription", metadata =>
-  {
-    return [Cr.NS_OK, 200, currentTest.header + "\n!Expires: 8 hours\nfoo\n!bar\n\n@@bas\n#bam"];
-  });
-
-  let tests = [
-    {header: "[Adblock]", downloadStatus: "synchronize_ok", requiredVersion: null},
-    {header: "[Adblock Plus]", downloadStatus: "synchronize_ok", requiredVersion: null},
-    {header: "(something)[Adblock]", downloadStatus: "synchronize_ok", requiredVersion: null},
-    {header: "[Adblock Plus 0.0.1]", downloadStatus: "synchronize_ok", requiredVersion: "0.0.1"},
-    {header: "[Adblock Plus 99.9]", downloadStatus: "synchronize_ok", requiredVersion: "99.9"},
-    {header: "[Foo]", downloadStatus: "synchronize_invalid_data", requiredVersion: null}
-  ];
-
-  let runTest = () =>
-  {
-    if (!tests.length)
-      return;
-
-    currentTest = tests.shift();
-
-    resetSubscription(subscription)
-    return this.runScheduledTasks(2).then(() =>
-    {
-      test.equal(subscription.downloadStatus, currentTest.downloadStatus, "Download status for " + currentTest.header);
-      test.equal(subscription.requiredVersion, currentTest.requiredVersion, "Required version for " + currentTest.header);
+exports.testSubscriptionHeaders = {};
+
+for (let currentTest of [
+  {header: "[Adblock]", downloadStatus: "synchronize_ok", requiredVersion: null},
+  {header: "[Adblock Plus]", downloadStatus: "synchronize_ok", requiredVersion: null},
+  {header: "(something)[Adblock]", downloadStatus: "synchronize_ok", requiredVersion: null},
+  {header: "[Adblock Plus 0.0.1]", downloadStatus: "synchronize_ok", requiredVersion: "0.0.1"},
+  {header: "[Adblock Plus 99.9]", downloadStatus: "synchronize_ok", requiredVersion: "99.9"},
+  {header: "[Foo]", downloadStatus: "synchronize_invalid_data", requiredVersion: null}
+])
+{
+  exports.testSubscriptionHeaders[currentTest.header] = function(test)
+  {
+    let subscription = Subscription.fromURL("http://example.com/subscription");
+    FilterStorage.addSubscription(subscription);
+
+    this.registerHandler("/subscription", metadata =>
+    {
+      return [Cr.NS_OK, 200, currentTest.header + "\n!Expires: 8 hours\nfoo\n!bar\n\n@@bas\n#bam"];
+    });
+
+    this.runScheduledTasks(2).then(() =>
+    {
+      test.equal(subscription.downloadStatus, currentTest.downloadStatus, "Download status");
+      test.equal(subscription.requiredVersion, currentTest.requiredVersion, "Required version");
 
       if (currentTest.downloadStatus == "synchronize_ok")
       {
         test.deepEqual(subscription.filters, [
           Filter.fromText("foo"),
           Filter.fromText("!bar"),
           Filter.fromText("@@bas"),
           Filter.fromText("#bam"),
-        ], "Resulting subscription filters for " + currentTest.header);
+        ], "Resulting subscription filters");
       }
       else
       {
         test.deepEqual(subscription.filters, [
-        ], "Resulting subscription filters for " + currentTest.header);
+        ], "Resulting subscription filters");
       }
-    }).then(runTest);
-  };
-
-  runTest().catch(unexpectedError.bind(test)).then(() => test.done());
-};
+    }).catch(unexpectedError.bind(test)).then(() => test.done());
+  };
+}
 
 exports.testsDisabledUpdates  = function(test)
 {
   Prefs.subscriptions_autoupdate = false;
 
   let subscription = Subscription.fromURL("http://example.com/subscription");
   FilterStorage.addSubscription(subscription);
 
   let requests = 0;
   this.registerHandler("/subscription", metadata =>
   {
     requests++;
     throw new Error("Unexpected request");
   });
 
   this.runScheduledTasks(50).then(() =>
   {
     test.equal(requests, 0, "Request count");
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };
 
-exports.testExpirationTime = function(test)
-{
-  let subscription = Subscription.fromURL("http://example.com/subscription");
-  FilterStorage.addSubscription(subscription);
-
-  let currentTest;
-  let requests = [];
-  this.registerHandler("/subscription", metadata =>
-  {
-    requests.push(this.getTimeOffset());
-    return [Cr.NS_OK, 200, "[Adblock]\nfoo\n!Expires: " + currentTest.expiration + "\nbar"];
-  });
-
-  let tests = [
-    {
-      expiration: "default",
-      randomResult: 0.5,
-      requests: [0 + initialDelay, 5 * 24 +  initialDelay]
-    },
-    {
-      expiration: "1 hours",  // Minimal expiration interval
-      randomResult: 0.5,
-      requests: [0 + initialDelay, 1 + initialDelay, 2 + initialDelay, 3 + initialDelay]
-    },
-    {
-      expiration: "26 hours",
-      randomResult: 0.5,
-      requests: [0 + initialDelay, 26 + initialDelay]
-    },
-    {
-      expiration: "2 days",
-      randomResult: 0.5,
-      requests: [0 + initialDelay, 48 + initialDelay]
-    },
-    {
-      expiration: "20 days",  // Too large, will be corrected
-      randomResult: 0.5,
-      requests: [0 + initialDelay, 14 * 24 + initialDelay]
-    },
-    {
-      expiration: "35 hours",
-      randomResult: 0,        // Changes interval by factor 0.8
-      requests: [0 + initialDelay, 28 + initialDelay]
-    },
-    {
-      expiration: "35 hours",
-      randomResult: 1,        // Changes interval by factor 1.2
-      requests: [0 + initialDelay, 42 + initialDelay]
-    },
-    {
-      expiration: "35 hours",
-      randomResult: 0.25,     // Changes interval by factor 0.9
-      requests: [0 + initialDelay, 32 + initialDelay]
-    },
-    {
-      expiration: "40 hours",
-      randomResult: 0.5,
-      skipAfter: 5 + initialDelay,
-      skip: 10,               // Short break should not increase soft expiration
-      requests: [0 + initialDelay, 40 + initialDelay]
-    },
-    {
-      expiration: "40 hours",
-      randomResult: 0.5,
-      skipAfter: 5 + initialDelay,
-      skip: 30,               // Long break should increase soft expiration
-      requests: [0 + initialDelay, 70 + initialDelay]
-    },
-    {
-      expiration: "40 hours",
-      randomResult: 0.5,
-      skipAfter: 5 + initialDelay,
-      skip: 80,               // Hitting hard expiration, immediate download
-      requests: [0 + initialDelay, 85 + initialDelay]
-    }
-  ]
-
-  let runTest = () =>
-  {
-    if (!tests.length)
-      return;
-
-    currentTest = tests.shift();
-
-    requests = [];
+exports.testExpirationTime = {};
+
+for (let currentTest of [
+  {
+    expiration: "default",
+    randomResult: 0.5,
+    requests: [0 + initialDelay, 5 * 24 +  initialDelay]
+  },
+  {
+    expiration: "1 hours",  // Minimal expiration interval
+    randomResult: 0.5,
+    requests: [0 + initialDelay, 1 + initialDelay, 2 + initialDelay, 3 + initialDelay]
+  },
+  {
+    expiration: "26 hours",
+    randomResult: 0.5,
+    requests: [0 + initialDelay, 26 + initialDelay]
+  },
+  {
+    expiration: "2 days",
+    randomResult: 0.5,
+    requests: [0 + initialDelay, 48 + initialDelay]
+  },
+  {
+    expiration: "20 days",  // Too large, will be corrected
+    randomResult: 0.5,
+    requests: [0 + initialDelay, 14 * 24 + initialDelay]
+  },
+  {
+    expiration: "35 hours",
+    randomResult: 0,        // Changes interval by factor 0.8
+    requests: [0 + initialDelay, 28 + initialDelay]
+  },
+  {
+    expiration: "35 hours",
+    randomResult: 1,        // Changes interval by factor 1.2
+    requests: [0 + initialDelay, 42 + initialDelay]
+  },
+  {
+    expiration: "35 hours",
+    randomResult: 0.25,     // Changes interval by factor 0.9
+    requests: [0 + initialDelay, 32 + initialDelay]
+  },
+  {
+    expiration: "40 hours",
+    randomResult: 0.5,
+    skipAfter: 5 + initialDelay,
+    skip: 10,               // Short break should not increase soft expiration
+    requests: [0 + initialDelay, 40 + initialDelay]
+  },
+  {
+    expiration: "40 hours",
+    randomResult: 0.5,
+    skipAfter: 5 + initialDelay,
+    skip: 30,               // Long break should increase soft expiration
+    requests: [0 + initialDelay, 70 + initialDelay]
+  },
+  {
+    expiration: "40 hours",
+    randomResult: 0.5,
+    skipAfter: 5 + initialDelay,
+    skip: 80,               // Hitting hard expiration, immediate download
+    requests: [0 + initialDelay, 85 + initialDelay]
+  }
+])
+{
+  let testId = `"${currentTest.expiration}"`;
+  if (currentTest.randomResult != 0.5)
+    testId += " with Math.random() returning " + currentTest.randomResult;
+  if (currentTest.skip)
+    testId += " skipping " + currentTest.skip + " hours after " + currentTest.skipAfter + " hours";
+  exports.testExpirationTime[testId] = function(test)
+  {
+    let subscription = Subscription.fromURL("http://example.com/subscription");
+    FilterStorage.addSubscription(subscription);
+
+    let requests = [];
+    this.registerHandler("/subscription", metadata =>
+    {
+      requests.push(this.getTimeOffset());
+      return [Cr.NS_OK, 200, "[Adblock]\nfoo\n!Expires: " + currentTest.expiration + "\nbar"];
+    });
+
     this.randomResult = currentTest.randomResult;
-    resetSubscription(subscription);
 
     let maxHours = Math.round(Math.max.apply(null, currentTest.requests)) + 1;
-    return this.runScheduledTasks(maxHours, currentTest.skipAfter, currentTest.skip).then(() =>
-    {
-      let randomAddendum = (this.randomResult == 0.5 ? "" : " with Math.random() returning " + this.randomResult);
-      let skipAddendum = (typeof currentTest.skip != "number" ? "" : " skipping " + currentTest.skip + " hours after " + currentTest.skipAfter + " hours");
-      test.deepEqual(requests, currentTest.requests, "Requests for \"" + currentTest.expiration + "\"" + randomAddendum + skipAddendum);
-    }).then(runTest);
-  };
-
-  runTest().catch(unexpectedError.bind(test)).then(() => test.done());
-};
-
-exports.testChecksumVerification = function(test)
-{
-  let subscription = Subscription.fromURL("http://example.com/subscription");
-  FilterStorage.addSubscription(subscription);
-
-  let testName, subscriptionBody, expectedResult;
-  let tests = [
-    ["Correct checksum", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\nbar\n", true],
-    ["Wrong checksum", "[Adblock]\n! Checksum: wrongggny6Fn24b7JHsq/A\nfoo\nbar\n", false],
-    ["Empty lines ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\n\nfoo\n\nbar\n\n", true],
-    ["CR LF line breaks treated like LR", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\r\nbar\r\n", true],
-    ["CR line breaks treated like LR", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\rbar\r", true],
-    ["Trailing line break not ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\nbar", false],
-    ["Line breaks between lines not ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoobar", false],
-    ["Lines with spaces not ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\n \nfoo\n\nbar\n", false],
-    ["Extra content in checksum line is part of the checksum", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A foobar\nfoo\nbar\n", false],
-    ["= symbols after checksum are ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A===\nfoo\nbar\n", true],
-    ["Header line is part of the checksum", "[Adblock Plus]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\nbar\n", false],
-    ["Special comments are part of the checksum", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\n! Expires: 1\nfoo\nbar\n", false],
-  ];
-
-  this.registerHandler("/subscription", metadata =>
-  {
-    return [Cr.NS_OK, 200, subscriptionBody];
-  });
-
-  let runTest = () =>
-  {
-    if (!tests.length)
-      return;
-
-    [testName, subscriptionBody, expectedResult] = tests.shift();
-
-    resetSubscription(subscription);
-    return this.runScheduledTasks(2).then(() =>
-    {
-      test.equal(subscription.downloadStatus, expectedResult ? "synchronize_ok" : "synchronize_checksum_mismatch", testName);
-    }).then(runTest);
-  };
-
-  runTest().catch(unexpectedError.bind(test)).then(() => test.done());
-};
-
-exports.testSpecialComments = function(test)
-{
-  let subscription = Subscription.fromURL("http://example.com/subscription");
-  FilterStorage.addSubscription(subscription);
-
-  let comment, check;
-  let tests = [
-    ["! Homepage: http://example.com/", () => test.equal(subscription.homepage, "http://example.com/", "Valid homepage comment")],
-    ["! Homepage: ssh://example.com/", () => test.equal(subscription.homepage, null, "Invalid homepage comment")],
-    ["! Title: foo", function()
-      {
-        test.equal(subscription.title, "foo", "Title comment");
-        test.equal(subscription.fixedTitle, true, "Fixed title");
-      }],
-    ["! Version: 1234", () => test.equal(subscription.version, 1234, "Version comment")]
-  ];
-
-  this.registerHandler("/subscription", metadata =>
-  {
-    return [Cr.NS_OK, 200, "[Adblock]\n" + comment + "\nfoo\nbar"];
-  });
-
-  let runTest = () =>
-  {
-    if (!tests.length)
-      return;
-
-    [comment, check] = tests.shift();
-
-    resetSubscription(subscription);
-    return this.runScheduledTasks(2).then(() =>
-    {
-      check();
+    this.runScheduledTasks(maxHours, currentTest.skipAfter, currentTest.skip).then(() =>
+    {
+      test.deepEqual(requests, currentTest.requests, "Requests");
+    }).catch(unexpectedError.bind(test)).then(() => test.done());
+  };
+}
+
+exports.testChecksumVerification = {};
+
+for (let [testName, subscriptionBody, expectedResult] of [
+  ["Correct checksum", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\nbar\n", true],
+  ["Wrong checksum", "[Adblock]\n! Checksum: wrongggny6Fn24b7JHsq/A\nfoo\nbar\n", false],
+  ["Empty lines ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\n\nfoo\n\nbar\n\n", true],
+  ["CR LF line breaks treated like LR", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\r\nbar\r\n", true],
+  ["CR line breaks treated like LR", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\rbar\r", true],
+  ["Trailing line break not ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\nbar", false],
+  ["Line breaks between lines not ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoobar", false],
+  ["Lines with spaces not ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\n \nfoo\n\nbar\n", false],
+  ["Extra content in checksum line is part of the checksum", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A foobar\nfoo\nbar\n", false],
+  ["= symbols after checksum are ignored", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A===\nfoo\nbar\n", true],
+  ["Header line is part of the checksum", "[Adblock Plus]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\nfoo\nbar\n", false],
+  ["Special comments are part of the checksum", "[Adblock]\n! Checksum: e/JCmqXny6Fn24b7JHsq/A\n! Expires: 1\nfoo\nbar\n", false],
+])
+{
+  exports.testChecksumVerification[testName] = function(test)
+  {
+    let subscription = Subscription.fromURL("http://example.com/subscription");
+    FilterStorage.addSubscription(subscription);
+
+    this.registerHandler("/subscription", metadata =>
+    {
+      return [Cr.NS_OK, 200, subscriptionBody];
+    });
+
+    this.runScheduledTasks(2).then(() =>
+    {
+      test.equal(subscription.downloadStatus, expectedResult ? "synchronize_ok" : "synchronize_checksum_mismatch");
+    }).catch(unexpectedError.bind(test)).then(() => test.done());
+  };
+}
+
+exports.testSpecialComments = {};
+
+for (let [comment, check] of [
+  ["! Homepage: http://example.com/", (test, subscription) =>
+  {
+    test.equal(subscription.homepage, "http://example.com/", "Valid homepage comment");
+  }],
+  ["! Homepage: ssh://example.com/", (test, subscription) =>
+  {
+    test.equal(subscription.homepage, null, "Invalid homepage comment");
+  }],
+  ["! Title: foo", (test, subscription) =>
+    {
+      test.equal(subscription.title, "foo", "Title comment");
+      test.equal(subscription.fixedTitle, true, "Fixed title");
+    }],
+  ["! Version: 1234", (test, subscription) =>
+  {
+    test.equal(subscription.version, 1234, "Version comment");
+  }]
+])
+{
+  exports.testSpecialComments[comment] = function(test)
+  {
+    let subscription = Subscription.fromURL("http://example.com/subscription");
+    FilterStorage.addSubscription(subscription);
+
+    this.registerHandler("/subscription", metadata =>
+    {
+      return [Cr.NS_OK, 200, "[Adblock]\n" + comment + "\nfoo\nbar"];
+    });
+
+    this.runScheduledTasks(2).then(() =>
+    {
+      check(test, subscription);
       test.deepEqual(subscription.filters, [Filter.fromText("foo"), Filter.fromText("bar")], "Special comment not added to filters");
-    }).then(runTest);
-  };
-
-  runTest().catch(unexpectedError.bind(test)).then(() => test.done());
-};
+    }).catch(unexpectedError.bind(test)).then(() => test.done());
+  };
+}
 
 exports.testRedirects = function(test)
 {
   let subscription = Subscription.fromURL("http://example.com/subscription");
   FilterStorage.addSubscription(subscription);
 
   this.registerHandler("/subscription", metadata =>
   {
     return [Cr.NS_OK, 200, "[Adblock]\nfoo\n!Redirect: http://example.com/redirected\nbar"];
   });
@@ skipping 196 matching lines @@
     return this.runScheduledTasks(24);
   }).then(() =>
   {
     test.equal(subscription.downloadStatus, "synchronize_connection_error", "downloadStatus after download error");
     test.equal(subscription.lastDownload * MILLIS_IN_SECOND, startTime + (26 + initialDelay) * MILLIS_IN_HOUR, "lastDownload after download error");
     test.equal(subscription.lastSuccess * MILLIS_IN_SECOND, startTime + initialDelay * MILLIS_IN_HOUR, "lastSuccess after download error");
     test.equal(subscription.lastCheck * MILLIS_IN_SECOND, startTime + (27 + initialDelay) * MILLIS_IN_HOUR, "lastCheck after download error");
     test.equal(subscription.errors, 2, "errors after download error");
   }).catch(unexpectedError.bind(test)).then(() => test.done());
 };