Issue 4878 - Start using ESLint for adblockpluscore

test/_common.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 fs = require("fs");
-let path = require("path");
-let SandboxedModule = require("sandboxed-module");
+const fs = require("fs");
+const path = require("path");
+const SandboxedModule = require("sandboxed-module");
 
 const Cr = exports.Cr = {
   NS_OK: 0,
   NS_BINDING_ABORTED: 0x804B0002,
   NS_ERROR_FAILURE: 0x80004005
 };
 
 const MILLIS_IN_SECOND = exports.MILLIS_IN_SECOND = 1000;
 const MILLIS_IN_MINUTE = exports.MILLIS_IN_MINUTE = 60 * MILLIS_IN_SECOND;
 const MILLIS_IN_HOUR = exports.MILLIS_IN_HOUR = 60 * MILLIS_IN_MINUTE;
 
 function URL(urlString)
 {
   return require("url").parse(urlString);
 }
 
+let Services = {
+  obs: {
+    addObserver() {}
+  },
+  vc: {
+    compare(v1, v2)
+    {
+      function comparePart(p1, p2)
+      {
+        if (p1 != "*" && p2 == "*")
+          return -1;
+        else if (p1 == "*" && p2 != "*")
+          return 1;
+        else if (p1 == p2)
+          return 0;
+        return parseInt(p1, 10) - parseInt(p2, 10);
+      }
+
+      let parts1 = v1.split(".");
+      let parts2 = v2.split(".");
+      for (let i = 0; i < Math.max(parts1.length, parts2.length); i++)
+      {
+        let result = comparePart(parts1[i] || "0", parts2[i] || "0");
+        if (result != 0)
+          return result;
+      }
+      return 0;
+    }
+  }
+};
+let XPCOMUtils = {
+  generateQI() {}
+};
+let FileUtils = {};
+let resources = {Services, XPCOMUtils, FileUtils};
+
 let globals = {
   atob: data => new Buffer(data, "base64").toString("binary"),
   btoa: data => new Buffer(data, "binary").toString("base64"),
   Ci: {
   },
   Cu: {
-    import() {},
+    import(resource)
+    {
+      let match = /^resource:\/\/gre\/modules\/(.+)\.jsm$/.exec(resource);
+      let resourceName = match && match[1];
+      if (resourceName && resources.hasOwnProperty(resourceName))
+        return {[resourceName]: resources[resourceName]};
+
+      throw new Error(
+        "Attempt to import unknown JavaScript module " + resource
+      );
+    },
     reportError(e) {}
   },
   console: {
     log() {},
     error() {}
   },
   navigator: {
   },
   onShutdown: {
     add() {}
-  },
-  Services: {
-    obs: {
-      addObserver() {}
-    },
-    vc: {
-      compare(v1, v2)
-      {
-        function comparePart(p1, p2)
-        {
-          if (p1 != "*" && p2 == "*")
-            return -1;
-          else if (p1 == "*" && p2 != "*")
-            return 1;
-          else if (p1 == p2)
-            return 0;
-          return parseInt(p1, 10) - parseInt(p2, 10);
-        }
-
-        let parts1 = v1.split(".");
-        let parts2 = v2.split(".");
-        for (let i = 0; i < Math.max(parts1.length, parts2.length); i++)
-        {
-          let result = comparePart(parts1[i] || "0", parts2[i] || "0");
-          if (result != 0)
-            return result;
-        }
-        return 0;
-      }
-    }
-  },
-  XPCOMUtils: {
-    generateQI() {}
   },
   URL
 };
 
 let knownModules = new Map();
 for (let dir of [path.join(__dirname, "stub-modules"),
                  path.join(__dirname, "..", "lib")])
 {
   for (let file of fs.readdirSync(path.resolve(dir)))
   {
@@ skipping 298 matching lines @@
       nsIHttpChannel: () => null
     },
     Cr,
     XMLHttpRequest,
     Date: {
       now: () => currentTime
     }
   };
 };
 
-/* eslint-disable no-console */

[Sebastian Noack, 2017/02/21 09:19:32]

Why is this necessary anyway? We shouldn't have any occurrence of console.log()
anymore. And ESLint makes sure that we don't regress.

[kzar, 2017/02/21 10:37:03]

Honestly I'm not sure why but when running our unit tests console.warn is not
defined, so I map it to console.log here.

[Sebastian Noack, 2017/02/21 11:11:56]

Please first figure out what's going on here. Perhaps another limitation of
PhantomJS? At least, Node.js does have console.warn(). But then, don't we only
run content scripts with PhantomJS, while we have no consle.warn() in there?

If there is really no way around that hack, I might prefer to just disable the
no-console rule for the tests, as you already have an .eslintrc.json in the
tests directory, where you already disable other rules anyway.

[kzar, 2017/02/21 11:27:41]

Well I've tried but I couldn't figure it out. I start Node.js and confirmed
console.warn worked as I expected. Then I ran the tests and I get this trace (I
stripped the paths):

TypeError: console.warn is not a function
    at verifySignature (.../adblockpluscore/lib/rsa.js:200:13)
    at Object.exports.testVeryLongData
(.../adblockpluscore/test/signatures.js:129:12)
    at .../adblockpluscore/node_modules/nodeunit/lib/core.js:232:20
    at .../adblockpluscore/node_modules/nodeunit/deps/async.js:168:13
    at .../adblockpluscore/node_modules/nodeunit/deps/async.js:131:25
    at .../adblockpluscore/node_modules/nodeunit/deps/async.js:165:17
    at .../adblockpluscore/node_modules/nodeunit/deps/async.js:463:34
    at Object.exports.setUp (.../adblockpluscore/test/signatures.js:31:3)
    at .../adblockpluscore/node_modules/nodeunit/lib/core.js:260:35
    at .../adblockpluscore/node_modules/nodeunit/deps/async.js:458:21
Done.

 console.warn = console.log;
-/* eslint-enable no-console */
 
 exports.setupRandomResult = function()
 {
   let randomResult = 0.5;
   Object.defineProperty(this, "randomResult", {
     get: () => randomResult,
     set: value => randomResult = value
   });
 
   return {
     Math: {
       random: () => randomResult,
       min: Math.min,
       max: Math.max,
       round: Math.round
     }
   };
 };
 
 exports.unexpectedError = function(error)
 {
   console.error(error);
   this.ok(false, "Unexpected error: " + error);
 };