You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by mi...@apache.org on 2017/09/17 18:22:18 UTC
svn commit: r1808646 [18/22] - in /jmeter/trunk: docs/ docs/css/
docs/images/screenshots/ docs/images/screenshots/changes/3.3/
docs/images/screenshots/jdbc-config/ docs/localising/ docs/usermanual/
src/core/org/apache/jmeter/util/ xdocs/
Modified: jmeter/trunk/docs/usermanual/jmeter_tutorial.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/jmeter_tutorial.html?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/jmeter_tutorial.html (original)
+++ jmeter/trunk/docs/usermanual/jmeter_tutorial.html Sun Sep 17 18:22:16 2017
@@ -1,19 +1,209 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
-<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-15"><title>Apache JMeter
+<html lang="en">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
+<title>Apache JMeter
-
- How to write a plugin for JMeter</title><meta name="author" value="JMeter developers"><meta name="email" value="dev@jmeter.apache.org"><meta name="viewport" content="width=device-width, initial-scale=1"><link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css"><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css"><link rel="stylesheet" type="text/css" href="../css/new-style.css"><link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png"><link rel="icon" href="../images/favicon.png"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="../images/mstile-144x144.png"><meta name="theme-color" content="#ffffff"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!--
+ How to write a plugin for JMeter</title>
+<meta name="author" value="JMeter developers">
+<meta name="email" value="dev@jmeter.apache.org">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css">
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css">
+<link rel="stylesheet" type="text/css" href="../css/new-style.css">
+<link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png">
+<link rel="icon" href="../images/favicon.png">
+<meta name="msapplication-TileColor" content="#ffffff">
+<meta name="msapplication-TileImage" content="../images/mstile-144x144.png">
+<meta name="theme-color" content="#ffffff">
+</head>
+<body role="document">
+<a href="#content" class="hidden">Main content</a>
+<div class="header">
+<!--
APACHE LOGO
- --><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
+ -->
+<div>
+<a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a>
+</div>
+<!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li>
<li><a href="../usermanual/best-practices.html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log
Sampler</a></li><li><a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><
/ul></li></ul></div><div class="main" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="jmeter_accesslog_sampler_step_by_step.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="section"><h1 id="howto">30. How to write a plugin for JMeter<a class="sectionlink" href="#howto" title="Link to here">¶</a></h1>
+ -->
+<div>
+<a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a>
+</div>
+<div class="banner">
+<a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a>
+<div class="clear"></div>
+</div>
+</div>
+<div class="nav">
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">About</div>
+<ul>
+<li>
+<a href="../index.html">Overview</a>
+</li>
+<li>
+<a href="http://www.apache.org/licenses/">License</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Download</div>
+<ul>
+<li>
+<a href="../download_jmeter.cgi">Download Releases</a>
+</li>
+<li>
+<a href="../changes.html">Release Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Documentation</div>
+<ul>
+<li>
+<a href="../usermanual/get-started.html">Get Started</a>
+</li>
+<li>
+<a href="../usermanual/index.html">User Manual</a>
+</li>
+<li>
+<a href="../usermanual/best-practices.html">Best Practices</a>
+</li>
+<li>
+<a href="../usermanual/component_reference.html">Component Reference</a>
+</li>
+<li>
+<a href="../usermanual/functions.html">Functions Reference</a>
+</li>
+<li>
+<a href="../usermanual/properties_reference.html">Properties Reference</a>
+</li>
+<li>
+<a href="../changes_history.html">Change History</a>
+</li>
+<li>
+<a href="../api/index.html">Javadocs</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter">JMeter Wiki</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Tutorials</div>
+<ul>
+<li>
+<a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a>
+</li>
+<li>
+<a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Community</div>
+<ul>
+<li>
+<a href="../issues.html">Issue Tracking</a>
+</li>
+<li>
+<a href="http://www.apache.org/security/">Security</a>
+</li>
+<li>
+<a href="../mail.html">Mailing Lists</a>
+</li>
+<li>
+<a href="../svnindex.html">Source Repositories</a>
+</li>
+<li>
+<a href="../building.html">Building and Contributing</a>
+</li>
+<li>
+<a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Foundation</div>
+<ul>
+<li>
+<a href="http://www.apache.org/">The Apache Software Foundation (ASF)</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="main" id="content">
+<div class="social-media">
+<ul class="social-media-links">
+<li class="twitter">
+<a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a>
+</li>
+<li class="github">
+<a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a>
+</li>
+</ul>
+</div>
+<ul class="pagelinks">
+<li>
+<a href="jmeter_accesslog_sampler_step_by_step.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+</ul>
+<div class="section">
+<h1 id="howto">29. How to write a plugin for JMeter<a class="sectionlink" href="#howto" title="Link to here">¶</a>
+</h1>
+
<h3>Introduction from Peter Lin</h3>
+
<p>
On more than one occasion, users have complained JMeter's developer documentation is out of
date and not very useful. In an effort to make it easier for developers, I decided to write a simple
step-by-step tutorial. When I mentioned this to mike, he had some ideas about what the tutorial
should cover.
</p>
+
<p>
Before we dive into the tutorial, I'd like to say writing a plugin isn't necessarily easy, even for
someone with several years of java experience. The first extension I wrote for JMeter was a
@@ -24,6 +214,7 @@ Most of the commercial tools out there f
Rather than fork over several hundred dollars for a lame testing tool, or a couple thousand dollars
for a good one, I decided it was easier and cheaper to write a plugin for JMeter.
</p>
+
<p>
After a two weeks of coding on my free time, I had a working prototype using Apache Soap driver.
I submitted it back to JMeter and mike asked me if I want to be a committer. I had contributed
@@ -32,13 +223,16 @@ written the access log sampler, Tomcat 5
improved the access log sampler tremendously and made it much more useful.
</p>
+
<h3>Introduction from Mike Stover</h3>
+
<p>
One of my primary goals in designing JMeter was to make it easy to write plugins to enhance as
many of JMeter's features as possible. Part of the benefit of being open-source is that a lot of
people could potentially lend their efforts to improve the application. I made a conscious decision
to sacrifice some simplicity in the code to make plugin writing a way of life for a JMeter developer.
</p>
+
<p>
While some folks have successfully dug straight into the code and made improvements to JMeter,
a real tutorial on how to do this has been lacking. I tried a long time ago to write some
@@ -46,7 +240,11 @@ documentation about it, but most people
attempt will be more successful.
</p>
-<div class="subsection"><h2 id="basic-structure">30.1 Basic structure of JMeter<a class="sectionlink" href="#basic-structure" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="basic-structure">29.1 Basic structure of JMeter<a class="sectionlink" href="#basic-structure" title="Link to here">¶</a>
+</h2>
+
<p>
JMeter is organized by protocols and functionality. This is done so that developers can build new
@@ -55,63 +253,168 @@ building JMeter later in the tutorial. S
use eclipse directory as a reference point.
</p>
+
<p>
Root directory - <span class="code">/eclipse/workspace/apache-jmeter/</span>
+
</p>
+
<p>
The folders inside of <span class="code">apache-jmeter</span>
+
</p>
+
<dl>
- <dt><span class="code">bin</span></dt><dd>contains the <span class="code">.bat</span> and <span class="code">.sh</span> files for starting JMeter.
+
+<dt>
+<span class="code">bin</span>
+</dt>
+<dd>contains the <span class="code">.bat</span> and <span class="code">.sh</span> files for starting JMeter.
It also contains <span class="code">ApacheJMeter.jar</span> and properties file</dd>
- <dt><span class="code">docs</span></dt><dd>directory contains the JMeter documentation files</dd>
- <dt><span class="code">extras</span></dt><dd>ant related extra files</dd>
- <dt><span class="code">lib</span></dt><dd>contains the required jar files for JMeter</dd>
- <dt><span class="code">lib/ext</span></dt><dd>contains the core jar files for JMeter and the protocols</dd>
- <dt><span class="code">src</span></dt><dd>contains subdirectory for each protocol and component</dd>
- <dt><span class="code">test</span></dt><dd>unit test related directory</dd>
- <dt><span class="code">xdocs</span></dt><dd>XML files for documentation. JMeter generates its documentation from XML.</dd>
+
+<dt>
+<span class="code">docs</span>
+</dt>
+<dd>directory contains the JMeter documentation files</dd>
+
+<dt>
+<span class="code">extras</span>
+</dt>
+<dd>ant related extra files</dd>
+
+<dt>
+<span class="code">lib</span>
+</dt>
+<dd>contains the required jar files for JMeter</dd>
+
+<dt>
+<span class="code">lib/ext</span>
+</dt>
+<dd>contains the core jar files for JMeter and the protocols</dd>
+
+<dt>
+<span class="code">src</span>
+</dt>
+<dd>contains subdirectory for each protocol and component</dd>
+
+<dt>
+<span class="code">test</span>
+</dt>
+<dd>unit test related directory</dd>
+
+<dt>
+<span class="code">xdocs</span>
+</dt>
+<dd>XML files for documentation. JMeter generates its documentation from XML.</dd>
+
</dl>
+
<p>
As the tutorial progresses, an explanation of the subdirectories will be provided. For now, lets
focus on <span class="code">src</span> directory.
</p>
+
<p>
The folders inside of <span class="code">src</span>
+
</p>
+
<dl>
- <dt><span class="code">components</span></dt><dd>contains non-protocol-specific components like visualizers, assertions, etc.</dd>
- <dt><span class="code">core</span></dt><dd>the core code of JMeter including all core interfaces and abstract classes.</dd>
- <dt><span class="code">examples</span></dt><dd>example sampler demonstrating how to use the new bean framework</dd>
- <dt><span class="code">functions</span></dt><dd>standard functions used by all components</dd>
- <dt><span class="code">jorphan</span></dt><dd>utility classes providing common utility functions</dd>
- <dt><span class="code">protocol</span></dt><dd>contains the different protocols JMeter supports</dd>
+
+<dt>
+<span class="code">components</span>
+</dt>
+<dd>contains non-protocol-specific components like visualizers, assertions, etc.</dd>
+
+<dt>
+<span class="code">core</span>
+</dt>
+<dd>the core code of JMeter including all core interfaces and abstract classes.</dd>
+
+<dt>
+<span class="code">examples</span>
+</dt>
+<dd>example sampler demonstrating how to use the new bean framework</dd>
+
+<dt>
+<span class="code">functions</span>
+</dt>
+<dd>standard functions used by all components</dd>
+
+<dt>
+<span class="code">jorphan</span>
+</dt>
+<dd>utility classes providing common utility functions</dd>
+
+<dt>
+<span class="code">protocol</span>
+</dt>
+<dd>contains the different protocols JMeter supports</dd>
+
</dl>
+
<p>
Within <span class="code">protocol</span> directory, are the protocol specific components.
</p>
+
<p>
The folders inside of <span class="code">protocol</span>
+
</p>
+
<dl>
- <dt><span class="code">ftp</span></dt><dd>components for load testing ftp servers</dd>
- <dt><span class="code">http</span></dt><dd>components for load testing web servers</dd>
- <dt><span class="code">java</span></dt><dd>components for load testing java components</dd>
- <dt><span class="code">jdbc</span></dt><dd>components for load testing database servers using JDBC</dd>
- <dt><span class="code">jndi</span></dt><dd>components for load testing JNDI</dd>
- <dt><span class="code">ldap</span></dt><dd>components for load testing LDAP servers</dd>
- <dt><span class="code">mail</span></dt><dd>components for load testing mail servers</dd>
- <dt><span class="code">tcp</span></dt><dd>components for load testing TCP services</dd>
+
+<dt>
+<span class="code">ftp</span>
+</dt>
+<dd>components for load testing ftp servers</dd>
+
+<dt>
+<span class="code">http</span>
+</dt>
+<dd>components for load testing web servers</dd>
+
+<dt>
+<span class="code">java</span>
+</dt>
+<dd>components for load testing java components</dd>
+
+<dt>
+<span class="code">jdbc</span>
+</dt>
+<dd>components for load testing database servers using JDBC</dd>
+
+<dt>
+<span class="code">jndi</span>
+</dt>
+<dd>components for load testing JNDI</dd>
+
+<dt>
+<span class="code">ldap</span>
+</dt>
+<dd>components for load testing LDAP servers</dd>
+
+<dt>
+<span class="code">mail</span>
+</dt>
+<dd>components for load testing mail servers</dd>
+
+<dt>
+<span class="code">tcp</span>
+</dt>
+<dd>components for load testing TCP services</dd>
+
</dl>
+
<p>
As a general rule, all samplers related to HTTP will reside in <span class="code">http</span> directory. The exception to the
rule is the Tomcat5 monitor. It is separate, because the functionality of the monitor is slightly
@@ -120,9 +423,14 @@ own directory. In terms of difficulty, w
write.
</p>
+
</div>
-<div class="subsection"><h2 id="testelement-contract">30.2 JMeter Gui – TestElement Contract<a class="sectionlink" href="#testelement-contract" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="testelement-contract">29.2 JMeter Gui – TestElement Contract<a class="sectionlink" href="#testelement-contract" title="Link to here">¶</a>
+</h2>
+
<p>
When writing any JMeter component, there are certain contracts you must be aware of – ways a
@@ -130,6 +438,7 @@ JMeter component is expected to behave i
section describes the contract that the GUI part of your component must fulfill.
</p>
+
<p>
GUI code in JMeter is strictly separated from Test Element code. Therefore, when you write a
component, there will be a class for the Test Element, and another for the GUI presentation. The
@@ -137,49 +446,88 @@ GUI presentation class is stateless in t
Test Element (there are exceptions to this though).
</p>
+
<p>
A GUI element should extend the appropriate abstract class provided:
</p>
+
<ul>
- <li><span class="code">AbstractSamplerGui</span></li>
- <li><span class="code">AbstractAssertionGui</span></li>
- <li><span class="code">AbstractConfigGui</span></li>
- <li><span class="code">AbstractControllerGui</span></li>
- <li><span class="code">AbstractPostProcessorGui</span></li>
- <li><span class="code">AbstractPreProcessorGui</span></li>
- <li><span class="code">AbstractVisualizer</span></li>
- <li><span class="code">AbstractTimerGui</span></li>
+
+<li>
+<span class="code">AbstractSamplerGui</span>
+</li>
+
+<li>
+<span class="code">AbstractAssertionGui</span>
+</li>
+
+<li>
+<span class="code">AbstractConfigGui</span>
+</li>
+
+<li>
+<span class="code">AbstractControllerGui</span>
+</li>
+
+<li>
+<span class="code">AbstractPostProcessorGui</span>
+</li>
+
+<li>
+<span class="code">AbstractPreProcessorGui</span>
+</li>
+
+<li>
+<span class="code">AbstractVisualizer</span>
+</li>
+
+<li>
+<span class="code">AbstractTimerGui</span>
+</li>
+
</ul>
+
<p>
These abstract classes provide so much plumbing work for you that not extending them, and
instead implementing the interfaces directly is hardly an option. If you have some burning need to
not extend these classes, then you can join me in IRC where I can convince you otherwise :-).
</p>
+
<p>
So, you've extended the appropriate GUI class, what's left to do? Follow these steps:
</p>
+
<ol>
- <li>Implement <span class="code">getResourceLabel()</span>
- <ol>
- <li>This method should return the name of the resource that represents the title/name of the
+
+<li>Implement <span class="code">getResourceLabel()</span>
+
+<ol>
+
+<li>This method should return the name of the resource that represents the title/name of the
component. The resource will have to be entered into JMeters <span class="code">messages.properties</span> file
(and possibly translations as well).</li>
- </ol>
- </li>
- <li>Create your GUI. Whatever style you like, layout your GUI. Your class ultimately extends
+
+</ol>
+
+</li>
+
+<li>Create your GUI. Whatever style you like, layout your GUI. Your class ultimately extends
<span class="code">JPanel</span>, so your layout must be in your class's own <span class="code">ContentPane</span>.
Do not hook up GUI elements to your <span class="code">TestElement</span> class via actions and events.
Let swing's internal model hang onto all the data as much as you possibly can.
<ol>
- <li>Some standard GUI stuff should be added to all JMeter GUI components:
+
+<li>Some standard GUI stuff should be added to all JMeter GUI components:
<ol>
- <li>Call <span class="code">setBorder(makeBorder())</span> for your class. This will give it the standard JMeter
+
+<li>Call <span class="code">setBorder(makeBorder())</span> for your class. This will give it the standard JMeter
border</li>
- <li>Add the title pane via <span class="code">makeTitlePanel()</span>. Usually this is the first thing added to your
+
+<li>Add the title pane via <span class="code">makeTitlePanel()</span>. Usually this is the first thing added to your
GUI, and should be done in a Box vertical layout scheme, or with JMeter's <span class="code">VerticalLayout</span>
class. Here is an example <span class="code">init()</span> method:
<pre class="source">
@@ -193,16 +541,25 @@ private void init() {
add(makeParameterPanel(),BorderLayout.CENTER);
}
</pre>
- </li>
- </ol>
- </li>
- </ol>
- </li>
- <li>Implement <span class="code">public void configure(TestElement el)</span>
- <ol>
- <li>Be sure to call <span class="code">super.configure(e)</span>. This will populate some of the data for you, like
+
+</li>
+
+</ol>
+
+</li>
+
+</ol>
+
+</li>
+
+<li>Implement <span class="code">public void configure(TestElement el)</span>
+
+<ol>
+
+<li>Be sure to call <span class="code">super.configure(e)</span>. This will populate some of the data for you, like
the name of the element.</li>
- <li>Use this method to set data into your GUI elements. Example:
+
+<li>Use this method to set data into your GUI elements. Example:
<pre class="source">
public void configure(TestElement el) {
super.configure(el);
@@ -222,14 +579,18 @@ public void configure(TestElement el) {
el.getPropertyAsString(RegexExtractor.REFNAME));
}
</pre>
- </li>
- <li>Implement <span class="code">public void modifyTestElement(TestElement e)</span>. This is where you
+
+</li>
+
+<li>Implement <span class="code">public void modifyTestElement(TestElement e)</span>. This is where you
move the data from your GUI elements to the <span class="code">TestElement</span>. It is the logical reverse of the
previous method.
<ol>
- <li>Call <span class="code">super.configureTestElement(e)</span>. This will take care of some default data for
+
+<li>Call <span class="code">super.configureTestElement(e)</span>. This will take care of some default data for
you.</li>
- <li>Example:
+
+<li>Example:
<pre class="source">
public void modifyTestElement(TestElement e) {
super.configureTestElement(e);
@@ -247,10 +608,14 @@ public void modifyTestElement(TestElemen
}
}
</pre>
- </li>
- </ol>
- </li>
- <li>Implement <span class="code">public TestElement createTestElement()</span>. This method should create a
+
+</li>
+
+</ol>
+
+</li>
+
+<li>Implement <span class="code">public TestElement createTestElement()</span>. This method should create a
new instance of your <span class="code">TestElement</span> class, and then pass it to the <span class="code">modifyTestElement(TestElement)</span>
method you made above
<pre class="source">
@@ -260,10 +625,15 @@ public TestElement createTestElement() {
return extractor;
}
</pre>
- </li>
- </ol>
- </li>
+
+</li>
+
</ol>
+
+</li>
+
+</ol>
+
<p>
The reason you cannot hold onto a reference for your Test Element is because JMeter reuses
@@ -275,20 +645,37 @@ knows when to call your configure, and <
straightforward way.
</p>
+
<p>
Writing Visualizers is somewhat of a special case, however.
</p>
+
</div>
-<div class="subsection"><h2 id="visualizer">30.3 Writing a Visualizer<a class="sectionlink" href="#visualizer" title="Link to here">¶</a></h2>
-<div class="clear"></div><div class="note">Load Testing in GUI mode being a bad practice, you should not develop such plugin. Have
+
+<div class="subsection">
+<h2 id="visualizer">29.3 Writing a Visualizer<a class="sectionlink" href="#visualizer" title="Link to here">¶</a>
+</h2>
+
+<div class="clear"></div>
+<div class="note">Load Testing in GUI mode being a bad practice, you should not develop such plugin. Have
a look at more up to date components like:
<ul>
-<li><a href="generating-dashboard.html">Web report</a></li>
-<li><a href="realtime-results.html">Real-Time results</a> with <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a></li>
+
+<li>
+<a href="generating-dashboard.html">Web report</a>
+</li>
+
+<li>
+<a href="realtime-results.html">Real-Time results</a> with <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a>
+</li>
+
</ul>
-</div><div class="clear"></div>
+
+</div>
+<div class="clear"></div>
+
<p>
Of the component types, visualizers require greater depth in Swing than something like controllers,
functions or samplers. You can find the full source for the distribution graph in
@@ -296,47 +683,87 @@ functions or samplers. You can find the
classes.
</p>
+
<dl>
- <dt><span class="code">DistributionGraphVisualizer</span></dt><dd>visualizer which JMeter instantiates</dd>
- <dt><span class="code">DistributionGraph</span></dt><dd>JComponent which draws the actual graph</dd>
+
+<dt>
+<span class="code">DistributionGraphVisualizer</span>
+</dt>
+<dd>visualizer which JMeter instantiates</dd>
+
+<dt>
+<span class="code">DistributionGraph</span>
+</dt>
+<dd>JComponent which draws the actual graph</dd>
+
</dl>
+
<p>
The easiest way to write a visualizer is to do the following:
</p>
+
<ol>
- <li>Extend <span class="code">org.apache.jmeter.visualizers.gui.AbstractVisualizer</span></li>
- <li>Implement any additional interfaces need for call back and event notification.
+
+<li>Extend <span class="code">org.apache.jmeter.visualizers.gui.AbstractVisualizer</span>
+</li>
+
+<li>Implement any additional interfaces need for call back and event notification.
For example, the <span class="code">DistributionGraphVisualizer</span> implements the following interfaces:
<ul>
- <li><span class="code">ImageVisualizer</span></li>
- <li><span class="code">ItemListener</span> – according to the comments in the class,
+
+<li>
+<span class="code">ImageVisualizer</span>
+</li>
+
+<li>
+<span class="code">ItemListener</span> – according to the comments in the class,
<span class="code">ItemListener</span> is out of date and isn't used anymore.</li>
- <li><span class="code">GraphListener</span></li>
- <li><span class="code">Clearable</span></li>
- </ul>
- </li>
+
+<li>
+<span class="code">GraphListener</span>
+</li>
+
+<li>
+<span class="code">Clearable</span>
+</li>
+
+</ul>
+
+</li>
+
</ol>
+
<p>
+
<span class="code">AbstractVisualizer</span> provides some common functionality, which most visualizers like
<span class="code">Graph Results</span> use. The common functionality provided by the abstract class includes:
</p>
+
<ul>
- <li>Configure test elements – This means it create a new <span class="code">ResultCollector</span>, sets the file and sets the error log</li>
- <li>Create the stock menu</li>
- <li>Update the test element when changes are made</li>
- <li>Create a file panel for the log file</li>
- <li>Create the title panel</li>
+
+<li>Configure test elements – This means it create a new <span class="code">ResultCollector</span>, sets the file and sets the error log</li>
+
+<li>Create the stock menu</li>
+
+<li>Update the test element when changes are made</li>
+
+<li>Create a file panel for the log file</li>
+
+<li>Create the title panel</li>
+
</ul>
+
<p>
In some cases, you may not want to display the menu for the file textbox. In that case, you can
override the <span class="code">init()</span> method. Here is the implementation for <span class="code">DistributionGraphVisualizer</span>.
</p>
+
<pre class="source">
/**
* Initialize the GUI.
@@ -359,12 +786,14 @@ private void init() {
}
</pre>
+
<p>
The first thing the <span class="code">init</span> method does is create a new <span class="code">BorderLayout</span>. Depending on how you want to
layout the widgets, you may want to use a different layout manager. Keep mind using different
layout managers is for experts.
</p>
+
<p>
The second thing the <span class="code">init</span> method does is create a border. If you want to increase or decrease
the border, change the four integer values. Each integer value represents pixels. If you want your
@@ -372,6 +801,7 @@ visualizer to have no border, skip lines
responsible for configuring and adding the <span class="code">DistributionGraph</span> to the visualizer.
</p>
+
<pre class="source">
private Component createGraphPanel() {
graphPanel = new JPanel();
@@ -383,11 +813,13 @@ private Component createGraphPanel() {
}
</pre>
+
<p>
At line 5, the graph component is added to the graph panel. The constructor is where a new
instance of <span class="code">DistributionGraph</span> is created.
</p>
+
<pre class="source">
public DistributionGraphVisualizer() {
model = new SamplingStatCalculator("Distribution");
@@ -397,12 +829,14 @@ public DistributionGraphVisualizer() {
}
</pre>
+
<p>
The constructor of <span class="code">DistributionGraphVisualizer</span> is responsible for creating the model and the
graph. Every time a new result is complete, the engine passes the result to all the listeners by
calling <span class="code">add(SampleResult res)</span>. The visualizer passes the new <span class="code">SampleResult</span> to the model.
</p>
+
<pre class="source">
public synchronized void add(SampleResult res) {
model.addSample(res);
@@ -410,11 +844,13 @@ public synchronized void add(SampleResul
}
</pre>
+
<p>
In the case of the <span class="code">DistributionGraphVisualizer</span>, the <span class="code">add</span> method doesn't actually update the
graph. Instead, it calls <span class="code">updateGui</span> in line three.
</p>
+
<pre class="source">
public synchronized void updateGui(Sample s) {
// We have received one more sample
@@ -427,11 +863,13 @@ public synchronized void updateGui(Sampl
}
</pre>
+
<p>
Unlike <span class="code">GraphVisualizer</span>, the distribution graph attempts to show how the results clump; therefore
the <span class="code">DistributionGraphVisualizer</span> delays the update. The default delay is <span class="code">10</span> sampleresults.
</p>
+
<pre class="source">
public synchronized void updateGui() {
if (graph.getWidth() < 10) {
@@ -444,6 +882,7 @@ public synchronized void updateGui() {
}
</pre>
+
<p>
Lines 2 to 3 are suppose to resize the graph, if the user resizes the window or drags the divider.
Line 7 updates the panel containing the graph. Line 8 triggers the update of the <span class="code">DistributionGraph</span>.
@@ -451,18 +890,21 @@ Before we cover writing graphs, there ar
implement.
</p>
+
<pre class="source">
public String getLabelResource() {
return "distribution_graph_title";
}
</pre>
+
<p>
The label resource retrieves the name of the visualizer from the properties file. The file is located
in <span class="code">core/org/apache/jmeter/resources</span>. It's best not to hardcode the name of the visualizer.
<span class="code">Message.properties</span> file is organized alphabetically, so adding a new entry is easy.
</p>
+
<pre class="source">
public synchronized void clear() {
this.graph.clear();
@@ -471,40 +913,60 @@ public synchronized void clear() {
}
</pre>
+
<p>
Every component in JMeter should implement logic for <span class="code">clear()</span> method. If this isn't done, the
component will not clear the UI or model when the user tries to clear the last results and run a
new test. If clear is not implemented, it can result in a memory leak.
</p>
+
<pre class="source">
public JComponent getPrintableComponent() {
return this.graphPanel;
}
</pre>
+
<p>
The last method visualizers should implement is <span class="code">getPrintableComponent()</span>. The method is
responsible for returning the JComponent that can be saved or printed. This feature was recently
added so that users can save a screen capture of any given visualizer.
</p>
+
</div>
-<div class="subsection"><h2 id="graphlistener">30.4 GraphListener<a class="sectionlink" href="#graphlistener" title="Link to here">¶</a></h2>
-<div class="clear"></div><div class="note">Load Testing in GUI mode being a bad practice, you should not develop such plugin. Have
+
+<div class="subsection">
+<h2 id="graphlistener">29.4 GraphListener<a class="sectionlink" href="#graphlistener" title="Link to here">¶</a>
+</h2>
+
+<div class="clear"></div>
+<div class="note">Load Testing in GUI mode being a bad practice, you should not develop such plugin. Have
a look at more up to date components like:
<ul>
-<li><a href="generating-dashboard.html">Web report</a></li>
-<li><a href="realtime-results.html">Real-Time results</a> with <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a></li>
+
+<li>
+<a href="generating-dashboard.html">Web report</a>
+</li>
+
+<li>
+<a href="realtime-results.html">Real-Time results</a> with <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a>
+</li>
+
</ul>
-</div><div class="clear"></div>
+
+</div>
+<div class="clear"></div>
+
<p>
Visualizers should implement <span class="code">GraphListener</span>. This is done to make it simpler to add new Sample
instances to listeners. As a general rule, if the custom graph does not plot every single sample,
it does not need to implement the interface.
</p>
+
<pre class="source">
public interface GraphListener {
public void updateGui(Sample s);
@@ -512,6 +974,7 @@ public interface GraphListener {
}
</pre>
+
<p>
The important method in the interface is <span class="code">updateGui(Sample s)</span>. From
<span class="code">DistributionGraphVisualizer</span>, we see it calls <span class="code">graph.repaint()</span>
@@ -523,16 +986,32 @@ been updated, the visualizer will need t
implement the interface, please look at <span class="code">GraphVisualizer</span>.
</p>
+
</div>
-<div class="subsection"><h2 id="custom-graphs">30.5 Writing Custom Graphs<a class="sectionlink" href="#custom-graphs" title="Link to here">¶</a></h2>
-<div class="clear"></div><div class="note">Load Testing in GUI mode being a bad practice, you should not develop such plugin. Have
+
+<div class="subsection">
+<h2 id="custom-graphs">29.5 Writing Custom Graphs<a class="sectionlink" href="#custom-graphs" title="Link to here">¶</a>
+</h2>
+
+<div class="clear"></div>
+<div class="note">Load Testing in GUI mode being a bad practice, you should not develop such plugin. Have
a look at more up to date components like:
<ul>
-<li><a href="generating-dashboard.html">Web report</a></li>
-<li><a href="realtime-results.html">Real-Time results</a> with <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a></li>
+
+<li>
+<a href="generating-dashboard.html">Web report</a>
+</li>
+
+<li>
+<a href="realtime-results.html">Real-Time results</a> with <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a>
+</li>
+
</ul>
-</div><div class="clear"></div>
+
+</div>
+<div class="clear"></div>
+
<p>
For those new to Swing and haven't written custom JComponents yet, I would suggest getting a
book on Swing and get a good feel for how Swing widgets work. This tutorial will not attempt to
@@ -541,6 +1020,7 @@ MVC (Model View Controller) design patte
we see a new instance of <span class="code">DistributionGraph</span> is created with an instance of the model.
</p>
+
<pre class="source">
public DistributionGraph(SamplingStatCalculator model) {
this();
@@ -548,10 +1028,12 @@ public DistributionGraph(SamplingStatCal
}
</pre>
+
<p>
The implementation of <span class="code">setModel</span> method is straight forward.
</p>
+
<pre class="source">
private void setModel(Object model) {
this.model = (SamplingStatCalculator) model;
@@ -559,12 +1041,14 @@ private void setModel(Object model) {
}
</pre>
+
<p>
Notice the method calls <span class="code">repaint</span> after it sets the model. If <span class="code">repaint</span> isn't called, it can cause the
GUI to not draw the graph. Once the test starts, the graph would redraw, so calling <span class="code">repaint</span> isn't
critical.
</p>
+
<pre class="source">
public void paintComponent(Graphics g) {
super.paintComponent(g);
@@ -575,6 +1059,7 @@ public void paintComponent(Graphics g) {
}
</pre>
+
<p>
The other important aspect of updating the widget is placing the call to <span class="code">drawSample</span> within a
synchronized block. If <span class="code">drawSample</span> wasn't synchronized, JMeter would throw a
@@ -586,6 +1071,7 @@ until the graph is done redrawing before
implementation of <span class="code">drawSample</span>.
</p>
+
<pre class="source">
private void drawSample(SamplingStatCalculator model, Graphics g) {
width = getWidth();
@@ -659,6 +1145,7 @@ private void drawSample(SamplingStatCalc
}
</pre>
+
<p>
In general, the rendering of the graph should be fairly quick and shouldn't be a bottleneck. As a
general rule, it is a good idea to profile custom plugins. The only way to make sure a visualizer
@@ -667,51 +1154,83 @@ create a simple test plan and run it. Th
and predictable.
</p>
+
</div>
-<div class="subsection"><h2 id="testbean">30.6 Making a TestBean Plugin For JMeter<a class="sectionlink" href="#testbean" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="testbean">29.6 Making a TestBean Plugin For JMeter<a class="sectionlink" href="#testbean" title="Link to here">¶</a>
+</h2>
+
<p>
In this part, we will go through the process of creating a simple component for JMeter that uses
the new <span class="code">TestBean</span> framework.
</p>
+
<p>
This component will be a CSV file reading element that will let users easily vary their input data
using CSV files. To most effectively use this tutorial, open the three files specified below (found in
JMeter's <span class="code">src/components</span> directory).
</p>
+
<ol>
- <li>Pick a package and make three files:
+
+<li>Pick a package and make three files:
<ul>
- <li>[ComponentName].java (org.apache.jmeter.config.CSVDataSet.java)</li>
- <li>[ComponentName]BeanInfo.java (org.apache.jmeter.config.CSVDataSetBeanInfo.java)</li>
- <li>[ComponentName]Resources.properties (org.apache.jmeter.config.CSVDataSetResources.properties)</li>
- </ul>
- </li>
- <li><span class="code">CSVDataSet.java</span> must implement the <span class="code">TestBean</span> interface. In addition, it will extend
+
+<li>[ComponentName].java (org.apache.jmeter.config.CSVDataSet.java)</li>
+
+<li>[ComponentName]BeanInfo.java (org.apache.jmeter.config.CSVDataSetBeanInfo.java)</li>
+
+<li>[ComponentName]Resources.properties (org.apache.jmeter.config.CSVDataSetResources.properties)</li>
+
+</ul>
+
+</li>
+
+<li>
+<span class="code">CSVDataSet.java</span> must implement the <span class="code">TestBean</span> interface. In addition, it will extend
<span class="code">ConfigTestElement</span>, and implement <span class="code">LoopIterationListener</span>.
<ul>
- <li><span class="code">TestBean</span> is a marker interface, so there are no methods to implement.</li>
- <li>Extending <span class="code">ConfigTestElement</span> will make our component a <span class="code">Config</span> element in a test
+
+<li>
+<span class="code">TestBean</span> is a marker interface, so there are no methods to implement.</li>
+
+<li>Extending <span class="code">ConfigTestElement</span> will make our component a <span class="code">Config</span> element in a test
plan. By extending different abstract classes, you can control the type of element your
component will be (i.e. <span class="code">AbstractSampler</span>, <span class="code">AbstractVisualizer</span>, <span class="code">GenericController</span>, etc -
though you can also make different types of elements just by instantiating the right
interfaces, the abstract classes can make your life easier).
</li>
- </ul>
- </li>
- <li><span class="code">CSVDataSetBeanInfo.java</span> should extend <span class="code">org.apache.jmeter.testbeans.BeanInfoSupport</span>
- <ul>
- <li>create a zero-parameter constructor in which we call <span class="code">super(CSVDataSet.class);</span></li>
- <li>we'll come back to this.</li>
- </ul>
- </li>
- <li><span class="code">CSVDataSetResources.properties</span> - blank for now</li>
- <li>Implement your special logic for you plugin class.
+
+</ul>
+
+</li>
+
+<li>
+<span class="code">CSVDataSetBeanInfo.java</span> should extend <span class="code">org.apache.jmeter.testbeans.BeanInfoSupport</span>
+
+<ul>
+
+<li>create a zero-parameter constructor in which we call <span class="code">super(CSVDataSet.class);</span>
+</li>
+
+<li>we'll come back to this.</li>
+
+</ul>
+
+</li>
+
+<li>
+<span class="code">CSVDataSetResources.properties</span> - blank for now</li>
+
+<li>Implement your special logic for you plugin class.
<ol>
- <li>The <span class="code">CSVDataSet</span> will read a single CSV file and will store the values it finds into
+
+<li>The <span class="code">CSVDataSet</span> will read a single CSV file and will store the values it finds into
JMeter's running context. The user will define the file, define the variable names for
each "<span class="code">column</span>". The <span class="code">CSVDataSet</span> will open the file when the test starts, and close it
when the test ends (thus we implement <span class="code">TestListener</span>). The <span class="code">CSVDataSet</span> will update
@@ -722,22 +1241,31 @@ JMeter's <span class="code">src/componen
attention to your properties. These properties will become the basis of a GUI form by
which users will configure the <span class="code">CSVDataSet</span> element.
</li>
- <li>Your element will be cloned by JMeter when the test starts. Each thread will get it's
+
+<li>Your element will be cloned by JMeter when the test starts. Each thread will get it's
own instance. However, you will have a chance to control how the cloning is done, if
you need it.
</li>
- <li>Properties: <span class="code">filename</span>, <span class="code">variableNames</span>. With public getters and setters.
+
+<li>Properties: <span class="code">filename</span>, <span class="code">variableNames</span>. With public getters and setters.
<ul>
- <li><span class="code">filename</span> is self-explanatory, it will hold the name of the CSV file we'll read</li>
- <li><span class="code">variableNames</span> is a String which will allow a user to enter the names of the
+
+<li>
+<span class="code">filename</span> is self-explanatory, it will hold the name of the CSV file we'll read</li>
+
+<li>
+<span class="code">variableNames</span> is a String which will allow a user to enter the names of the
variables we'll assign values to. Why a String? Why not a Collection? Surely
users will need to enter multiple (and unknown number of) variable names? True,
but if we used a List or Collection, we'd have to write a GUI component to handle
collections, and I just want to do this quickly. Instead, we'll let users input
comma-delimited list of variable names.</li>
- </ul>
- </li>
- <li>I then implemented the <span class="code">IterationStart</span> method of the <span class="code">LoopIterationListener</span> interface.
+
+</ul>
+
+</li>
+
+<li>I then implemented the <span class="code">IterationStart</span> method of the <span class="code">LoopIterationListener</span> interface.
The point of this "event" is that your component is notified of when the test has entered
it's parent controller. For our purposes, every time the <span class="code">CSVDataSet</span>'s parent controller
is entered, we will read a new line of the data file and set the variables. Thus, for a
@@ -745,18 +1273,24 @@ JMeter's <span class="code">src/componen
read. For a loop controller, each iteration will do likewise. Every test thread will get
different values as well.
</li>
- </ol>
- </li>
- <li>Setting up your GUI elements in <span class="code">CSVDataSetBeanInfo</span>:
+
+</ol>
+
+</li>
+
+<li>Setting up your GUI elements in <span class="code">CSVDataSetBeanInfo</span>:
<ul>
- <li>You can create groupings for your component's properties. Each grouping you create
+
+<li>You can create groupings for your component's properties. Each grouping you create
needs a label and a list of property names to include in that grouping. I.e.:
<pre class="source">
createPropertyGroup("csv_data",
new String[] { "filename", "variableNames" });
</pre>
- </li>
- <li>Creates a grouping called <span class="code">csv_data</span> that will include GUI input elements for the
+
+</li>
+
+<li>Creates a grouping called <span class="code">csv_data</span> that will include GUI input elements for the
<span class="code">filename</span> and <span class="code">variableNames</span> properties of <span class="code">CSVDataSet</span>.
Then, we need to define what kind of properties we want these to be:
<pre class="source">
@@ -775,13 +1309,34 @@ p.setValue(NOT_EXPRESSION, Boolean.TRUE)
property. Here is a rundown:
<dl>
- <dt><span class="code">NOT_UNDEFINED</span></dt><dd>The property will not be left <span class="code">null</span>.</dd>
- <dt><span class="code">DEFAULT</span></dt><dd>A default values must be given if <span class="code">NOT_UNDEFINED</span> is <span class="code">true</span>.</dd>
- <dt><span class="code">NOT_EXPRESSION</span></dt><dd>The value will not be parsed for functions if this is <span class="code">true</span>.</dd>
- <dt><span class="code">NOT_OTHER</span></dt><dd>This is not a free form entry field – a list of values has to be provided.</dd>
- <dt><span class="code">TAGS</span></dt><dd>With a <span class="code">String[]</span> as the value, this sets up a predefined
+
+<dt>
+<span class="code">NOT_UNDEFINED</span>
+</dt>
+<dd>The property will not be left <span class="code">null</span>.</dd>
+
+<dt>
+<span class="code">DEFAULT</span>
+</dt>
+<dd>A default values must be given if <span class="code">NOT_UNDEFINED</span> is <span class="code">true</span>.</dd>
+
+<dt>
+<span class="code">NOT_EXPRESSION</span>
+</dt>
+<dd>The value will not be parsed for functions if this is <span class="code">true</span>.</dd>
+
+<dt>
+<span class="code">NOT_OTHER</span>
+</dt>
+<dd>This is not a free form entry field – a list of values has to be provided.</dd>
+
+<dt>
+<span class="code">TAGS</span>
+</dt>
+<dd>With a <span class="code">String[]</span> as the value, this sets up a predefined
list of acceptable values, and JMeter will create a dropdown select.</dd>
- </dl>
+
+</dl>
Additionally, a custom property editor can be specified for a property:
@@ -792,29 +1347,66 @@ p.setPropertyEditorClass(FileEditor.clas
This will create a text input plus browse button that opens a dialog for finding a file.
Usually, complex property settings are not needed, as now. For a more complex
example, look at <span class="code">org.apache.jmeter.protocol.http.sampler.AccessLogSamplerBeanInfo</span>
- </li>
- </ul>
- </li>
- <li>Defining your resource strings. In <span class="code">CSVDataSetResources.properties</span> we have to define all our
+
+</li>
+
+</ul>
+
+</li>
+
+<li>Defining your resource strings. In <span class="code">CSVDataSetResources.properties</span> we have to define all our
string resources. To provide translations, one would create additional files such as
<span class="code">CSVDataSetResources_ja.properties</span>, and <span class="code">CSVDataSetResources_de.properties</span>. For our
component, we must define the following resources:
<dl>
- <dt><span class="code">displayName</span></dt><dd>This will provide a name for the element that will appear in menus.</dd>
- <dt><span class="code">csv_data.displayName</span></dt><dd>we create a property grouping called <span class="code">csv_data</span>,
+
+<dt>
+<span class="code">displayName</span>
+</dt>
+<dd>This will provide a name for the element that will appear in menus.</dd>
+
+<dt>
+<span class="code">csv_data.displayName</span>
+</dt>
+<dd>we create a property grouping called <span class="code">csv_data</span>,
so we have to provide a label for the grouping</dd>
- <dt><span class="code">filename.displayName</span></dt><dd>a label for the filename input element.</dd>
- <dt><span class="code">filename.shortDescription</span></dt><dd>a tool-tip-like help text blurb.</dd>
- <dt><span class="code">variableNames.displayName</span></dt><dd>a label for the variable name input element.</dd>
- <dt><span class="code">variableNames.shortDescription</span></dt><dd>tool tip for the <span class="code">variableNames</span> input element.</dd>
- </dl>
- </li>
- <li>Debug your component.</li>
+
+<dt>
+<span class="code">filename.displayName</span>
+</dt>
+<dd>a label for the filename input element.</dd>
+
+<dt>
+<span class="code">filename.shortDescription</span>
+</dt>
+<dd>a tool-tip-like help text blurb.</dd>
+
+<dt>
+<span class="code">variableNames.displayName</span>
+</dt>
+<dd>a label for the variable name input element.</dd>
+
+<dt>
+<span class="code">variableNames.shortDescription</span>
+</dt>
+<dd>tool tip for the <span class="code">variableNames</span> input element.</dd>
+
+</dl>
+
+</li>
+
+<li>Debug your component.</li>
+
</ol>
+
</div>
-<div class="subsection"><h2 id="building">30.6 Building JMeter<a class="sectionlink" href="#building" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="building">29.6 Building JMeter<a class="sectionlink" href="#building" title="Link to here">¶</a>
+</h2>
+
<p>
Like other Jakarta projects, JMeter uses ANT to compile and build the distribution. JMeter has
@@ -823,51 +1415,173 @@ build tool similar to make on Unix. A li
below.
</p>
+
<dl>
- <dt><span class="code">all</span></dt><dd>builds all components and protocols</dd>
- <dt><span class="code">compile</span></dt><dd>compiles all the directories and components</dd>
- <dt><span class="code">compile-core</span></dt><dd>compiles the core directory and all dependencies</dd>
- <dt><span class="code">compile-components</span></dt><dd>compiles the components directory and all dependencies</dd>
- <dt><span class="code">compile-ftp</span></dt><dd>compiles the samples in ftp directory and all dependencies</dd>
- <dt><span class="code">compile-functions</span></dt><dd>compiles the functions and all dependencies</dd>
- <dt><span class="code">compile-htmlparser</span></dt><dd>compiles htmlparser and all dependencies</dd>
- <dt><span class="code">compile-http</span></dt><dd>compiles the samplers in http directory and all dependencies</dd>
- <dt><span class="code">compile-java</span></dt><dd>compiles the samplers in java directory and all dependencies</dd>
- <dt><span class="code">compile-jdbc</span></dt><dd>compiles the samplers in jdbc directory and all dependencies</dd>
- <dt><span class="code">compile-jorphan</span></dt><dd>compiles the jorphan utility classes</dd>
- <dt><span class="code">compile-ldap</span></dt><dd>compiles the samplers in ldap directory and all dependencies</dd>
- <dt><span class="code">compile-monitor</span></dt><dd>compiles the sampler in monitor directory and all dependencies</dd>
- <dt><span class="code">compile-rmi</span></dt><dd>compiles the samplers in rmi directory and all dependencies</dd>
- <dt><span class="code">compile-tests</span></dt><dd>compiles the tests and all dependencies</dd>
- <dt><span class="code">docs-api</span></dt><dd>creates the <span class="code">javadocsdocs-all</span> – generates all docs.</dd>
- <dt><span class="code">package</span></dt><dd>compiles everything and creates jar files of the compiled protocols</dd>
- <dt><span class="code">package-only</span></dt><dd>creates jar files of the compiled components</dd>
+
+<dt>
+<span class="code">all</span>
+</dt>
+<dd>builds all components and protocols</dd>
+
+<dt>
+<span class="code">compile</span>
+</dt>
+<dd>compiles all the directories and components</dd>
+
+<dt>
+<span class="code">compile-core</span>
+</dt>
+<dd>compiles the core directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-components</span>
+</dt>
+<dd>compiles the components directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-ftp</span>
+</dt>
+<dd>compiles the samples in ftp directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-functions</span>
+</dt>
+<dd>compiles the functions and all dependencies</dd>
+
+<dt>
+<span class="code">compile-htmlparser</span>
+</dt>
+<dd>compiles htmlparser and all dependencies</dd>
+
+<dt>
+<span class="code">compile-http</span>
+</dt>
+<dd>compiles the samplers in http directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-java</span>
+</dt>
+<dd>compiles the samplers in java directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-jdbc</span>
+</dt>
+<dd>compiles the samplers in jdbc directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-jorphan</span>
+</dt>
+<dd>compiles the jorphan utility classes</dd>
+
+<dt>
+<span class="code">compile-ldap</span>
+</dt>
+<dd>compiles the samplers in ldap directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-monitor</span>
+</dt>
+<dd>compiles the sampler in monitor directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-rmi</span>
+</dt>
+<dd>compiles the samplers in rmi directory and all dependencies</dd>
+
+<dt>
+<span class="code">compile-tests</span>
+</dt>
+<dd>compiles the tests and all dependencies</dd>
+
+<dt>
+<span class="code">docs-api</span>
+</dt>
+<dd>creates the javadocs</dd>
+
+<dt>
+<span class="code">docs-all</span>
+</dt>
+<dd>generates all docs.</dd>
+
+<dt>
+<span class="code">package</span>
+</dt>
+<dd>compiles everything and creates jar files of the compiled protocols</dd>
+
+<dt>
+<span class="code">package-only</span>
+</dt>
+<dd>creates jar files of the compiled components</dd>
+
</dl>
+
<p>
Here are some example commands.
</p>
+
<dl>
- <dt><span class="code">ant compile-http</span></dt><dd>Compiles just http components</dd>
- <dt><span class="code">ant package</span></dt><dd>Creates the jar files</dd>
- <dt><span class="code">ant docs-all</span></dt><dd>Generates the html documentation and javadocs</dd>
+
+<dt>
+<span class="code">ant compile-http</span>
+</dt>
+<dd>Compiles just http components</dd>
+
+<dt>
+<span class="code">ant package</span>
+</dt>
+<dd>Creates the jar files</dd>
+
+<dt>
+<span class="code">ant docs-all</span>
+</dt>
+<dd>Generates the html documentation and javadocs</dd>
+
</dl>
+
</div>
-</div><ul class="pagelinks"><li><a href="jmeter_accesslog_sampler_step_by_step.html">< Prev</a></li><li><a href="../index.html">Index</a></li></ul><div class="share-links">
+
+</div>
+<ul class="pagelinks">
+<li>
+<a href="jmeter_accesslog_sampler_step_by_step.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+</ul>
+<div class="share-links">
Share this page:
- <ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright">
+ <ul>
+<li class="fb">
+<a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a>
+</li>
+<li class="twitter">
+<a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a>
+</li>
+<li class="gplus">
+<a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a>
+</li>
+</ul>
+</div>
+</div>
+<div class="footer">
+<div class="copyright">
Copyright ©
1999 –
2017
, Apache Software Foundation
- </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
+ </div>
+<div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
feather, and the Apache JMeter logo are
trademarks of the
Apache Software Foundation.
- </div></div><script>(function(){
+ </div>
+</div>
+<script>(function(){
// fill in the current location into social links on this page.
"use strict";
var as = document.getElementsByTagName('a');
@@ -881,4 +1595,6 @@ Here are some example commands.
as[i].href = href + encodeURIComponent(loc);
}
}
- })();</script></body></html>
\ No newline at end of file
+ })();</script>
+</body>
+</html>
Modified: jmeter/trunk/docs/usermanual/junitsampler_tutorial.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/junitsampler_tutorial.html?rev=1808646&r1=1808645&r2=1808646&view=diff
==============================================================================
--- jmeter/trunk/docs/usermanual/junitsampler_tutorial.html (original)
+++ jmeter/trunk/docs/usermanual/junitsampler_tutorial.html Sun Sep 17 18:22:16 2017
@@ -1,18 +1,213 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
-<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-15"><title>Apache JMeter
+<html lang="en">
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
+<title>Apache JMeter
-
- JUnit Sampler Tutorial</title><meta name="author" value="JMeter developers"><meta name="email" value="dev@jmeter.apache.org"><meta name="viewport" content="width=device-width, initial-scale=1"><link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css"><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css"><link rel="stylesheet" type="text/css" href="../css/new-style.css"><link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png"><link rel="icon" href="../images/favicon.png"><meta name="msapplication-TileColor" content="#ffffff"><meta name="msapplication-TileImage" content="../images/mstile-144x144.png"><meta name="theme-color" content="#ffffff"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!--
+ JUnit Sampler Tutorial</title>
+<meta name="author" value="JMeter developers">
+<meta name="email" value="dev@jmeter.apache.org">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css">
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type="text/css">
+<link rel="stylesheet" type="text/css" href="../css/new-style.css">
+<link rel="apple-touch-icon-precomposed" href="../images/apple-touch-icon.png">
+<link rel="icon" href="../images/favicon.png">
+<meta name="msapplication-TileColor" content="#ffffff">
+<meta name="msapplication-TileImage" content="../images/mstile-144x144.png">
+<meta name="theme-color" content="#ffffff">
+</head>
+<body role="document">
+<a href="#content" class="hidden">Main content</a>
+<div class="header">
+<!--
APACHE LOGO
- --><div><a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a></div><!--
+ -->
+<div>
+<a href="http://www.apache.org"><img title="Apache Software Foundation" class="asf-logo logo" src="../images/asf-logo.svg" alt="Logo ASF"></a>
+</div>
+<!--
PROJECT LOGO
- --><div><a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a></div><div class="banner"><a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li onClick="return true"><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../changes.html">Release Notes</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Documentation</div><ul><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li>
<li><a href="../usermanual/best-practices.html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../usermanual/properties_reference.html">Properties Reference</a></li><li><a href="../changes_history.html">Change History</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Tutorials</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log
Sampler</a></li><li><a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Community</div><ul><li><a href="../issues.html">Issue Tracking</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">Source Repositories</a></li><li><a href="../building.html">Building and Contributing</a></li><li><a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li></ul></li></ul><ul class="menu"><li onClick="return true"><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><
/ul></li></ul></div><div class="main" id="content"><div class="social-media"><ul class="social-media-links"><li class="twitter"><a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a></li><li class="github"><a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a></li></ul></div><ul class="pagelinks"><li><a href="jmeter_proxy_step_by_step.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="jmeter_accesslog_sampler_step_by_step.html">Next ></a></li></ul><div class="section"><h1 id="junit">28. JUnit Sampler Tutorial<a class="sectionlink" href="#junit" title="Link to here">¶</a></h1>
+ -->
+<div>
+<a href="http://jmeter.apache.org/"><img class="logo" src="../images/logo.svg" alt="Apache JMeter"></a>
+</div>
+<div class="banner">
+<a href="http://www.apache.org/events/current-event.html"><img src="http://www.apache.org/events/current-event-234x60.png" alt="Current Apache event teaser"></a>
+<div class="clear"></div>
+</div>
+</div>
+<div class="nav">
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">About</div>
+<ul>
+<li>
+<a href="../index.html">Overview</a>
+</li>
+<li>
+<a href="http://www.apache.org/licenses/">License</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Download</div>
+<ul>
+<li>
+<a href="../download_jmeter.cgi">Download Releases</a>
+</li>
+<li>
+<a href="../changes.html">Release Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Documentation</div>
+<ul>
+<li>
+<a href="../usermanual/get-started.html">Get Started</a>
+</li>
+<li>
+<a href="../usermanual/index.html">User Manual</a>
+</li>
+<li>
+<a href="../usermanual/best-practices.html">Best Practices</a>
+</li>
+<li>
+<a href="../usermanual/component_reference.html">Component Reference</a>
+</li>
+<li>
+<a href="../usermanual/functions.html">Functions Reference</a>
+</li>
+<li>
+<a href="../usermanual/properties_reference.html">Properties Reference</a>
+</li>
+<li>
+<a href="../changes_history.html">Change History</a>
+</li>
+<li>
+<a href="../api/index.html">Javadocs</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter">JMeter Wiki</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Tutorials</div>
+<ul>
+<li>
+<a href="../usermanual/jmeter_distributed_testing_step_by_step.html">Distributed Testing</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_proxy_step_by_step.html">Recording Tests</a>
+</li>
+<li>
+<a href="../usermanual/junitsampler_tutorial.html">JUnit Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_accesslog_sampler_step_by_step.html">Access Log Sampler</a>
+</li>
+<li>
+<a href="../usermanual/jmeter_tutorial.html">Extending JMeter</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Community</div>
+<ul>
+<li>
+<a href="../issues.html">Issue Tracking</a>
+</li>
+<li>
+<a href="http://www.apache.org/security/">Security</a>
+</li>
+<li>
+<a href="../mail.html">Mailing Lists</a>
+</li>
+<li>
+<a href="../svnindex.html">Source Repositories</a>
+</li>
+<li>
+<a href="../building.html">Building and Contributing</a>
+</li>
+<li>
+<a href="https://projects.apache.org/project.html?jmeter">Project info at Apache</a>
+</li>
+<li>
+<a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="menu">
+<li onClick="return true">
+<div class="menu-title">Foundation</div>
+<ul>
+<li>
+<a href="http://www.apache.org/">The Apache Software Foundation (ASF)</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+</li>
+<li>
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="main" id="content">
+<div class="social-media">
+<ul class="social-media-links">
+<li class="twitter">
+<a href="https://twitter.com/ApacheJMeter" title="Follow us on Twitter"><i class="fa fa-twitter" aria-hidden="true"></i>Twitter</a>
+</li>
+<li class="github">
+<a href="https://github.com/apache/jmeter" title="Fork us on github"><i class="fa fa-github" aria-hidden="true"></i>github</a>
+</li>
+</ul>
+</div>
+<ul class="pagelinks">
+<li>
+<a href="jmeter_proxy_step_by_step.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+<li>
+<a href="jmeter_accesslog_sampler_step_by_step.html">Next ></a>
+</li>
+</ul>
+<div class="section">
+<h1 id="junit">27. JUnit Sampler Tutorial<a class="sectionlink" href="#junit" title="Link to here">¶</a>
+</h1>
+
<p>
This tutorial attempts to explain the basic design, functionality and usage of the new JUnit Sampler for JMeter.
The sampler was introduced in version 2.1.2 release of JMeter. Earlier releases do not have the sampler.
</p>
-<div class="subsection"><h2 id="design">28.1 Design<a class="sectionlink" href="#design" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="design">27.1 Design<a class="sectionlink" href="#design" title="Link to here">¶</a>
+</h2>
+
<p>
The current implementation supports standard JUnit convention and extensions, like <span class="code">oneTimeSetUp</span>
@@ -20,61 +215,118 @@ and <span class="code">oneTimeTearDown</
with some differences.
</p>
+
<ul>
- <li>Rather than use JMeter's test interface, it scans the jar files for classes extending JUnit's
+
+<li>Rather than use JMeter's test interface, it scans the jar files for classes extending JUnit's
<span class="code">TestCase</span> class. This means any class or subclass.</li>
- <li>JUnit test jar files are copied to <span class="code">jmeter/lib/junit</span> instead of
- <span class="code">jmeter/lib</span></li>
- <li>JUnit sampler does not use name/value pairs for configuration. The sampler assumes
+
+<li>JUnit test jar files are copied to <span class="code">jmeter/lib/junit</span> instead of
+ <span class="code">jmeter/lib</span>
+</li>
+
+<li>JUnit sampler does not use name/value pairs for configuration. The sampler assumes
<span class="code">setUp</span> and <span class="code">tearDown</span> will configure the test correctly.
- <div class="clear"></div><div class="note">Note: <span class="code">setUp</span> and <span class="code">tearDown</span> methods must be declared <span class="code">public</span>,
- so that JMeter can use it.</div><div class="clear"></div>
- </li>
- <li>The sampler measures the elapsed time only for the test method and does not include
+ <div class="clear"></div>
+<div class="note">Note: <span class="code">setUp</span> and <span class="code">tearDown</span> methods must be declared <span class="code">public</span>,
+ so that JMeter can use it.</div>
+<div class="clear"></div>
+
+</li>
+
+<li>The sampler measures the elapsed time only for the test method and does not include
<span class="code">setUp</span> and <span class="code">tearDown</span>.
</li>
- <li>Each time the test method is called, JMeter will pass the result to the listeners.</li>
- <li>Support for <span class="code">oneTimeSetUp</span> and <span class="code">oneTimeTearDown</span> is done as a method.
+
+<li>Each time the test method is called, JMeter will pass the result to the listeners.</li>
+
+<li>Support for <span class="code">oneTimeSetUp</span> and <span class="code">oneTimeTearDown</span> is done as a method.
Since JMeter is multi-threaded, we cannot call <span class="code">oneTimeSetUp</span>/<span class="code">oneTimeTearDown</span>
the same way maven does it.</li>
- <li>The sampler reports unexpected exceptions as errors.</li>
+
+<li>The sampler reports unexpected exceptions as errors.</li>
+
</ul>
+
</div>
-<div class="subsection"><h2 id="functionality">28.2 Functionality<a class="sectionlink" href="#functionality" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="functionality">27.2 Functionality<a class="sectionlink" href="#functionality" title="Link to here">¶</a>
+</h2>
+
<p>
Here is a description of the functionality.
</p>
+
<dl>
- <dt>Name</dt><dd>name for the sample. This is the same as all JMeter samplers.</dd>
- <dt>Package Filter</dt><dd>provides a way to filter the classes by package name.</dd>
- <dt>Classname</dt><dd>the name of the class to test. The sampler will scan the jar files in
+
+<dt>Name</dt>
+<dd>name for the sample. This is the same as all JMeter samplers.</dd>
+
+<dt>Package Filter</dt>
+<dd>provides a way to filter the classes by package name.</dd>
+
+<dt>Classname</dt>
+<dd>the name of the class to test. The sampler will scan the jar files in
<span class="code">jmeter/lib/ext</span> and <span class="code">jmeter/lib/junit</span> for classes extending
JUnit's <span class="code">TestCase</span>.</dd>
- <dt>Constructor String</dt><dd>a string to pass to the string constructor of the test class.</dd>
- <dt>Test Method</dt><dd>the name of the method to test in the sampler.</dd>
- <dt>Success message</dt><dd>a descriptive message indicating what success means.</dd>
- <dt>Success code</dt><dd>an unique code indicating the test was successful.</dd>
- <dt>Failure message</dt><dd>a descriptive message indicating what failure means.</dd>
- <dt>Failure code</dt><dd>an unique code indicating the test failed</dd>
- <dt>Error message</dt><dd>a description for errors</dd>
- <dt>Error code</dt><dd>some code for errors. Does not need to be unique</dd>
- <dt>Do not call <span class="code">setUp</span> and <span class="code">tearDown</span></dt><dd>set the sampler not
+
+<dt>Constructor String</dt>
+<dd>a string to pass to the string constructor of the test class.</dd>
+
+<dt>Test Method</dt>
+<dd>the name of the method to test in the sampler.</dd>
+
+<dt>Success message</dt>
+<dd>a descriptive message indicating what success means.</dd>
+
+<dt>Success code</dt>
+<dd>an unique code indicating the test was successful.</dd>
+
+<dt>Failure message</dt>
+<dd>a descriptive message indicating what failure means.</dd>
+
+<dt>Failure code</dt>
+<dd>an unique code indicating the test failed</dd>
+
+<dt>Error message</dt>
+<dd>a description for errors</dd>
+
+<dt>Error code</dt>
+<dd>some code for errors. Does not need to be unique</dd>
+
+<dt>Do not call <span class="code">setUp</span> and <span class="code">tearDown</span>
+</dt>
+<dd>set the sampler not
to call <span class="code">setUp</span> and <span class="code">tearDown</span>. By default, <span class="code">setUp</span> and
<span class="code">tearDown</span> should be called. Not calling those methods could affect the test and
make it inaccurate. This option should be used with caution.
- <div class="clear"></div><div class="note">If the selected method is <span class="code">oneTimeSetUp</span> or <span class="code">oneTimeTearDown</span>,
- this option should be checked.</div><div class="clear"></div></dd>
- <dt>Append assertion error</dt><dd>By default, the sampler will not append the assert failures
+ <div class="clear"></div>
+<div class="note">If the selected method is <span class="code">oneTimeSetUp</span> or <span class="code">oneTimeTearDown</span>,
+ this option should be checked.</div>
+<div class="clear"></div>
+</dd>
+
+<dt>Append assertion error</dt>
+<dd>By default, the sampler will not append the assert failures
to the failure message. To see the message in the result tree, check the option.</dd>
- <dt>Append runtime exception</dt><dd>By default, the sampler will not append the exceptions
+
+<dt>Append runtime exception</dt>
+<dd>By default, the sampler will not append the exceptions
to the failure message. To see the stacktrace, check the option</dd>
+
</dl>
-<figure><a href="../images/screenshots/junit_sampler.png"><img src="../images/screenshots/junit_sampler.png" width="397" height="536" alt="JUnit Request"></a><figcaption>JUnit Request</figcaption></figure>
+
+<figure>
+<a href="../images/screenshots/junit_sampler.png"><img src="../images/screenshots/junit_sampler.png" width="397" height="536" alt="JUnit Request"></a>
+<figcaption>JUnit Request</figcaption>
+</figure>
+
<p>
The current implementation of the sampler will try to create an instance using the string constructor
@@ -82,7 +334,10 @@ first. If the test class does not declar
constructor. Example below:
</p>
-<div class="example"><div class="title">Constructor Examples<a class="sectionlink" href="#constructor-examples" title="Link to here">¶</a></div>
+
+<div class="example">
+<div class="title">Constructor Examples<a class="sectionlink" href="#constructor-examples" title="Link to here">¶</a>
+</div>
Empty Constructor:
<pre class="source">
public class myTestCase {
@@ -98,44 +353,76 @@ public class myTestCase {
}
}
</pre>
+
</div>
+
<p>
By default, JMeter will provide some default values for the success/failure code and message.
Users should define a set of unique success and failure codes and use them uniformly across all tests.
</p>
+
</div>
-<div class="subsection"><h2 id="usage">28.3 Usage<a class="sectionlink" href="#usage" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="usage">27.3 Usage<a class="sectionlink" href="#usage" title="Link to here">¶</a>
+</h2>
+
<p>
Here is a short step-by-step.
</p>
+
<ol>
- <li>Write your JUnit test and jar the classes</li>
- <li>Copy and paste the jar files into <span class="code">jmeter/lib/junit</span> directory</li>
- <li>Start JMeter</li>
- <li>Select <span class="code">Test Plan</span></li>
- <li>Right click
- <span class="menuchoice"><span class="guimenuitem">Add</span> → <span class="guimenuitem">Thread Group</span></span></li>
- <li>Select <span class="code">Thread Group</span></li>
- <li>Right click
- <span class="menuchoice"><span class="guimenuitem">Add</span> → <span class="guimenuitem">Sampler</span> → <span class="guimenuitem">JUnit Request</span></span></li>
- <li>Enter <span class="code">my unit test</span> in the name</li>
- <li>Enter the package of your JUnit test</li>
- <li>Select the class you want to test</li>
- <li>Select a method to test</li>
- <li>Enter <span class="code">test successful</span> in success message</li>
- <li>Enter <span class="code">1000</span> in success code</li>
- <li>Enter <span class="code">test failed</span> in failure message</li>
- <li>Enter <span class="code">0001</span> in failure code</li>
- <li>Select the Thread Group</li>
- <li>Right click
- <span class="menuchoice"><span class="guimenuitem">Add</span> → <span class="guimenuitem">Listener</span> → <span class="guimenuitem">View Results Tree</span></span></li>
+
+<li>Write your JUnit test and jar the classes</li>
+
+<li>Copy and paste the jar files into <span class="code">jmeter/lib/junit</span> directory</li>
+
+<li>Start JMeter</li>
+
+<li>Select <span class="code">Test Plan</span>
+</li>
+
+<li>Right click
+ <span class="menuchoice"><span class="guimenuitem">Add</span> → <span class="guimenuitem">Thread Group</span></span>
+</li>
+
+<li>Select <span class="code">Thread Group</span>
+</li>
+
+<li>Right click
+ <span class="menuchoice"><span class="guimenuitem">Add</span> → <span class="guimenuitem">Sampler</span> → <span class="guimenuitem">JUnit Request</span></span>
+</li>
+
+<li>Enter <span class="code">my unit test</span> in the name</li>
+
+<li>Enter the package of your JUnit test</li>
+
+<li>Select the class you want to test</li>
+
+<li>Select a method to test</li>
+
+<li>Enter <span class="code">test successful</span> in success message</li>
+
+<li>Enter <span class="code">1000</span> in success code</li>
+
+<li>Enter <span class="code">test failed</span> in failure message</li>
+
+<li>Enter <span class="code">0001</span> in failure code</li>
+
+<li>Select the Thread Group</li>
+
+<li>Right click
+ <span class="menuchoice"><span class="guimenuitem">Add</span> → <span class="guimenuitem">Listener</span> → <span class="guimenuitem">View Results Tree</span></span>
+</li>
+
</ol>
+
<p>
One benefit of the JUnit sampler is it allows the user to select any method from a variety
of unit tests to create a test plan. This should reduce the amount of code an user needs to
@@ -143,10 +430,12 @@ write to create a variety of test scenar
sequences and tests can be created using JMeter's GUI.
</p>
+
<p>
For example:
</p>
+
<p>
Test Plan1
<pre class="source">
@@ -156,8 +445,10 @@ TestCase1.testSelect100
TestCase2.testUpdateOrder
TestCase1.testSelect1000
</pre>
+
</p>
+
<p>
TestPlan2
<pre class="source">
@@ -166,48 +457,93 @@ TestCase1.testSelect100
TestCase1.testSelect1000
TestCase2.testAdd100Customers
</pre>
+
</p>
+
</div>
-<div class="subsection"><h2 id="guidelines">28.4 General Guidelines<a class="sectionlink" href="#guidelines" title="Link to here">¶</a></h2>
+
+<div class="subsection">
+<h2 id="guidelines">27.4 General Guidelines<a class="sectionlink" href="#guidelines" title="Link to here">¶</a>
+</h2>
+
<p>
Here are some general guidelines for writing JUnit tests so they work well with JMeter. Since JMeter
runs multi-threaded, it is important to keep certain things in mind.
</p>
+
<ul>
- <li>Write the <span class="code">setUp</span> and <span class="code">tearDown</span> methods so they are thread safe. This
+
+<li>Write the <span class="code">setUp</span> and <span class="code">tearDown</span> methods so they are thread safe. This
generally means avoid using static members.</li>
- <li>Make the test methods discrete units of work and not long sequences of actions. By keeping
+
+<li>Make the test methods discrete units of work and not long sequences of actions. By keeping
the test method to a discrete operation, it makes it easier to combine test methods to create
new test plans.</li>
- <li>Avoid making test methods depend on each other. Since JMeter allows arbitrary sequencing of
+
+<li>Avoid making test methods depend on each other. Since JMeter allows arbitrary sequencing of
test methods, the runtime behavior is different than the default JUnit behavior.</li>
- <li>If a test method is configurable, be careful about where the properties are stored. Reading
+
+<li>If a test method is configurable, be careful about where the properties are stored. Reading
the properties from the Jar file is recommended.</li>
- <li>Each sampler creates an instance of the test class, so write your test so the setup happens
+
+<li>Each sampler creates an instance of the test class, so write your test so the setup happens
in <span class="code">oneTimeSetUp</span> and <span class="code">oneTimeTearDown</span>.</li>
- <li>If you select a class and no methods show up, it means the sampler had a problem creating an
+
+<li>If you select a class and no methods show up, it means the sampler had a problem creating an
instance of the test class. The best way to debug this is to add some <span class="code">System.out</span>
to your class constructor and see what is happening.</li>
+
</ul>
+
</div>
-</div><ul class="pagelinks"><li><a href="jmeter_proxy_step_by_step.html">< Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="jmeter_accesslog_sampler_step_by_step.html">Next ></a></li></ul><div class="share-links">
+
+</div>
+<ul class="pagelinks">
+<li>
+<a href="jmeter_proxy_step_by_step.html">< Prev</a>
+</li>
+<li>
+<a href="../index.html">Index</a>
+</li>
+<li>
+<a href="jmeter_accesslog_sampler_step_by_step.html">Next ></a>
+</li>
+</ul>
+<div class="share-links">
Share this page:
- <ul><li class="fb"><a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a></li><li class="twitter"><a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a></li><li class="gplus"><a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a></li></ul></div></div><div class="footer"><div class="copyright">
+ <ul>
+<li class="fb">
+<a data-social-url="https://facebook.com/sharer/sharer.php?u=" title="Share on facebook"><i class="fa fa-facebook" aria-hidden="true"></i>share</a>
+</li>
+<li class="twitter">
+<a data-social-url="https://twitter.com/intent/tweet?url=" title="Tweet on twitter"><i class="fa fa-twitter" aria-hidden="true"></i>tweet</a>
+</li>
+<li class="gplus">
+<a data-social-url="https://plus.google.com/share?url=" title="Share on Google+"><i class="fa fa-google-plus" aria-hidden="true"></i>share</a>
+</li>
+</ul>
+</div>
+</div>
+<div class="footer">
+<div class="copyright">
Copyright ©
1999 –
2017
, Apache Software Foundation
- </div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
+ </div>
+<div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
feather, and the Apache JMeter logo are
trademarks of the
Apache Software Foundation.
- </div></div><script>(function(){
+ </div>
+</div>
+<script>(function(){
// fill in the current location into social links on this page.
"use strict";
var as = document.getElementsByTagName('a');
@@ -221,4 +557,6 @@ runs multi-threaded, it is important to
as[i].href = href + encodeURIComponent(loc);
}
}
- })();</script></body></html>
\ No newline at end of file
+ })();</script>
+</body>
+</html>