Issue 4838 - Use nodeunit framework for integration tests running in browser

browsertests.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2016 Eyeo GmbH
+ * Copyright (C) 2006-2017 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";
 
-try
+(function()
 {
-  var fs = require("fs");
-  var system = require("system");
-  var webpage = require("webpage");
+  // We are currently limited to ECMAScript 5 in this file, because it is being
+  // used in the browser tests. See https://issues.adblockplus.org/ticket/4796
+  // Once this is resolved we should use promises here.
+  function safeCall(callback)
+  {
+    return function()
+    {
+      try
+      {
+        callback.apply(this, arguments);
+      }
+      catch (e)
+      {
+        var message = String(e);
+        if (e.stack)
+          message += "\n" + e.stack;
+        console.log(message);
+        phantom.exit(1);
+      }
+    };
+  }
 
-  var nodeunitUrl = system.args[1];
-  var urls = system.args.slice(2);
+  function loadScript(doc, url, callback)
+  {
+    var script = doc.createElement("script");
+    script.src = url;
+    script.async = false;
+    doc.head.appendChild(script);
+    if (callback)
+      window.setTimeout(callback, 0);
+  }
 
-  // No need to load anything, about:blank will do for us
-  var page = webpage.create();
-  page.evaluate(initPage, nodeunitUrl);
-  window.setTimeout(function()
+  function loadModules(urls, callback)
   {
-    runTests(urls, function()
+    var modules = {};
+
+    var loadNext = safeCall(function()
     {
-      phantom.exit();
+      if (urls.length)
+      {
+        // Load each module into a new frame so that their scopes don't clash
+        var frame = document.createElement("iframe");
+        document.body.appendChild(frame);
+
+        var wnd = frame.contentWindow;
+        wnd.loadScript = loadScript.bind(null, wnd.document);
+        wnd.console = console;
+        wnd.require = require;
+        wnd.exports = {};
+        wnd.module = {exports: wnd.exports};
+
+        var url = urls.shift();
+        var name = url.split("/").pop();
+        wnd.loadScript(url, safeCall(function()
+        {
+          modules[name] = nodeunit.testCase(wnd.module.exports);
+          loadNext();
+        }));
+      }
+      else
+        callback(modules);
     });
-  }, 0);
-}
-catch(e)
-{
-  console.error(e);
-  phantom.exit();
-}
 
-function runTests(urls, callback)
-{
-  page.onError = function(msg, trace)
-  {
-    var message = "Error: " + msg + "\n";
-    if (trace)
-    {
-      for (var i = 0; i < trace.length; i++)
-      {
-        message += "\n  " + trace[i].file + ":" + trace[i].line +
-                   (trace[i].function ? " in function " + trace[i].function
-                                      : " in global code");
-      }
-    }
-    console.error(message);
-  };
+    loadNext();
+  }
 
-  page.onCallback = function(data)
+  function runTests(modules, callback)
   {
     function bold(str)
     {
       return "\u001B[1m" + str + "\u001B[22m";
     }
 
     function ok(str)
     {
       return "\u001B[32m" + str + "\u001B[39m";
     }
 
     function error(str)
     {
       return "\u001B[31m" + str + "\u001B[39m";
     }
 
-    if (data.type == "moduleStart")
-      console.log(bold(data.name));
-    else if (data.type == "testDone")
-    {
-      if (data.failures.length == 0)
-        console.log("\u2714 " + data.name);
-      else
+    nodeunit.runModules(modules, {
+      moduleStart: function(name)
       {
-        console.log(error("\u2716 " + data.name) + "\n");
-        data.failures.forEach(function(failure)
+        console.log(bold(name));
+      },
+      testDone: function(name, assertions)
+      {
+        var errors = assertions.filter(function(assertion)
         {
-          console.log(failure.join("\n") + "\n");
-        })
+          return assertion.failed();
+        }).map(function(assertion)
+        {
+          return assertion.error;
+        });
+
+        if (errors.length == 0)
+          console.log("\u2714 " + name);
+        else
+        {
+          console.log(error("\u2716 " + name) + "\n");
+          errors.forEach(function(error)
+          {
+            console.log(String(error));
+            if (error.stack)
+              console.log(error.stack);
+            console.log("");
+          });
+        }
+      },
+      done: function(assertions)
+      {
+        var failures = assertions.filter(function(assertion)
+        {
+          return assertion.failed();
+        });
+        if (failures.length)
+        {
+          console.log(
+            "\n" +
+            bold(error("FAILURES: ")) +
+            failures.length + "/" + assertions.length + " assertions failed"
+          );
+        }
+        else
+        {
+          console.log(
+            "\n" + bold(ok("OK: ")) +
+            assertions.length + " assertions"
+          );
+        }
+
+        callback(!failures.length);
       }
-    }
-    else if (data.type == "done")
-    {
-      if (data.failures)
-      {
-        console.log(
-          "\n" +
-          bold(error("FAILURES: ")) +
-          data.failures + "/" + data.assertions + " assertions failed"
-        );
-      }
-      else
-      {
-        console.log("\n" + bold(ok("OK: ")) + data.assertions + " assertions");
-      }
-
-      page.close();
-      callback();
-    }
-    else if (data.type == "log")
-    {
-      console.log(data.args.join(" "));
-    }
-    else if (data.type == "error")
-    {
-      console.error(data.args.join(" "));
-    }
-  };
-
-  page.evaluate(runTestsContent, urls);
-}
-
-function initPage(nodeunitUrl)
-{
-  function normalizeArgs(args)
-  {
-    var normalized = [];
-    for (var i = 0; i < args.length; i++)
-    {
-      try
-      {
-        if (typeof args[i] == "string")
-          normalized.push(args[i]);
-        else
-          normalized.push(JSON.stringify(args[i]));
-      }
-      catch (e)
-      {
-        normalized.push(String(args[i]));
-      }
-    }
-    return normalized;
+    });
   }
 
-  window.console = {
-    log: function()
+  function run()
+  {
+    var system = require("system");
+    var nodeunitUrl = system.args[1];
+    var urls = system.args.slice(2);
+
+    loadScript(document, nodeunitUrl, safeCall(function()
     {
-      window.callPhantom({type: "log", args: normalizeArgs(arguments)});
-    },
-    error: function()
-    {
-      window.callPhantom({type: "error", args: normalizeArgs(arguments)});
-    }
-  };
+      loadModules(urls, safeCall(function(modules)
+      {
+        runTests(modules, function(success)
+        {
+          phantom.exit(success ? 0 : 1);
+        });
+      }));
+    }));
+  }
 
