org.openqa.selenium.remote.Augmenter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-remote-driver 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.19.1
Show newest version
// 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;


import static net.bytebuddy.matcher.ElementMatchers.any;
import static net.bytebuddy.matcher.ElementMatchers.named;

import com.google.common.collect.ImmutableList;

import net.bytebuddy.ByteBuddy;
import net.bytebuddy.description.annotation.AnnotationDescription;
import net.bytebuddy.implementation.FixedValue;
import net.bytebuddy.implementation.InvocationHandlerAdapter;

import org.openqa.selenium.Capabilities;
import org.openqa.selenium.ImmutableCapabilities;
import org.openqa.selenium.WebDriver;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;
import java.util.logging.Logger;


/**
 * Enhance the interfaces implemented by an instance of the
 * {@link org.openqa.selenium.remote.RemoteWebDriver} based on the returned
 * {@link org.openqa.selenium.Capabilities} of the driver.
 *
 * Note: this class is still experimental. Use at your own risk.
 */
public class Augmenter extends BaseAugmenter {

  private static final Logger logger = Logger.getLogger(Augmenter.class.getName());

  @Override
  protected  X create(
      RemoteWebDriver driver,
      Map, AugmenterProvider> augmentors,
      X objectToAugment) {
    CompoundHandler handler = determineAugmentation(driver, augmentors, objectToAugment);

    X augmented = performAugmentation(handler, objectToAugment);

    copyFields(objectToAugment.getClass(), objectToAugment, augmented);

    return augmented;
  }

  @Override
  protected RemoteWebDriver extractRemoteWebDriver(WebDriver driver) {
    if (driver.getClass().isAnnotationPresent(Augmentable.class)) {
      return (RemoteWebDriver) driver;
    }

    logger.warning("Augmenter should be applied to the instances of @Augmentable classes " +
        "or previously augmented instances only (instance class was: " + driver.getClass() + ")");
    return null;
  }

  private void copyFields(Class clazz, Object source, Object target) {
    if (Object.class.equals(clazz)) {
      // Stop!
      return;
    }

    for (Field field : clazz.getDeclaredFields()) {
      copyField(source, target, field);
    }

    copyFields(clazz.getSuperclass(), source, target);
  }

  private void copyField(Object source, Object target, Field field) {
    if (Modifier.isFinal(field.getModifiers())) {
      return;
    }

    try {
      field.setAccessible(true);
      Object value = field.get(source);
      field.set(target, value);
    } catch (IllegalAccessException e) {
      throw new RuntimeException(e);
    }
  }

  private CompoundHandler determineAugmentation(
      RemoteWebDriver driver,
      Map, AugmenterProvider> augmentors,
      Object objectToAugment) {
    CompoundHandler handler = new CompoundHandler(driver, objectToAugment);

    Capabilities capabilities = ImmutableCapabilities.copyOf(driver.getCapabilities());

    for (Map.Entry, AugmenterProvider> entry : augmentors.entrySet()) {
      if (!entry.getKey().test(capabilities)) {
        continue;
      }

      AugmenterProvider augmenter = entry.getValue();
      handler.addCapabilityHander(augmenter.getDescribedInterface(), augmenter.getImplementation(capabilities));
    }
    return handler;
  }

  @SuppressWarnings({"unchecked"})
  protected  X performAugmentation(CompoundHandler handler, X from) {
    if (handler.isNeedingApplication()) {
      Class superClass = from.getClass();

      Class loaded = new ByteBuddy()
          .subclass(superClass)
          .implement(ImmutableList.copyOf(handler.getInterfaces()))
          .annotateType(AnnotationDescription.Builder.ofType(Augmentable.class).build())
          .method(any()).intercept(InvocationHandlerAdapter.of(handler))
          .method(named("isAugmented")).intercept(FixedValue.value(true))
          .make()
          .load(superClass.getClassLoader())
          .getLoaded()
          .asSubclass(from.getClass());

      try {
        return (X) loaded.getDeclaredConstructor().newInstance();
      } catch (ReflectiveOperationException e) {
        throw new RuntimeException("Unable to create subclass", e);
      }
    }

    return from;
  }

  private class CompoundHandler implements InvocationHandler {

    private final ExecuteMethod execute;
    private final Object originalInstance;
    private final Map handlers = new HashMap<>();
    private final Set> interfaces = new HashSet<>();

    private CompoundHandler(RemoteWebDriver driver, Object originalInstance) {
      this.execute = new RemoteExecuteMethod(driver);
      this.originalInstance = originalInstance;
    }

    void addCapabilityHander(Class fromInterface, InterfaceImplementation handledBy) {
      if (fromInterface.isInterface()) {
        interfaces.add(fromInterface);
      }
      for (Method method : fromInterface.getDeclaredMethods()) {
        handlers.put(method, handledBy);
      }
    }

    Set> getInterfaces() {
      return interfaces;
    }

    boolean isNeedingApplication() {
      return !handlers.isEmpty();
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
      InterfaceImplementation handler = handlers.get(method);

      if (handler == null) {
        try {
          return method.invoke(originalInstance, args);
        } catch (InvocationTargetException e) {
          throw e.getTargetException();
        }
      }

      return handler.invoke(execute, proxy, method, args);
    }
  }
}