se.claremont.taf.websupport.brokenlinkcheck.BrokenLinkReporter Maven / Gradle / Ivy

Go to download
package se.claremont.taf.websupport.brokenlinkcheck;

import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import se.claremont.taf.core.logging.LogLevel;
import se.claremont.taf.core.reporting.UxColors;
import se.claremont.taf.core.testcase.TestCase;

import java.util.ArrayList;
import java.util.List;

/**
 * Created by jordam on 2017-04-01.
 */
public class BrokenLinkReporter {
    private final TestCase testCase;
    private final WebDriver driver;
    private ArrayList linkCheckResults = null;
    private long startTime = 0;
    private LogLevel logLevel = LogLevel.VERIFICATION_PASSED;

    public BrokenLinkReporter(TestCase testCase, WebDriver driver){
        this.testCase = testCase;
        this.driver = driver;
    }

    /**
     * Checks current page for broken links and reports results to log as verifications.
     *
     * @param onlyDisplayedLinks Set to true to filter links for displayed links.
     * TODO: Should also add context path to local links
     * @return Returns true if successful
     */
    public boolean reportBrokenLinks(boolean onlyDisplayedLinks){
        log(LogLevel.DEBUG, "Initiating a check for broken links on current page (URL: '" + driver.getCurrentUrl() + "').");
        startTime = System.currentTimeMillis();
        linkCheckResults = getLinkCheckResults(onlyDisplayedLinks);
        setLogLevel();
        testCase.logDifferentlyToTextLogAndHtmlLog(logLevel, getReportAsText(), getReportAsHtml());
        return !logLevel.isFail();
    }

    @SuppressWarnings("UnnecessaryContinue")
    private void setLogLevel(){
        for(String[] linkresults : linkCheckResults){
            if(linkresults == null)continue;
            String responseCode = linkresults[1];
            if(responseCode != null && (responseCode.startsWith("2") || responseCode.startsWith("3"))){
                continue;
            } else if (responseCode == null || responseCode.equals("null")){
                if(logLevel != LogLevel.VERIFICATION_FAILED) logLevel = LogLevel.VERIFICATION_PROBLEM;
            } else {
                logLevel = LogLevel.VERIFICATION_FAILED;
                return;
            }
        }
    }

    private List getAllLinksOnCurrentPage(){
        return driver.findElements(By.xpath("//a"));
    }

    private ArrayList getLinkCheckResults(boolean onlyDisplayedLinks){
        ArrayList resultsTableRows = new ArrayList<>();
        List linkCheckingThreads = new ArrayList<>();
        for(WebElement link : getAllLinksOnCurrentPage()){
            if(link == null)continue;
            try{
                if(onlyDisplayedLinks && !link.isDisplayed())continue;
                Thread linkCheck = new Thread(new LinkCheck(resultsTableRows, link.getAttribute("href")));
                linkCheckingThreads.add(linkCheck);
                linkCheck.start();
            }catch (Exception e){
                System.out.println("Problems checking link: '" + link + "': " + e.toString());
            }
        }

        //Code below for waiting for all threads to finish due to log timing issues
        //noinspection ForLoopReplaceableByForEach
        for(int i = 0; i < linkCheckingThreads.size(); i++)
            try {
                linkCheckingThreads.get(i).join();
            } catch (InterruptedException e) {
                log(LogLevel.FRAMEWORK_ERROR, "Problems with checking links on page. Error: " + e.getMessage());
            }
        return resultsTableRows;
    }

    private void log(LogLevel logLevel, String message){
        if(testCase == null) {
            System.out.println(logLevel.toString() + ": " + message);
        } else {
            testCase.log(logLevel, message);
        }
    }

    private String getReportAsHtml(){
        StringBuilder htmlResults = new StringBuilder();
        htmlResults.append("");
        htmlResults.append("").append(System.lineSeparator());
        htmlResults.append("Checking for broken links on current page. Current URL: '").append(driver.getCurrentUrl()).append("'
").append(System.lineSeparator());
        htmlResults.append("A total of " + linkCheckResults.size() + " links were found on page. Results listing:
").append(System.lineSeparator());
        htmlResults.append("").append(System.lineSeparator());
        for(String[] linkresults : linkCheckResults) {
            String linkUrl = linkresults[0];
            String responseCode = linkresults[1];
            String responseTime = linkresults[2];
            String comment = linkresults[3];
            String rowClass;
            if (responseCode != null && (responseCode.startsWith("2") || responseCode.startsWith("3"))) {
                rowClass = "linkcheckpassed";
                if (comment == null) comment = "Ok";
            } else if (responseCode == null || responseCode.equals("null")) {
                rowClass = "linkcheckproblem";
                if (comment == null) comment = "Problems checking link";
            } else {
                rowClass = "linkcheckfail";
                if (comment == null) comment = "Link fail";
            }
            htmlResults.append("").append(System.lineSeparator());
        }
        htmlResults.append("Link Response
code Response
time (ms) Comment
" + linkUrl + " " + responseCode + " " + responseTime + " " + comment + "").append(System.lineSeparator());
        htmlResults.append("
Total verification time for link checks was " + (System.currentTimeMillis() - startTime) + " milliseconds.

").append(System.lineSeparator());
        htmlResults.append("").append(System.lineSeparator());
        return htmlResults.toString();
    }

    private String getReportAsText(){
        StringBuilder textResults = new StringBuilder();
        textResults.append(System.lineSeparator()).append("Checking for broken links on current page. Current URL: '").append(driver.getCurrentUrl()).append("'").append(System.lineSeparator());
        textResults.append("A total of " + linkCheckResults.size() + " links were found on page. Results listing:").append(System.lineSeparator());
        for(String[] linkresults : linkCheckResults){
            String linkUrl = linkresults[0];
            String responseCode = linkresults[1];
            String responseTime = linkresults[2];
            String comment = linkresults[3];
            if(responseCode != null && (responseCode.startsWith("2") || responseCode.startsWith("3"))){
                if(comment == null) comment = "Ok";
            } else if (responseCode == null || responseCode.equals("null")){
                if(comment == null) comment = "Problems checking link";
            } else {
                if(comment == null) comment = "Link fail";
            }
            textResults.append("URL: '" + linkUrl + "' => " + responseCode + " (" + responseTime + " ms) - " + comment + "").append(System.lineSeparator());
        }
        textResults.append("Total verification time for link checks was " + (System.currentTimeMillis() - startTime) + " milliseconds.").append(System.lineSeparator());
        return textResults.toString();
    }

}