<?xml version="1.0"?>
<!--
   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.
-->

<!DOCTYPE document[
<!ENTITY sect-num '3'>
<!ENTITY hellip   "&#x02026;" >
]>

<document prev="build-test-plan.html" next="build-web-test-plan.html" id="$Id: test_plan.xml 1796491 2017-05-28 13:36:37Z fschumacher $">

<properties>
<title>User's Manual: Elements of a Test Plan</title>
</properties>

<body>

<section name="&sect-num;. Elements of a Test Plan">
<p>
This section describes the different parts of a test plan.
</p>
<p>
A minimal test will consist of the Test Plan, a Thread Group and one or more Samplers.
</p>

<subsection name="&sect-num;.0 Test Plan" anchor="test_plan">
<p>The Test Plan object has a checkbox called "<code>Functional Testing</code>".  If selected, it
will cause JMeter to record the data returned from the server for each sample.  If you have 
selected a file in your test listeners, this data will be written to file.  This can be useful if
you are doing a small run to ensure that JMeter is configured correctly, and that your server
is returning the expected results.  The consequence is that the file will grow huge quickly, and
JMeter's performance will suffer.  This option should be off if you are doing stress-testing (it
is off by default).  </p>
<p>If you are not recording the data to file, this option makes no difference.</p>
<p>You can also use the <code>Configuration</code> button on a listener to decide what fields to save.</p>
</subsection>

<subsection name="&sect-num;.1 Thread Group" anchor="thread_group">
<p>Thread group elements are the beginning points of any test plan.
All controllers and samplers must be under a thread group.
Other elements, e.g. Listeners, may be placed directly under the test plan,
in which case they will apply to all the thread groups.  
As the name implies, the thread group
element controls the number of threads JMeter will use to execute your test.  The
controls for a thread group allow you to:
<ul><li>Set the number of threads</li>
<li>Set the ramp-up period</li>
<li>Set the number of times to execute the test</li>
</ul></p>

<p>Each thread will execute the test plan in its entirety and completely independently
of other test threads.  Multiple threads are used to simulate concurrent connections
to your server application.</p>

<p>The ramp-up period tells JMeter how long to take to "ramp-up" to the full number of
threads chosen.  If 10 threads are used, and the ramp-up period is 100 seconds, then
JMeter will take 100 seconds to get all 10 threads up and running.  Each thread will
start 10 (100/10) seconds after the previous thread was begun.  If there are 30 threads
and a ramp-up period of 120 seconds, then each successive thread will be delayed by 4 seconds.</p>

<p>Ramp-up needs to be long enough to avoid too large a work-load at the start
of a test, and short enough that the last threads start running before
the first ones finish (unless one wants that to happen).
</p>
<p>
Start with Ramp-up = number of threads and adjust up or down as needed.
</p>

<p>By default, the thread group is configured to loop once through its elements.</p>

<p>Thread Group also provides a <b>scheduler</b>. 
    Click the checkbox at the bottom of the Thread Group panel to enable/disable extra fields
     in which you can enter the duration of test, the startup delay, the start and end times of the run. 
     You can configure <code>Duration (seconds)</code> and <code>Startup Delay (seconds)</code> to control
     the duration of each thread group and the after how much seconds it starts.
     When the test is started, JMeter will wait <code>Startup Delay (seconds)</code> before starting the Threads 
     of the Thread Group and run for the configured <code>Duration (seconds)</code> time.
     Note those 2 options override the <code>Start time</code> and <code>End time</code>.
     
     <p>Alternatively (although not recommended as not very flexible) you can use the two other fields <code>Start time</code> and <code>End time</code>.
     When the test is started, JMeter will wait if necessary until the start-time has been reached.
     At the end of each cycle, JMeter checks if the end-time has been reached, and if so, the run is stopped,
     otherwise the test is allowed to continue until the iteration limit is reached.</p>
     </p>
</subsection>

<subsection name="&sect-num;.2 Controllers" anchor="controllers">

<p>
JMeter has two types of Controllers: Samplers and Logical Controllers.
These drive the processing of a test.
</p>

<p>Samplers tell JMeter to send requests to a server. For
example, add an HTTP Request Sampler if you want JMeter
to send an HTTP request.  You can also customize a request by adding one
or more Configuration Elements to a Sampler.  For more
information, see
<a href="#samplers">Samplers</a>.</p>

<p>Logical Controllers let you customize the logic that JMeter uses to
decide when to send requests.  For example, you can add an Interleave
Logic Controller to alternate between two HTTP Request Samplers.
For more information, see <a href="#logic_controller">Logical Controllers</a>.</p>

