Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Counter documentation is wrong in required fieds #4793

Closed
asfimport opened this issue Jun 12, 2018 · 3 comments
Closed

Counter documentation is wrong in required fieds #4793

asfimport opened this issue Jun 12, 2018 · 3 comments

Comments

@asfimport
Copy link
Collaborator

orimarko (Bug 62446):
Counter documentation is wrong in required fields:

Reference name - can be empty will create a JMeter variable with empty string which can be called as ${}

Starting value - can be empty will create a value from 0

Increment - can be empty will increment a value with 0 (no increment)

Should update documentation or add limitation in code

Based on https://stackoverflow.com/questions/50794408/jmeters-counter-without-required-fields

Severity: normal
OS: All

Blocks:

@asfimport
Copy link
Collaborator Author

@FSchumacher (migrated from Bugzilla):
I think the empty name and increment of zero is a bug.

An empty name should probably be handled as a user input error.

The other two fields can be set to a default value. My preference would be start counter with 0 and increment by 1.

The docs should - of course - reflect this.

@asfimport
Copy link
Collaborator Author

orimarko (migrated from Bugzilla):
Created attachment patch62446.patch: Patch with updated docs

patch62446.patch
Index: xdocs/changes.xml
===================================================================
--- xdocs/changes.xml	(revision 1839678)
+++ xdocs/changes.xml	(working copy)
@@ -257,6 +257,7 @@
 <ul>
     <li><bug>62211</bug>Fix HTTP Request Server Documentation. Contributed by orimarko at gmail.com</li>
     <li><pr>388</pr>Fix a typo. Contributed by Giancarlo Romeo (giancarloromeo at gmail.com)</li>
+	<li><bug>62446</bug>Counter documentation is wrong in required fieds. Contributed by orimarko at gmail.com</li>
 </ul>
 
 <h3>General</h3>
Index: xdocs/usermanual/component_reference.xml
===================================================================
--- xdocs/usermanual/component_reference.xml	(revision 1839678)
+++ xdocs/usermanual/component_reference.xml	(working copy)
@@ -4236,10 +4236,10 @@
 </description>
 <properties>
         <property name="Name" required="">Descriptive name for this element that is shown in the tree.</property>
-        <property name="Starting value" required="Yes">The starting value for the counter.  The counter will equal this
-        value during the first iteration.</property>
+        <property name="Starting value" required="No">The starting value for the counter.  The counter will equal this
+        value during the first iteration (default 0).</property>
         <property name="Increment" required="Yes">How much to increment the counter by after each
-        iteration.</property>
+        iteration (default 0, meaning no increment).</property>
         <property name="Maximum value" required="No">If the counter exceeds the maximum, then it is reset to the <code>Starting value</code>.
         Default is <code>Long.MAX_VALUE</code>
         </property>
@@ -4248,9 +4248,9 @@
         If there is a problem interpreting the format, then it is ignored.
     [The default format is generated using <code>Long.toString()</code>]
         </property>
-        <property name="Exported Variable Name" required="Yes">This will be the variable name under which the counter value is available.  
+        <property name="Exported Variable Name" required="No">This will be the variable name under which the counter value is available.  
         If you name it <code>counterA</code>, you can then access it using <code>${counterA}</code> 
-        as explained in <a href="functions.html">user-defined values</a></property>
+        as explained in <a href="functions.html">user-defined values</a> (By default create an empty string variable that can be access using <code>${}</code> )</property>
         <property name="Track Counter Independently for each User" required="No">In other words, is this a global counter, or does each user get their
         own counter?  If unchecked, the counter is global (i.e., user #1 will get value "<code>1</code>", and user #2 will get value "<code>2</code>" on
         the first iteration).  If checked, each user has an independent counter.</property>

@asfimport
Copy link
Collaborator Author

@pmouawad (migrated from Bugzilla):
Author: pmouawad
Date: Sun Mar 3 13:31:55 2019
New Revision: 1854709

URL: http://svn.apache.org/viewvc?rev=1854709&view=rev
Log:
#4793 - Counter documentation is wrong in required fieds
#4793

Modified:
jmeter/trunk/xdocs/changes.xml
jmeter/trunk/xdocs/usermanual/component_reference.xml

See #5029

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant