/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.jmeter;
import java.awt.event.ActionEvent;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import org.apache.commons.cli.avalon.CLArgsParser;
import org.apache.commons.cli.avalon.CLOption;
import org.apache.commons.cli.avalon.CLOptionDescriptor;
import org.apache.commons.cli.avalon.CLUtil;
import org.apache.jmeter.config.gui.AbstractConfigGui;
import org.apache.jmeter.control.gui.ReportGui;
import org.apache.jmeter.engine.event.LoopIterationEvent;
import org.apache.jmeter.gui.ReportGuiPackage;
import org.apache.jmeter.plugin.JMeterPlugin;
import org.apache.jmeter.plugin.PluginManager;
import org.apache.jmeter.samplers.Remoteable;
import org.apache.jmeter.save.SaveService;
import org.apache.jmeter.services.FileServer;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.TestListener;
import org.apache.jmeter.testelement.ReportPlan;
import org.apache.jmeter.report.gui.ReportPageGui;
import org.apache.jmeter.report.gui.action.ReportLoad;
import org.apache.jmeter.report.gui.action.ReportActionRouter;
import org.apache.jmeter.report.gui.action.ReportCheckDirty;
import org.apache.jmeter.report.gui.tree.ReportTreeListener;
import org.apache.jmeter.report.gui.tree.ReportTreeModel;
import org.apache.jmeter.report.writers.gui.HTMLReportWriterGui;
import org.apache.jmeter.reporters.ResultCollector;
import org.apache.jmeter.reporters.Summariser;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jmeter.visualizers.gui.AbstractVisualizer;
import org.apache.jorphan.collections.HashTree;
import org.apache.jorphan.gui.ComponentUtil;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.util.JOrphanUtils;
import org.apache.log.Logger;
/**
*
* JMeterReport is the main class for the reporting component. For now,
* the plan is to make the reporting component a separate GUI, which
* can run in GUI or console mode. The purpose of the GUI is to design
* reports, which can then be run. One of the primary goals of the
* reporting component is to make it so the reports can be run in an
* automated process.
* The report GUI is different than the main JMeter GUI in several ways.
* <ul>
* <li> the gui is not multi-threaded</li>
* <li> the gui uses different components</li>
* <li> the gui is focused on designing reports from the jtl logs
* generated during a test run</li>
* </ul>
* The class follows the same design as JMeter.java. This should keep
* things consistent and make it easier to maintain.
*/
public class JMeterReport implements JMeterPlugin {
private static final Logger log = LoggingManager.getLoggerForClass();
private static final int PROPFILE_OPT = 'p';
private static final int PROPFILE2_OPT = 'q'; // Bug 33920 - additional
// prop files
private static final int TESTFILE_OPT = 't';
private static final int LOGFILE_OPT = 'l';
private static final int NONGUI_OPT = 'n';
private static final int HELP_OPT = 'h';
private static final int VERSION_OPT = 'v';
private static final int SERVER_OPT = 's';
private static final int JMETER_PROPERTY = 'J';
private static final int SYSTEM_PROPERTY = 'D';
private static final int LOGLEVEL = 'L';
private static final int REMOTE_OPT = 'r';
private static final int JMETER_HOME_OPT = 'd';
private JMeterReport parent;
private static final CLOptionDescriptor[] options = new CLOptionDescriptor[] {
new CLOptionDescriptor("help", CLOptionDescriptor.ARGUMENT_DISALLOWED, HELP_OPT,
"print usage information 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("addprop", CLOptionDescriptor.ARGUMENT_REQUIRED
| CLOptionDescriptor.DUPLICATES_ALLOWED, // Bug 33920 -
// allow
// multiple
// props
PROPFILE2_OPT, "additional property file(s)"),
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("nongui", CLOptionDescriptor.ARGUMENT_DISALLOWED, NONGUI_OPT,
"run JMeter in nongui mode"),
new CLOptionDescriptor("server", CLOptionDescriptor.ARGUMENT_DISALLOWED, SERVER_OPT,
"run the JMeter server"),
new CLOptionDescriptor("jmeterproperty", CLOptionDescriptor.DUPLICATES_ALLOWED
| CLOptionDescriptor.ARGUMENTS_REQUIRED_2, JMETER_PROPERTY, "Define additional JMeter properties"),
new CLOptionDescriptor("systemproperty", CLOptionDescriptor.DUPLICATES_ALLOWED
| CLOptionDescriptor.ARGUMENTS_REQUIRED_2, SYSTEM_PROPERTY, "Define additional JMeter properties"),
new CLOptionDescriptor("loglevel", CLOptionDescriptor.DUPLICATES_ALLOWED
| CLOptionDescriptor.ARGUMENTS_REQUIRED_2, LOGLEVEL,
"Define loglevel: [category=]level e.g. jorphan=INFO or " + "jmeter.util=DEBUG"),
new CLOptionDescriptor("runremote", CLOptionDescriptor.ARGUMENT_DISALLOWED, REMOTE_OPT,
"Start remote servers from non-gui mode"),
new CLOptionDescriptor("homedir", CLOptionDescriptor.ARGUMENT_REQUIRED, JMETER_HOME_OPT,
"the jmeter home directory to use"), };
transient boolean testEnded = false;
/**
*
*/
public JMeterReport() {
super();
}
/**
* The default icons for the report GUI.
*/
private static final String[][] DEFAULT_ICONS = {
{ AbstractVisualizer.class.getName(), "org/apache/jmeter/images/meter.png" },
{ AbstractConfigGui.class.getName(), "org/apache/jmeter/images/testtubes.png" },
{ HTMLReportWriterGui.class.getName(), "org/apache/jmeter/images/new/pencil.png" },
{ ReportPageGui.class.getName(), "org/apache/jmeter/images/new/scroll.png" },
{ ReportGui.class.getName(), "org/apache/jmeter/images/new/book.png" }
};
/* (non-Javadoc)
* @see org.apache.jmeter.plugin.JMeterPlugin#getIconMappings()
*/
public String[][] getIconMappings() {
String iconProp = JMeterUtils.getPropDefault("jmeter.icons", "org/apache/jmeter/images/icon.properties");
Properties p = JMeterUtils.loadProperties(iconProp);
if (p == null) {
log.info(iconProp + " not found - using default icon set");
return DEFAULT_ICONS;
}
log.info("Loaded icon properties from " + iconProp);
String[][] iconlist = new String[p.size()][3];
Enumeration pe = p.keys();
int i = 0;
while (pe.hasMoreElements()) {
String key = (String) pe.nextElement();
String icons[] = JOrphanUtils.split(p.getProperty(key), " ");
iconlist[i][0] = key;
iconlist[i][1] = icons[0];
if (icons.length > 1){
iconlist[i][2] = icons[1];
}
i++;
}
return iconlist;
}
/* (non-Javadoc)
* @see org.apache.jmeter.plugin.JMeterPlugin#getResourceBundles()
*/
public String[][] getResourceBundles() {
return new String[0][];
}
public void startNonGui(CLOption testFile, CLOption logFile){
System.setProperty("JMeter.NonGui", "true");
JMeterReport driver = new JMeterReport();
driver.parent = this;
PluginManager.install(this, false);
}
public void startGui(CLOption testFile) {
PluginManager.install(this, true);
ReportTreeModel treeModel = new ReportTreeModel();
ReportTreeListener treeLis = new ReportTreeListener(treeModel);
treeLis.setActionHandler(ReportActionRouter.getInstance());
ReportGuiPackage.getInstance(treeLis, treeModel);
org.apache.jmeter.gui.ReportMainFrame main =
new org.apache.jmeter.gui.ReportMainFrame(ReportActionRouter.getInstance(),
treeModel, treeLis);
ComponentUtil.centerComponentInWindow(main, 80);
main.show();
ReportActionRouter.getInstance().actionPerformed(new ActionEvent(main, 1, ReportCheckDirty.ADD_ALL));
if (testFile != null) {
FileInputStream reader = null;
try {
File f = new File(testFile.getArgument());
log.info("Loading file: " + f);
reader = new FileInputStream(f);
HashTree tree = SaveService.loadTree(reader);
ReportGuiPackage.getInstance().setReportPlanFile(f.getAbsolutePath());
new ReportLoad().insertLoadedTree(1, tree);
} catch (Exception e) {
log.error("Failure loading test file", e);
JMeterUtils.reportErrorToUser(e.toString());
}
finally{
JOrphanUtils.closeQuietly(reader);
}
}
}
private void run(String testFile, String logFile, boolean remoteStart) {
FileInputStream reader = null;
try {
File f = new File(testFile);
if (!f.exists() || !f.isFile()) {
System.out.println("Could not open " + testFile);
return;
}
FileServer.getFileServer().setBasedir(f.getAbsolutePath());
reader = new FileInputStream(f);
log.info("Loading file: " + f);
HashTree tree = SaveService.loadTree(reader);
// Remove the disabled items
// For GUI runs this is done in Start.java
convertSubTree(tree);
if (logFile != null) {
ResultCollector logger = new ResultCollector();
logger.setFilename(logFile);
tree.add(tree.getArray()[0], logger);
}
String summariserName = JMeterUtils.getPropDefault(
"summariser.name", "");//$NON-NLS-1$
if (summariserName.length() > 0) {
log.info("Creating summariser <" + summariserName + ">");
System.out.println("Creating summariser <" + summariserName + ">");
Summariser summer = new Summariser(summariserName);
tree.add(tree.getArray()[0], summer);
}
tree.add(tree.getArray()[0], new ListenToTest(parent));
System.out.println("Created the tree successfully");
/**
JMeterEngine engine = null;
if (!remoteStart) {
engine = new StandardJMeterEngine();
engine.configure(tree);
System.out.println("Starting the test");
engine.runTest();
} else {
String remote_hosts_string = JMeterUtils.getPropDefault(
"remote_hosts", "127.0.0.1");
java.util.StringTokenizer st = new java.util.StringTokenizer(
remote_hosts_string, ",");
List engines = new LinkedList();
while (st.hasMoreElements()) {
String el = (String) st.nextElement();
System.out.println("Configuring remote engine for " + el);
// engines.add(doRemoteInit(el.trim(), tree));
}
System.out.println("Starting remote engines");
Iterator iter = engines.iterator();
while (iter.hasNext()) {
engine = (JMeterEngine) iter.next();
engine.runTest();
}
System.out.println("Remote engines have been started");
}
**/
} catch (Exception e) {
System.out.println("Error in NonGUIDriver " + e.toString());
log.error("", e);
}
finally{
JOrphanUtils.closeQuietly(reader);
}
}
/**
*
* @param args
*/
public void start(String[] args) {
CLArgsParser parser = new CLArgsParser(args, options);
if (null != parser.getErrorString()) {
System.err.println("Error: " + parser.getErrorString());
System.out.println("Usage");
System.out.println(CLUtil.describeOptions(options).toString());
return;
}
try {
initializeProperties(parser);
log.info("Version " + JMeterUtils.getJMeterVersion());
log.info("java.version=" + System.getProperty("java.version"));
log.info(JMeterUtils.getJMeterCopyright());
if (parser.getArgumentById(VERSION_OPT) != null) {
System.out.println(JMeterUtils.getJMeterCopyright());
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(NONGUI_OPT) == null) {
startGui(parser.getArgumentById(TESTFILE_OPT));
} else {
startNonGui(parser.getArgumentById(TESTFILE_OPT), parser.getArgumentById(LOGFILE_OPT));
}
} catch (Exception e) {
e.printStackTrace();
System.out.println("An error occurred: " + e.getMessage());
System.exit(-1);
}
}
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");
}
// Bug 33845 - allow direct override of Home dir
if (parser.getArgumentById(JMETER_HOME_OPT) == null) {
JMeterUtils.setJMeterHome(NewDriver.getJMeterDir());
} else {
JMeterUtils.setJMeterHome(parser.getArgumentById(JMETER_HOME_OPT).getArgument());
}
// Process command line property definitions (can occur multiple times)
Properties jmeterProps = JMeterUtils.getJMeterProperties();
List clOptions = parser.getArguments();
int size = clOptions.size();
for (int i = 0; i < size; i++) {
CLOption option = (CLOption) clOptions.get(i);
String name = option.getArgument(0);
String value = option.getArgument(1);
switch (option.getDescriptor().getId()) {
case PROPFILE2_OPT: // Bug 33920 - allow multiple props
File f = new File(name);
try {
jmeterProps.load(new FileInputStream(f));
} catch (FileNotFoundException e) {
log.warn("Can't find additional property file: " + name, e);
} catch (IOException e) {
log.warn("Error loading additional property file: " + name, e);
}
break;
case SYSTEM_PROPERTY:
if (value.length() > 0) { // Set it
log.info("Setting System property: " + name + "=" + value);
System.getProperties().setProperty(name, value);
} else { // Reset it
log.warn("Removing System property: " + name);
System.getProperties().remove(name);
}
break;
case JMETER_PROPERTY:
if (value.length() > 0) { // Set it
log.info("Setting JMeter property: " + name + "=" + value);
jmeterProps.setProperty(name, value);
} else { // Reset it
log.warn("Removing JMeter property: " + name);
jmeterProps.remove(name);
}
break;
case LOGLEVEL:
if (value.length() > 0) { // Set category
log.info("LogLevel: " + name + "=" + value);
LoggingManager.setPriority(value, name);
} else { // Set root level
log.warn("LogLevel: " + name);
LoggingManager.setPriority(name);
}
break;
}
}
}
/**
* Code copied from AbstractAction.java and modified to suit TestElements
*
* @param tree
*/
private void convertSubTree(HashTree tree) {// TODO check build dependencies
Iterator iter = new LinkedList(tree.list()).iterator();
while (iter.hasNext()) {
TestElement item = (TestElement) iter.next();
if (item.isEnabled()) {
// This is done for GUI runs in JMeterTreeModel.addSubTree()
if (item instanceof ReportPlan) {
ReportPlan tp = (ReportPlan) item;
}
// TODO handle ReplaceableControllers
// if (item instanceof ReplaceableController)
// {
// System.out.println("Replaceable "+item.getClass().getName());
// HashTree subTree = tree.getTree(item);
//
// if (subTree != null)
// {
// ReplaceableController rc =
// (ReplaceableController) item;//.createTestElement();
// rc.replace(subTree);
// convertSubTree(subTree);
// tree.replace(item, rc.getReplacement());
// }
// }
// else
{
// System.out.println("NonReplaceable
// "+item.getClass().getName());
convertSubTree(tree.getTree(item));
// TestElement testElement = item.createTestElement();
// tree.replace(item, testElement);
}
} else {
// System.out.println("Disabled "+item.getClass().getName());
tree.remove(item);
}
}
}
/**
* 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 static class ListenToTest implements TestListener, Runnable, Remoteable {
int started = 0;
private JMeterReport _parent;
private ListenToTest(JMeterReport parent) {
_parent = parent;
}
public synchronized void testEnded(String host) {
started--;
log.info("Remote host " + host + " finished");
if (started == 0) {
testEnded();
}
}
public void testEnded() {
Thread stopSoon = new Thread(this);
stopSoon.start();
}
public synchronized void testStarted(String host) {
started++;
log.info("Started remote host: " + 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() {
System.out.println("Tidying up ...");
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
// ignored
}
System.out.println("... end of run");
_parent.testEnded = true;
}
/**
* @see TestListener#testIterationStart(LoopIterationEvent)
*/
public void testIterationStart(LoopIterationEvent event) {
// ignored
}
}
}