/*
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001,2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache JMeter" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache JMeter", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jmeter.engine;
import java.io.PrintWriter;
import java.io.Serializable;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.apache.jmeter.reporters.ResultCollector;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.TestListener;
import org.apache.jmeter.testelement.TestPlan;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.threads.JMeterThread;
import org.apache.jmeter.threads.JMeterThreadMonitor;
import org.apache.jmeter.threads.ListenerNotifier;
import org.apache.jmeter.threads.TestCompiler;
import org.apache.jmeter.threads.ThreadGroup;
import org.apache.jorphan.collections.HashTree;
import org.apache.jorphan.collections.ListedHashTree;
import org.apache.jorphan.collections.SearchByClass;
import org.apache.log.Hierarchy;
import org.apache.log.Logger;
/**
* @author $Author: mstover1 $
* @version $Revision: 1.28 $
*/
public class StandardJMeterEngine
implements JMeterEngine, JMeterThreadMonitor, Runnable, Serializable
{
transient private static Logger log =
Hierarchy.getDefaultHierarchy().getLoggerFor("jmeter.engine");
private Thread runningThread;
private static long WAIT_TO_DIE = 5 * 1000; //5 seconds
Map allThreads;
boolean running = false;
boolean serialized = false;
boolean schcdule_run = false;
HashTree test;
SearchByClass testListeners;
String host = null;
ListenerNotifier notifier;
public StandardJMeterEngine()
{
allThreads = new HashMap();
}
public StandardJMeterEngine(String host)
{
this();
this.host = host;
}
public void configure(HashTree testTree)
{
test = testTree;
}
public void setHost(String host)
{
this.host = host;
}
protected HashTree getTestTree()
{
return test;
}
protected void compileTree()
{
PreCompiler compiler = new PreCompiler();
getTestTree().traverse(compiler);
}
public void runTest() throws JMeterEngineException
{
try
{
runningThread = new Thread(this);
runningThread.start();
}
catch (Exception err)
{
stopTest();
StringWriter string = new StringWriter();
PrintWriter writer = new PrintWriter(string);
err.printStackTrace(writer);
throw new JMeterEngineException(string.toString());
}
}
private void removeThreadGroups(List elements)
{
Iterator iter = elements.iterator();
while (iter.hasNext())
{
Object item = iter.next();
if (item instanceof ThreadGroup)
{
iter.remove();
}
else if (!(item instanceof TestElement))
{
iter.remove();
}
}
}
protected void setMode()
{
SearchByClass testPlan = new SearchByClass(TestPlan.class);
getTestTree().traverse(testPlan);
Object[] plan = testPlan.getSearchResults().toArray();
ResultCollector.enableFunctionalMode(
((TestPlan) plan[0]).isFunctionalMode());
}
protected void notifyTestListenersOfStart()
{
Iterator iter = testListeners.getSearchResults().iterator();
while (iter.hasNext())
{
if (host == null)
{
((TestListener) iter.next()).testStarted();
}
else
{
((TestListener) iter.next()).testStarted(host);
}
}
}
protected void notifyTestListenersOfEnd()
{
Iterator iter = testListeners.getSearchResults().iterator();
while (iter.hasNext())
{
if (host == null)
{
((TestListener) iter.next()).testEnded();
}
else
{
((TestListener) iter.next()).testEnded(host);
}
}
}
private ListedHashTree cloneTree(ListedHashTree tree)
{
TreeCloner cloner = new TreeCloner(true);
tree.traverse(cloner);
return cloner.getClonedTree();
}
public void reset()
{
if (running)
{
stopTest();
}
}
public synchronized void threadFinished(JMeterThread thread)
{
allThreads.remove(thread);
if (!serialized && allThreads.size() == 0 && !schcdule_run )
{
stopTest();
}
}
public synchronized void stopTest()
{
Thread stopThread = new Thread(new StopTest());
stopThread.start();
}
private class StopTest implements Runnable
{
public void run()
{
if (running)
{
running = false;
tellThreadsToStop();
try
{
Thread.sleep(10 * allThreads.size());
}
catch (InterruptedException e)
{}
verifyThreadsStopped();
notifyTestListenersOfEnd();
}
}
}
public void run()
{
log.info("Running the test!");
running = true;
SearchByClass testPlan = new SearchByClass(TestPlan.class);
getTestTree().traverse(testPlan);
Object[] plan = testPlan.getSearchResults().toArray();
if (((TestPlan) plan[0]).isSerialized())
serialized = true;
compileTree();
List testLevelElements =
new LinkedList(getTestTree().list(getTestTree().getArray()[0]));
removeThreadGroups(testLevelElements);
SearchByClass searcher = new SearchByClass(ThreadGroup.class);
testListeners = new SearchByClass(TestListener.class);
setMode();
getTestTree().traverse(testListeners);
getTestTree().traverse(searcher);
TestCompiler.initialize();
//for each thread group, generate threads
// hand each thread the sampler controller
// and the listeners, and the timer
JMeterThread[] threads;
Iterator iter = searcher.getSearchResults().iterator();
if (iter.hasNext())
{
notifyTestListenersOfStart();
}
notifier = new ListenerNotifier();
schcdule_run = true;
JMeterContextService.getContext().setSamplingStarted(true);
int groupCount = 1;
while (iter.hasNext())
{
ThreadGroup group = (ThreadGroup) iter.next();
threads = new JMeterThread[group.getNumThreads()];
log.info("Starting " + threads.length + " test threads");
for (int i = 0; running && i < threads.length; i++)
{
ListedHashTree threadGroupTree =
(ListedHashTree) searcher.getSubTree(group);
threadGroupTree.add(group, testLevelElements);
threads[i] =
new JMeterThread(
cloneTree(threadGroupTree),
this,
notifier);
threads[i].setThreadNum(i);
threads[i].setInitialContext(JMeterContextService.getContext());
threads[i].setInitialDelay(
(int) (((float) (group.getRampUp() * 1000)
/ (float) group.getNumThreads())
* (float) i));
threads[i].setThreadName(group.getName() + (groupCount++) + "-" + (i + 1));
scheduleThread(threads[i], group);
Thread newThread = new Thread(threads[i]);
newThread.setName(threads[i].getThreadName());
allThreads.put(threads[i], newThread);
if (serialized
&& !iter.hasNext()
&& i == threads.length - 1) //last thread
{
serialized = false;
}
newThread.start();
}
schcdule_run = false;
if (serialized)
{
while (running && allThreads.size() > 0)
{
try
{
Thread.sleep(1000);
}
catch (InterruptedException e)
{}
}
}
}
}
/**
* This will schedule the time for the JMeterThread.
*
* @param thread
* @param group
*/
private void scheduleThread(JMeterThread thread, ThreadGroup group)
{
//if true the Scheduler is enabled
if (group.getScheduler())
{
//set the starttime for the Thread
thread.setStartTime(group.getStartTime());
//set the endtime for the Thread
thread.setEndTime(group.getEndTime());
//Enables the scheduler
thread.setScheduled(true);
}
}
private void verifyThreadsStopped()
{
Iterator iter = new HashSet(allThreads.keySet()).iterator();
while (iter.hasNext())
{
Thread t = (Thread) allThreads.get(iter.next());
if (t != null && t.isAlive())
{
try
{
t.join(WAIT_TO_DIE);
}
catch (InterruptedException e)
{}
if (t.isAlive())
{
log.info("Thread won't die: " + t.getName());
}
}
log.debug("finished thread");
}
}
private void tellThreadsToStop()
{
Iterator iter = new HashSet(allThreads.keySet()).iterator();
while (iter.hasNext())
{
JMeterThread item = (JMeterThread) iter.next();
item.stop();
Thread t = (Thread) allThreads.get(item);
if (t != null)
{
t.interrupt();
}
else
{
log.warn("Lost thread: " + item.getThreadName());
allThreads.remove(item);
}
}
}
}