TestLogHelper.java

package com.framework.utils.log;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;


/**
 * Class to handle setting/removing MDC on per test case basis. This helps
 * us log each test case into it's own log file. Please see
 * {@link http://logback.qos.ch/manual/appenders.html#SiftingAppender}
 * and {@link http://logback.qos.ch/manual/mdc.html}
 * @author nullin
 */

public class TestLogHelper
{

	//region TestLogHelper - Variables Declaration and Initialization Section.

	private static final Logger logger = LoggerFactory.getLogger( TestLogHelper.class );

	public static final String TEST_NAME = "test-name";

	//endregion


	/**
	 * Adds the test name to MDC so that sift appender can use it and log the new
	 * log events to a different file
	 * @param name name of the new log file
	 */
	public static void startTestLogging( String name )
	{
		MDC.put( TEST_NAME, name );
	}

	/**
	 * Removes the key (log file name) from MDC
	 * @return name of the log file, if one existed in MDC
	 */
	public static String stopTestLogging()
	{
		String name = MDC.get( TEST_NAME );
		MDC.remove( TEST_NAME );
		return name;
	}
}