node: Add support for installing unpacked addons at runtime in Firefo…

…x webdriver (#10216) * node: Add support for installing unpacked addons at runtime in Firefox webdriver * Move example webextension files to //common/extensions
SeleniumHQ · Jan 10, 2022 · 3b67ff7 · 3b67ff7
1 parent 5d2f6c6
commit 3b67ff7
Show file tree

Hide file tree

Showing 14 changed files with 93 additions and 35 deletions.
diff --git a/common/extensions/BUILD.bazel b/common/extensions/BUILD.bazel
@@ -0,0 +1,10 @@
+filegroup(
+    name = "extensions",
+    srcs = glob([
+        "*",
+        "**/*",
+    ]),
+    visibility = [
+        "//javascript/node/selenium-webdriver:__pkg__",
+    ],
+)
diff --git a/...ver/lib/test/data/chrome/webextension.crx → ...nsions/webextensions-selenium-example.crx b/...ver/lib/test/data/chrome/webextension.crx → ...nsions/webextensions-selenium-example.crx
diff --git a/...er/lib/test/data/firefox/webextension.xpi → ...nsions/webextensions-selenium-example.xpi b/...er/lib/test/data/firefox/webextension.xpi → ...nsions/webextensions-selenium-example.xpi
diff --git a/...er/lib/test/data/firefox/webextension.zip → ...nsions/webextensions-selenium-example.zip b/...er/lib/test/data/firefox/webextension.zip → ...nsions/webextensions-selenium-example.zip
diff --git a/common/extensions/webextensions-selenium-example/inject.js b/common/extensions/webextensions-selenium-example/inject.js
@@ -0,0 +1,6 @@
+((function(document) {
+  var div = document.createElement('div');
+  div.id = 'webextensions-selenium-example'
+  div.textContent = "Content injected by webextensions-selenium-example";
+  document.body.appendChild(div);
+})(document))
diff --git a/common/extensions/webextensions-selenium-example/manifest.json b/common/extensions/webextensions-selenium-example/manifest.json
@@ -0,0 +1,17 @@
+{
+  "manifest_version": 2,
+  "name": "webextensions-selenium-example",
+  "description": "Inject a div with id webextensions-selenium-example to verify that WebExtensions work in Firefox/Selenium" ,
+  "version": "0.1",
+  "content_scripts": [
+    {
+      "matches": ["https://*/*","http://*/*"],
+      "js": ["inject.js"]
+    }
+  ],
+  "applications": {
+   "gecko": {
+     "id": "webextensions-selenium-example@example.com"
+   }
+ }
+}
diff --git a/javascript/node/selenium-webdriver/BUILD.bazel b/javascript/node/selenium-webdriver/BUILD.bazel
@@ -72,6 +72,7 @@ jasmine_node_test(
     data = TEST_DATA + [
         "tools/init_jasmine.js",
         "//common/src/web",
+        "//common/extensions",
         "@npm//express",
         "@npm//multer",
         "@npm//serve-index",

diff --git a/javascript/node/selenium-webdriver/firefox.js b/javascript/node/selenium-webdriver/firefox.js
@@ -116,6 +116,7 @@
 
 'use strict'
 
+const fs = require('fs')
 const path = require('path')
 const Symbols = require('./lib/symbols')
 const command = require('./lib/command')
@@ -670,7 +671,15 @@ class Driver extends webdriver.WebDriver {
    * @see #uninstallAddon
    */
   async installAddon(path, temporary = false) {
-    let buf = await io.read(path)
+    let stats = fs.statSync(path)
+    let buf;
+    if (stats.isDirectory()) {
+      let zip = new Zip()
+      await zip.addDir(path)
+      buf = await zip.toBuffer('DEFLATE')
+    } else {
+      buf = await io.read(path)
+    }
     return this.execute(
       new command.Command(ExtensionCommand.INSTALL_ADDON)
         .setParameter('addon', buf.toString('base64'))

diff --git a/javascript/node/selenium-webdriver/lib/test/data/chrome/download.bin b/javascript/node/selenium-webdriver/lib/test/data/chrome/download.bin
diff --git a/javascript/node/selenium-webdriver/test/chrome/devtools_test.js b/javascript/node/selenium-webdriver/test/chrome/devtools_test.js
@@ -162,18 +162,18 @@ test.suite(
         const dir = await io.tmpDir()
         await driver.setDownloadPath(dir)
 
-        const url = fileServer.whereIs('/data/firefox/webextension.xpi')
+        const url = fileServer.whereIs('/data/chrome/download.bin')
         await driver.get(`data:text/html,<!DOCTYPE html>
   <div><a download="" href="${url}">Go!</a></div>`)
 
         await driver.findElement({ css: 'a' }).click()
 
-        const downloadPath = path.join(dir, 'webextension.xpi')
+        const downloadPath = path.join(dir, 'download.bin')
         await driver.wait(() => io.exists(downloadPath), 5000)
 
         const goldenPath = path.join(
           __dirname,
-          '../../lib/test/data/firefox/webextension.xpi'
+          '../../lib/test/data/chrome/download.bin'
         )
         assert.strictEqual(
           fs.readFileSync(downloadPath, 'binary'),

diff --git a/javascript/node/selenium-webdriver/test/chrome/options_test.js b/javascript/node/selenium-webdriver/test/chrome/options_test.js
@@ -24,11 +24,10 @@ const path = require('path')
 const chrome = require('../../chrome')
 const symbols = require('../../lib/symbols')
 const test = require('../../lib/test')
+const { locate } = require('../../lib/test/resources')
 
-const WEBEXTENSION_CRX = path.join(
-  __dirname,
-  '../../lib/test/data/chrome/webextension.crx'
-)
+const WEBEXTENSION_CRX = locate(
+  'common/extensions/webextensions-selenium-example.crx')
 
 describe('chrome.Options', function () {
   describe('addArguments', function () {

diff --git a/javascript/node/selenium-webdriver/test/edge/options_test.js b/javascript/node/selenium-webdriver/test/edge/options_test.js
@@ -24,11 +24,10 @@ const path = require('path')
 const edge = require('../../edge')
 const symbols = require('../../lib/symbols')
 const test = require('../../lib/test')
+const { locate } = require('../../lib/test/resources')
 
-const WEBEXTENSION_CRX = path.join(
-  __dirname,
-  '../../lib/test/data/chrome/webextension.crx'
-)
+const WEBEXTENSION_CRX = locate(
+  'common/extensions/webextensions-selenium-example.crx')
 
 describe('edge.Options', function () {
   describe('addArguments', function () {

diff --git a/javascript/node/selenium-webdriver/test/firefox_test.js b/javascript/node/selenium-webdriver/test/firefox_test.js
@@ -25,15 +25,14 @@ const io = require('../io')
 const { Browser } = require('../')
 const { Context } = require('../firefox')
 const { Pages, suite } = require('../lib/test')
+const { locate } = require('../lib/test/resources')
 
-const WEBEXTENSION_EXTENSION_XPI = path.join(
-  __dirname,
-  '../lib/test/data/firefox/webextension.xpi'
-)
-const WEBEXTENSION_EXTENSION_ZIP = path.join(
-  __dirname,
-  '../lib/test/data/firefox/webextension.zip'
-)
+const WEBEXTENSION_EXTENSION_XPI = locate(
+  'common/extensions/webextensions-selenium-example.xpi')
+const WEBEXTENSION_EXTENSION_ZIP = locate(
+  'common/extensions/webextensions-selenium-example.zip')
+const WEBEXTENSION_EXTENSION_DIR = locate(
+  'common/extensions/webextensions-selenium-example')
 
 const WEBEXTENSION_EXTENSION_ID =
   'webextensions-selenium-example@example.com.xpi'
@@ -220,21 +219,40 @@ suite(
         })
       })
 
-      it('addons can be installed and uninstalled at runtime', async function () {
-        driver = env.builder().build()
+      describe('installAddon', function() {
+        beforeEach(function () {
+          driver = env.builder().build()
+        })
+
+        it('addons can be installed and uninstalled at runtime', async function () {
+
+            await driver.get(Pages.echoPage)
+            await verifyWebExtensionNotInstalled()
+
+            let id = await driver.installAddon(WEBEXTENSION_EXTENSION_XPI)
+            await driver.sleep(1000) // Give extension time to install (yuck).
 
-        await driver.get(Pages.echoPage)
-        await verifyWebExtensionNotInstalled()
+            await driver.get(Pages.echoPage)
+            await verifyWebExtensionWasInstalled()
 
-        let id = await driver.installAddon(WEBEXTENSION_EXTENSION_XPI)
-        await driver.sleep(1000) // Give extension time to install (yuck).
+            await driver.uninstallAddon(id)
+            await driver.get(Pages.echoPage)
+            await verifyWebExtensionNotInstalled()
+          })
 
-        await driver.get(Pages.echoPage)
-        await verifyWebExtensionWasInstalled()
+        it('unpacked addons can be installed and uninstalled at runtime', async function () {
+          await driver.get(Pages.echoPage)
+          await verifyWebExtensionNotInstalled()
 
-        await driver.uninstallAddon(id)
-        await driver.get(Pages.echoPage)
-        await verifyWebExtensionNotInstalled()
+          let id = await driver.installAddon(WEBEXTENSION_EXTENSION_DIR, true)
+
+          await driver.get(Pages.echoPage)
+          await verifyWebExtensionWasInstalled()
+
+          await driver.uninstallAddon(id)
+          await driver.get(Pages.echoPage)
+          await verifyWebExtensionNotInstalled()
+        })
       })
 
       async function verifyUserAgentWasChanged() {

diff --git a/javascript/node/selenium-webdriver/test/io/zip_test.js b/javascript/node/selenium-webdriver/test/io/zip_test.js
@@ -24,11 +24,10 @@ const path = require('path')
 const io = require('../../io')
 const zip = require('../../io/zip')
 const { InvalidArgumentError } = require('../../lib/error')
+const { locate } = require('../../lib/test/resources')
 
-const XPI_PATH = path.join(
-  __dirname,
-  '../../lib/test/data/firefox/webextension.xpi'
-)
+const XPI_PATH = locate(
+  'common/extensions/webextensions-selenium-example.xpi')
 
 describe('io/zip', function () {
   describe('unzip', function () {