Browser Extension

TestingBot Storage

With TestingBot Storage, you can upload your extensions to the TestingBot servers.
The advantage of this is that our test VMs can immediately download your extension from the TestingBot network, which is much faster than downloading from the public internet.

The API call will return a unique identifier, similar to tb://efe932jfk.
You can then use this identifier with the capability: "load-extension" : "tb://..."

Chrome Browser Extension Testing

Once you've specified "load-extension", the Chrome browser will start up with the extension preloaded. You can now run your Selenium tests while the extension is active on the remote browser.

UI Testing Chrome Extensions

To test the UI of your Chrome extension, you can have your Selenium test navigate to a chrome-extension:// URL.
For example, if the ID of your addon is paaamahlcokbnafoiahanekijojkhbdm, you can navigate to chrome-extension://paaamahlcokbnafoiahanekijojkhbdm.

Please see the NodeJS example below for a complete rundown on how to test the UI of your Chrome extension:

const webdriver = require('selenium-webdriver');
const capabilities = {
 'platform' : 'WIN10',
 'browserName' : 'chrome',
 'version' : 'latest',
 'tb:options': {
   'load-extension': 'https://...path..to..extension'
 }
}
async function runTest () {
  let driver = new webdriver.Builder()
    .usingServer('https://api_key:api_secret@hub.testingbot.com/wd/hub')
    .withCapabilities(capabilities)
    .build();
  await driver.get('chrome-extension://paaamahlcokbnafoiahanekijojkhbdm/popup/index.html');
  const element = await driver.findElement(By.css('#environments'));
  const isElementDisplayed = await element.isDisplayed();
  if (isElementDisplayed) {
    console.log('Element is present on the page.');
  } else {
    console.log('Element is not present on the page.');
  }
  await driver.quit();
}
runTest();

Firefox Browser Extension Testing

You can specify the URL to a xpi file in the load-extension capability. This will make sure the Firefox browser has the extension installed (as a temporary extension) at the start of the Selenium test.

UI Testing Firefox Extensions

If you want to test the UI of your Firefox extension, the moz-extension:// URL, you will need to specify the extension ID in the URL.
Because TestingBot installs the extension as a temporary extension, the id will always be different as it is generated as a random uuid(4).

TestingBot provides a capability to hardcode your Firefox exension to a fixed uuid which you've generated, by using the firefoxExtensionMap capability. To use this, you could set the ID in the manifest.json of the extension:

"browser_specific_settings": {
  "gecko": {
    "id": "addon@testingbot.com",
    "strict_min_version": "109.0"
  }
}

You can now link the gecko id to a uuid you've generated:

const webdriver = require('selenium-webdriver');
const capabilities = {
 'platform' : 'WIN10',
 'browserName' : 'chrome',
 'version' : 'latest',
 'tb:options': {
   'load-extension': 'https://...path..to..extension',
   'firefoxExtensionMap': {
      'addon@testingbot.com': '3d9b1639-77fb-44a1-888a-6d97d773e96b'
    }
  }
}
async function runTest () {
  let driver = new webdriver.Builder()
    .usingServer('https://api_key:api_secret@hub.testingbot.com/wd/hub')
    .withCapabilities(capabilities)
    .build();
  await driver.get('moz-extension://3d9b1639-77fb-44a1-888a-6d97d773e96b/popup/index.html');
  const element = await driver.findElement(By.css('#environments'));
  const isElementDisplayed = await element.isDisplayed();
  if (isElementDisplayed) {
    console.log('Element is present on the page.');
  } else {
    console.log('Element is not present on the page.');
  }
  await driver.quit();
}
runTest();

Edge Browser Extension Testing

Once you've specified "load-extension", the Edge browser will start up with the extension preloaded. You can now run your Selenium tests while the extension is active on the remote Edge browser.

UI Testing Edge Extensions

To test the UI of your Edge extension, you can have your Selenium test navigate to a chrome-extension:// or extension:// URL.
For example, if the ID of your addon is paaamahlcokbnafoiahanekijojkhbdm, you can navigate to extension://paaamahlcokbnafoiahanekijojkhbdm.

Please see the NodeJS example below for a complete rundown on how to test the UI of your Chrome extension:

const webdriver = require('selenium-webdriver');
const capabilities = {
 'platform' : 'WIN10',
 'browserName' : 'microsoftedge',
 'version' : 'latest',
 'tb:options': {
   'load-extension': 'https://...path..to..extension'
 }
}
async function runTest () {
  let driver = new webdriver.Builder()
    .usingServer('https://api_key:api_secret@hub.testingbot.com/wd/hub')
    .withCapabilities(capabilities)
    .build();
  await driver.get('extension://paaamahlcokbnafoiahanekijojkhbdm/popup/index.html');
  const element = await driver.findElement(By.css('#environments'));
  const isElementDisplayed = await element.isDisplayed();
  if (isElementDisplayed) {
    console.log('Element is present on the page.');
  } else {
    console.log('Element is not present on the page.');
  }
  await driver.quit();
}
runTest();

Safari Extension Testing

TestingBot allows you to upload a zip file containing your (unsigned) Safari Web Extension or Safari App Extension. Simply provide a URL to a zip file containing the extension, or upload the zip file on TestingBot Storage.

You can now specify the URL to this file in the load-extension capability. When your test starts on a remote Safari instance, the extension will be enabled by default.

