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

test/wrappers/pages.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
@@ skipping 32 matching lines @@
     driver.switchTo().window(goTo).then(() =>
       promiseFinally(
         new Promise(resolve => resolve(callback && callback())),
         () => driver.close()
       )
     ),
     () => driver.switchTo().window(returnTo)
   );
 }
 
-function takeScreenshot(element)
+function takeScreenshot(element, browser)
 {
+  if (/edge/gi.test(browser))
+  {
+    return element.takeScreenshot()
+      .then(s => Jimp.read(Buffer.from(s, "base64")))
+      .then(image => image.bitmap);
+  }
   // It would be preferable if we could use WebElement.takeScreenshot(),
   // but it's not supported on Chrome, and produces incorrect output when
   // called repeatedly, on Firefox >=58 or when using geckodriver >=1.13.
   // So as a workaround, we scroll to the position of the element, take a
   // screenshot of the viewport and crop it to the element's size and position.
   lastScreenshot = Promise.all([element.getRect(),
                                 lastScreenshot]).then(([rect]) =>
     element.getDriver().executeScript(`
       window.scrollTo(${rect.x}, ${rect.y});
       return [window.scrollX, window.scrollY];
@@ skipping 21 matching lines @@
       ])
     ))
   ).then(sections => sections.filter(
     ([title, demo, filters]) => title && demo && filters.length > 0
   ));
 }
 
 it("test pages", function()
 {
   return this.driver.navigate().to(TEST_PAGES_URL).then(() =>
-    this.driver.findElements(By.css(".site-pagelist a"))
+    this.driver.sleep(1000).then(() =>

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

Please retry rather than using delay:

  this.driver.wait(until.elementLocated(By.css(".site-pagelist a"), 1000)

+      this.driver.findElements(By.css(".site-pagelist a"))
+    )
   ).then(elements =>
     Promise.all(elements.map(elem => elem.getAttribute("href")))
   ).then(urls =>
   {
     let p1 = Promise.resolve();
     for (let url of urls)
       p1 = p1.then(() =>
         this.driver.navigate().to(url)
       ).then(() =>
         Promise.all([
           getSections(this.driver),
           this.driver.findElement(By.css("h2")).getAttribute("textContent"),
           this.driver.executeScript("document.body.classList.add('expected');")
         ])
       ).then(([sections, pageTitle]) =>
         Promise.all(sections.map(([title, demo, filters]) =>
           Promise.all([
             title.getAttribute("textContent").then(testTitle =>
               `${pageTitle.trim()} - ${testTitle.trim()}`
             ),
-            takeScreenshot(demo),
+            takeScreenshot(demo, this.test.parent.title),
             Promise.all(filters.map(elem => elem.getAttribute("textContent")))
           ])
         ))
       ).then(testCases =>
       {
         let p2 = Promise.resolve();
+
+        let edgeFailingTests = [
+          "Basic :-abp-has() usage",
+          "Chained extended selectors",
+          "Regular expression in :-abp-properties()",
+          "$object - Test case",
+          "$websocket - Test case",
+          "$webrtc - Test case",
+          "$elemhide Exception - Test case"
+        ];
+
         for (let i = 0; i < testCases.length; i++)
         {
           let [title, expectedScreenshot, filters] = testCases[i];
           let browser = this.test.parent.title.replace(/\s.*$/, "");
 
           if (// https://issues.adblockplus.org/ticket/6917
               title == "$subdocument - Test case" && browser == "Firefox" ||
               // Chromium doesn't support Flash
-              /^\$object(-subrequest)? /.test(title) && browser == "Chromium")
+              /^\$object(-subrequest)? /.test(title) && browser == "Chromium" ||
+              edgeFailingTests.includes(title) || /edge/gi.test(browser))
             continue;
 
           p2 = p2.then(() =>
             this.driver.navigate().to(this.origin + "/options.html")
           ).then(() =>
             this.driver.executeAsyncScript(`
               let filters = arguments[0];
               let callback = arguments[arguments.length - 1];
               browser.runtime.sendMessage({type: "subscriptions.get",
                                            downloadable: true,
                                            special: true}).then(subs =>
               {
                 for (let subscription of subs)
                   browser.runtime.sendMessage({type: "subscriptions.remove",
                                                url: subscription.url});
                 return browser.runtime.sendMessage({type: "filters.importRaw",
                                                     text: filters});
               }).then(() => callback(), callback);
             `, filters.join("\n"))
           ).then(error =>
           {
             if (error)
               throw error;
-            return this.driver.navigate().to(url);
+            return this.driver.sleep(1500)
+              .then(() => this.driver.navigate().to(url));
           }).then(() =>
           {
             if (title.startsWith("$popup "))
             {
               return getSections(this.driver).then(sections =>
                 sections[i][1].findElement(By.css("a[href],button")).click()
               ).then(() =>
                 this.driver.sleep(100)
               ).then(() =>
                 this.driver.getAllWindowHandles()
               ).then(handles =>
               {
                 if (title.startsWith("$popup Exception -"))
                 {
                   assert.equal(handles.length, 3, title);
                   return closeWindow(this.driver, handles[2], handles[1]);
                 }
 
                 assert.equal(handles.length, 2, title);
               });
             }
 
             let checkTestCase = () =>
               getSections(this.driver).then(sections =>
                 this.driver.wait(() =>
-                  takeScreenshot(sections[i][1]).then(screenshot =>
+                  takeScreenshot(sections[i][1], browser).then(screenshot =>
                     screenshot.width == expectedScreenshot.width &&
                     screenshot.height == expectedScreenshot.height &&
                     screenshot.data.compare(expectedScreenshot.data) == 0
                   ), 1000, title
                 )
               );
 
             // Sometimes on Firefox there is a delay until the added
             // filters become effective. So if the test case fails once,
             // we reload the page and try once again.
             return checkTestCase().catch(() =>
               this.driver.navigate().refresh().then(checkTestCase)
             );
           });
         }
         return p2;
       });
     return p1;
   });
 });
 
 it("subscribe link", function()
 {
   return this.driver.navigate().to(TEST_PAGES_URL).then(() =>
     this.driver.findElement(By.id("subscribe-button")).click()
   ).then(() =>
-    this.driver.wait(() =>
+    this.driver.sleep(1000).then(() => this.driver.wait(() =>
       this.driver.getAllWindowHandles().then(handles =>
         handles.length > 2 ? handles : null
       ), 3000
-    )
+    ))
   ).then(handles =>
     closeWindow(this.driver, handles[2], handles[1], () =>
       this.driver.wait(until.ableToSwitchToFrame(0), 1000).then(() =>
         this.driver.wait(
           until.elementLocated(By.id("dialog-content-predefined")), 1000
         )
       ).then(dialog =>
-        Promise.all([
-          dialog.isDisplayed(),
-          dialog.findElement(By.css("h3")).getText()
-        ]).then(([displayed, title]) =>
-        {
-          assert.ok(displayed, "dialog shown");
-          assert.equal(title, "ABP Testcase Subscription", "title matches");
+        this.driver.sleep(1500).then(() =>

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

No delays please, use this.driver.wait() as shown here:
https://gitlab.com/eyeo/adblockplus/adblockpluschrome/merge_requests/9#note_1...

+          Promise.all([
+            dialog.isDisplayed(),
+            dialog.findElement(By.css("h3")).getText()
+          ])).then(([displayed, title]) =>
+          {
+            assert.ok(displayed, "dialog shown");
+            assert.equal(title, "ABP Testcase Subscription", "title matches");
 
-          return dialog.findElement(By.css("button")).click();
-        })
+            return dialog.findElement(By.css("button")).click();
+          })
       ).then(() =>
         this.driver.executeAsyncScript(`
           let callback = arguments[arguments.length - 1];
           browser.runtime.sendMessage({type: "subscriptions.get",
                                        ignoreDisabled: true,
                                        downloadable: true}).then(subs =>
             subs.some(s =>
               s.url == "${TEST_PAGES_URL}abp-testcase-subscription.txt"
             )
           ).then(
             res => callback([res, null]),
             err => callback([null, err])
           );
         `)
       ).then(([added, err]) =>
       {
         if (err)
           throw err;
         assert.ok(added, "subscription added");
       })
     )
   );
 });