org.openqa.selenium.grid.data.DefaultSlotMatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-grid Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 4.27.0
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.openqa.selenium.grid.data;

import org.openqa.selenium.Capabilities;

import java.util.Objects;

/**
 * Default matching implementation for slots, loosely based on the
 * requirements for capability matching from the WebDriver spec. A match
 * is made if the following are all true:
 * 
 *   All non-extension capabilities from the {@code stereotype} match
 *       those in the {@link Capabilities} being considered.
 *   
If the {@link Capabilities} being considered contain any of:
 *       
 *         browserName
 *         
browserVersion
 *         
platform
 *       
 *       Then the {@code stereotype} must contain the same values.
 * 
 * 
 * One thing to note is that extension capabilities are not considered when
 * matching slots, since the matching of these is implementation-specific
 * to each driver.
 */
public class DefaultSlotMatcher implements SlotMatcher {

  @Override
  public boolean matches(Capabilities stereotype, Capabilities capabilities) {

    Boolean initialMatch = stereotype.getCapabilityNames().stream()
      // Matching of extension capabilities is implementation independent. Skip them
      .filter(name -> !name.contains(":"))
      // Platform matching is special, we do it below
      .filter(name -> !"platform".equalsIgnoreCase(name) && !"platformName".equalsIgnoreCase(name))
      .map(name -> {
        Object value = capabilities.getCapability(name);
        boolean matches;
        if (value instanceof String) {
          matches = stereotype.getCapability(name).toString().equalsIgnoreCase(value.toString());
        } else {
          matches = value == null || Objects.equals(stereotype.getCapability(name), value);
        }
        return matches;
      })
      .reduce(Boolean::logicalAnd)
      .orElse(false);

    if (!initialMatch) {
      return false;
    }

    // Simple browser, browserVersion and platformName match
    boolean browserNameMatch =
      capabilities.getBrowserName() == null ||
      Objects.equals(stereotype.getBrowserName(), capabilities.getBrowserName());
    boolean browserVersionMatch =
      (capabilities.getBrowserVersion() == null || capabilities.getBrowserVersion().isEmpty()) ||
      Objects.equals(stereotype.getBrowserVersion(), capabilities.getBrowserVersion());
    boolean platformNameMatch =
      capabilities.getPlatformName() == null ||
      Objects.equals(stereotype.getPlatformName(), capabilities.getPlatformName()) ||
      (stereotype.getPlatformName() != null &&
       stereotype.getPlatformName().is(capabilities.getPlatformName()));
    return browserNameMatch && browserVersionMatch && platformNameMatch;
  }
}