io.testable.selenium

Class TestableCSVReader

java.lang.Object

io.testable.selenium.TestableCSVReader

public class TestableCSVReader
extends java.lang.Object

Operations to read from a CSV file while running a test on the Testable platform. When run locally it simply tries to load the file from your local classpath/working directory. It is assumed your CSV file has a header row with column names in the first row.

Constructor Summary

Constructors

Constructor and Description
TestableCSVReader(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.csv.CSVRecord	get(int index) Get a row from the file by index (zero based).
org.apache.commons.csv.CSVRecord	next() Gets the next row in the CSV file.
org.apache.commons.csv.CSVRecord	next(boolean wrap) Gets the next row in the CSV file.
java.util.List<org.apache.commons.csv.CSVRecord>	next(int rows) Gets the next 1 or more rows from the CSV file.
java.util.List<org.apache.commons.csv.CSVRecord>	next(int rows, boolean wrap) Gets the next 1 or more rows from the CSV file.
org.apache.commons.csv.CSVRecord	random() Get a random row from the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestableCSVReader

public TestableCSVReader(java.lang.String path)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

get

public org.apache.commons.csv.CSVRecord get(int index)

Get a row from the file by index (zero based).

Parameters:

index - The row index to load. The first row in the file after the header row is row 0.

Returns:

A row record

random

public org.apache.commons.csv.CSVRecord random()

Get a random row from the file.

Returns:

A random row record

next

public org.apache.commons.csv.CSVRecord next()
                                      throws java.io.IOException

Gets the next row in the CSV file. When run on Testable this functions as a global iterator across all regions and test runners. This ensures that the rows in the file are evenly distributed across your virtual users. When the last row is reached the next call globally will return the first row in the file.

Returns:

The next row record

Throws:

java.io.IOException

next

public org.apache.commons.csv.CSVRecord next(boolean wrap)
                                      throws java.io.IOException

Gets the next row in the CSV file. When run on Testable this functions as a global iterator across all regions and test runners. This ensures that the rows in the file are evenly distributed across your virtual users.

Parameters:

wrap - If true once the last row is reached loop back to the first row. If false a ClientProtocolException is thrown when the end of the file is reached.

Returns:

The next row record

Throws:

java.io.IOException

next

public java.util.List<org.apache.commons.csv.CSVRecord> next(int rows)
                                                      throws java.io.IOException

Gets the next 1 or more rows from the CSV file. When run on Testable this functions as a global iterator across all regions and test runners. This ensures that the rows in the file are evenly distributed across your virtual users. When the last row is reached the next call globally will return the first row in the file.

Parameters:

rows - Number of rows to return

Returns:

A list of the records

Throws:

java.io.IOException

next

public java.util.List<org.apache.commons.csv.CSVRecord> next(int rows,
                                                             boolean wrap)
                                                      throws java.io.IOException

Gets the next 1 or more rows from the CSV file. When run on Testable this functions as a global iterator across all regions and test runners. This ensures that the rows in the file are evenly distributed across your virtual users.

Parameters:

rows - Number of rows to return

wrap - If true once the last row is reached loop back to the first row. If false a ClientProtocolException is thrown when the end of the file is reached.

Returns:

Throws:

java.io.IOException