Noissue - Automatically test subscription links

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
  * 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 TEST_PAGES_URL = "https://testpages.adblockplus.org/";
 
 const assert = require("assert");
 const Jimp = require("jimp");
 const {By} = require("selenium-webdriver");
 
+// Once we require Node.js >= 10 this should be replaced with
+// the built-in finally() method of the Promise object.
+function promiseFinally(p, callback)
+{
+  return p.then(callback, callback);
+}
+
+function closeWindow(driver, goTo, returnTo, callback)
+{
+  return promiseFinally(
+    driver.switchTo().window(goTo).then(() =>
+      promiseFinally(
+        new Promise(resolve => resolve(callback && callback())),
+        () => driver.close()
+      )
+    ),
+    () => driver.switchTo().window(returnTo)
+  );
+}
+
+function testSubscribeLink(driver)
+{
+  return driver.findElement(By.id("subscribe-button")).click().then(() =>
+    driver.wait(() =>
+      driver.getAllWindowHandles().then(handles =>
+        handles.length > 2 ? handles : null
+      ), 1000
+    )
+  ).then(handles =>
+    closeWindow(driver, handles[2], handles[1], () =>
+      driver.switchTo().frame(0).then(() =>
+        driver.findElement(By.id("dialog-content-predefined"))
+      ).then(dialog =>
+        Promise.all([
+          dialog.isDisplayed(),
+          dialog.findElement(By.css("h3")).getText()
+        ]).then(([displayed, title]) =>
+        {
+          assert.ok(displayed, "subscribe link: dialog shown");
+          assert.equal(title, "ABP Testcase Subscription",
+                       "subscribe link: title shown in dialog");
+
+          return dialog.findElement(By.css("button")).click();
+        })
+      ).then(() =>
+        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.endsWith("${TEST_PAGES_URL.replace(/^[^:]+/, "")}" +
+                             "abp-testcase-subscription.txt")
+            )
+          ).then(
+            res => callback([res, null]),
+            err => callback([null, err])
+          );
+        `)
+      ).then(([added, err]) =>
+      {
+        if (err)
+          throw err;
+        assert.ok(added, "subscribe link: subscription added");
+      })
+    )
+  );
+}
+
 function imageFromBase64(s)
 {
   return Jimp.read(Buffer.from(s, "base64"));
 }
 
 function takeScreenshot(element)
 {
   return element.takeScreenshot().then(
     imageFromBase64,
 
@@ skipping 38 matching lines @@
 }
 
 it("test pages", function()
 {
   return this.driver.navigate().to(TEST_PAGES_URL).then(() =>
     this.driver.findElements(By.css(".site-pagelist a"))
   ).then(elements =>
     Promise.all(elements.map(elem => elem.getAttribute("href")))
   ).then(urls =>
   {
-    let p1 = Promise.resolve();
+    let p1 = testSubscribeLink(this.driver);
     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]) =>
@@ skipping 54 matching lines @@
                 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 this.driver.switchTo().window(handles[2]).then(() =>
-                    this.driver.close()
-                  ).then(() =>
-                    this.driver.switchTo().window(handles[1])
-                  );
+                  return closeWindow(this.driver, handles[2], handles[1]);
                 }
 
                 assert.equal(handles.length, 2, title);
               });
             }
 
             return takeScreenshot(element).then(screenshot =>
               assert.ok(
                 screenshot.width == expectedScreenshot.width &&
                 screenshot.height == expectedScreenshot.height &&
                 screenshot.data.compare(expectedScreenshot.data) == 0,
                 title
               )
             );
           });
         }
         return p2;
       });
     return p1;
   });
 });