@eyeo/get-browser-binary 0.5.0 → 0.7.0

package/src/utils.js

@@ -22,7 +22,6 @@ import {promisify} from "util";
 import {exec} from "child_process";
 
 import got from "got";
-import fsExtra from "fs-extra";
 import dmg from "dmg";
 
 /**
@@ -66,7 +65,7 @@ export async function extractDmg(archive, dir) {
   let source = path.join(mpath, target);
   await fs.promises.mkdir(dir);
   try {
-    await fsExtra.copy(source, path.join(dir, target));
+    await fs.promises.cp(source, path.join(dir, target), {recursive: true});
   }
   finally {
     try {
@@ -78,11 +77,6 @@ export async function extractDmg(archive, dir) {
   }
 }
 
-export async function getBrowserVersion(driver) {
-  let version = (await driver.getCapabilities()).getBrowserVersion();
-  return version ? parseInt(version.split(".")[0], 10) : null;
-}
-
 // Useful to unlock the driver file before replacing it or executing it
 export async function killDriverProcess(driverName) {
   let cmd = `kill $(pgrep ${driverName})`;

package/test/browsers.js

@@ -21,19 +21,17 @@ import path from "path";
 
 import {BROWSERS, snapshotsBaseDir} from "../index.js";
 import {killDriverProcess} from "../src/utils.js";
+import Jimp from "jimp";
 
-// Required to set the driver path on Windows
-import "chromedriver";
-import "geckodriver";
+import "geckodriver"; // Required to set the driver path on Windows
 
 const VERSIONS = {
   chromium: ["latest", "75.0.3770.0", "beta", "dev"],
   firefox: ["latest", "60.0", "beta"],
-  edge: ["latest", "95.0.1020.53", "beta", "dev"],
-  opera: ["latest", "62.0.3331.66"]
+  edge: ["latest", "95.0.1020.40", "beta", "dev"]
 };
 const TEST_URL = "https://gitlab.com/eyeo/developer-experience/get-browser-binary";
-let extensionPaths = [path.resolve(process.cwd(), "test", "extension")];
+const TEST_URL_LONG_PAGE = "https://abptestpages.org/";
 
 async function switchToHandle(driver, testFn) {
   for (let handle of await driver.getAllWindowHandles()) {
@@ -45,7 +43,6 @@ async function switchToHandle(driver, testFn) {
     catch (e) {
       continue;
     }
-
     if (testFn(url))
       return handle;
   }
@@ -91,11 +88,28 @@ expect.extend({
   }
 });
 
-for (let browser of Object.keys(BROWSERS)) {
-  describe(`Browser: ${browser}`, function() {
-    this.timeout(150000);
+function getExtension(browser, version) {
+  let manifest = "mv2";
+  // The latest Edge installed on the Gitlab Windows Shared Runners is Edge 79,
+  // which does not support manifest v3. More info:
+  // https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/issues/29
+  let windowsSharedRunners =
+    browser == "edge" && process.platform == "win32" && process.env.CI_JOB_ID;
+  if (["chromium", "edge"].includes(browser) &&
+      ["latest", "beta", "dev"].includes(version) && !windowsSharedRunners)
+    manifest = "mv3";
+
+  let extensionPaths =
+    [path.resolve(process.cwd(), "test", "extension", manifest)];
+  return {extensionPaths, manifest};
+}
 
+for (let browser of Object.keys(BROWSERS)) {
+  describe(`Browser: ${browser}`, () => {
     before(async() => {
+      if (process.env.TEST_KEEP_SNAPSHOTS == "true")
+        return;
+
       try {
         await fs.promises.rm(snapshotsBaseDir, {recursive: true});
       }
@@ -121,16 +135,13 @@ for (let browser of Object.keys(BROWSERS)) {
 
         afterEach(quitDriver);
 
-        it("downloads", async function() {
+        it("installs", async function() {
           if (browser == "edge" && process.platform == "win32")
             this.skip();
 
           let {binary, versionNumber} =
-            await BROWSERS[browser].downloadBinary(version);
-          let browserName =
-            browser == "opera" ? /(opera|Opera)/ :
-            browser == "edge" ? /(edge|Edge)/ :
-            browser;
+            await BROWSERS[browser].installBrowser(version);
+          let browserName = browser == "edge" ? /(edge|Edge)/ : browser;
           expect(binary).toEqual(expect.stringMatching(browserName));
 
           let installedVersion =
@@ -143,8 +154,7 @@ for (let browser of Object.keys(BROWSERS)) {
           let names = {
             chromium: "chrome",
             firefox: "firefox",
-            edge: /(MicrosoftEdge|msedge)/,
-            opera: /(opera|chrome)/
+            edge: /(MicrosoftEdge|msedge)/
           };
 
           driver = await BROWSERS[browser].getDriver(version);
@@ -172,8 +182,22 @@ for (let browser of Object.keys(BROWSERS)) {
           expect(sizeDevToolsOpen).toMeasureLessThan(sizeDevToolsClosed);
         });
 
+        it("takes a full page screenshot", async() => {
+          driver = await BROWSERS[browser].getDriver(version);
+          await driver.navigate().to(TEST_URL_LONG_PAGE);
+
+          let fullImg = await BROWSERS[browser].takeFullPageScreenshot(driver);
+          // Taking a regular webdriver screenshot, which should be shorter
+          let data = await driver.takeScreenshot();
+          let partImg = await Jimp.read(Buffer.from(data, "base64"));
+
+          expect(fullImg.bitmap.width).toBeGreaterThan(0);
+          expect(fullImg.bitmap.height).toBeGreaterThan(partImg.bitmap.height);
+        });
+
         it("loads an extension", async() => {
           let headless = browser == "firefox";
+          let {extensionPaths} = getExtension(browser, version);
 
           driver = await BROWSERS[browser].getDriver(
             version, {headless, extensionPaths});
@@ -184,24 +208,25 @@ for (let browser of Object.keys(BROWSERS)) {
           if (browser == "firefox" && version == "60.0")
             this.skip();
 
+          let {extensionPaths, manifest} = getExtension(browser, version);
           driver = await BROWSERS[browser].getDriver(
             version, {headless: false, extensionPaths, incognito: true});
           await BROWSERS[browser].enableExtensionInIncognito(
-            driver, "Browser download test extension"
+            driver, `Browser test extension - ${manifest}`
           );
           await getHandle(driver, "/index.html");
         });
       });
     }
 
-    it("does not download unsupported versions", async function() {
+    it("does not install unsupported versions", async function() {
       if (browser == "edge" && process.platform == "win32")
         this.skip();
 
-      const UNSUPPORTED = "0.0";
-
-      await expect(BROWSERS[browser].downloadBinary(UNSUPPORTED))
-        .rejects.toThrow(`Unsupported browser version: ${UNSUPPORTED}`);
+      for (let unsupported of ["0.0", "invalid"]) {
+        await expect(BROWSERS[browser].installBrowser(unsupported))
+          .rejects.toThrow(`Unsupported browser version: ${unsupported}`);
+      }
     });
   });
 }

package/test/extension/mv2/index.html

@@ -0,0 +1 @@
+<h1>Browser test extension - mv2</h1>

package/test/extension/{manifest.json → mv2/manifest.json}

@@ -1,7 +1,6 @@
 {
-  "name": "Browser download test extension",
+  "name": "Browser test extension - mv2",
   "version": "0.1",
-  "description": "Browser download test extension",
   "manifest_version": 2,
   "background": {
     "scripts": ["background.js"]

package/test/extension/mv3/background.js

@@ -0,0 +1,3 @@
+"use strict";
+
+chrome.tabs.create({url: "index.html"});

package/test/extension/mv3/index.html

@@ -0,0 +1 @@
+<h1>Browser test extension - mv3</h1>

package/test/extension/mv3/manifest.json

@@ -0,0 +1,8 @@
+{
+  "name": "Browser test extension - mv3",
+  "version": "0.1",
+  "manifest_version": 3,
+  "background": {
+    "service_worker": "background.js"
+  }
+}

package/test/extension/index.html

@@ -1 +0,0 @@
-<h1>Browser download test extension</h1>