@eyeo/get-browser-binary 0.2.0 → 0.4.0

package/src/utils.js

@@ -25,6 +25,12 @@ import got from "got";
 import fsExtra from "fs-extra";
 import dmg from "dmg";
 
+/**
+ * Downloads url resources.
+ * @param {string} url - The url of the resource to be downloaded.
+ * @param {string} destFile - The destination file path.
+ * @throws {TypeError} Invalid URL.
+ */
 export async function download(url, destFile) {
   let cacheDir = path.dirname(destFile);
 
@@ -37,7 +43,11 @@ export async function download(url, destFile) {
     await promisify(pipeline)(got.stream(url), writable);
   }
   catch (error) {
-    await fs.promises.rm(tempDest, {recursive: true});
+    try {
+      await fs.promises.rm(tempDest, {recursive: true});
+    }
+    catch (e) {}
+
     throw error;
   }
 
@@ -46,7 +56,7 @@ export async function download(url, destFile) {
 
 export async function extractTar(archive, dir) {
   await fs.promises.mkdir(dir);
-  await promisify(exec)(["tar", "-jxf", archive, "-C", dir].join(" "));
+  await promisify(exec)(`tar -jxf ${archive} -C ${dir}`);
 }
 
 export async function extractDmg(archive, dir) {
@@ -68,13 +78,74 @@ export async function extractDmg(archive, dir) {
   }
 }
 
-export async function runWinInstaller(archive, dir) {
-  // Procedure inspired from mozinstall. Uninstaller will also need to be run.
-  // https://hg.mozilla.org/mozilla-central/file/tip/testing/mozbase/mozinstall/mozinstall/mozinstall.py
-  await promisify(exec)(`"${archive}" /extractdir=${dir}`);
-}
-
 export async function getBrowserVersion(driver) {
   let version = (await driver.getCapabilities()).getBrowserVersion();
-  return parseInt(version.split(".")[0], 10);
+  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})`;
+  let shell;
+  if (process.platform == "win32") {
+    cmd = `Get-Process -Name ${driverName} | Stop-Process; Start-Sleep 1`;
+    shell = "powershell.exe";
+  }
+
+  try {
+    await promisify(exec)(cmd, {shell});
+  }
+  catch (err) {
+    // Command will fail when the driver process is not found
+    if (!err.toString().includes("Command failed"))
+      throw err;
+  }
+}
+
+export function wait(condition, timeout = 0, message, pollTimeout = 100) {
+  if (typeof condition !== "function")
+    throw TypeError("Wait condition must be a function");
+
+  function evaluateCondition() {
+    return new Promise((resolve, reject) => {
+      try {
+        resolve(condition(this));
+      }
+      catch (ex) {
+        reject(ex);
+      }
+    });
+  }
+
+  let result = new Promise((resolve, reject) => {
+    let startTime = Date.now();
+    let pollCondition = async() => {
+      evaluateCondition().then(value => {
+        let elapsed = Date.now() - startTime;
+        if (value) {
+          resolve(value);
+        }
+        else if (timeout && elapsed >= timeout) {
+          try {
+            let timeoutMessage = message ?
+              `${typeof message === "function" ? message() : message}\n` : "";
+            reject(
+              new Error(`${timeoutMessage}Wait timed out after ${elapsed}ms`)
+            );
+          }
+          catch (ex) {
+            reject(
+              new Error(`${ex.message}\nWait timed out after ${elapsed}ms`)
+            );
+          }
+        }
+        else {
+          setTimeout(pollCondition, pollTimeout);
+        }
+      }, reject);
+    };
+    pollCondition();
+  });
+
+  return result;
 }

package/test/browsers.js

@@ -0,0 +1,163 @@
+/*
+ * Copyright (c) 2006-present eyeo GmbH
+ *
+ * This module is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import fs from "fs";
+import expect from "expect";
+import path from "path";
+
+import {BROWSERS, snapshotsBaseDir} from "../index.js";
+import {killDriverProcess} from "../src/utils.js";
+
+// Required to set the driver path on Windows
+import "chromedriver";
+import "geckodriver";
+import "msedgedriver";
+
+const VERSIONS = {
+  chromium: [void 0, "77.0.3865.0", "beta", "dev"],
+  firefox: [void 0, "68.0", "beta"],
+  edge: [void 0, "95.0.1020.53", "beta", "dev"],
+  opera: [void 0, "64.0.3417.92"]
+};
+const TEST_URL = "https://gitlab.com/eyeo/developer-experience/get-browser-binary";
+let extensionPaths = [path.resolve(process.cwd(), "test", "extension")];
+
+async function switchToHandle(driver, testFn) {
+  for (let handle of await driver.getAllWindowHandles()) {
+    let url;
+    try {
+      await driver.switchTo().window(handle);
+      url = await driver.getCurrentUrl();
+    }
+    catch (e) {
+      continue;
+    }
+
+    if (testFn(url))
+      return handle;
+  }
+}
+
+async function getHandle(driver, page) {
+  let url;
+  let handle = await driver.wait(() => switchToHandle(driver, handleUrl => {
+    if (!handleUrl)
+      return false;
+
+    url = new URL(handleUrl);
+    return url.pathname == page;
+  }), 8000, `${page} did not open`);
+
+  return handle;
+}
+
+function normalize(version) {
+  // Discards any numbers after the third dot. For example, "103.0.5060.134"
+  // will return "103.0.5060", and "68.0" will return "68.0"
+  let normalized = version.split(".").slice(0, 3).join(".");
+  // On Windows, Firefox beta versions look like "103.0b9", but the installed
+  // version returned by the browser is actually "103.0"
+  return normalized.split("b")[0];
+}
+
+for (let browser of Object.keys(BROWSERS)) {
+  describe(`Browser: ${browser}`, function() {
+    this.timeout(40000);
+
+    before(async() => {
+      try {
+        await fs.promises.rm(snapshotsBaseDir, {recursive: true});
+      }
+      catch (e) {}
+    });
+
+    for (let version of VERSIONS[browser]) {
+      describe(`Version: ${version || "latest"}`, () => {
+        let driver = null;
+        afterEach(async() => {
+          if (!driver)
+            return;
+
+          await driver.quit();
+          driver = null;
+          // Some platforms don't immediately kill the driver process
+          if (browser == "chromium")
+            await killDriverProcess("chromedriver");
+          else if (browser == "firefox")
+            await killDriverProcess("geckodriver");
+        });
+
+        it("downloads", async function() {
+          if (browser == "edge" && process.platform != "linux")
+            this.skip();
+
+          let {binary, versionNumber} =
+            await BROWSERS[browser].downloadBinary(version);
+          let browserDir = browser == "opera" ? /(opera|Opera)/ : browser;
+          expect(binary).toEqual(expect.stringMatching(browserDir));
+
+          let installedVersion =
+            await BROWSERS[browser].getInstalledVersion(binary);
+          expect(installedVersion).toEqual(
+            expect.stringContaining(normalize(versionNumber)));
+        });
+
+        it("runs", async() => {
+          let names = {
+            chromium: "chrome",
+            firefox: "firefox",
+            edge: /(MicrosoftEdge|msedge)/,
+            opera: /(opera|chrome)/
+          };
+
+          driver = await BROWSERS[browser].getDriver(version);
+          await driver.navigate().to(TEST_URL);
+
+          expect((await driver.getCapabilities()).getBrowserName())
+            .toEqual(expect.stringMatching(names[browser]));
+        });
+
+        it("supports extra args", async() => {
+          let extraArgs = browser == "firefox" ?
+            ["--devtools"] : ["auto-open-devtools-for-tabs"];
+          driver = await BROWSERS[browser].getDriver(version, {extraArgs});
+          await driver.navigate().to(TEST_URL);
+        });
+
+        it("loads an extension", async() => {
+          let headless = browser == "firefox";
+
+          driver = await BROWSERS[browser].getDriver(
+            version, {headless, extensionPaths});
+          await getHandle(driver, "/index.html");
+        });
+
+        it("loads an extension in incognito mode", async function() {
+          if (browser == "firefox" && version == "68.0")
+            this.skip();
+
+          driver = await BROWSERS[browser].getDriver(
+            version, {headless: false, extensionPaths, incognito: true});
+          await BROWSERS[browser].enableExtensionInIncognito(
+            driver, "Browser download test extension"
+          );
+          await getHandle(driver, "/index.html");
+        });
+      });
+    }
+  });
+}

package/test/docker/Dockerfile

@@ -0,0 +1,20 @@
+FROM node:16-bullseye-slim
+
+# General packages
+RUN apt-get update && apt-get install -y git procps wget unzip bzip2 gnupg
+# xvfb (headful browser run)
+RUN apt-get install -y libgtk-3-0 libxt6 xvfb libnss3 libxss1
+# General browser dependencies
+RUN apt-get install -y libgconf-2-4 libasound2 libgbm1
+# Edge dependencies
+RUN apt-get install -y fonts-liberation libatomic1 xdg-utils
+# Opera dependencies
+RUN apt-get install -y libcurl4 libgdk-pixbuf2.0-0
+
+COPY package*.json get-browser-binary/
+RUN cd get-browser-binary && npm install
+
+COPY . get-browser-binary/
+
+ENV TEST_ARGS="--grep Browser"
+ENTRYPOINT get-browser-binary/test/docker/entrypoint.sh

package/test/docker/entrypoint.sh

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+cd get-browser-binary
+xvfb-run -a npm test -- $TEST_ARGS

package/test/utils.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2006-present eyeo GmbH
+ *
+ * This module is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import fs from "fs";
+import expect from "expect";
+import path from "path";
+
+import {snapshotsBaseDir, download} from "../index.js";
+
+describe("Utils", () => {
+  it("defines a browser snapshots folder", () => expect(snapshotsBaseDir)
+    .toBe(path.join(process.cwd(), "browser-snapshots")));
+
+  let destFile = path.join(snapshotsBaseDir, "download-test.txt");
+
+  it("downloads resources", async() => {
+    let url = "https://gitlab.com/eyeo/developer-experience/get-browser-binary/-/raw/main/package.json";
+    await download(url, destFile);
+    let contents = await fs.promises.readFile(destFile, {encoding: "utf8"});
+    expect(contents).toEqual(
+      expect.stringContaining("\"name\": \"@eyeo/get-browser-binary\""));
+  });
+
+  it("does not download invalid resources", async() => {
+    expect(download("invalid", destFile)).rejects
+      .toThrow("TypeError [ERR_INVALID_URL]: Invalid URL");
+  });
+});

package/test/runner.js

@@ -1,178 +0,0 @@
-/*
- * Copyright (c) 2006-present eyeo GmbH
- *
- * This module is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-import fs from "fs";
-import expect from "expect";
-import path from "path";
-import {exec} from "child_process";
-import {promisify} from "util";
-
-import {BROWSERS, snapshotsBaseDir} from "../src/browsers.js";
-
-// Required to start the driver on some platforms (e.g. Windows).
-import "chromedriver";
-import "geckodriver";
-import "msedgedriver";
-
-const VERSIONS = {
-  chromium: [void 0, "beta", "dev", "77.0.3865.0"],
-  firefox: [void 0, "beta", "68.0"],
-  edge: [void 0]
-};
-let extensionPaths = [path.resolve(process.cwd(), "test", "extension")];
-
-async function switchToHandle(driver, testFn) {
-  for (let handle of await driver.getAllWindowHandles()) {
-    let url;
-    try {
-      await driver.switchTo().window(handle);
-      url = await driver.getCurrentUrl();
-    }
-    catch (e) {
-      continue;
-    }
-
-    if (testFn(url))
-      return handle;
-  }
-}
-
-async function getHandle(driver, page) {
-  let url;
-  let handle = await driver.wait(() => switchToHandle(driver, handleUrl => {
-    if (!handleUrl)
-      return false;
-
-    url = new URL(handleUrl);
-    return url.pathname == page;
-  }), 8000, `${page} did not open`);
-
-  return handle;
-}
-
-async function killDriverProcess() {
-  for (let name of ["chromedriver", "msedgedriver"]) {
-    let stdout;
-    if (process.platform == "win32") {
-      try {
-        ({stdout} = await promisify(exec)(
-          `(Get-Process -Name ${name}).Id | Stop-Process`,
-          {shell: "powershell.exe"}
-        ));
-      }
-      catch (err) {
-        if (err.toString().includes("Command failed"))
-          continue; // Command will fail when driver process is not found
-
-        throw err;
-      }
-    }
-    else {
-      try {
-        ({stdout} =
-          await promisify(exec)(`ps -a | grep ${name} | grep -v grep`));
-      }
-      catch (err) {
-        if (err.toString().includes("Command failed"))
-          continue; // Command will fail when driver process is not found
-
-        throw err;
-      }
-      let pid = /\s*(\d*)/.exec(stdout)[1]; // first number after any spaces
-      await promisify(exec)(`kill ${pid}`);
-    }
-  }
-}
-
-for (let browser of Object.keys(BROWSERS)) {
-  for (let version of VERSIONS[browser]) {
-    describe(`Browser: ${browser} ${version || "latest"}`, function() {
-      this.timeout(15000);
-
-      before(async() => {
-        try {
-          await fs.promises.rm(snapshotsBaseDir, {recursive: true});
-        }
-        catch (e) {}
-      });
-
-      let driver = null;
-      afterEach(async() => {
-        if (!driver)
-          return;
-
-        await driver.quit();
-        driver = null;
-        // Some platforms don't immediately kill the webdriver process
-        await killDriverProcess();
-      });
-
-      it("downloads", async function() {
-        if (browser == "edge")
-          // Edge download is not implemented. It is assumed to be installed.
-          this.skip();
-
-        this.timeout(40000);
-        let {binary} = await BROWSERS[browser].downloadBinary(version);
-
-        await fs.promises.access(binary);
-        expect(binary).toEqual(
-          expect.stringContaining(path.join(snapshotsBaseDir, browser)));
-      });
-
-      it("runs", async() => {
-        let names = {
-          chromium: "chrome",
-          firefox: "firefox",
-          edge: /(MicrosoftEdge|msedge)/
-        };
-
-        driver = await BROWSERS[browser].getDriver(version);
-        await driver.navigate().to("about:blank");
-
-        expect((await driver.getCapabilities()).getBrowserName())
-          .toEqual(expect.stringMatching(names[browser]));
-      });
-
-      it("supports extra args", async() => {
-        driver = await BROWSERS[browser].getDriver(
-          version, {extraArgs: ["auto-open-devtools-for-tabs"]});
-        await driver.navigate().to("about:blank");
-      });
-
-      it("loads an extension", async() => {
-        let headless = browser == "firefox";
-
-        driver = await BROWSERS[browser].getDriver(
-          version, {headless, extensionPaths});
-        await getHandle(driver, "/index.html");
-      });
-
-      it("loads an extension in incognito mode", async function() {
-        if (browser != "firefox" || version == "68.0")
-          this.skip();
-
-        driver = await BROWSERS[browser].getDriver(
-          version, {headless: false, extensionPaths, incognito: true});
-        await BROWSERS[browser].enableExtensionInIncognito(
-          driver, "Browser download test extension"
-        );
-        await getHandle(driver, "/index.html");
-      });
-    });
-  }
-}