</subsection>

<subsection name="&sect-num;.2.1 Samplers" anchor="samplers">

<p>
Samplers tell JMeter to send requests to a server and wait for a response.
They are processed in the order they appear in the tree.
Controllers can be used to modify the number of repetitions of a sampler.
</p>
<p>
JMeter samplers include:
<ul>
    <li>FTP Request</li>
    <li>HTTP Request (can be used for SOAP or REST Webservice also)</li>
    <li>JDBC Request</li>
    <li>Java object request</li>
    <li>JMS request</li>
    <li>JUnit Test request</li>
    <li>LDAP Request</li>
    <li>Mail request</li>
    <li>OS Process request</li>
    <li>TCP request</li>
</ul>
Each sampler has several properties you can set.
You can further customize a sampler by adding one or more Configuration Elements to the Test Plan.
</p>

<p>If you are going to send multiple requests of the same type (for example,
HTTP Request) to the same server, consider using a Defaults Configuration
Element. Each controller has one or more Defaults elements (see below). </p>

<p>Remember to add a Listener to your test plan to view and/or store the
results of your requests to disk.</p>

<p>If you are interested in having JMeter perform basic validation on
the response of your request, add an <a href="#assertions">Assertion</a> to
the sampler.  For example, in stress testing a web application, the server
may return a successful "HTTP Response" code, but the page may have errors on it or
may be missing sections. You could add assertions to check for certain HTML tags,
common error strings, and so on. JMeter lets you create these assertions using regular
expressions.</p>

<p><a href="component_reference.html#samplers">JMeter's built-in samplers</a></p>
</subsection>

<subsection name="&sect-num;.2.2 Logic Controllers" anchor="logic_controller">
<p>Logic Controllers let you customize the logic that JMeter uses to
decide when to send requests.
Logic Controllers can change the order of requests coming from their
child elements.  They can modify the requests themselves, cause JMeter to repeat
requests, etc.
</p>

<p>To understand the effect of Logic Controllers on a test plan, consider the
following test tree:</p>

<p>
<ul>
<li>Test Plan</li>
    <ul>
    <li>Thread Group</li>
        <ul>
        <li>Once Only Controller</li>
            <ul>
            <li>Login Request (an <complink name="HTTP Request"/>)</li>
            </ul>
        <li>Load Search Page (HTTP Sampler)</li>
        <li>Interleave Controller</li>
            <ul>
            <li>Search "A" (HTTP Sampler)</li>
            <li>Search "B" (HTTP Sampler)</li>
            <li>HTTP default request (Configuration Element)</li>
            </ul>
        <li>HTTP default request (Configuration Element)</li>
        <li>Cookie Manager (Configuration Element)</li>
        </ul>
    </ul>
</ul>
</p>

<p>The first thing about this test is that the login request will be executed only
the first time through.  Subsequent iterations will skip it.  This is due to the
effects of the <complink name="Once Only Controller"/>.</p>

<p>After the login, the next Sampler loads the search page (imagine a
web application where the user logs in, and then goes to a search page to do a search).  This
is just a simple request, not filtered through any Logic Controller.</p>

