com.seleniumtests.reporter.TestLogging Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
There is a newer version: 4.23.18
/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 *
 * Licensed 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 com.seleniumtests.reporter;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.log4j.Appender;
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;

import org.testng.ITestResult;
import org.testng.Reporter;

import com.google.gdata.util.common.html.HtmlToText;
import com.seleniumtests.driver.screenshots.ScreenShot;
import com.seleniumtests.util.StringUtility;

/**
 * Log methods for test operations.
 */
public class TestLogging {

    private static Map>>> logMap = Collections.synchronizedMap(
            new HashMap>>>());

    private TestLogging() {
		// As a utility class, it is not meant to be instantiated.
	}
    
    /**
     * error Logger.
     *
     * @param  message
     */
    public static void errorLogger(String message) {
        String formattedMessage = "" + message + "";
        log(formattedMessage, false, false);
    }
    
    public static Logger getLogger(final Class cls) {
        boolean rootIsConfigured = Logger.getRootLogger().getAllAppenders().hasMoreElements();
        if (!rootIsConfigured) {
            BasicConfigurator.configure();
            Logger.getRootLogger().setLevel(Level.INFO);

            Appender appender = (Appender) Logger.getRootLogger().getAllAppenders().nextElement();
            appender.setLayout(new PatternLayout(" %-5p %d [%t] %C{1}: %m%n"));
        }

        return Logger.getLogger(cls);
    }

    public static Map>> getPageListenerLog(final String pageListenerClassName) {
        return logMap.get(pageListenerClassName);
    }

    public static List getPageListenerLogByMethodInstance(final ITestResult testResult) {

        for (Entry>>> listenerEntry : logMap.entrySet()) {
            if (!PluginsHelper.getInstance().isTestResultEffected(listenerEntry.getKey())) {
                continue;
            }

            Map>> pageMap = listenerEntry.getValue();
            for (Entry>> pageEntry : pageMap.entrySet()) {
                Map> errorMap = pageEntry.getValue();
                String methodInstance = StringUtility.constructMethodSignature(testResult.getMethod()
                            .getConstructorOrMethod().getMethod(), testResult.getParameters());
                return errorMap.get(methodInstance);
            }
        }

        return new ArrayList<>();
    }

    /**
     * Log info.
     *
     * @param  message
     */
    public static void logInfo(String message) {
        String formattedMessage = "" + message + "";
        log(formattedMessage, false, false);
    }

    /**
     * Log method.
     *
     * @param  message
     */
    public static void log(final String message) {
        log(message, false, false);
    }

    /**
     * Log.
     *
     * @param  message
     * @param  logToStandardOutput
     */
    public static void log(final String message, final boolean logToStandardOutput) {
        log(message, false, logToStandardOutput);
    }

    /**
     * Log principal method (all others log methods use this one at the end)
     *
     * @param  message
     * @param  failed
     * @param  logToStandardOutput
     */
    public static void log(String message, final boolean failed, final boolean logToStandardOutput) {

    	String formattedMessage = message;
        if (formattedMessage == null) {
        	formattedMessage = "";
        }

        formattedMessage = formattedMessage.replaceAll("\\n", "
");

        if (failed) {
        	formattedMessage = "" + formattedMessage + "";
        }

        Reporter.log(escape(formattedMessage), logToStandardOutput);
    }

    public static String escape(final String message) {
        return message.replaceAll("\\n", "
").replaceAll("<", "@@lt@@").replaceAll(">", "^^greaterThan^^");
    }

    public static String unEscape(String message) {
        String formattedMessage = message.replaceAll("
", "\\n").replaceAll("@@lt@@", "<").replaceAll("\\^\\^gt\\^\\^", ">");

        formattedMessage = HtmlToText.htmlToPlainText(formattedMessage);
        return formattedMessage;
    }

    /**
     * Log Web Output (add "Output:" to the message)
     *
     * @param  url
     * @param  message
     * @param  failed
     */
    public static void logWebOutput(final String message, final boolean failed) {
        log("Output: " + message + "
", failed, false);
    }

    /**
     * Log Web Step (add the message in the list of steps (with a number))
     *
     * @param  url
     * @param  message
     * @param  failed
     */
    public static void logWebStep(final String message, final boolean failed) {
        log("" + (failed ? "FailedStep: " : " ") + message + "", failed, false);
    }
    
    public static void logTestStep(TestStep testStep) {
    	log("" + (testStep.getFailed() ? "FailedStep: " : " ") + "" + testStep.getName() + "", testStep.getFailed(), false);
    	List actionList = testStep.getStepActions();
    	
    	if (!actionList.isEmpty()) {
    		log("");
	    	for (TestAction action: actionList) {
	    		if (action instanceof TestStep) {	
					logTestStep((TestStep)action);	
				} else {
					log("" + (action.getFailed() ? "FailedAction: " : " ") + action.getName() + "", action.getFailed(), false);
				}
			}
    		log("");
    	}
    	log("");
    	
    }

    /**
     * Log Screenshot method
     * Return: screenshot message with links
     *
     * @param  screenShot
     * 
     * @return String
     */
    public static String buildScreenshotLog(final ScreenShot screenShot) {
        StringBuilder sbMessage = new StringBuilder("");
        if (screenShot.getLocation() != null) {
            sbMessage.append("Application URL");
        }

        if (screenShot.getHtmlSourcePath() != null) {
            sbMessage.append(" | Application HTML Source");
        }

        if (screenShot.getImagePath() != null) {
            sbMessage.append(" | Application Snapshot");
        }

        return sbMessage.toString();
    }

    /**
     * Log method.
     *
     * @param  message
     */
    public static void warning(String message) {
        String formattedMessage = "" + message + "";
        log(formattedMessage, false, false);
    }
}