Issue 6930 - Add support for Microsoft Edge to WebDriver-based test automation

test/all.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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";
 
 const glob = require("glob");
 const path = require("path");
+const os = require("os");
 const {exec} = require("child_process");
 
 function getBrowserBinaries(module, browser)
 {
   let spec = process.env[`${browser.toUpperCase()}_BINARY`];
+
+  if (browser == "edge")

[Sebastian Noack, 2018/12/06 03:47:31]

Nit: This can go at the very top of the function.

+    return [{version: "installed", getPath: () => Promise.resolve(null)}];

[Sebastian Noack, 2018/12/06 03:47:31]

Nit: The version property only exists to distinguish the oldest and latest
version of Chromium and Firefox. I think we should just omit it here (since we
only run the tests on one version of Microsoft Edge, rather than having it
listed as "Edge (installed)" in the test output.

+
   if (spec)
   {
     if (spec == "installed")
       return [{getPath: () => Promise.resolve(null)}];
     if (spec.startsWith("path:"))
       return [{getPath: () => Promise.resolve(spec.substr(5))}];
     if (spec.startsWith("download:"))
       return [{getPath: () => module.ensureBrowser(spec.substr(9))}];
   }
 
@@ skipping 11 matching lines @@
 
 for (let backend of glob.sync("./test/browsers/*.js"))
 {
   let module = require(path.resolve(backend));
   let browser = path.basename(backend, ".js");
   let devenvCreated = null;
 
   for (let binary of getBrowserBinaries(module, browser))
   {
     let description = browser.replace(/./, c => c.toUpperCase());
+    let describeTest = module.platform == "edge" && os.platform() != "win32" ?
+      describe.skip : describe;

[Sebastian Noack, 2018/12/06 03:47:31]

Is this sufficient? I suppose the before() hook would still run and fail for
Microsoft Edge on platforms other than Windows.

+
     if (binary.version)
       description += ` (${binary.version})`;
 
-    describe(description, function()
+    describeTest(description, function()
     {
       this.timeout(0);
 
       before(function()
       {
         if (!devenvCreated)
           devenvCreated = new Promise((resolve, reject) =>
           {
             exec(
               `bash -c "python build.py devenv -t ${module.platform}"`,
               (error, stdout, stderr) =>
               {
                 if (error)
                 {
                   console.error(stderr);
                   reject(error);
                 }
                 else resolve(stdout);
               }
             );
           });
 
         return Promise.all([binary.getPath(), devenvCreated]).then(
           ([browserBinary]) =>
           {
+            if (module.platform == "edge" && os.platform() == "win32")
+            {
+              return module
+                .sideloadExtension(`devenv.${module.platform}`)
+                .then(extensionPath =>
+                {
+                  this.driver = module.getDriver(extensionPath);
+
+                  return this.driver.sleep(3000)

[Sebastian Noack, 2018/12/06 03:47:30]

Is this really necessary? Or is there any promise we could wait for? If not,
retrying would be at least better than a fixed delay.

+                    .then(() => this.driver.wait(() =>
+                      this.driver.getAllWindowHandles()
+                        .then(handles => handles[1])));
+                });
+            }
+
             this.driver = module.getDriver(
               browserBinary,
               path.resolve(`./devenv.${module.platform}`)
             );
             return this.driver.wait(() =>
               this.driver.getAllWindowHandles().then(handles => handles[1])
             );
           }
         ).then(handle =>
           this.driver.switchTo().window(handle)
@@ skipping 14 matching lines @@
       }
 
       after(function()
       {
         if (this.driver)
           return this.driver.quit();
       });
     });
   }
 }