Package org.apache.jmeter.functions

Class CSVRead

java.lang.Object
org.apache.jmeter.functions.AbstractFunction
org.apache.jmeter.functions.CSVRead
All Implemented Interfaces:
org.apache.jmeter.functions.Function
@AutoService(org.apache.jmeter.functions.Function.class) public class CSVRead extends org.apache.jmeter.functions.AbstractFunction
The function represented by this class allows data to be read from CSV files. Syntax is similar to StringFromFile function. The function allows the test to line-thru the data in the CSV file - one line per each test. E.g. inserting the following in the test scripts : 

 ${__CSVRead(c:/BOF/abcd.csv,0)} // read (first) line of 'c:/BOF/abcd.csv'
     // and return the 1st column (represented by the '0')
 ${__CSVRead(c:/BOF/abcd.csv,1)} // read (first) line of 'c:/BOF/abcd.csv'
     // and return the 2nd column (represented by the '1')
 ${__CSVRead(c:/BOF/abcd.csv,next())} // Go to next line of 'c:/BOF/abcd.csv'
NOTE: A single instance of each different file is opened and used for all threads.

To open the same file twice, use the alias function: 

 __CSVRead(abc.csv,*ONE);
 __CSVRead(abc.csv,*TWO);
and later use the references to read from the files:
__CSVRead(*ONE,1);, etc.
Since:
1.9

  • Constructor Details

    • CSVRead

      public CSVRead()

  • Method Details

    • execute

      public String execute(org.apache.jmeter.samplers.SampleResult previousResult, org.apache.jmeter.samplers.Sampler currentSampler) throws org.apache.jmeter.functions.InvalidVariableException
      Specified by:
      execute in interface org.apache.jmeter.functions.Function
      Specified by:
      execute in class org.apache.jmeter.functions.AbstractFunction
      Throws:
      org.apache.jmeter.functions.InvalidVariableException

    • getArgumentDesc

      public List<String> getArgumentDesc()

    • getReferenceKey

      public String getReferenceKey()
      Specified by:
      getReferenceKey in interface org.apache.jmeter.functions.Function
      Specified by:
      getReferenceKey in class org.apache.jmeter.functions.AbstractFunction

    • setParameters

      public void setParameters(Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters) throws org.apache.jmeter.functions.InvalidVariableException
      Specified by:
      setParameters in interface org.apache.jmeter.functions.Function
      Specified by:
      setParameters in class org.apache.jmeter.functions.AbstractFunction
      Throws:
      org.apache.jmeter.functions.InvalidVariableException