org.openqa.selenium.remote.server.CapabilitiesComparator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-server 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.0.0-alpha-2
// 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.remote.server;

import static org.openqa.selenium.remote.CapabilityType.SUPPORTS_JAVASCRIPT;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.common.collect.Ordering;

import org.openqa.selenium.Capabilities;
import org.openqa.selenium.Platform;

import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;

/**
 * Compares two sets of {@link Capabilities} against a desired standard. Capabilities are compared
 * by...
 * 
 *   {@link Capabilities#getBrowserName() browser name},
 *   
{@link Capabilities#getVersion() browser version},
 *   
{@link Capabilities#is(String)} whether JavaScript is enabled},
 *   
and {@link Capabilities#getPlatform() platform}
 * 
 * For all comparisons, if the capability is missing, that particular criteria shall not factor
 * into the comparison.
 *
 * When comparing platforms, preference will be given to an exact platform match over a fuzzy
 * match (e.g. Platform.WINDOWS will match Platform.WINDOWS before it matches Platform.XP).
 * Furthermore, configurations matching the current system's platform will be given preference.
 * For example, when {@code Platform.getCurrent() == Platform.WINDOWS}, a set of Capabilities
 * with {@code Platform.WINDOWS} will score higher than one with {@code Platform.ANY}.
 */
class CapabilitiesComparator implements Comparator {

  private final Comparator compareWith;

  public CapabilitiesComparator(final Capabilities desiredCapabilities,
                                final Platform currentPlatform) {
    final CapabilityScorer browserNameScorer =
        new CapabilityScorer<>(desiredCapabilities.getBrowserName());
    Comparator byBrowserName =
        Comparator.comparingInt(c -> browserNameScorer.score(c.getBrowserName()));

    final CapabilityScorer versionScorer =
        new VersionScorer(desiredCapabilities.getVersion());
    Comparator byVersion =
        Comparator.comparingInt(c -> versionScorer.score(c.getVersion()));

    final CapabilityScorer jsScorer =
        new CapabilityScorer<>(desiredCapabilities.is(SUPPORTS_JAVASCRIPT));
    Comparator byJavaScript =
        Comparator.comparingInt(c -> jsScorer.score(c.is(SUPPORTS_JAVASCRIPT)));

    Platform desiredPlatform = desiredCapabilities.getPlatform();
    if (desiredPlatform == null) {
      desiredPlatform = Platform.ANY;
    }

    final CapabilityScorer currentPlatformScorer =
        new CurrentPlatformScorer(currentPlatform, desiredPlatform);
    Comparator byCurrentPlatform =
        Comparator.comparingInt(c -> currentPlatformScorer.score(c.getPlatform()));

    final CapabilityScorer strictPlatformScorer =
        new CapabilityScorer<>(desiredPlatform);
    Comparator byStrictPlatform =
        Comparator.comparingInt(c -> strictPlatformScorer.score(c.getPlatform()));

    final CapabilityScorer fuzzyPlatformScorer =
        new FuzzyPlatformScorer(desiredPlatform);
    Comparator byFuzzyPlatform =
        Comparator.comparingInt(c -> fuzzyPlatformScorer.score(c.getPlatform()));

    compareWith = Ordering.compound(Arrays.asList(
        byBrowserName,
        byVersion,
        byJavaScript,
        byCurrentPlatform,
        byStrictPlatform,
        byFuzzyPlatform));
  }

  public static  T getBestMatch(
      Capabilities against, Collection toCompare) {
    return getBestMatch(against, toCompare, Platform.getCurrent());
  }

  @VisibleForTesting
  static  T getBestMatch(
      Capabilities against, Collection toCompare, Platform currentPlatform) {
    return Ordering.from(new CapabilitiesComparator(against, currentPlatform)).max(toCompare);
  }

  public int compare(final Capabilities a, final Capabilities b) {
    return compareWith.compare(a, b);
  }

  private static boolean isNullOrAny(Platform platform) {
    return null == platform || Platform.ANY == platform;
  }

  private static class CapabilityScorer {
    final T scoreAgainst;

    public CapabilityScorer(T scoreAgainst) {
      this.scoreAgainst = scoreAgainst;
    }

    public int score(T value) {
      if (value == null || scoreAgainst == null) {
        return 0;
      } else if (value.equals(scoreAgainst)) {
        return 1;
      }
      return -1;
    }
  }

  private static class CurrentPlatformScorer extends CapabilityScorer {

    private final boolean currentIsDesired;

    private CurrentPlatformScorer(Platform currentPlatform, Platform desiredPlatform) {
      super(currentPlatform);
      currentIsDesired = !isNullOrAny(currentPlatform)
          && (currentPlatform.is(desiredPlatform) || desiredPlatform.is(currentPlatform));
    }

    @Override
    public int score(Platform value) {
      if (!currentIsDesired || isNullOrAny(value)) {
        return 0;
      }

      return scoreAgainst.is(value) || value.is(scoreAgainst) ? 1 : -1;
    }
  }

  private static class FuzzyPlatformScorer extends CapabilityScorer {

    public FuzzyPlatformScorer(Platform scoreAgainst) {
      super(scoreAgainst);
    }

    @Override
    public int score(Platform value) {
      if (isNullOrAny(value)) {
        return 0;
      }

      return value.is(scoreAgainst) || scoreAgainst.is(value) ? 1 : -1;
    }
  }

  private static class VersionScorer extends CapabilityScorer {

    public VersionScorer(String against) {
      super(Strings.nullToEmpty(against).trim());
    }

    @Override
    public int score(String other) {
      other = Strings.nullToEmpty(other).trim();
      if (other.isEmpty() || scoreAgainst.isEmpty()) {
        return 0;
      } else if (other.equals(scoreAgainst)) {
        return 1;
      }
      return -1;
    }
  }
}