com.github.markusbernhardt.selenium2library.keywords.Logging Maven / Gradle / Ivy

Go to download
package com.github.markusbernhardt.selenium2library.keywords;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.python.core.PyString;
import org.python.util.PythonInterpreter;

import com.github.markusbernhardt.selenium2library.Selenium2LibraryNonFatalException;
import com.github.markusbernhardt.selenium2library.utils.Python;

public abstract class Logging extends JavaScript {

	protected final static Map VALID_LOG_LEVELS;

	static {
		VALID_LOG_LEVELS = new HashMap();
		VALID_LOG_LEVELS.put("debug", new String[] { "debug", "" });
		VALID_LOG_LEVELS.put("html", new String[] { "info", ", True, False" });
		VALID_LOG_LEVELS.put("info", new String[] { "info", "" });
		VALID_LOG_LEVELS.put("trace", new String[] { "trace", "" });
		VALID_LOG_LEVELS.put("warn", new String[] { "warn", "" });
	}

	// ##############################
	// Internal Methods
	// ##############################

	@Override
	protected void trace(String msg) {
		log(msg, "trace");
	}

	@Override
	protected void debug(String msg) {
		log(msg, "debug");
	}

	@Override
	protected void info(String msg) {
		log(msg, "info");
	}

	@Override
	protected void html(String msg) {
		log(msg, "html");
	}

	@Override
	protected void warn(String msg) {
		log(msg, "warn");
	}

	@Override
	protected void log(String msg, String logLevel) {
		String[] methodParameters = VALID_LOG_LEVELS
				.get(logLevel.toLowerCase());
		if (methodParameters != null) {
			log0(msg, methodParameters[0], methodParameters[1]);
		} else {
			throw new Selenium2LibraryNonFatalException(String.format(
					"Given log level %s is invalid.", logLevel));
		}
	}

	protected void log0(String msg, String methodName, String methodArguments) {
		if (msg.length() > 1024) {
			// Message is too large.
			// There is a hard limit of 100k in the Jython source code parser
			try {
				// Write message to temp file
				File tempFile = File
						.createTempFile("Selenium2Library-", ".log");
				tempFile.deleteOnExit();
				FileWriter writer = new FileWriter(tempFile);
				writer.write(msg);
				writer.close();

				// Read the message in Python back and log it.
				loggingPythonInterpreter.get().exec(
						String.format("from __future__ import with_statement\n"
								+ "\n" + "with open('%s', 'r') as msg_file:\n"
								+ "    msg = msg_file.read()\n"
								+ "    logger.%s(msg%s)", tempFile
								.getAbsolutePath().replace("\\", "\\\\"),
								methodName, methodArguments));

			} catch (IOException e) {
				throw new Selenium2LibraryNonFatalException(
						"Error in handling temp file for long log message.", e);
			}
		} else {
			// Message is small enough to get parsed by Jython
			loggingPythonInterpreter.get().exec(
					String.format("logger.%s('%s'%s)", methodName,
							msg.replace("'", "\\'").replace("\n", "\\n"),
							methodArguments));
		}
	}

	@Override
	protected List logList(List items) {
		return logList(items, "item");
	}

	@Override
	protected List logList(List items, String what) {
		List msg = new ArrayList();
		msg.add(String.format("Altogether %d %s%s.\n", items.size(), what,
				items.size() == 1 ? "" : "s"));
		for (int index = 0; index < items.size(); index++) {
			msg.add(String.format("%d: %s", index + 1, items.get(index)));
		}
		info(Python.join("\n", msg));
		return items;
	}

	@Override
	protected File getLogDir() {
		PyString logDirName = (PyString) loggingPythonInterpreter.get().eval(
				"GLOBAL_VARIABLES['${LOG FILE}']");
		if (logDirName != null) {
			return new File(logDirName.asString()).getParentFile();
		}
		logDirName = (PyString) loggingPythonInterpreter.get().eval(
				"GLOBAL_VARIABLES['${OUTPUTDIR}']");
		return new File(logDirName.asString()).getParentFile();
	}

	protected static ThreadLocal loggingPythonInterpreter = new ThreadLocal() {

		@Override
		protected PythonInterpreter initialValue() {
			PythonInterpreter pythonInterpreter = new PythonInterpreter();
			pythonInterpreter
					.exec("from robot.variables import GLOBAL_VARIABLES; from robot.api import logger;");
			return pythonInterpreter;
		}
	};
}