UI Testing Safari Extensions

To test the UI of your Safari extension, you will need to know the safari-web-extension:// URI. As Safari can change this to a random UUID, you will need to use the tb:getExtensionId command in your test to determine the correct URI to use.

Safaridriver currently contains a bug that does not detect the load completion of a safari-web-extension:// request. To work around this, set the pageLoad timeout to a low value and catch any timeout error.

Please see the examples below on how to run a UI test against a Safari Web/App Extension:

require 'rubygems'
require 'selenium-webdriver'

caps = Selenium::WebDriver::Remote::Capabilities.new
caps["browserName"] = "safari"
caps["browserVersion"] = "18.0"
caps["platformName"] = "SEQUOIA"
caps["tb:options"] = {
  "load-extension": "tb://...safari-extension-path..."
}

http_client = Selenium::WebDriver::Remote::Http::Default.new
http_client.read_timeout = 300
http_client.open_timeout = 300

driver = Selenium::WebDriver.for(
  :remote,
  :url => "https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub",
  :options => caps,
  :http_client => http_client)

driver.navigate.to "http://www.google.com/ncr"
driver.manage.timeouts.page_load = 5
extension_id = driver.execute_script("tb:getExtensionId")

begin
  driver.navigate.to "#{extension_id}popup/index.html"
rescue => e
  puts e.message
end

puts driver.page_source
driver.quit

import org.openqa.selenium.*;
import org.openqa.selenium.remote.*;
import java.net.URL;
import java.util.*;

public class SafariExtensionTest {
  public static void main(String[] args) throws Exception {
    MutableCapabilities caps = new MutableCapabilities();
    caps.setCapability("browserName", "safari");
    caps.setCapability("browserVersion", "18.0");
    caps.setCapability("platformName", "SEQUOIA");

    Map<String, Object> tbOptions = new HashMap<>();
    tbOptions.put("load-extension", "tb://...safari-extension-path...");
    caps.setCapability("tb:options", tbOptions);

    WebDriver driver = new RemoteWebDriver(
      new URL("https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"),
      caps
    );

    driver.get("http://www.google.com/ncr");
    ((JavascriptExecutor) driver).executeScript("tb:setPageLoadTimeout", 5);

    String extensionId = (String) ((JavascriptExecutor) driver).executeScript("tb:getExtensionId");
    try {
      driver.get(extensionId + "popup/index.html");
    } catch (TimeoutException e) {
      System.out.println(e.getMessage());
    }

    System.out.println(driver.getPageSource());
    driver.quit();
  }
}

const { Builder } = require("selenium-webdriver");

(async () => {
  let caps = {
    browserName: "safari",
    browserVersion: "18.0",
    platformName: "SEQUOIA",
    "tb:options": {
      "load-extension": "tb://...safari-extension-path..."
    }
  };

  let driver = await new Builder()
    .usingServer("https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub")
    .withCapabilities(caps)
    .build();

  await driver.get("http://www.google.com/ncr");
  await driver.manage().setTimeouts({ pageLoad: 5000 });

  const extensionId = await driver.executeScript("tb:getExtensionId");

  try {
    await driver.get(`${extensionId}popup/index.html`);
  } catch (e) {
    console.log(e.message);
  }

  const pageSource = await driver.getPageSource();
  console.log(pageSource);
  await driver.quit();
})();

from selenium import webdriver
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities

caps = {
    "browserName": "safari",
    "browserVersion": "18.0",
    "platformName": "SEQUOIA",
    "tb:options": {
        "load-extension": "tb://...safari-extension-path..."
    }
}

driver = webdriver.Remote(
    command_executor="https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub",
    desired_capabilities=caps
)

driver.get("http://www.google.com/ncr")
driver.set_page_load_timeout(5)

extension_id = driver.execute_script("tb:getExtensionId")

try:
    driver.get(f"{extension_id}popup/index.html")
except Exception as e:
    print(e)

print(driver.page_source)
driver.quit()

using OpenQA.Selenium;
using OpenQA.Selenium.Remote;
using System;
using System.Collections.Generic;

class SafariExtensionTest
{
  static void Main()
  {
    var capabilities = new DesiredCapabilities();
    capabilities.SetCapability("browserName", "safari");
    capabilities.SetCapability("browserVersion", "18.0");
    capabilities.SetCapability("platformName", "SEQUOIA");
    capabilities.SetCapability("tb:options", new Dictionary<string, object> {
      { "load-extension", "tb://...safari-extension-path..." }
    });

    var driver = new RemoteWebDriver(
      new Uri("https://API_KEY:API_SECRET@hub.testingbot.com/wd/hub"),
      capabilities
    );

    driver.Navigate().GoToUrl("http://www.google.com/ncr");
    driver.Manage().Timeouts().PageLoad = TimeSpan.FromSeconds(5);

    string extensionId = (string)((IJavaScriptExecutor)driver).ExecuteScript("tb:getExtensionId");
    try
    {
      driver.Navigate().GoToUrl(extensionId + "popup/index.html");
    }
    catch (WebDriverTimeoutException e)
    {
      Console.WriteLine(e.Message);
    }

    Console.WriteLine(driver.PageSource);
    driver.Quit();
  }
}

Older Safari versions

For Safari versions up to Safari 12, you can use a .safariextz format, in a zip file, to run and test Safari extensions.