Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use addMetadata method of org.openqa.selenium.remote.RemoteWebDriverBuilder class

Best Selenium code snippet using org.openqa.selenium.remote.RemoteWebDriverBuilder.addMetadata

Source:RemoteWebDriverBuilder.java

...60 * <pre>61 *   WebDriver driver = RemoteWebDriver.builder()62 *     .addAlternative(new FirefoxOptions())63 *     .addAlternative(new ChromeOptions())64 *     .addMetadata("cloud:key", "hunter2")65 *     .setCapability("proxy", new Proxy())66 *     .build();67 * </pre>68 * In this example, we ask for a session where the browser will be either Firefox or Chrome (we69 * don't care which), but where either browser will use the given {@link org.openqa.selenium.Proxy}.70 * In addition, we've added some metadata to the session, setting the "{@code cloud.key}" to be the71 * secret passphrase of our account with the cloud "Selenium as a Service" provider.72 * <p>73 * If no call to {@link #withDriverService(DriverService)} or {@link #url(URL)} is made, the builder74 * will use {@link ServiceLoader} to find all instances of {@link DriverService.Builder} and will75 * call {@link DriverService.Builder#score(Capabilities)} for each alternative until a new session76 * can be created.77 */78@Beta79public class RemoteWebDriverBuilder {80  private final static Set<String> ILLEGAL_METADATA_KEYS = ImmutableSet.of(81      "alwaysMatch",82      "capabilities",83      "firstMatch");84  private final static AcceptedW3CCapabilityKeys OK_KEYS = new AcceptedW3CCapabilityKeys();85  private final List<Map<String, Object>> options = new ArrayList<>();86  private final Map<String, Object> metadata = new TreeMap<>();87  private final Map<String, Object> additionalCapabilities = new TreeMap<>();88  private URL remoteHost;89  private DriverService service;90  RemoteWebDriverBuilder() {91    // Access through RemoteWebDriver.builder92  }93  /**94   * Clears the current set of alternative browsers and instead sets the list of possible choices to95   * the arguments given to this method.96   */97  public RemoteWebDriverBuilder oneOf(Capabilities maybeThis, Capabilities... orOneOfThese) {98    options.clear();99    addAlternative(maybeThis);100    for (Capabilities anOrOneOfThese : orOneOfThese) {101      addAlternative(anOrOneOfThese);102    }103    return this;104  }105  /**106   * Add to the list of possible configurations that might be asked for. It is possible to ask for107   * more than one type of browser per session. For example, perhaps you have an extension that is108   * available for two different kinds of browser, and you'd like to test it).109   */110  public RemoteWebDriverBuilder addAlternative(Capabilities options) {111    Map<String, Object> serialized = validate(Objects.requireNonNull(options));112    this.options.add(serialized);113    return this;114  }115  /**116   * Adds metadata to the outgoing new session request, which can be used by intermediary of end117   * nodes for any purpose they choose (commonly, this is used to request additional features from118   * cloud providers, such as video recordings or to set the timezone or screen size). Neither119   * parameter can be {@code null}.120   */121  public RemoteWebDriverBuilder addMetadata(String key, Object value) {122    if (ILLEGAL_METADATA_KEYS.contains(key)) {123      throw new IllegalArgumentException(key + " is a reserved key");124    }125    metadata.put(Objects.requireNonNull(key), Objects.requireNonNull(value));126    return this;127  }128  /**129   * Sets a capability for every single alternative when the session is created. These capabilities130   * are only set once the session is created, so this will be set on capabilities added via131   * {@link #addAlternative(Capabilities)} or {@link #oneOf(Capabilities, Capabilities...)} even132   * after this method call.133   */134  public RemoteWebDriverBuilder setCapability(String capabilityName, String value) {135    if (!OK_KEYS.test(capabilityName)) {...

Source:RemoteWebDriverBuilderTest.java

...120  public void shouldAllowMetaDataToBeSet() {121    AtomicBoolean seen = new AtomicBoolean(false);122    RemoteWebDriver.builder()123      .oneOf(new FirefoxOptions())124      .addMetadata("cloud:options", "merhaba")125      .address("http://localhost:34576")126      .connectingWith(config -> req -> {127        Map<String, Object> payload = new Json().toType(Contents.string(req), MAP_TYPE);128        seen.set("merhaba".equals(payload.getOrDefault("cloud:options", "")));129        return CANNED_SESSION_RESPONSE;130      })131      .build();132    assertThat(seen.get()).isTrue();133  }134  @Test135  public void doesNotAllowFirstMatchToBeUsedAsAMetadataNameAsItIsConfusing() {136    RemoteWebDriverBuilder builder = RemoteWebDriver.builder();137    assertThatExceptionOfType(IllegalArgumentException.class)138      .isThrownBy(() -> builder.addMetadata("firstMatch", "cheese"));139  }140  @Test141  public void doesNotAllowAlwaysMatchToBeUsedAsAMetadataNameAsItIsConfusing() {142    RemoteWebDriverBuilder builder = RemoteWebDriver.builder();143    assertThatExceptionOfType(IllegalArgumentException.class)144      .isThrownBy(() -> builder.addMetadata("alwaysMatch", "cheese"));145  }146  @Test147  public void doesNotAllowCapabilitiesToBeUsedAsAMetadataName() {148    RemoteWebDriverBuilder builder = RemoteWebDriver.builder();149    assertThatExceptionOfType(IllegalArgumentException.class)150      .isThrownBy(() -> builder.addMetadata("capabilities", "cheese"));151  }152  @Test153  public void shouldAllowCapabilitiesToBeSetGlobally() {154    AtomicBoolean seen = new AtomicBoolean(false);155    RemoteWebDriver.builder()156      .oneOf(new FirefoxOptions())157      .setCapability("se:option", "cheese")158      .address("http://localhost:34576")159      .connectingWith(config -> req -> {160        listCapabilities(req).stream()161          .map(caps -> "cheese".equals(caps.getCapability("se:option")))162          .reduce(Boolean::logicalAnd)163          .ifPresent(seen::set);164        return CANNED_SESSION_RESPONSE;...

addMetadata

Using AI Code Generation

1import org.openqa.selenium.WebDriver;2import org.openqa.selenium.chrome.ChromeDriver;3import org.openqa.selenium.remote.RemoteWebDriverBuilder;4public class AddMetadata {5    public static void main(String[] args) {6        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();7        builder.addMetadata("foo", "bar");8        WebDriver driver = builder.build();9        System.out.println(driver.getTitle());10        driver.quit();11    }12}13Add ability to add metadata to the session (#7786)14Add ability to add a custom executor to the RemoteWebDriverBuilder class (#7785)15Add the ability to set the default value for the acceptInsecureCerts capability (#7784)16Add the ability to set the default value for the pageLoadStrategy capability (#7783)17Add the ability to set the default value for the unhandledPromptBehavior capability (#7782)18Add the ability to set the default value for the setWindowRect capability (#7781)19Add the ability to set the default value for the setNetworkConditions capability (#7780)20Add the ability to set the default value for the acceptInsecureCerts capability (#7779)21Add the ability to set the default value for the pageLoadStrategy capability (#7778)22Add the ability to set the default value for the unhandledPromptBehavior capability (#7777)23Add the ability to set the default value for the setWindowRect capability (#7776)24Add the ability to set the default value for the setNetworkConditions capability (#7775)25Add the ability to set the default value for the acceptInsecureCerts capability (#7774)26Add the ability to set the default value for the pageLoadStrategy capability (#7773)

addMetadata

Using AI Code Generation

1import java.net.MalformedURLException;2import java.net.URL;3import java.util.HashMap;4import java.util.Map;5import java.util.concurrent.TimeUnit;6import org.openqa.selenium.Platform;7import org.openqa.selenium.WebDriver;8import org.openqa.selenium.WebDriverException;9import org.openqa.selenium.remote.DesiredCapabilities;10import org.openqa.selenium.remote.RemoteWebDriver;11public class SeleniumGrid {12public static void main(String[] args) throws MalformedURLException, InterruptedException {

addMetadata

Using AI Code Generation

1public class RemoteWebDriverBuilderAddMetadata {2    public static void main(String[] args) {3        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();4        builder.addMetadata("key1", "value1");5        builder.addMetadata("key2", "value2");6        builder.addMetadata("key3", "value3");7        RemoteWebDriver driver = builder.build();8    }9}10public class RemoteWebDriverBuilderAddMetadata {11    public static void main(String[] args) {12        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();13        builder.addMetadata("key1", "value1");14        builder.addMetadata("key2", "value2");15        builder.addMetadata("key3", "value3");16        RemoteWebDriver driver = builder.build();17    }18}19public class RemoteWebDriverBuilderAddMetadata {20    public static void main(String[] args) {21        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();22        builder.addMetadata("key1", "value1");23        builder.addMetadata("key2", "value2");24        builder.addMetadata("key3", "value3");25        RemoteWebDriver driver = builder.build();26    }27}28public class RemoteWebDriverBuilderAddMetadata {29    public static void main(String[] args) {30        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();31        builder.addMetadata("key1", "value1");32        builder.addMetadata("key2", "value2");33        builder.addMetadata("key3", "value3");34        RemoteWebDriver driver = builder.build();35    }36}37public class RemoteWebDriverBuilderAddMetadata {38    public static void main(String[] args) {39        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();40        builder.addMetadata("key1", "value1");41        builder.addMetadata("key2", "value2");42        builder.addMetadata("key3", "value3");43        RemoteWebDriver driver = builder.build();44    }45}46public class RemoteWebDriverBuilderAddMetadata {47    public static void main(String[] args) {48        RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();

addMetadata

Using AI Code Generation

1import org.openqa.selenium.remote.RemoteWebDriverBuilder;2import org.openqa.selenium.remote.DesiredCapabilities;3RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();4builder.addMetadata("os", "Windows");5builder.addMetadata("os_version", "7");6builder.addMetadata("browser", "Chrome");7builder.addMetadata("browser_version", "62.0");8builder.addMetadata("browserstack.debug", "true");9builder.addMetadata("browserstack.local", "true");10builder.addMetadata("browserstack.localIdentifier", "Test123");11DesiredCapabilities caps = builder.build();12caps.setCapability("browserstack.user", "BROWSERSTACK_USERNAME");13caps.setCapability("browserstack.key", "BROWSERSTACK_ACCESS_KEY");14caps.setCapability("browserstack.local", "true");15caps.setCapability("browserstack.localIdentifier", "Test123");16driver.quit();17import org.openqa.selenium.remote.RemoteWebDriverBuilder;18import org.openqa.selenium.remote.DesiredCapabilities;19RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();20builder.setMetadata("os", "Windows");21builder.setMetadata("os_version", "7");22builder.setMetadata("browser", "Chrome");23builder.setMetadata("browser_version", "62.0");24builder.setMetadata("browserstack.debug", "true");25builder.setMetadata("browserstack.local", "true");26builder.setMetadata("browserstack.localIdentifier", "Test123");27DesiredCapabilities caps = builder.build();28caps.setCapability("browserstack.user", "BROWSERSTACK_USERNAME");29caps.setCapability("browserstack.key", "BROWSERSTACK_ACCESS_KEY");30caps.setCapability("browserstack.local", "true");31caps.setCapability("browserstack.localIdentifier", "Test123");32driver.quit();33import org.openqa.selenium.remote.RemoteWebDriverBuilder;34import org.openqa.selenium.remote.DesiredCapabilities;35RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();36builder.setMetadata("os", "Windows");37builder.setMetadata("os

addMetadata

Using AI Code Generation

1RemoteWebDriver driver = new RemoteWebDriverBuilder()2  .addMetadata("foo", "bar")3  .addMetadata("foo", "baz")4  .addMetadata("foo", "qux")5  .build();6RemoteWebDriver driver = new RemoteWebDriverBuilder()7  .addMetadata("foo", "bar", "baz", "qux")8  .build();9RemoteWebDriver driver = new RemoteWebDriverBuilder()10  .addMetadata("foo", "bar", "baz", "qux")11  .addMetadata("foo", "quux")12  .build();13RemoteWebDriver driver = new RemoteWebDriverBuilder()14  .addMetadata("foo", "bar", "baz", "qux")15  .addMetadata("foo", "quux")16  .addMetadata("foo", "quuz")17  .build();18RemoteWebDriver driver = new RemoteWebDriverBuilder()19  .addMetadata("foo", "bar", "baz", "qux")20  .addMetadata("foo", "quux", "quuz")21  .build();22RemoteWebDriver driver = new RemoteWebDriverBuilder()23  .addMetadata("foo", "bar", "baz", "qux")24  .addMetadata("foo", "quux", "quuz")25  .addMetadata("foo", "quuux")26  .build();27RemoteWebDriver driver = new RemoteWebDriverBuilder()28  .addMetadata("foo", "bar", "baz", "qux")29  .addMetadata("foo", "quux", "quuz", "quuux")30  .build();31RemoteWebDriver driver = new RemoteWebDriverBuilder()32  .addMetadata("foo", "bar", "baz", "qux")33  .addMetadata("foo", "quux", "quuz", "quuux")34  .addMetadata("foo", "quuuux")

addMetadata

Using AI Code Generation

1public class RemoteWebDriverBuilderAddMetadataExample {2	public static void main(String[] args) throws MalformedURLException {3		RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();4				.addMetadata("foo", "bar")5				.build();6		System.out.println(driver.getTitle());7		driver.quit();8	}9}10public class RemoteWebDriverBuilderAddMetadataExample {11	public static void main(String[] args) throws MalformedURLException {12		RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();13				.addMetadata("foo", "bar")14				.addMetadata("bar", "baz")15				.addMetadata("baz", "foo")16				.build();17		System.out.println(driver.getTitle());18		driver.quit();19	}20}21public class RemoteWebDriverBuilderAddMetadataExample {22	public static void main(String[] args) throws MalformedURLException {23		RemoteWebDriverBuilder builder = new RemoteWebDriverBuilder();24				.addMetadata("foo", "bar")25				.addMetadata("bar", "baz")26				.addMetadata("baz", "foo")27				.addMetadata(Map.of("foo", "bar", "bar", "baz", "baz", "foo"))28				.build();29		System.out.println(driver.getTitle());30		driver.quit();31	}32}

addMetadata

Using AI Code Generation

1import org.openqa.selenium.remote.RemoteWebDriverBuilder2import org.openqa.selenium.remote.DesiredCapabilities3import org.openqa.selenium.remote.RemoteWebDriver4def driver = new RemoteWebDriverBuilder()5    .withCapabilities(DesiredCapabilities.chrome())6    .addMetadata("browserstack.user", System.getenv("BROWSERSTACK_USERNAME"))7    .addMetadata("browserstack.key", System.getenv("BROWSERSTACK_ACCESS_KEY"))8    .addMetadata("browserstack.local", "true")9    .addMetadata("browserstack.localIdentifier", System.getenv("BROWSERSTACK_LOCAL_IDENTIFIER"))10    .build()11import org.openqa.selenium.remote.RemoteWebDriver12import org.openqa.selenium.remote.DesiredCapabilities13driver.setCapability("browserstack.user", System.getenv("BROWSERSTACK_USERNAME"))14driver.setCapability("browserstack.key", System.getenv("BROWSERSTACK_ACCESS_KEY"))15driver.setCapability("browserstack.local", "true")16driver.setCapability("browserstack.localIdentifier", System.getenv("BROWSERSTACK_LOCAL_IDENTIFIER"))17import org.openqa.selenium.remote.DesiredCapabilities18def caps = DesiredCapabilities.chrome()19caps.setCapability("browserstack.user", System.getenv("BROWSERSTACK_USERNAME"))20caps.setCapability("browserstack.key", System.getenv("BROWSERSTACK_ACCESS_KEY"))21caps.setCapability("browserstack.local", "true")22caps.setCapability("browserstack.localIdentifier", System.getenv("BROWSERSTACK_LOCAL_IDENTIFIER"))23import org.openqa.selenium.remote.RemoteWebDriver24import org.openqa.selenium.remote.DesiredCapabilities25driver.setCapability("browserstack.user", System.getenv("BROWSERSTACK_USERNAME"))26driver.setCapability("browserstack.key", System.getenv("BROWSERSTACK_ACCESS_KEY"))27driver.setCapability("browserstack.local", "true")28driver.setCapability("browserstack.localIdentifier", System.getenv("BROWSERSTACK_LOCAL_IDENTIFIER"))

Selenium 4 Tutorial:

LambdaTest’s Selenium 4 tutorial is covering every aspects of Selenium 4 testing with examples and best practices. Here you will learn basics, such as how to upgrade from Selenium 3 to Selenium 4, to some advanced concepts, such as Relative locators and Selenium Grid 4 for Distributed testing. Also will learn new features of Selenium 4, such as capturing screenshots of specific elements, opening a new tab or window on the browser, and new protocol adoptions.

Chapters:

Upgrading From Selenium 3 To Selenium 4?: In this chapter, learn in detail how to update Selenium 3 to Selenium 4 for Java binding. Also, learn how to upgrade while using different build tools such as Maven or Gradle and get comprehensive guidance for upgrading Selenium.
What’s New In Selenium 4 & What’s Being Deprecated? : Get all information about new implementations in Selenium 4, such as W3S protocol adaption, Optimized Selenium Grid, and Enhanced Selenium IDE. Also, learn what is deprecated for Selenium 4, such as DesiredCapabilites and FindsBy methods, etc.
Selenium 4 With Python: Selenium supports all major languages, such as Python, C#, Ruby, and JavaScript. In this chapter, learn how to install Selenium 4 for Python and the features of Python in Selenium 4, such as Relative locators, Browser manipulation, and Chrom DevTool protocol.
Selenium 4 Is Now W3C Compliant: JSON Wireframe protocol is retiring from Selenium 4, and they are adopting W3C protocol to learn in detail about the advantages and impact of these changes.
How To Use Selenium 4 Relative Locator? : Selenium 4 came with new features such as Relative Locators that allow constructing locators with reference and easily located constructors nearby. Get to know its different use cases with examples.
Selenium Grid 4 Tutorial For Distributed Testing: Selenium Grid 4 allows you to perform tests over different browsers, OS, and device combinations. It also enables parallel execution browser testing, reads up on various features of Selenium Grid 4 and how to download it, and runs a test on Selenium Grid 4 with best practices.
Selenium Video Tutorials: Binge on video tutorials on Selenium by industry experts to get step-by-step direction from automating basic to complex test scenarios with Selenium.