/*
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 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;
import java.awt.event.ActionEvent;
import java.io.File;
import java.io.FileInputStream;
import java.net.Authenticator;
import org.apache.avalon.excalibur.cli.CLArgsParser;
import org.apache.avalon.excalibur.cli.CLOption;
import org.apache.avalon.excalibur.cli.CLOptionDescriptor;
import org.apache.avalon.excalibur.cli.CLUtil;
import org.apache.jmeter.engine.RemoteJMeterEngine;
import org.apache.jmeter.engine.RemoteJMeterEngineImpl;
import org.apache.jmeter.engine.StandardJMeterEngine;
import org.apache.jmeter.exceptions.IllegalUserActionException;
import org.apache.jmeter.gui.GuiPackage;
import org.apache.jmeter.gui.action.ActionRouter;
import org.apache.jmeter.gui.action.CheckDirty;
import org.apache.jmeter.gui.action.Load;
import org.apache.jmeter.gui.tree.JMeterTreeListener;
import org.apache.jmeter.gui.tree.JMeterTreeModel;
import org.apache.jmeter.reporters.ResultCollector;
import org.apache.jmeter.save.SaveService;
import org.apache.jmeter.testelement.TestListener;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.log.Hierarchy;
import org.apache.log.Logger;
import org.apache.jorphan.collections.HashTree;
import org.apache.jorphan.gui.ComponentUtil;
/**
* @author mstover
*
* To change this generated comment edit the template variable "typecomment":
* Window>Preferences>Java>Templates.
*/
public class JMeter {
transient private static Logger log = Hierarchy.getDefaultHierarchy().getLoggerFor(
"jmeter");
private final static int PROPFILE_OPT = 'p';
private final static int TESTFILE_OPT = 't';
private final static int LOGFILE_OPT = 'l';
private final static int NONGUI_OPT = 'n';
protected static final int HELP_OPT = 'h';
protected static final int VERSION_OPT = 'v';
protected static final int SERVER_OPT = 's';
protected static final int PROXY_HOST = 'H';
protected static final int PROXY_PORT = 'P';
protected static final int PROXY_USERNAME = 'u';
protected static final int PROXY_PASSWORD = 'a';
/**
* Define the understood options. Each CLOptionDescriptor contains:
* - The "long" version of the option. Eg, "help" means that "--help" will
* be recognised.
* - The option flags, governing the option's argument(s).
* - The "short" version of the option. Eg, 'h' means that "-h" will be
* recognised.
* - A description of the option.
*/
protected static final CLOptionDescriptor[] options =
new CLOptionDescriptor[] {
new CLOptionDescriptor(
"help",
CLOptionDescriptor.ARGUMENT_DISALLOWED,
HELP_OPT,
"print this message and exit"),
new CLOptionDescriptor(
"version",
CLOptionDescriptor.ARGUMENT_DISALLOWED,
VERSION_OPT,
"print the version information and exit"),
new CLOptionDescriptor(
"propfile",
CLOptionDescriptor.ARGUMENT_REQUIRED,
PROPFILE_OPT,
"the jmeter property file to use"),
new CLOptionDescriptor(
"testfile",
CLOptionDescriptor.ARGUMENT_REQUIRED,
TESTFILE_OPT,
"the jmeter test(.jmx) file to run"),
new CLOptionDescriptor(
"logfile",
CLOptionDescriptor.ARGUMENT_REQUIRED,
LOGFILE_OPT,
"the file to log samples to"),
new CLOptionDescriptor(
"logfile",
CLOptionDescriptor.ARGUMENT_DISALLOWED,
NONGUI_OPT,
"run JMeter in nongui mode"),
new CLOptionDescriptor(
"server",
CLOptionDescriptor.ARGUMENT_DISALLOWED,
SERVER_OPT,
"run the JMeter server"),
new CLOptionDescriptor(
"proxyHost",
CLOptionDescriptor.ARGUMENT_REQUIRED,
PROXY_HOST,
"Set a proxy server for JMeter to use"),
new CLOptionDescriptor(
"proxyPort",
CLOptionDescriptor.ARGUMENT_REQUIRED,
PROXY_PORT,
"Set proxy server port for JMeter to use"),
new CLOptionDescriptor(
"username",
CLOptionDescriptor.ARGUMENT_REQUIRED,
PROXY_USERNAME,
"Set username for proxy server that JMeter is to use"),
new CLOptionDescriptor(
"password",
CLOptionDescriptor.ARGUMENT_REQUIRED,
PROXY_PASSWORD,
"Set password for proxy server that JMeter is to use"),
};
public JMeter() {
}
/**
* Starts up JMeter in GUI mode
*/
public void startGui(CLOption testFile) throws IllegalUserActionException {
JMeterTreeModel treeModel = new JMeterTreeModel();
JMeterTreeListener treeLis = new JMeterTreeListener(treeModel);
treeLis.setActionHandler(ActionRouter.getInstance());
GuiPackage guiPack = GuiPackage.getInstance(treeLis, treeModel);
org.apache.jmeter.gui.MainFrame main =
new org.apache.jmeter.gui.MainFrame(
ActionRouter.getInstance(),
treeModel,
treeLis);
main.setTitle("Apache JMeter");
main.setIconImage(JMeterUtils.getImage("jmeter.jpg").getImage());
ComponentUtil.centerComponentInWindow(main, 80);
main.show();
ActionRouter.getInstance().actionPerformed(
new ActionEvent(main, 1, CheckDirty.ADD_ALL));
if(testFile != null)
{
try
{
File f = new File(testFile.getArgument());
FileInputStream reader = new FileInputStream(f);
HashTree tree = SaveService.loadSubTree(reader);
new Load().insertLoadedTree(1,tree);
}
catch (Exception e)
{
log.error("Failure loading test file",e);
}
}
}
/**
* Takes the command line arguments and uses them to determine how to startup JMeter.
*/
public void start(String[] args) {
CLArgsParser parser = new CLArgsParser(args, options);
if (null != parser.getErrorString()) {
System.err.println("Error: " + parser.getErrorString());
return;
}
try {
initializeProperties(parser);
setProxy(parser);
if (parser.getArgumentById(VERSION_OPT) != null) {
System.out.println(
"Apache JMeter, Copyright (c) 2002 The Apache Software Foundation");
System.out.println("Version " + JMeterUtils.getJMeterVersion());
} else if (parser.getArgumentById(HELP_OPT) != null) {
System.out.println(
JMeterUtils.getResourceFileAsText("org/apache/jmeter/help.txt"));
} else if (parser.getArgumentById(SERVER_OPT) != null) {
startServer();
} else if (parser.getArgumentById(NONGUI_OPT) == null) {
startGui(parser.getArgumentById(TESTFILE_OPT));
} else {
startNonGui(
parser.getArgumentById(TESTFILE_OPT),
parser.getArgumentById(LOGFILE_OPT));
}
} catch (IllegalUserActionException e) {
System.out.println(e.getMessage());
System.out.println("Incorrect Usage");
System.out.println(CLUtil.describeOptions(options).toString());
}
}
/**
* Sets a proxy server for the JVM if the command line arguments are specified.
*/
private void setProxy(CLArgsParser parser) throws IllegalUserActionException {
if(parser.getArgumentById(PROXY_USERNAME) != null)
{
if(parser.getArgumentById(PROXY_PASSWORD) != null)
{
Authenticator.setDefault(new ProxyAuthenticator(
parser.getArgumentById(PROXY_USERNAME).getArgument(),
parser.getArgumentById(PROXY_PASSWORD).getArgument()));
}
else
{
Authenticator.setDefault(new ProxyAuthenticator(
parser.getArgumentById(PROXY_USERNAME).getArgument(),
""));
}
}
if (parser.getArgumentById(PROXY_HOST) != null
&& parser.getArgumentById(PROXY_PORT) != null) {
System.setProperty(
"http.proxyHost",
parser.getArgumentById(PROXY_HOST).getArgument());
System.setProperty(
"https.proxyHost",
parser.getArgumentById(PROXY_HOST).getArgument());
System.setProperty(
"http.proxyPort",
parser.getArgumentById(PROXY_PORT).getArgument());
System.setProperty(
"https.proxyPort",
parser.getArgumentById(PROXY_PORT).getArgument());
} else if (
parser.getArgumentById(PROXY_HOST) != null
|| parser.getArgumentById(PROXY_PORT) != null) {
throw new IllegalUserActionException(
JMeterUtils.getResString("proxy_cl_error"));
}
}
private void initializeProperties(CLArgsParser parser) {
if (parser.getArgumentById(PROPFILE_OPT) != null) {
JMeterUtils.getProperties(parser.getArgumentById(PROPFILE_OPT).getArgument());
} else {
JMeterUtils.getProperties(NewDriver.getJMeterDir() +
File.separator + "bin" + File.separator + "jmeter.properties");
}
JMeterUtils.setJMeterHome(NewDriver.getJMeterDir());
}
public void startServer() {
try {
RemoteJMeterEngine engine = new RemoteJMeterEngineImpl();
while (true) {
Thread.sleep(Long.MAX_VALUE);
}
} catch (Exception ex) {
log.error("",ex);
}
}
public void startNonGui(CLOption testFile, CLOption logFile)
throws IllegalUserActionException {
JMeter driver = new JMeter();
if (testFile == null) {
throw new IllegalUserActionException();
}
if (logFile == null) {
driver.run(testFile.getArgument(), null);
} else {
driver.run(testFile.getArgument(), logFile.getArgument());
}
}
private void run(String testFile, String logFile) {
FileInputStream reader = null;
try {
File f = new File(testFile);
if (!f.exists() || !f.isFile()) {
println("Could not open " + testFile);
return;
}
reader = new FileInputStream(f);
HashTree tree = SaveService.loadSubTree(reader);
if(logFile != null)
{
ResultCollector logger = new ResultCollector();
logger.setFilename(logFile);
tree.add(tree.getArray()[0],logger);
}
tree.add(tree.getArray()[0],new ListenToTest());
println("Created the tree successfully");
StandardJMeterEngine engine = new StandardJMeterEngine();
engine.configure(tree);
println("Starting the test");
engine.runTest();
} catch (Exception e) {
System.out.println("Error in NonGUIDriver" + e.getMessage());
log.error("",e);
}
}
/**
* Listen to test and exit program after test completes, after a 5 second delay to give listeners
* a chance to close out their files.
*/
private class ListenToTest implements TestListener,Runnable
{
public void testEnded(String host)
{
}
public void testEnded()
{
Thread stopSoon = new Thread(this);
stopSoon.start();
}
public void testStarted(String host)
{
}
public void testStarted()
{
log.info(JMeterUtils.getResString("running_test"));
}
/**
* This is a hack to allow listeners a chance to close their files. Must implement
* a queue for sample responses tied to the engine, and the engine won't deliver testEnded
* signal till all sample responses have been delivered. Should also improve performance of
* remote JMeter testing.
*/
public void run()
{
try {
Thread.sleep(5000);
} catch(InterruptedException e) {
}
System.exit(0);
}
}
private static void println(String str) {
System.out.println(str);
}
}