com.nordstrom.automation.selenium.utility.PageSourceUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-foundation Show documentation
Selenium Foundation is an automation framework designed to extend and enhance the capabilities provided by Selenium (WebDriver).
There is a newer version: 28.3.1-s4
Show newest version
package com.nordstrom.automation.selenium.utility;

import java.net.URI;
import java.util.Optional;

import org.openqa.selenium.Capabilities;
import org.openqa.selenium.HasCapabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.slf4j.Logger;

import com.nordstrom.automation.selenium.core.WebDriverUtils;

/**
 * This utility class contains low-level methods that support page source artifact capture.
 */
public final class PageSourceUtils {
    
    private static final String TAKES_ELEMENT_SCREENSHOT = "takesElementScreenshot";
    private static final int HEAD_TAG_LENGTH = 6;
    
    /**
     * Private constructor to prevent instantiation.
     */
    private PageSourceUtils() {
        throw new AssertionError("PageSourceUtils is a static utility class that cannot be instantiated");
    }
    
    /**
     * Determine if the specified driver is capable of producing page source.
     * 
     * @param optDriver optional web driver object
     * @param logger SLF4J logger object; may be 'null'
     * @return 'true' if driver can produce page source; otherwise 'false
     */
    public static boolean canGetArtifact(final Optional optDriver, final Logger logger) {
        if (optDriver.isPresent()) {
            WebDriver driver = optDriver.get();
            if (driver instanceof HasCapabilities) {
                Capabilities caps = ((HasCapabilities) driver).getCapabilities();
                // if driver explicitly reports that it cannot produce page source
                if (Boolean.FALSE.equals(caps.getCapability(TAKES_ELEMENT_SCREENSHOT))) {
                    if (logger != null) {
                        logger.warn("This driver is not capable of producing page source.");
                    }
                } else {
                    return true;
                }
            } else {
                if (logger != null) {
                    logger.warn("Unable to determine if this driver can capture page source.");
                }
            }
        }
        return false;
    }
    
    /**
     * Produce page source from the specified driver.
     * 
     * @param optDriver optional web driver object
     * @param reason impetus for capture request; may be 'null'
     * @param logger SLF4J logger object; may be 'null'
     * @return page source; if capture fails, an empty string is returned
     */
    public static String getArtifact(
                    final Optional optDriver, final Throwable reason, final Logger logger) {
        
        if (canGetArtifact(optDriver, logger)) {
            try {
                WebDriver driver = optDriver.get();
                StringBuilder sourceBuilder = new StringBuilder(driver.getPageSource());
                insertBaseElement(sourceBuilder, driver);
                insertBreakpointInfo(sourceBuilder, reason);
                insertOriginalUrl(sourceBuilder, driver);
                return sourceBuilder.toString();
            } catch (WebDriverException e) {
                if (logger != null) {
                    logger.warn("The driver is capable of producing page source, but failed: {}", e.getMessage());
                }
            }
        }
        return "";
    }
    
    /**
     * Insert "base" node so that style sheets, images, and other relative resources load properly.
     * 
     * @param sourceBuilder {@link StringBuilder} object used to build page source
     * @param driver web driver object
     * @return the [sourceBuilder] object
     */
    private static StringBuilder insertBaseElement(final StringBuilder sourceBuilder, final WebDriver driver) {
        int offset = sourceBuilder.indexOf("") + HEAD_TAG_LENGTH;
        
        // if no head tag found
        if (offset < HEAD_TAG_LENGTH) {
            return sourceBuilder;
        }
        
        int closing = sourceBuilder.indexOf("", offset);
        String substr = sourceBuilder.substring(offset, closing);
        
        // if base already exists
        if (substr.contains("\n")
                .insert(offset, root)
                .insert(offset, "://")
                .insert(offset, uri.getScheme())
                .insert(offset, "\n");
        
        return sourceBuilder;
    }
    
    /**
     * Insert exception breakpoint information into page source.
     * 
     * @param sourceBuilder {@link StringBuilder} object used to build page source
     * @param reason impetus for capture request; may be 'null'
     * @return the [sourceBuilder] object
     */
    private static StringBuilder insertBreakpointInfo(final StringBuilder sourceBuilder, final Throwable reason) {
        if (reason != null) {
            Throwable cause = WebDriverUtils.getReportableCause(reason);
            StackTraceElement breakpoint = WebDriverUtils.getClientBreakpoint(cause);
            
            // if breakpoint was identified
            if (breakpoint != null) {
                // insert breakpoint message as comments
                sourceBuilder.insert(0, ") -->\n")
                        .insert(0, breakpoint.getLineNumber())
                        .insert(0, ":")
                        .insert(0, breakpoint.getClassName())
                        .insert(0, "\n")
                    .insert(0, message)
                    .insert(0, ": ")
                    .insert(0, cause.getClass().getSimpleName())
                    .insert(0, "\n")
                .insert(0, driver.getCurrentUrl())
                .insert(0, "