eu.tsystems.mms.tic.testframework.pageobjects.internal.ResponsiveClassFinder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of driver-ui Show documentation
Show all versions of driver-ui Show documentation
Testerra test automation framework - driver-ui module
/*
* Testerra
*
* (C) 2020, Peter Lehmann, T-Systems Multimedia Solutions GmbH, Deutsche Telekom AG
*
* Deutsche Telekom AG and all other contributors /
* copyright owners license 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 eu.tsystems.mms.tic.testframework.pageobjects.internal;
import eu.tsystems.mms.tic.testframework.exceptions.SystemException;
import eu.tsystems.mms.tic.testframework.pageobjects.PageObject;
import eu.tsystems.mms.tic.testframework.pageobjects.internal.asserts.PageAssertions;
import eu.tsystems.mms.tic.testframework.utils.JSUtils;
import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.commons.lang3.NotImplementedException;
import org.apache.commons.lang3.StringUtils;
import org.openqa.selenium.WebDriver;
import org.reflections.Reflections;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class is used in ResponsivePageFactory to find the best matching page implementation for the current page regarding the current browser resolution.
*
*/
final public class ResponsiveClassFinder {
private static final Logger LOGGER = LoggerFactory.getLogger(ResponsiveClassFinder.class);
private static final String SCHEMA_DIV = "_";
private static final String KEYWORD_PIXEL = "px";
private static final String KEYWORD_RES = "Res";
private static final String KEYWORD_MIN = "Min";
private static final String KEYWORD_MAX = "Max";
private static final String RESOLUTION_REGEX = "\\d+" + KEYWORD_PIXEL;
private static final String PATTERN_LOW = SCHEMA_DIV + KEYWORD_MIN + SCHEMA_DIV + RESOLUTION_REGEX;
private static final String PATTERN_MID = SCHEMA_DIV + RESOLUTION_REGEX + SCHEMA_DIV + RESOLUTION_REGEX;
private static final String PATTERN_HI = SCHEMA_DIV + RESOLUTION_REGEX + SCHEMA_DIV + KEYWORD_MAX;
private static final String PATTERN_RES = "TODO"; // TODO
/**
* This call takes some time. It has an impact to the duration of the first page check (takes ca 2-3 seconds longer).
*/
private static final Reflections reflections = new Reflections(filter(configure()));
private ResponsiveClassFinder() {
}
/**
* This configuration is complete but vastly overgenerates.
* The method exists separately for Sanity Checking that {@link #filter(ConfigurationBuilder)} does not accidentally filter [i]too much[/i].
*/
static ConfigurationBuilder configure() {
return new ConfigurationBuilder().setUrls(ClasspathHelper.forJavaClassPath());
}
/** This method should prune resources we are not interested in, but not change the interesting results. */
static ConfigurationBuilder filter(final ConfigurationBuilder configuration) {
configuration.setScanners(new SubTypesScanner()); // drops TypeAnnotationScanner
configuration.useParallelExecutor();
/**
* TODO: This filter does not shrink the results and has no impact to safe time.
* activate Test eu.tsystems.mms.tic.testframework.pageobjects.internal.ResponsiveClassFinderUnitTest.test_filterConfigure_yieldSameResults
*/
// configuration.filterInputsBy(name -> name.endsWith(".class"));
return configuration;
}
private static class Caches {
private static final String NULL_PAGE_PREFIX = " _ ";
private static final Map, Map>> IMPLEMENTATIONS_CACHE = new ConcurrentHashMap<>();
private static PrioritizedClassInfos getCache(Class pageClass, String prefixOrNull) {
if (StringUtils.isBlank(prefixOrNull)) {
prefixOrNull = NULL_PAGE_PREFIX;
}
synchronized (IMPLEMENTATIONS_CACHE) {
if (!IMPLEMENTATIONS_CACHE.containsKey(pageClass)) {
return null;
}
Map> map = IMPLEMENTATIONS_CACHE.get(pageClass);
if (!map.containsKey(prefixOrNull)) {
return null;
}
return map.get(prefixOrNull);
}
}
private static void setCache(Class pageClass, String prefixOrNull, PrioritizedClassInfos prioritizedClassInfos) {
if (StringUtils.isBlank(prefixOrNull)) {
prefixOrNull = NULL_PAGE_PREFIX;
}
synchronized (IMPLEMENTATIONS_CACHE) {
if (!IMPLEMENTATIONS_CACHE.containsKey(pageClass)) {
IMPLEMENTATIONS_CACHE.put(pageClass, new HashMap<>());
}
Map> map = IMPLEMENTATIONS_CACHE.get(pageClass);
map.put(prefixOrNull, prioritizedClassInfos);
}
}
}
/**
* Gets all matching subclasses of the given class. Matching means the subclasses name must consist of the name of the
* parent class followed by an integer number representing the minimum width and nothing else.
*
* @param baseClass The base page class
*/
@SuppressWarnings("unchecked")
private static void findSubPagesOf(final Class baseClass, String prefix) {
LOGGER.debug(String.format("Searching for subtypes of class <%s>", baseClass));
if (prefix == null) {
prefix = "";
}
final String baseClassName = baseClass.getSimpleName();
PrioritizedClassInfos prioritizedClassInfos = new PrioritizedClassInfos<>();
// at first, add the base page it self, only if not abstract
if (!Modifier.isAbstract(baseClass.getModifiers())) {
prioritizedClassInfos.setBaseClass(baseClass);
}
// search for sub pages
Set> subClasses = reflections.getSubTypesOf((Class) baseClass);
for (Class subClass : subClasses) {
String classname = subClass.getSimpleName();
if (Modifier.isAbstract(subClass.getModifiers())) {
LOGGER.debug("Not taking " + classname + " into consideration, because it is abstract");
} else {
tryToFindImplementationOf(subClass, classname, baseClassName, prefix, prioritizedClassInfos);
}
}
Caches.setCache(baseClass, prefix, prioritizedClassInfos);
}
private static void tryToFindImplementationOf(Class subClass, String classname,
String baseClassName, String prefix,
PrioritizedClassInfos prioritizedClassInfos) {
if (classname.startsWith(prefix + baseClassName)) {
String resPart = classname.replace(prefix + baseClassName, "");
if (matchesOurAnyOfPatterns(resPart)) {
// prefixed classes with existing and matching res part
prioritizedClassInfos.getPrefixedClasses().add(new ResolutionClassInfo<>(subClass, resPart));
} else if (StringUtils.isBlank(resPart)) {
// prefixed classes without res part
prioritizedClassInfos.setPrefixedBaseClass(subClass);
}
} else if (classname.startsWith(baseClassName)) {
String resPart = classname.replace(baseClassName, "");
if (matchesOurAnyOfPatterns(resPart)) {
// non-prefixed classes with existing and matching res part
prioritizedClassInfos.getNonPrefixedClasses().add(new ResolutionClassInfo<>(subClass, resPart));
}
}
}
private static boolean matchesOurAnyOfPatterns(String resPartOfClassName) {
if (StringUtils.isBlank(resPartOfClassName)) {
return false;
}
if (resPartOfClassName.matches(PATTERN_LOW) ||
resPartOfClassName.matches(PATTERN_MID) ||
resPartOfClassName.matches(PATTERN_HI) ||
resPartOfClassName.matches(PATTERN_RES)
) {
return true;
}
return false;
}
/**
* Gets the browsers viewport width.
*
* @param driver The web driver
* @return int
*/
private static int getBrowserViewportSize(final WebDriver driver, final int viewportWidth) {
if (viewportWidth > 0) {
// mehrfaches auslesen verhindern, nur auslesen wenn nötig
return viewportWidth;
}
// In case of using Chrome CDP device emulation
// https://developer.chrome.com/blog/visual-viewport-api
Object o = JSUtils.executeScript(driver, "return window.visualViewport.width");
if (o instanceof Long) {
int viewportWidthNew = (int) (long) (Long) o;
LOGGER.debug(String.format("Browser viewport width is %dpx", viewportWidthNew));
return viewportWidthNew;
}
return viewportWidth;
}
@SuppressWarnings("unchecked")
public static Class getBestMatchingClass(Class baseClass, WebDriver driver, String prefix) {
PrioritizedClassInfos prioritizedClassInfos = Caches.getCache(baseClass, prefix);
if (prioritizedClassInfos == null) {
// scan!
findSubPagesOf(baseClass, prefix);
prioritizedClassInfos = Caches.getCache(baseClass, prefix);
if (prioritizedClassInfos == null) {
throw new SystemException("Something went wrong scanning this class for sub types: " + baseClass.getName());
}
}
/*
log map
*/
prioritizedClassInfos.logContent();
/*
find best matching class
*/
List> prefixedClasses = prioritizedClassInfos.getPrefixedClasses();
List> nonPrexidClasses = prioritizedClassInfos.getNonPrefixedClasses();
int viewPortWidth = -1;
Class bestMatchingClass = null;
// check prefixed
for (ResolutionClassInfo c : prefixedClasses) {
if (c.hasResolution()) {
viewPortWidth = getBrowserViewportSize(driver, viewPortWidth);
if (c.matchesResolution(viewPortWidth)) {
bestMatchingClass = (Class) c.implClass;
}
}
}
// prefixedBase
if (bestMatchingClass == null) {
if (prioritizedClassInfos.prefixedBaseClass != null) {
bestMatchingClass = (Class) prioritizedClassInfos.prefixedBaseClass;
}
}
// check non-prefixed
if (bestMatchingClass == null) {
for (ResolutionClassInfo c : nonPrexidClasses) {
if (c.hasResolution()) {
viewPortWidth = getBrowserViewportSize(driver, viewPortWidth);
}
if (c.matchesResolution(viewPortWidth)) {
bestMatchingClass = (Class) c.implClass;
}
}
}
// base class
if (bestMatchingClass == null) {
if (prioritizedClassInfos.baseClass != null) {
bestMatchingClass = (Class) prioritizedClassInfos.baseClass;
}
}
/*
Evaluate
*/
if (bestMatchingClass == null) {
throw new RuntimeException("Could not find a matching page class implementation for " + baseClass.getSimpleName() +
"\nMaybe you can solve this by making the base class non-abstract.");
} else {
if (viewPortWidth > 0) {
LOGGER.debug("For " + viewPortWidth + "px view port width, I'm choosing: " + bestMatchingClass.getSimpleName());
} else {
LOGGER.debug("Without any viewport check, I'm choosing: " + bestMatchingClass.getSimpleName());
}
return bestMatchingClass;
}
}
public static void clearCache() {
Caches.IMPLEMENTATIONS_CACHE.clear();
}
private static class PrioritizedClassInfos {
List> prefixedClasses = new LinkedList<>();
Class prefixedBaseClass;
List> nonPrefixedClasses = new LinkedList<>();
Class baseClass;
public List> getPrefixedClasses() {
return prefixedClasses;
}
public List> getNonPrefixedClasses() {
return nonPrefixedClasses;
}
public void setBaseClass(Class baseClass) {
this.baseClass = baseClass;
}
public void setPrefixedBaseClass(Class prefixedBaseClass) {
this.prefixedBaseClass = prefixedBaseClass;
}
public void logContent() {
String msg = "";
if (prefixedClasses.size() > 0) {
msg += "Prefixed Res Impls:\n";
for (ResolutionClassInfo c : prefixedClasses) {
msg += " " + c + "\n";
}
}
if (prefixedBaseClass != null) {
msg += "Prefixed Base:\n";
msg += " " + prefixedBaseClass.getSimpleName() + "\n";
}
if (nonPrefixedClasses.size() > 0) {
msg += "Res Impls:\n";
for (ResolutionClassInfo c : nonPrefixedClasses) {
msg += " " + c + "\n";
}
}
if (baseClass != null) {
msg += "Base:\n";
msg += " " + baseClass.getSimpleName() + "\n";
}
if ("".equals(msg)) {
msg += "No usable (non-abstract) implementations found.";
}
LOGGER.debug(msg);
}
}
private static class ResolutionClassInfo {
int resLowerLimit = -1;
int resUpperLimit = -1;
Class implClass;
public ResolutionClassInfo(Class implClass, String resPart) {
this.implClass = implClass;
grabResolutions(resPart);
}
private void grabResolutions(String resPart) {
if (StringUtils.isBlank(resPart)) {
return;
}
String[] split = resPart.split(SCHEMA_DIV);
String leftValue = split[1];
String rightValue = split[2];
if (KEYWORD_RES.equals(leftValue)) {
throw new NotImplementedException("Invalid keyword: " + KEYWORD_RES);
} else {
if (!KEYWORD_MIN.equals(leftValue)) {
resLowerLimit = Integer.valueOf(leftValue.replace(KEYWORD_PIXEL, ""));
}
if (!KEYWORD_MAX.equals(rightValue)) {
resUpperLimit = Integer.valueOf(rightValue.replace(KEYWORD_PIXEL, ""));
}
}
}
public boolean hasResolution() {
if (resLowerLimit < 0 && resUpperLimit < 0) {
return false;
}
return true;
}
public boolean matchesResolution(int resolution) {
if (resolution < 1) {
return true;
}
if (resLowerLimit < 0 && resUpperLimit < 0) {
return true;
}
boolean lowMatches = false;
boolean highMatches = false;
if (resolution >= resLowerLimit) {
lowMatches = true;
}
if (resUpperLimit < 0 || resolution <= resUpperLimit) {
highMatches = true;
}
return lowMatches && highMatches;
}
@Override
public String toString() {
return implClass.getSimpleName();
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy