You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by fs...@apache.org on 2015/04/30 21:17:12 UTC
svn commit: r1677045 -
/jmeter/trunk/xdocs/usermanual/build-ldapext-test-plan.xml
Author: fschumacher
Date: Thu Apr 30 19:17:12 2015
New Revision: 1677045
URL: http://svn.apache.org/r1677045
Log:
Markup changes. Mostly code-tags.
Modified:
jmeter/trunk/xdocs/usermanual/build-ldapext-test-plan.xml
Modified: jmeter/trunk/xdocs/usermanual/build-ldapext-test-plan.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/build-ldapext-test-plan.xml?rev=1677045&r1=1677044&r2=1677045&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/build-ldapext-test-plan.xml (original)
+++ jmeter/trunk/xdocs/usermanual/build-ldapext-test-plan.xml Thu Apr 30 19:17:12 2015
@@ -40,15 +40,15 @@ needs.
<p>
You will create four users that send requests for four tests on the LDAP server. Also, you will tell
-the users to run their tests one time. So, the total number of requests is (1 users) x (9 requests) x
-repeat 1 time) = 9 LDAP requests. To construct the Test Plan, you will use the following elements:<br/>
+the users to run their tests one time. So, the total number of requests is <code>(1 users) x (9 requests) x
+repeat 1 time) = 9</code> LDAP requests. To construct the Test Plan, you will use the following elements:<br/>
<a href="test_plan.html#thread_group">Thread Group</a>,<br/>
<complink name="Adding LDAP Extended Request Defaults"/>,<br/>
<complink name="Adding LDAP Requests"/>, and<br/>
<complink name="Adding a Listener to View/Store the Test Results"/>
</p>
<p>
-This example assumes that the LDAP Server is available at ldap.test.com.
+This example assumes that the LDAP Server is available at <code>ldap.test.com</code>.
</p>
<p>
For the less experienced LDAP users, I build a <a href="ldapops_tutor.html">small
@@ -56,13 +56,13 @@ LDAP tutorial</a> which shortly explains
the several LDAP operations that can be used in building a complex testplan.
</p>
<p>
-Take care when using LDAP special characters in the distinguished name, in that case (e.g. you want to use a + sign in a
-distinguished name) you need to escape the character by adding an "\" sign before that character.
-Extra exception: if you want to add a \ character in a distinguished name (in an add or rename operation), you need to use 4 backslashes.
+Take care when using LDAP special characters in the distinguished name, in that case (e.g. you want to use a <code>+</code> sign in a
+distinguished name) you need to escape the character by adding an "<code>\</code>" sign before that character.
+Extra exception: if you want to add a <code>\</code> character in a distinguished name (in an add or rename operation), you need to use 4 backslashes.
Examples:
-cn=dolf\+smits to add/search an entry with the name like cn=dolf+smits
-cn=dolf \\ smits to search an entry with the name cn=dolf \ smits
-cn=c:\\\\log.txt to add an entry with a name like cn=c:\log.txt
+<code>cn=dolf\+smits</code> to add/search an entry with the name like <code>cn=dolf+smits</code>
+<code>cn=dolf \\ smits</code> to search an entry with the name <code>cn=dolf \ smits</code>
+<code>cn=c:\\\\log.txt</code> to add an entry with a name like <code>cn=c:\log.txt</code>
</p>
@@ -73,9 +73,9 @@ The Thread Group tells JMeter the number
requests, and the how many requests they should send.
</p>
<p>
-Go ahead and add the <b>Thread Group</b> element by first selecting the <b>Test Plan</b>, clicking your
-right mouse button to get the <b>Add</b> menu, and then select <b>Add</b>><b>Threads (Users)</b>><b>Thread Group</b>.
-You should now see the <b>Thread Group</b> element under <b>Test Plan</b>. If you do not see the element, then "expand" the Test Plan tree by
+Go ahead and add the <code>Thread Group</code> element by first selecting the <code>Test Plan</code>, clicking your
+right mouse button to get the <code>Add</code> menu, and then select <code>Add</code>><code>Threads (Users)</code>><code>Thread Group</code>.
+You should now see the <code>Thread Group</code> element under <code>Test Plan</code>. If you do not see the element, then "expand" the Test Plan tree by
clicking on the Test Plan element.
</p>
<p>
@@ -87,11 +87,11 @@ Figure §-num;.1. Thread Group with D
<subsection name="§-num;.2 Adding LDAP Extended Request Defaults" anchor="add_ldapext_defaults">
<p>
Begin by selecting the LDAP Ext Users element. Click your right mouse button
-to get the <b>Add</b> menu, and then select <b>Add </b>><b>Config Element</b>><b>LDAP Extended Request Defaults</b>. Then,
+to get the <code>Add</code> menu, and then select <code>Add</code>><code>Config Element</code>><code>LDAP Extended Request Defaults</code>. Then,
select this new element to view its Control Panel.
</p>
<p>
-Like most JMeter elements, the <b>LDAP Extended Request Defaults</b> Control Panel has a name
+Like most JMeter elements, the <code>LDAP Extended Request Defaults</code> Control Panel has a name
field that you can modify. In this example, leave this field with the default value.
</p>
<p><figure image="ldaptest/extrequestdefaults.png"><br/>
@@ -143,8 +143,8 @@ JMeter sends requests in the order that
</p>
<p>
Adding a requests always start by:<br/>
-Adding the <b>LDAP Extended Request</b> to the LDAP Ext Users element (<b>Add</b>><b>
-Sampler</b>><b>LDAP Ext Request</b>). Then, select the <b>LDAP Ext Request</b> element in the tree
+Adding the <code>LDAP Extended Request</code> to the LDAP Ext Users element (<code>Add</code>>
+<code>Sampler</code>><code>LDAP Ext Request</code>). Then, select the <code>LDAP Ext Request</code> element in the tree
and edit the following properties.</p>
@@ -152,20 +152,20 @@ and edit the following properties.</p>
<p>
<ol>
<li>
-Rename the element: "1. Thread bind"
+Rename the element: "<code>1. Thread bind</code>"
</li>
<li>
-Select the "Thread bind" button.
+Select the "<code>Thread bind</code>" button.
</li>
<li>
Enter the hostname value from the LDAP server in the Servername field
</li>
<li>
-Enter the portnumber from the LDAP server (636 : ldap over SSL) in the port field
+Enter the portnumber from the LDAP server (<code>636</code> : ldap over SSL) in the port field
</li>
<li>
<i>(Optional)</i> Enter the baseDN in the DN field, this baseDN will be used as the starting point for searches, add, deletes, etc.<br/>
-take care that this must be the uppermost shared level for all your request, e.g. when all information is stored under ou=Users, dc=test, dc=com, you can use this value in the basedn.<br/>
+take care that this must be the uppermost shared level for all your request, e.g. when all information is stored under <code>ou=Users, dc=test, dc=com</code>, you can use this value in the basedn.<br/>
</li>
<li>
<i>(Optional)</i> Enter the distinguished name from the user you want to use for authentication.
@@ -192,17 +192,17 @@ Figure §-num;.3.1. Thread Bind examp
<p>
<ol>
<li>
-Rename the element: "2. Search Test"
+Rename the element: "<code>2. Search Test</code>"
</li>
<li>
-Select the "Search Test" button.
+Select the "<code>Search Test</code>" button.
</li>
<li>
<i>(Optional)</i> enter the searchbase under which you want to perform the search, relative to the basedn, used in the thread bind request.<br/>
When left empty, the basedn is used as a search base, this files is important if you want to use a "base-entry" or "one-level" search (see below)
</li>
<li>
-Enter the searchfilter, any decent LDAP search filter will do, but for now, use something simple, like (sn=Doe) or (cn=*)
+Enter the searchfilter, any decent LDAP search filter will do, but for now, use something simple, like <code>(sn=Doe)</code> or <code>(cn=*)</code>
</li>
<li>
<i>(Optional)</i> Enter the scope in the scope field, it has three options:
@@ -221,7 +221,7 @@ Enter the searchfilter, any decent LDAP
<i>(Optional)</i> Time limit, specifies the maximum number of milliseconds, the SERVER can use for performing the search. It is NOT the maximum time the application will wait.<br/>
When a very large returnset is returned, from a very fast server, over a very slow line, you may have to wait for ages for the completion of the search request, but this parameter will not influence this.
</li>
-<li><i>(Optional)</i> Attributes you want in the search answer. This can be used to limit the size of the answer, especially when an object has very large attributes (like jpegPhoto). There are three possibilities:
+<li><i>(Optional)</i> Attributes you want in the search answer. This can be used to limit the size of the answer, especially when an object has very large attributes (like <code>jpegPhoto</code>). There are three possibilities:
<ol><li>Leave empty (the default setting must also be empty) This will return all attributes.
</li>
<li>Put in one empty value (""), it will request a non-existent attributes, so in reality it returns no attributes
@@ -249,16 +249,16 @@ Figure §-num;.3.2. search request ex
<p>
<ol>
<li>
-Rename the element: "3. Compare Test"
+Rename the element: "<code>3. Compare Test</code>"
</li>
<li>
-Select the "Compare" button.
+Select the "<code>Compare</code>" button.
</li>
<li>
-enter the entryname form the object on which you want the compare operation to work, relative to the basedn, e.g. "cn=jdoe,ou=Users"
+enter the entryname form the object on which you want the compare operation to work, relative to the basedn, e.g. "<code>cn=jdoe,ou=Users</code>"
</li>
<li>
-Enter the compare filter, this must be in the form "attribute=value", e.g. "mail=jdoe@test.com"
+Enter the compare filter, this must be in the form "<code>attribute=value</code>", e.g. "<code>mail=jdoe@test.com</code>"
</li>
</ol>
</p>
@@ -272,14 +272,14 @@ Figure §-num;.3.3. Compare example</
<p>
<ol>
<li>
-Rename the element: "4. Single bind/unbind Test"
+Rename the element: "<code>4. Single bind/unbind Test</code>"
</li>
<li>
-Select the "Single bind/unbind" button.
+Select the "<code>Single bind/unbind</code>" button.
</li>
<li>
Enter the FULL distinguished name from the user you want to use for authentication.<br/>
-E.g. cn=jdoe,ou=Users,dc=test,dc=com
+E.g. <code>cn=jdoe,ou=Users,dc=test,dc=com</code>
When this field is kept empty, an anonymous bind will be established.
</li>
<li>
@@ -297,19 +297,19 @@ Figure §-num;.3.4. Single bind/unbin
<p>
<ol>
<li>
-Rename the element: "5. Add Test"
+Rename the element: "<code>5. Add Test</code>"
</li>
<li>
-Select the "Add" button.
+Select the "<code>Add</code>" button.
</li>
<li>
Enter the distinguished name for the object to add, relative to the basedn.
</li>
<li>
-Add a line in the "add test" table, fill in the attribute and value.<br/>
+Add a line in the "<code>add test</code>" table, fill in the attribute and value.<br/>
When you need the same attribute more than once, just add a new line, add the attribute again, and a different value.<br/>
All necessary attributes and values must be specified to pass the test, see picture!<br/>
-(sometimes the server adds the attribute "objectClass=top", this might give a problem.
+(sometimes the server adds the attribute "<code>objectClass=top</code>", this might give a problem.
</li>
</ol>
</p>
@@ -323,35 +323,37 @@ Figure §-num;.3.5. Add request examp
<p>
<ol>
<li>
-Rename the element: "6. Modify Test"
+Rename the element: "<code>6. Modify Test</code>"
</li>
<li>
-Select the "Modify test" button.
+Select the "<code>Modify test</code>" button.
</li>
<li>
Enter the distinguished name for the object to modify, relative to the basedn.
</li>
<li>
-Add a line in the "modify test" table, with the "add" button.
+Add a line in the "<code>modify test</code>" table, with the "<code>add</code>" button.
</li>
<li>
You need to enter the attribute you want to modify, (optional) a value, and the opcode. The meaning of this opcode:
-<ol><li><b>add</b><br/> this will mean that the attribute value (not optional in this case) will be added to the attribute.<br/>
+<dl>
+<dt><code>add</code></dt><dd>this will mean that the attribute value (not optional in this case) will be added to the attribute.<br/>
When the attribute is not existing, it will be created and the value added<br/>
When it is existing, and defined multi-valued, the new value is added.<br/>
-when it is existing, but single valued, it will fail.</li>
-<li><b>replace</b><br/>
+when it is existing, but single valued, it will fail.</dd>
+<dt><code>replace</code></dt><dd>
This will overwrite the attribute with the given new value (not optional here)<br/>
When the attribute is not existing, it will be created and the value added<br/>
-When it is existing, old values are removed, the new value is added.</li>
-<li><b>delete</b><br/>
+When it is existing, old values are removed, the new value is added.</dd>
+<dt><code>delete</code></dt><dd>
When no value is given, all values will be removed<br/>
When a value is given, only that value will be removed<br/>
when the given value is not existing, the test will fail
-</li></ol>
+</dd>
+</dl>
</li>
<li>
-<i>(Optional)</i> Add more modifications in the "modify test" table.<br/>
+<i>(Optional)</i> Add more modifications in the "<code>modify test</code>" table.<br/>
All modifications which are specified must succeed, to let the modification test pass. When one modification fails,
NO modifications at all will be made and the entry will remain unchanged.
</li>
@@ -367,21 +369,21 @@ Figure §-num;.3.6. Modify example</f
<p>
<ol>
<li>
-Rename the element: "7. Rename entry (moddn)"
+Rename the element: "<code>7. Rename entry (moddn)</code>"
</li>
<li>
-Select the "Rename Entry" button.
+Select the "<code>Rename Entry</code>" button.
</li>
<li>
-Enter the name of the entry, relative to the baseDN, in the "old entry name-Field".<br/>
-that is, if you want to rename "cn=Little John Doe,ou=Users", and you set the baseDN to "dc=test,dc=com",
-you need to enter "cn=John Junior Doe,ou=Users" in the old entry name-field.
+Enter the name of the entry, relative to the baseDN, in the "<code>old entry name</code>"-Field.<br/>
+that is, if you want to rename "<code>cn=Little John Doe,ou=Users</code>", and you set the baseDN to "<code>dc=test,dc=com</code>",
+you need to enter "<code>cn=John Junior Doe,ou=Users</code>" in the <code>old entry name</code>-Field.
</li>
<li>
-Enter the new name of the entry, relative to the baseDN, in the "new distinguished name-Field".<br/>
+Enter the new name of the entry, relative to the baseDN, in the "<code>new distinguished name</code>"-Field.<br/>
when you only change the RDN, it will simply rename the entry<br/>
-when you also add a different subtree, e.g. you change from cn=john doe,ou=Users to cn=john doe,ou=oldusers, it will move the entry.
-You can also move a complete subtree (If your LDAP server supports this!), eg ou=Users,ou=retired, to ou=oldusers,ou=users,
+when you also add a different subtree, e.g. you change from <code>cn=john doe,ou=Users</code> to <code>cn=john doe,ou=oldusers</code>, it will move the entry.
+You can also move a complete subtree (If your LDAP server supports this!), e.g. <code>ou=Users,ou=retired</code>, to <code>ou=oldusers,ou=users</code>,
this will move the complete subtree, plus all retired people in the subtree to the new place in the tree.
</li>
</ol>
@@ -396,15 +398,15 @@ Figure §-num;.3.8. Rename example</f
<p>
<ol>
<li>
-Rename the element: "8. Delete Test"
+Rename the element: "<code>8. Delete Test</code>"
</li>
<li>
-Select the "Delete" button.
+Select the "<code>Delete</code>" button.
</li>
<li>
-Enter the name of the entry, relative to the baseDN, in the Delete-Field.<br/>
-that is, if you want to remove "cn=John Junior Doe,ou=Users,dc=test,dc=com", and you set the baseDN to "dc=test,dc=com",
-you need to enter "cn=John Junior Doe,ou=Users" in the Delete-field.
+Enter the name of the entry, relative to the baseDN, in the <code>Delete</code>-Field.<br/>
+that is, if you want to remove "<code>cn=John Junior Doe,ou=Users,dc=test,dc=com</code>", and you set the baseDN to "<code>dc=test,dc=com</code>",
+you need to enter "<code>cn=John Junior Doe,ou=Users</code>" in the <code>Delete</code>-field.
</li>
</ol>
</p>
@@ -418,10 +420,10 @@ Figure §-num;.3.7. Delete example</f
<p>
<ol>
<li>
-Rename the element: 9. Thread unbind"
+Rename the element: "<code>9. Thread unbind</code>"
</li>
<li>
-Select the "Thread unbind" button.
+Select the "<code>Thread unbind</code>" button.
This will be enough as it just closes the current connection.
The information which is needed is already known by the system
</li></ol>
@@ -437,8 +439,8 @@ Figure §-num;.3.9. Unbind example</f
<p>
The final element you need to add to your Test Plan is a Listener.
This element is responsible for storing all of the results of your LDAP
-requests in a file and presenting a visual model of the data.Select the Thread group
-element and add a <b>View Results Tree</b> (<b>Add</b>><b>Listener</b>><b>View Results Tree</b>)
+requests in a file and presenting a visual model of the data. Select the Thread group
+element and add a <code>View Results Tree</code> (<code>Add</code>><code>Listener</code>><code>View Results Tree</code>)
</p>
<p>
<figure image="ldaptest/extviewtree.png">