-  window.loadScript = function(url, callback)
-  {
-    var script = document.createElement("script");
-    script.src = url;
-    script.async = false;
-    document.head.appendChild(script);
-    if (callback)
-      window.setTimeout(callback, 0);
-  };
-
-  loadScript(nodeunitUrl);
-}
-
-function runTestsContent(urls)
-{
-  var modules = {};
-
-  var loadNext = function()
-  {
-    if (urls.length)
-    {
-      window.exports = {};
-      window.module = {exports: window.exports};
-
-      var url = urls.shift();
-      var name = url.split("/").pop();
-      loadScript(url, function()
-      {
-        modules[name] = nodeunit.testCase(window.module.exports);
-        loadNext();
-      });
-    }
-    else
-    {
-      nodeunit.runModules(modules, {
-        moduleStart: function(name)
-        {
-          window.callPhantom({type: "moduleStart", name: name});
-        },
-        testDone: function(name, assertions)
-        {
-          var failures = assertions.filter(function(assertion)
-          {
-            return assertion.failed();
-          }).map(function(assertion)
-          {
-            return [String(assertion.error), assertion.error.stack];
-          });
-          window.callPhantom({
-            type: "testDone",
-            name: name,
-            failures: failures
-          });
-        },
-        done: function(assertions)
-        {
-          window.callPhantom({
-            type: "done",
-            assertions: assertions.length,
-            failures: assertions.filter(function(assertion)
-            {
-              return assertion.failed();
-            }).length
-          });
-        }
-      });
-    }
-  }
-  loadNext();
-}
+  safeCall(run)();
+})();