<p>After loading the search page, we want to do a search.  Actually, we want to do
two different searches.  However, we want to re-load the search page itself between
each search.  We could do this by having 4 simple HTTP request elements (load search,
search "A", load search, search "B").  Instead, we use the <complink name="Interleave
Controller"/> which passes on one child request each time through the test.  It keeps the
ordering (i.e. it doesn't pass one on at random, but "remembers" its place) of its
child elements.  Interleaving 2 child requests may be overkill, but there could easily have
been 8, or 20 child requests.</p>

<p>Note the <complink name="HTTP Request Defaults"/> that
belongs to the Interleave Controller.  Imagine that "Search A" and "Search B" share
the same PATH info (an HTTP request specification includes domain, port, method, protocol,
path, and arguments, plus other optional items).  This makes sense - both are search requests,
 hitting the same back-end search engine (a servlet or cgi-script, let's say).  Rather than
 configure both HTTP Samplers with the same information in their PATH field, we
 can abstract that information out to a single Configuration Element.  When the Interleave
 Controller "passes on" requests from "Search A" or "Search B", it will fill in the blanks with
 values from the HTTP default request Configuration Element.  So, we leave the PATH field
 blank for those requests, and put that information into the Configuration Element.  In this
case, this is a minor benefit at best, but it demonstrates the feature.</p>

<p>The next element in the tree is another HTTP default request, this time added to the
Thread Group itself.  The Thread Group has a built-in Logic Controller, and thus, it uses
this Configuration Element exactly as described above.  It fills in the blanks of any
Request that passes through.  It is extremely useful in web testing to leave the DOMAIN
field blank in all your HTTP Sampler elements, and instead, put that information
into an HTTP default request element, added to the Thread Group.  By doing so, you can
test your application on a different server simply by changing one field in your Test Plan.
Otherwise, you'd have to edit each and every Sampler.</p>

<p>The last element is a <complink name="HTTP Cookie
Manager"/>.  A Cookie Manager should be added to all web tests - otherwise JMeter will
ignore cookies.  By adding it at the Thread Group level, we ensure that all HTTP requests
will share the same cookies.</p>

<p>Logic Controllers can be combined to achieve various results.  See the list of <a href="component_reference.html#logic_controllers">built-in
Logic Controllers</a>.</p>
</subsection>

<subsection name="&sect-num;.2.3 Test Fragments" anchor="test_fragments">
<p>The Test Fragment element is a special type of <a href="#controllers">controller</a> that
exists on the Test Plan tree at the same level as the Thread Group element.  It is distinguished
from a Thread Group in that it is not executed unless it is 
referenced by either a <complink name="Module Controller"/> or an <complink name="Include_Controller"/>.
</p>
<p>This element is purely for code re-use within Test Plans</p>
</subsection>

<subsection name="&sect-num;.3 Listeners" anchor="listeners">
<p>Listeners provide access to the information JMeter gathers about the test cases while
JMeter runs.  The  <complink name="Graph
Results"/> listener plots the response times on a graph.  
The "View Results Tree" Listener shows details of sampler requests and responses, and can display basic HTML and XML representations of the response.
Other listeners provide summary or aggregation information.
</p>

<p>
Additionally, listeners can direct the data to a file for later use.  
Every listener in JMeter provides a field to indicate the file to store data to.
There is also a Configuration button which can be used to choose which fields to save, and whether to use CSV or XML format.
<note>Note that all Listeners save the same data; the only difference is in the way the data is presented on the screen.</note>
</p>

<p>
Listeners can be added anywhere in the test, including directly under the test plan.
They will collect data only from elements at or below their level.
</p>

<p>There are several <a href="component_reference.html#listeners">listeners</a>
that come with JMeter.</p>
</subsection>

<subsection name="&sect-num;.4 Timers" anchor="timers">

<p>By default, a JMeter thread executes samplers in sequence without pausing.
We recommend that you specify a delay by adding one of the available timers to
your Thread Group. If you do not add a delay, JMeter could overwhelm your server by
making too many requests in a very short amount of time.</p>

<p>A timer will cause JMeter to delay a certain amount of time <b>before</b> each
sampler which is in its <a href="#scoping_rules">scope</a>.</p>

<p>
If you choose to add more than one timer to a Thread Group, JMeter takes the sum of
the timers and pauses for that amount of time before executing the samplers to which the timers apply.
Timers can be added as children of samplers or controllers in order to restrict the samplers to which they are applied.
</p>
<p>
To provide a pause at a single place in a test plan, one can use the <complink name="Test Action"/> Sampler.
</p>
</subsection>

<subsection name="&sect-num;.5 Assertions" anchor="assertions">

<p>Assertions allow you to assert facts about responses received from the
server being tested. Using an assertion, you can essentially "test" that your
application is returning the results you expect it to. </p>

<p>For instance, you can assert that the response to a query will contain some
particular text. The text you specify can be a Perl-style regular expression, and
you can indicate that the response is to contain the text, or that it should match
the whole response.</p>

<p>You can add an assertion to any Sampler. For example, you can
add an assertion to a HTTP Request that checks for the text, "<code>&lt;/HTML&gt;</code>".  JMeter
will then check that the text is present in the HTTP response.  If JMeter cannot find the
text, then it will mark this as a failed request.</p>

<note>
Note that assertions apply to all samplers which are in their <a href="#scoping_rules">scope</a>.
To restrict an assertion to a single sampler, add the assertion as a child of the sampler.
</note>

<p>To view assertion results, add an Assertion Listener to the Thread Group.
Failed Assertions will also show up in the Tree View and Table Listeners, 
and will count towards the error %age for example in the Aggregate and Summary reports.
</p>
</subsection>

<subsection name="&sect-num;.6 Configuration Elements" anchor="config_elements">
<p>A configuration element works closely with a Sampler.  Although it does not send requests
(except for <complink name="HTTP(S) Test Script Recorder"/>), it can add to or modify requests.</p>

<p>A configuration element is accessible from only inside the tree branch where you place the element.
For example, if you place an HTTP Cookie Manager inside a Simple Logic Controller, the Cookie Manager will
only be accessible to HTTP Request Controllers you place inside the Simple Logic Controller (see figure 1).
The Cookie Manager is accessible to the HTTP requests "Web Page 1" and "Web Page 2", but not "Web Page 3".  </p>
<p>Also, a configuration element inside a tree branch has higher precedence than the same element in a "parent"
branch.  For example, we defined two HTTP Request Defaults elements, "Web Defaults 1" and "Web Defaults 2".
Since we placed "Web Defaults 1" inside a Loop Controller, only "Web Page 2" can access it.  The other HTTP
requests will use "Web Defaults 2", since we placed it in the Thread Group (the "parent" of all other branches).</p>

<figure image="http-config/http-config-example.png">Figure 1 -
    Test Plan Showing Accessibility of Configuration Elements</figure>

<note>
The <complink name="User Defined Variables"/> Configuration element is different. 
It is processed at the start of a test, no matter where it is placed.
For simplicity, it is suggested that the element is placed only at the start of a Thread Group.
</note>
</subsection>

<subsection name="&sect-num;.7 Pre-Processor Elements" anchor="preprocessors">
<p>A Pre-Processor executes some action prior to a Sampler Request being made. 
If a Pre-Processor is attached to a Sampler element, then it will execute just prior to that sampler element running. 
A Pre-Processor is most often used to modify the settings of a Sample Request just before it runs, or to update variables that aren't extracted from response text.  
See the <a href="test_plan.html#scoping_rules"><b>scoping rules</b></a> for more details on when Pre-Processors are executed.</p>
</subsection>

<subsection name="&sect-num;.8 Post-Processor Elements" anchor="postprocessors">
<p>A Post-Processor executes some action after a Sampler Request has been made.
If a Post-Processor is attached to a Sampler element, then it will execute just after that sampler element runs.
A Post-Processor is most often used to process the response data, often to extract values from it.  
See the <a href="test_plan.html#scoping_rules"><b>scoping rules</b></a> for more details on when Post-Processors are executed.</p>
</subsection>

<subsection name="&sect-num;.9 Execution order" anchor="executionorder">
<ol start="0">
<li>Configuration elements</li>
<li>Pre-Processors</li>
<li>Timers</li>
<li>Sampler</li>
<li>Post-Processors (unless SampleResult is <code>null</code>)</li>
<li>Assertions (unless SampleResult is <code>null</code>)</li>
<li>Listeners (unless SampleResult is <code>null</code>)</li>
</ol>

<note>
Please note that Timers, Assertions, Pre- and Post-Processors are only processed if there is a sampler to which they apply.
Logic Controllers and Samplers are processed in the order in which they appear in the tree. 
Other test elements are processed according to the scope in which they are found, and the type of test element.
[Within a type, elements are processed in the order in which they appear in the tree].
</note>
<p>
For example, in the following test plan:
<ul>
<li>Controller</li>
<ul>
<li>Post-Processor 1</li>
<li>Sampler 1</li>
<li>Sampler 2</li>
<li>Timer 1</li>
<li>Assertion 1</li>
<li>Pre-Processor 1</li>
<li>Timer 2</li>
<li>Post-Processor 2</li>
</ul>
</ul>
The order of execution would be:
<pre>
Pre-Processor 1
Timer 1
Timer 2
Sampler 1
Post-Processor 1
Post-Processor 2
Assertion 1

Pre-Processor 1
Timer 1
Timer 2
Sampler 2
Post-Processor 1
Post-Processor 2
Assertion 1
</pre>
</p>
</subsection>

<subsection name="&sect-num;.10 Scoping Rules" anchor="scoping_rules">
<p>
The JMeter test tree contains elements that are both hierarchical and ordered.  Some elements in the test trees are strictly hierarchical (Listeners, Config Elements, Post-Processors, Pre-Processors, Assertions, Timers), and some are primarily ordered (controllers, samplers).  When you create your test plan, you will create an ordered list of sample request (via Samplers) that represent a set of steps to be executed.  These requests are often organized within controllers that are also ordered.  Given the following test tree:</p>
<figure image="scoping1.png">Example test tree</figure>
<p>The order of requests will be, One, Two, Three, Four.</p>
<p>Some controllers affect the order of their subelements, and you can read about these specific controllers in <a href="component_reference.html">the component reference</a>.</p>
<p>Other elements are hierarchical.  An Assertion, for instance, is hierarchical in the test tree.  
If its parent is a request, then it is applied to that request. If its
parent is a Controller, then it affects all requests that are descendants of
that Controller.  In the following test tree:</p>
<figure image="scoping2.png">Hierarchy example</figure>
<p>Assertion #1 is applied only to Request One, while Assertion #2 is applied to Requests Two and Three.</p>
<p>Another example, this time using Timers:</p>
<figure image="scoping3.png">complex example</figure>
<p>In this example, the requests are named to reflect the order in which they will be executed.  Timer #1 will apply to Requests Two, Three, and Four (notice how order is irrelevant for hierarchical elements).  Assertion #1 will apply only to Request Three.  Timer #2 will affect all the requests.</p>
<p>Hopefully these examples make it clear how configuration (hierarchical) elements are applied.  If you imagine each Request being passed up the tree branches, to its parent, then to its parent's parent, etc., and each time collecting all the configuration elements of that parent, then you will see how it works.  </p>
<note>
The Configuration elements Header Manager, Cookie Manager and Authorization manager are
treated differently from the Configuration Default elements.
The settings from the Configuration Default elements are merged into a set of values that the Sampler has access to.
However, the settings from the Managers are not merged.
If more than one Manager is in the scope of a Sampler, 
only one Manager is used, but there is currently no way to specify <em>which</em> is used.
</note>
</subsection>


<subsection name="&sect-num;.11 Properties and Variables" anchor="properties">

<p>
JMeter <em>properties</em> are defined in <code>jmeter.properties</code> (see <a href="get-started.html#configuring_jmeter">Getting Started - Configuring JMeter</a> for more details).
<br></br>
Properties are global to jmeter, and are mostly used to define some of the defaults JMeter uses.
For example the property <code>remote_hosts</code> defines the servers that JMeter will try to run remotely.
Properties can be referenced in test plans 
- see <a href="functions.html#__property">Functions - read a property</a> -
but cannot be used for thread-specific values.
</p>
<p>
JMeter <em>variables</em> are local to each thread. The values may be the same for each thread, or they may be different.
<br></br>
If a variable is updated by a thread, only the thread copy of the variable is changed.
For example the <complink name="Regular Expression Extractor"/> Post-Processor 
will set its variables according to the sample that its thread has read, and these can be used later
by the same thread.
For details of how to reference variables and functions, see <a href="functions.html">Functions and Variables</a>
</p>
<p>
Note that the values defined by the <complink name="Test Plan"/>  and the <complink name="User Defined Variables"/> configuration element
are made available to the whole test plan at startup. 
If the same variable is defined by multiple UDV elements, then the last one takes effect.
Once a thread has started, the initial set of variables is copied to each thread.
Other elements such as the 
<complink name="User Parameters"/> Pre-Processor or <complink name="Regular Expression Extractor"/> Post-Processor
may be used to redefine the same variables (or create new ones). These redefinitions only apply to the current thread.
</p>
<p>
The <a href="functions.html#__setProperty">setProperty</a> function can be used to define a JMeter property.
These are global to the test plan, so can be used to pass information between threads - should that be needed.
</p>
<note>Both variables and properties are case-sensitive.</note>
</subsection>

<subsection name="&sect-num;.12 Using Variables to parameterise tests" anchor="using_variables">
<p>
Variables don't have to vary - they can be defined once, and if left alone, will not change value.
So you can use them as short-hand for expressions that appear frequently in a test plan.
Or for items which are constant during a run, but which may vary between runs.
For example, the name of a host, or the number of threads in a thread group.
</p>
<p>
When deciding how to structure a Test Plan, 
make a note of which items are constant for the run, but which may change between runs.
Decide on some variable names for these - 
perhaps use a naming convention such as prefixing them with <code>C_</code> or <code>K_</code> or using uppercase only
to distinguish them from variables that need to change during the test.
Also consider which items need to be local to a thread - 
for example counters or values extracted with the Regular Expression Post-Processor.
You may wish to use a different naming convention for these.
</p>
<p>
For example, you might define the following on the Test Plan:
<pre>
HOST             www.example.com
THREADS          10
LOOPS            20
</pre>
You can refer to these in the test plan as <code>${HOST}</code> <code>${THREADS}</code> etc.
If you later want to change the host, just change the value of the <code>HOST</code> variable.
This works fine for small numbers of tests, but becomes tedious when testing lots of different combinations.
One solution is to use a property to define the value of the variables, for example:
<pre>
HOST             ${__P(host,www.example.com)}
THREADS          ${__P(threads,10)}
LOOPS            ${__P(loops,20)}
</pre>
You can then change some or all of the values on the command-line as follows:
<pre>
jmeter &hellip; -Jhost=www3.example.org -Jloops=13
</pre>
</p>
</subsection>

</section>

</body>
</document>
