Author: milamber
Date: Thu Nov 29 09:16:04 2012
New Revision: 1415096
URL: http://svn.apache.org/viewvc?rev=1415096&view=rev
Log:
Update the documentation with the new document extract text features on View
Results Tree, Response Assertion and Regular Expression Extractor.
Some (design/visual) improvements on VRT section.
Bugzilla Id: 54200
Added:
jmeter/trunk/docs/images/screenshots/view_results_tree_document.png (with
props)
jmeter/trunk/xdocs/images/screenshots/view_results_tree_document.png
(with props)
Modified:
jmeter/trunk/docs/images/screenshots/assertion/assertion.png
jmeter/trunk/docs/images/screenshots/assertion/example1a.png
jmeter/trunk/docs/images/screenshots/assertion/example1b.png
jmeter/trunk/docs/images/screenshots/assertion/example1c-fail.png
jmeter/trunk/docs/images/screenshots/assertion/example1c-pass.png
jmeter/trunk/docs/images/screenshots/regex_extractor.png
jmeter/trunk/docs/images/screenshots/view_results_tree.png
jmeter/trunk/docs/images/screenshots/view_results_tree_regex.png
jmeter/trunk/docs/images/screenshots/view_results_tree_xml.png
jmeter/trunk/xdocs/images/screenshots/assertion/assertion.png
jmeter/trunk/xdocs/images/screenshots/assertion/example1a.png
jmeter/trunk/xdocs/images/screenshots/assertion/example1b.png
jmeter/trunk/xdocs/images/screenshots/assertion/example1c-fail.png
jmeter/trunk/xdocs/images/screenshots/assertion/example1c-pass.png
jmeter/trunk/xdocs/images/screenshots/regex_extractor.png
jmeter/trunk/xdocs/images/screenshots/view_results_tree.png
jmeter/trunk/xdocs/images/screenshots/view_results_tree_regex.png
jmeter/trunk/xdocs/images/screenshots/view_results_tree_xml.png
jmeter/trunk/xdocs/usermanual/component_reference.xml
Modified: jmeter/trunk/docs/images/screenshots/assertion/assertion.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/assertion/assertion.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/assertion/example1a.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/assertion/example1a.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/assertion/example1b.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/assertion/example1b.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/assertion/example1c-fail.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/assertion/example1c-fail.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/assertion/example1c-pass.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/assertion/example1c-pass.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/regex_extractor.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/regex_extractor.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/view_results_tree.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/view_results_tree.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Added: jmeter/trunk/docs/images/screenshots/view_results_tree_document.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/view_results_tree_document.png?rev=1415096&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jmeter/trunk/docs/images/screenshots/view_results_tree_document.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: jmeter/trunk/docs/images/screenshots/view_results_tree_regex.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/view_results_tree_regex.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/docs/images/screenshots/view_results_tree_xml.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/docs/images/screenshots/view_results_tree_xml.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/assertion/assertion.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/assertion/assertion.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/assertion/example1a.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/assertion/example1a.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/assertion/example1b.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/assertion/example1b.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/assertion/example1c-fail.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/assertion/example1c-fail.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/assertion/example1c-pass.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/assertion/example1c-pass.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/regex_extractor.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/regex_extractor.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/view_results_tree.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/view_results_tree.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Added: jmeter/trunk/xdocs/images/screenshots/view_results_tree_document.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/view_results_tree_document.png?rev=1415096&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jmeter/trunk/xdocs/images/screenshots/view_results_tree_document.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: jmeter/trunk/xdocs/images/screenshots/view_results_tree_regex.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/view_results_tree_regex.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/images/screenshots/view_results_tree_xml.png
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/images/screenshots/view_results_tree_xml.png?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
Binary files - no diff available.
Modified: jmeter/trunk/xdocs/usermanual/component_reference.xml
URL:
http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/component_reference.xml?rev=1415096&r1=1415095&r2=1415096&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jmeter/trunk/xdocs/usermanual/component_reference.xml Thu Nov 29 09:16:04
2012
@@ -2597,7 +2597,7 @@ are part of the test plan.</p></descript
</links>
</component>
-<component name="View Results Tree" index="§-num;.3.6" width="878"
height="659" screenshot="view_results_tree.png">
+<component name="View Results Tree" index="§-num;.3.6" width="901"
height="646" screenshot="view_results_tree.png">
<description>The View Results Tree shows a tree of all sample responses,
allowing you to view the
response for any sample. In addition to showing the response, you can see the
time it took to get
this response, and some response codes.
@@ -2605,23 +2605,61 @@ Note that the Request panel only shows t
It does not show any headers (such as Host) that may be added by the HTTP
protocol implementation.
<p>
There are several ways to view the response, selectable by a drop-down box at
the bottom of the left hand panel.</p>
-<ul>
-<li>HTML</li>
-<li>HTML (download resources)</li>
-<li>JSON</li>
-<li>Regexp Tester</li>
-<li>Text</li>
-<li>XML</li>
-</ul>
-<p>Scroll automatically? option permit to have last node display in tree
selection</p>
-<p>
-Additional renderers can be created.
-The class must implement the interface
<code>org.apache.jmeter.visualizers.ResultRenderer</code>
-and/or extend the abstract class
<code>org.apache.jmeter.visualizers.SamplerResultTab</code>, and the
-compiled code must be available to JMeter (e.g. by adding it to the lib/ext
directory).
-</p>
-<p>
-The default "Text" view shows all of the text contained in the response.
+
+<table>
+<tr><th><b>Renderer</b></th><th><b>Description</b></th></tr>
+<tr><td><b>Document</b></td>
+<td>The <i>Document view</i> will show the extract text from various type of
documents like Microsoft Office
+(Word, Excel, PowerPoint 97-2003, 2007-2010 (openxml), Apache OpenOffice
(writer, calc, impress), HTML,
+gzip, jar/zip files (list of content), and some meta-data on "multimedia"
files like mp3, mp4, flv, etc. The complete list of
+support format is available on <a
href="http://tika.apache.org/1.2/formats.html";>Apache Tika format page.</a>
+<br/><br/>
+<b>Note:</b> A requirement to the <i>Document view</i> is to download the <a
href="http://tika.apache.org/download.html";>
+Apache Tika binary package</a> (tika-app-x.x.jar) and put this in
JMETER_HOME/lib directory.
+<br/><br/>
+If the document is larger than 10 MB, then it won't be displayed.
+To change this limit, set the JMeter property <b>document.max_size</b> (unit
is byte) or set to 0 to remove the limit.
+<br/></td></tr>
+<tr><td><b>HTML</b></td>
+<td>The <i>HTML view</i> attempts to render the response as
+HTML. The rendered HTML is likely to compare poorly to the view one
+would get in any web browser; however, it does provide a quick
+approximation that is helpful for initial result evaluation.<br/>
+Images, style-sheets, etc. aren't downloaded.
+<br/></td></tr>
+<tr><td><b>HTML (download resources)</b></td>
+<td>If the <i>HTML (download resources) view</i> option is selected, the
renderer
+may download images, style-sheets, etc. referenced by the HTML code.
+<br/></td></tr>
+<tr><td><b>JSON</b></td>
+<td>The <i>JSON view</i> will show the response in tree style (also handles
JSON embedded in JavaScript).
+<br/></td></tr>
+<tr><td><b>Regexp Tester</b></td>
+<td>The <i>Regexp Tester view</i> only works for text responses. It shows the
plain text in the upper panel.
+The "Test" button allows the user to apply the Regular Expression to the upper
panel and the results
+will be displayed in the lower panel.<br/>
+The engine of regular expression is the same that the Regular Expression
Extractor.<br/>
+For example, the RE <b>(JMeter\w*).*</b> applied to the current JMeter home
page gives the following output:
+<br/>
+<pre>
+Match count: 26
+Match[1][0]=JMeter - Apache JMeter&lt;/title>
+Match[1][1]=JMeter
+Match[2][0]=JMeter" title="JMeter" border="0"/>&lt;/a>
+Match[2][1]=JMeter
+Match[3][0]=JMeterCommitters">Contributors&lt;/a>
+Match[3][1]=JMeterCommitters
+... and so on ...
+</pre>
+<br/>
+The first number in [] is the match number; the second number is the group.
+Group [0] is whatever matched the whole RE.
+Group [1] is whatever matched the 1st group, i.e. (JMeter\w*) in this case.
+See Figure 9b (below).
+<br/></td></tr>
+<tr><td><b>Text</b></td>
+<td>
+The default <i>Text view</i> shows all of the text contained in the response.
Note that this will only work if the response content-type is considered to be
text.
If the content-type begins with any of the following, it is considered as
binary,
otherwise it is considered to be text.
@@ -2630,6 +2668,21 @@ image/
audio/
video/
</pre>
+<br/></td></tr>
+<tr><td><b>XML</b></td>
+<td>The <i>XML view</i> will show response in tree style.
+Any DTD nodes or Prolog nodes will not show up in tree; however, response may
contain those nodes.
+<br/></td></tr>
+</table>
+<p><i>Scroll automatically?</i> option permit to have last node display in
tree selection</p>
+<p>
+With <i>Search</i> option, most of the views also allow the displayed data to
be searched; the result of the search will be high-lighted
+in the display above. For example the Control panel screenshot below shows one
result of searching for "Java".
+Note that the search operates on the visible text, so you may get different
results when searching
+the Text and HTML views.
+<br/>Note: The regular expression uses the Java engine (not ORO engine like
the Regular Expression Extractor or Regexp Tester view).
+</p>
+<p>
If there is no content-type provided, then the content
will not be displayed in the any of the Response Data panels.
You can use <complink name="Save Responses to a file"/> to save the data in
this case.
@@ -2641,52 +2694,22 @@ To change this limit, set the JMeter pro
You can also use save the entire response to a file using
<complink name="Save Responses to a file"/>.
</p>
-<p>The HTML view attempts to render the response as
-HTML. The rendered HTML is likely to compare poorly to the view one
-would get in any web browser; however, it does provide a quick
-approximation that is helpful for initial result evaluation.
-No images etc are downloaded.
-If the HTML (download embedded resources) option is selected, the renderer
-may download images and style-sheets etc referenced by the HTML.
-</p>
-<p>The XML view will show response in tree style.
-Any DTD nodes or Prolog nodes will not show up in tree; however, response may
contain those nodes.
-</p>
-<p>The JSON view will show the response in tree style (also handles JSON
embedded in JavaScript).</p>
-<p>
-Most of the views also allow the displayed data to be searched; the result of
the search will be high-lighted
-in the display above. For example the Control panel screenshot below shows one
result of searching for "Java".
-Note that the search operates on the visible text, so you may get different
results when searching
-the Text and HTML views.
-</p>
-<p>The "Regexp Tester" view only works for text responses. It shows the plain
text in the upper panel.
-The "Test" button allows the user to apply the Regular Expression to the upper
panel and the results
-will be displayed in the lower panel.
-For example, the RE <b>(JMeter\w*).*</b> applied to the current JMeter home
page gives the following output:
-</p>
-<pre>
-Match count: 26
-Match[1][0]=JMeter - Apache JMeter&lt;/title>
-Match[1][1]=JMeter
-Match[2][0]=JMeter" title="JMeter" border="0"/>&lt;/a>
-Match[2][1]=JMeter
-Match[3][0]=JMeterCommitters">Contributors&lt;/a>
-Match[3][1]=JMeterCommitters
-... and so on ...
-</pre>
<p>
-The first number in [] is the match number; the second number is the group.
-Group [0] is whatever matched the whole RE.
-Group [1] is whatever matched the 1st group, i.e. (JMeter\w*) in this case.
-See Figure 9b (below).
+Additional renderers can be created.
+The class must implement the interface
<code>org.apache.jmeter.visualizers.ResultRenderer</code>
+and/or extend the abstract class
<code>org.apache.jmeter.visualizers.SamplerResultTab</code>, and the
+compiled code must be available to JMeter (e.g. by adding it to the lib/ext
directory).
</p>
</description>
<p>
- The Control Panel (above) shows an example of an HTML display.
- Figure 9 (below) shows an example of an XML display.
+ The Control Panel (above) shows an example of an HTML display.<br/>
+ Figure 9 (below) shows an example of an XML display.<br/>
+ Figure 9a (below) shows an example of an Regexp tester display.<br/>
+ Figure 9b (below) shows an example of an Document display.<br/>
<div align="center">
<figure width="873" height="653" image="view_results_tree_xml.png">Figure 9
Sample XML display</figure>
<figure width="858" height="643" image="view_results_tree_regex.png">Figure 9a
Sample Regexp Test display</figure>
+<figure width="961" height="623" image="view_results_tree_document.png">Figure
9b Sample Document (here PDF) display</figure>
</div>
</p>
</component>
@@ -3889,7 +3912,7 @@ GUI that they can use while developing n
"true" or "false" after all assertions for a sampler have been run.
</note>
</description>
-<component name="Response Assertion" index="§-num;.5.1"
anchor="basic_assertion" width="762" height="417"
screenshot="assertion/assertion.png">
+<component name="Response Assertion" index="§-num;.5.1"
anchor="basic_assertion" width="921" height="423"
screenshot="assertion/assertion.png">
<description><p>The response assertion control panel lets you add pattern
strings to be compared against various
fields of the response.
@@ -3900,7 +3923,7 @@ GUI that they can use while developing n
</ul>
</p>
<p>
- A summary of the pattern matching characters can be found at <a
href="http://jakarta.apache.org/oro/api/org/apache/oro/text/regex/package-summary.html";>http://jakarta.apache.org/oro/api/org/apache/oro/text/regex/package-summary.html</a>
+ A summary of the pattern matching characters can be found at <a
href="http://jakarta.apache.org/oro/api/org/apache/oro/text/regex/package-summary.html";>ORO
Perl5 regular expressions.</a>
</p>
<p>You can also choose whether the strings will be expected
to <b>match</b> the entire response, or if the response is only expected to
<b>contain</b> the
@@ -3940,7 +3963,8 @@ pattern. You can attach multiple asserti
</property>
<property name="Response Field to Test" required="Yes">Instructs
JMeter which field of the Response to test.
<ul>
- <li>Text Response - the response text from the server, i.e. the body,
excluing any HTTP headers.</li>
+ <li>Text Response - the response text from the server, i.e. the body,
excluding any HTTP headers.</li>
+ <li>Document (text) - the extract text from various type of documents
via Apache Tika (see <complink name="View Results Tree"/> Document view
section).</li>
<li>URL sampled</li>
<li>Response Code - e.g. 200</li>
<li>Response Message - e.g. OK</li>
@@ -3986,10 +4010,12 @@ pattern. You can attach multiple asserti
The pattern is a Perl5-style regular expression, but without the
enclosing brackets.
</p>
<example title="Assertion Examples" anchor="assertion_examples">
-<figure image="assertion/example1a.png">Figure 14 - Test Plan</figure>
-<figure image="assertion/example1b.png">Figure 15 - Assertion Control Panel
with Pattern</figure>
-<figure image="assertion/example1c-pass.png">Figure 16 - Assertion Listener
Results (Pass)</figure>
-<figure image="assertion/example1c-fail.png">Figure 17 - Assertion Listener
Results (Fail)</figure>
+<center>
+<figure image="assertion/example1a.png" width="242" height="123">Figure 14 -
Test Plan</figure>
+<figure image="assertion/example1b.png" width="920" height="451">Figure 15 -
Assertion Control Panel with Pattern</figure>
+<figure image="assertion/example1c-pass.png" width="801" height="230">Figure
16 - Assertion Listener Results (Pass)</figure>
+<figure image="assertion/example1c-fail.png" width="800" height="233">Figure
17 - Assertion Listener Results (Fail)</figure>
+</center>
</example>
@@ -4807,7 +4833,7 @@ this one will be used by "Calculate Pric
after all Assertions have been run.
</p>
</description>
-<component name="Regular Expression Extractor" index="§-num;.8.1"
width="728" height="301" screenshot="regex_extractor.png">
+<component name="Regular Expression Extractor" index="§-num;.8.1"
width="790" height="276" screenshot="regex_extractor.png">
<description><p>Allows the user to extract values from a server response using
a Perl-type regular expression. As a post-processor,
this element will execute after each Sample request in its scope, applying the
regular expression, extracting the requested values,
generate the template string, and store the result into the given variable
name.</p></description>
@@ -4838,6 +4864,7 @@ generate the template string, and store
Note that Html escapes are processed without regard to context, so
some incorrect substitutions
may be made.
</li>
+ <li>Body as a Document - the extract text from various type of
documents via Apache Tika (see <complink name="View Results Tree"/> Document
view section).</li>
<li>Headers - may not be present for non-HTTP samples</li>
<li>URL</li>
<li>Response Code - e.g. 200</li>
