SuiteDispatcher.java

package org.testng.remote;

import org.testng.ISuite;
import org.testng.ISuiteResult;
import org.testng.ITestListener;
import org.testng.ITestResult;
import org.testng.SuiteRunner;
import org.testng.TestNGException;
import org.testng.collections.Lists;
import org.testng.internal.IConfiguration;
import org.testng.internal.Invoker;
import org.testng.internal.PropertiesFile;
import org.testng.remote.adapter.DefaultMastertAdapter;
import org.testng.remote.adapter.IMasterAdapter;
import org.testng.remote.adapter.RemoteResultListener;
import org.testng.xml.XmlSuite;
import org.testng.xml.XmlTest;

import java.util.Collection;
import java.util.List;
import java.util.Properties;

/**
 * Dispatches test suits according to the strategy defined.
 * 
 *  
 * @author	Guy Korland
 * @date 	April 20, 2007
 */
public class SuiteDispatcher
{
	/**
	 * Properties allowed in remote.properties
	 */
	public static final String MASTER_STRATEGY = "testng.master.strategy";
	public static final String VERBOSE = "testng.verbose";
	public static final String MASTER_ADPATER = "testng.master.adpter";

	/**
	 * Values allowed for STRATEGY
	 */
	public static final String STRATEGY_TEST = "test";
	public static final String STRATEGY_SUITE = "suite";

	final private int m_verbose;
	final private boolean m_isStrategyTest;

	final private IMasterAdapter m_masterAdpter;


	/**
	 * Creates a new suite dispatcher.
	 * 
	 * @param propertiesFile
	 * @throws Exception
	 */
	public SuiteDispatcher( String propertiesFile) throws TestNGException
	{
		try
		{
			PropertiesFile file = new PropertiesFile( propertiesFile);
			Properties properties = file.getProperties();

			m_verbose = Integer.parseInt( properties.getProperty(VERBOSE, "1"));

			String strategy = properties.getProperty(MASTER_STRATEGY, STRATEGY_SUITE);
			m_isStrategyTest = STRATEGY_TEST.equalsIgnoreCase(strategy);

			String adapter = properties.getProperty(MASTER_ADPATER);
			if( adapter == null)
			{
				m_masterAdpter = new DefaultMastertAdapter();
			}
			else
			{
				Class clazz = Class.forName(adapter);
				m_masterAdpter = (IMasterAdapter)clazz.newInstance();
			}
			m_masterAdpter.init(properties);
		}
		catch( Exception e)
		{
			throw new TestNGException( "Fail to initialize master mode", e);
		}
	}

	/**
	 * Dispatch test suites 
	 * @param suites
	 * @param outputDir
	 * @param javadocAnnotationFinder
	 * @param jdkAnnotationFinder
	 * @param testListeners
	 * @return suites result
	 */
	public List<ISuite> dispatch(IConfiguration configuration,
	    List<XmlSuite> suites, String outputDir, List<ITestListener> testListeners){
		List<ISuite> result = Lists.newArrayList();
		try
		{
			//
			// Dispatch the suites/tests
			//

			for (XmlSuite suite : suites) {
				suite.setVerbose(m_verbose);
				SuiteRunner suiteRunner = new SuiteRunner(configuration, suite, outputDir);
				RemoteResultListener listener = new RemoteResultListener( suiteRunner);
				if (m_isStrategyTest) {
					for (XmlTest test : suite.getTests()) {
						XmlSuite tmpSuite = new XmlSuite();
						tmpSuite.setXmlPackages(suite.getXmlPackages());
						tmpSuite.setAnnotations(suite.getAnnotations());
						tmpSuite.setJUnit(suite.isJUnit());
           tmpSuite.setSkipFailedInvocationCounts(suite.skipFailedInvocationCounts());
						tmpSuite.setName("Temporary suite for " + test.getName());
						tmpSuite.setParallel(suite.getParallel());
						tmpSuite.setParameters(suite.getParameters());
						tmpSuite.setThreadCount(suite.getThreadCount());
            tmpSuite.setDataProviderThreadCount(suite.getDataProviderThreadCount());
						tmpSuite.setVerbose(suite.getVerbose());
						tmpSuite.setObjectFactory(suite.getObjectFactory());
						XmlTest tmpTest = new XmlTest(tmpSuite);
						tmpTest.setAnnotations(test.getAnnotations());
						tmpTest.setBeanShellExpression(test.getExpression());
						tmpTest.setXmlClasses(test.getXmlClasses());
						tmpTest.setExcludedGroups(test.getExcludedGroups());
						tmpTest.setIncludedGroups(test.getIncludedGroups());
						tmpTest.setJUnit(test.isJUnit());
						tmpTest.setMethodSelectors(test.getMethodSelectors());
						tmpTest.setName(test.getName());
						tmpTest.setParallel(test.getParallel());
						tmpTest.setParameters(test.getParameters());
						tmpTest.setVerbose(test.getVerbose());
						tmpTest.setXmlClasses(test.getXmlClasses());
						tmpTest.setXmlPackages(test.getXmlPackages());

						m_masterAdpter.runSuitesRemotely(tmpSuite, listener); 
					}
				}
				else
				{
					m_masterAdpter.runSuitesRemotely(suite, listener);
				}
				result.add(suiteRunner);  
			}        

			m_masterAdpter.awaitTermination(100000);

			//
			// Run test listeners
			//
			for (ISuite suite : result) {
				for (ISuiteResult suiteResult : suite.getResults().values()) {
					Collection<ITestResult> allTests[] = new Collection[] {
							suiteResult.getTestContext().getPassedTests().getAllResults(),
							suiteResult.getTestContext().getFailedTests().getAllResults(),  
							suiteResult.getTestContext().getSkippedTests().getAllResults(),  
							suiteResult.getTestContext().getFailedButWithinSuccessPercentageTests().getAllResults(),  
					};
					for (Collection<ITestResult> all : allTests) {
						for (ITestResult tr : all) {
							Invoker.runTestListeners(tr, testListeners);
						}
					}
				}
			}
		}
		catch( Exception ex)
		{
			//TODO add to logs
			ex.printStackTrace();
		}
		return result;
	}
}