add example code for Firefox Addons

Author: titusfortner

.gitignore

@@ -1,9 +1,9 @@
 .idea
 public/
-resources
 node_modules
 .DS_Store
 website_and_docs/.hugo_build.lock
+website_and_docs/resources
 
 **/target/*
 .classpath

examples/dotnet/SeleniumDocs/Browsers/FirefoxTest.cs

@@ -1,4 +1,7 @@
+using System;
+using System.IO;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium;
 using OpenQA.Selenium.Firefox;
 using WebDriverManager;
 using WebDriverManager.DriverConfigs.Impl;
@@ -8,15 +11,69 @@ namespace SeleniumDocs.Browsers
     [TestClass]
     public class FirefoxTest
     {
-        [TestMethod]
-        public void BasicOptions()
+        private FirefoxDriver driver;
+
+        [TestCleanup]
+        public void QuitDriver()
+        {
+            driver.Quit();
+        }
+
+        [TestInitialize]
+        public void SetupDriver()
         {
             new DriverManager().SetUpDriver(new FirefoxConfig());
+        }
 
+        [TestMethod]
+        public void BasicOptions()
+        {
             var options = new FirefoxOptions();
-            var driver = new FirefoxDriver(options);
+            driver = new FirefoxDriver(options);
+        }
 
-            driver.Quit();
+        [TestMethod]
+        public void InstallAddon()
+        {
+            driver = new FirefoxDriver();
+
+            string baseDir = AppDomain.CurrentDomain.BaseDirectory;
+            string extensionFilePath = Path.Combine(baseDir, "../../../Extensions/webextensions-selenium-example.xpi");
+            driver.InstallAddOnFromFile(Path.GetFullPath(extensionFilePath));
+
+            driver.Url = "https://www.selenium.dev/selenium/web/blank.html";
+
+            IWebElement injected = driver.FindElement(By.Id("webextensions-selenium-example"));
+            Assert.AreEqual("Content injected by webextensions-selenium-example", injected.Text);
         }
+
+         [TestMethod]
+         public void UnInstallAddon()
+         {
+             driver = new FirefoxDriver();
+
+             string baseDir = AppDomain.CurrentDomain.BaseDirectory;
+             string extensionFilePath = Path.Combine(baseDir, "../../../extensions/webextensions-selenium-example.xpi");
+             string extensionId = driver.InstallAddOnFromFile(Path.GetFullPath(extensionFilePath));
+             driver.UninstallAddOn(extensionId);
+
+             driver.Url = "https://www.selenium.dev/selenium/web/blank.html";
+             Assert.AreEqual(driver.FindElements(By.Id("webextensions-selenium-example")).Count, 0);
+         }
+
+         [TestMethod]
+         public void InstallUnsignedAddon()
+         {
+             driver = new FirefoxDriver();
+
+             string baseDir = AppDomain.CurrentDomain.BaseDirectory;
+             string extensionDirPath = Path.Combine(baseDir, "../../../extensions/webextensions-selenium-example/");
+             driver.InstallAddOnFromDirectory(Path.GetFullPath(extensionDirPath), true);
+
+             driver.Url = "https://www.selenium.dev/selenium/web/blank.html";
+
+             IWebElement injected = driver.FindElement(By.Id("webextensions-selenium-example"));
+             Assert.AreEqual("Content injected by webextensions-selenium-example", injected.Text);
+         }
     }
 }

examples/dotnet/SeleniumDocs/Extensions/webextensions-selenium-example.xpi

@@ -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))

examples/dotnet/SeleniumDocs/Extensions/webextensions-selenium-example/inject.js

@@ -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": "[email protected]"
+   }
+ }
+}

examples/dotnet/SeleniumDocs/Extensions/webextensions-selenium-example/manifest.json

@@ -2,11 +2,17 @@
 
 import io.github.bonigarcia.wdm.WebDriverManager;
 import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
+import org.openqa.selenium.By;
+import org.openqa.selenium.WebElement;
 import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.firefox.FirefoxOptions;
 
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
 public class FirefoxTest {
     public FirefoxDriver driver;
 
@@ -25,4 +31,37 @@ public void basicOptions() {
         FirefoxOptions options = new FirefoxOptions();
         driver = new FirefoxDriver(options);
     }
+
+    @Test
+    public void installAddon() {
+        driver = new FirefoxDriver();
+        Path xpiPath = Paths.get("src/test/resources/extensions/selenium-example.xpi");
+        driver.installExtension(xpiPath);
+
+        driver.get("https://www.selenium.dev/selenium/web/blank.html");
+        WebElement injected = driver.findElement(By.id("webextensions-selenium-example"));
+        Assertions.assertEquals("Content injected by webextensions-selenium-example", injected.getText());
+    }
+
+    @Test
+    public void uninstallAddon() {
+        driver = new FirefoxDriver();
+        Path xpiPath = Paths.get("src/test/resources/extensions/selenium-example.xpi");
+        String id = driver.installExtension(xpiPath);
+        driver.uninstallExtension(id);
+
+        driver.get("https://www.selenium.dev/selenium/web/blank.html");
+        Assertions.assertEquals(driver.findElements(By.id("webextensions-selenium-example")).size(), 0);
+    }
+
+    @Test
+    public void installUnsignedAddonPath() {
+        driver = new FirefoxDriver();
+        Path path = Paths.get("src/test/resources/extensions/selenium-example");
+        driver.installExtension(path, true);
+
+        driver.get("https://www.selenium.dev/selenium/web/blank.html");
+        WebElement injected = driver.findElement(By.id("webextensions-selenium-example"));
+        Assertions.assertEquals("Content injected by webextensions-selenium-example", injected.getText());
+    }
 }

examples/java/src/test/java/dev/selenium/browsers/FirefoxTest.java

@@ -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))

examples/java/src/test/resources/extensions/selenium-example.xpi

@@ -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": "[email protected]"
+   }
+ }
+}

examples/java/src/test/resources/extensions/selenium-example/inject.js

@@ -1,4 +1,7 @@
+import os
+
 from selenium import webdriver
+from selenium.webdriver.common.by import By
 from selenium.webdriver.firefox.options import Options as FirefoxOptions
 from selenium.webdriver.firefox.service import Service as FirefoxService
 from webdriver_manager.firefox import GeckoDriverManager
@@ -10,3 +13,37 @@ def test_basic_options():
     driver = webdriver.Firefox(options=options, service=service)
 
     driver.quit()
+
+def test_install_addon(firefox_driver):
+    driver = firefox_driver
+
+    path = os.path.abspath("tests/extensions/webextensions-selenium-example.xpi")
+    driver.install_addon(path)
+
+    driver.get("https://www.selenium.dev/selenium/web/blank.html")
+    injected = driver.find_element(By.ID, "webextensions-selenium-example")
+
+    assert injected.text == "Content injected by webextensions-selenium-example"
+
+
+def test_uninstall_addon(firefox_driver):
+    driver = firefox_driver
+
+    path = os.path.abspath("tests/extensions/webextensions-selenium-example.xpi")
+    id = driver.install_addon(path)
+    driver.uninstall_addon(id)
+
+    driver.get("https://www.selenium.dev/selenium/web/blank.html")
+    assert len(driver.find_elements(By.ID, "webextensions-selenium-example")) == 0
+
+
+def test_install_unsigned_addon_directory(firefox_driver):
+    driver = firefox_driver
+
+    path = os.path.abspath("tests/extensions/webextensions-selenium-example/")
+    driver.install_addon(path, temporary=True)
+
+    driver.get("https://www.selenium.dev/selenium/web/blank.html")
+    injected = driver.find_element(By.ID, "webextensions-selenium-example")
+
+    assert injected.text == "Content injected by webextensions-selenium-example"

examples/java/src/test/resources/extensions/selenium-example/manifest.json

@@ -1,7 +1,9 @@
 import pytest
 from selenium import webdriver
 from selenium.webdriver.chrome.service import Service as ChromeService
+from selenium.webdriver.firefox.service import Service as FirefoxService
 from webdriver_manager.chrome import ChromeDriverManager
+from webdriver_manager.firefox import GeckoDriverManager
 
 
 @pytest.fixture(scope='function')
@@ -12,3 +14,13 @@ def driver():
     yield driver
 
     driver.quit()
+
+
+@pytest.fixture(scope='function')
+def firefox_driver():
+    service = FirefoxService(executable_path=GeckoDriverManager().install())
+    driver = webdriver.Firefox(service=service)
+
+    yield driver
+
+    driver.quit()

examples/python/tests/browsers/test_firefox.py

@@ -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))

examples/python/tests/conftest.py

@@ -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": "[email protected]"
+   }
+ }
+}

examples/python/tests/extensions/webextensions-selenium-example.xpi

@@ -4,8 +4,37 @@
 require 'webdrivers'
 
 RSpec.describe 'Firefox' do
+  let(:driver) { start_firefox }
+
   it 'basic options' do
     options = Selenium::WebDriver::Options.firefox
     @driver = Selenium::WebDriver.for :firefox, options: options
   end
+
+  it 'installs addon' do
+    extension_file_path = File.expand_path('../extensions/webextensions-selenium-example.xpi', __dir__)
+    driver.install_addon(extension_file_path)
+
+    driver.get 'https://www.selenium.dev/selenium/web/blank.html'
+    injected = driver.find_element(id: 'webextensions-selenium-example')
+    expect(injected.text).to eq 'Content injected by webextensions-selenium-example'
+  end
+
+  it 'uninstalls addon' do
+    extension_file_path = File.expand_path('../extensions/webextensions-selenium-example.xpi', __dir__)
+    extension_id = driver.install_addon(extension_file_path)
+    driver.uninstall_addon(extension_id)
+
+    driver.get 'https://www.selenium.dev/selenium/web/blank.html'
+    expect(driver.find_elements(id: 'webextensions-selenium-example')).to be_empty
+  end
+
+  it 'installs unsigned addon' do
+    extension_dir_path = File.expand_path('../extensions/webextensions-selenium-example/', __dir__)
+    driver.install_addon(extension_dir_path, true)
+
+    driver.navigate.to 'https://www.selenium.dev/selenium/web/blank.html'
+    injected = driver.find_element(id: 'webextensions-selenium-example')
+    expect(injected.text).to eq 'Content injected by webextensions-selenium-example'
+  end
 end

examples/python/tests/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))

examples/python/tests/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": "[email protected]"
+   }
+ }
+}

examples/ruby/spec/browsers/firefox_spec.rb

@@ -21,12 +21,17 @@
     guards.add_condition(:platform, Selenium::WebDriver::Platform.os)
     results = guards.disposition
     send(*results) if results
-
-    def start_session
-      require 'webdrivers'
-      @driver = Selenium::WebDriver.for :chrome
-    end
   end
 
   config.after { @driver&.quit }
+
+  def start_session
+    require 'webdrivers'
+    @driver = Selenium::WebDriver.for :chrome
+  end
+
+  def start_firefox
+    require 'webdrivers'
+    @driver = Selenium::WebDriver.for :firefox
+  end
 end