hu.ibello.steps

Interface StepLibraryTool

public interface StepLibraryTool

Helper interface for step libraries.

There is no need to use this interface directly. The ibello dependency injection system automatically instantiates and injects an instance into step libraries.

Author:

Kornél Simon

See Also:

StepLibrary

Method Summary

Modifier and Type	Method and Description
CsvTransformer	csv() Returns an object which can be used to transform CSV file to java objects.
Value	getConfigurationValue(String name) Returns a configuration property as a Value.
String	getMergedURL(String url) Returns an URL which is merged with the ibello.url.base configuration property.
HttpClient	httpClient() Returns a HTTP client.
JsonTransformer	json() Returns an object which van be used to transform java objects into JSON and back.
OutputHandler	output() Returns the output handler tool.
RestClient	restClient() Returns a REST client.
TestDataBuilder	testData() Starts a new test data loading.

Method Detail

getConfigurationValue

Value getConfigurationValue(String name)

Returns a configuration property as a Value. The returned value offers some public methods to transform the configuration property into different java types. This method always has a non-null result, even if the configuration value does not exist - in this case, the wrapped value will be null.

Parameters:

name - name of the configuration parameter

Returns:

value of the configuration parameter wrapped into a Value instance

getMergedURL

String getMergedURL(String url)

Returns an URL which is merged with the ibello.url.base configuration property.

If the given URL is an absolute one with protocol, then it will be returned (without any changes).

If the URL is relative, then it will be concatenated to the configuration property, and the result will be returned.

Parameters:

url - the absolute or relative URL

Returns:

the merged URL

testData

TestDataBuilder testData()

Starts a new test data loading. The result is a TestDataBuilder instance which can be used to configure and perform the test loading operation.

Returns:

a test data loader instance

See Also:

TestDataBuilder

output

OutputHandler output()

Returns the output handler tool. With that we can add custom actions and expectations to the test report. For example, a custom logging can be performed as:

 output().recordCustomAction("Username is " + username);
 

We can do custom expectation with the following code (using the junit assertion library):

 org.junit.Assert.assertEquals("Username is wrong", "Martin", username);
 output().recordCustomExpectation("Username is the expected " + username);
 

This code will throw an AssertionError, if the username is not the expected one. (All AssertionError type exceptions are handled by the ibello automatically.) If the username is correct, then the second row will add a message to the test report.

Returns:

the output handler instance

See Also:

OutputHandler

restClient

RestClient restClient()

Returns a REST client. With that we can perform a REST operation - send a JSON REST request and receive it's response. The request and response data will be logged automatically.

Returns:

the REST client instance

See Also:

RestClient

httpClient

HttpClient httpClient()

Returns a HTTP client. With that we can perform a HTTP call - send a request and receive it's response. The request and response data will be logged automatically.

Returns:

the HTTP client instance

See Also:

HttpClient

json

JsonTransformer json()

Returns an object which van be used to transform java objects into JSON and back.

Returns:

JSON transformer instance

csv

CsvTransformer csv()

Returns an object which can be used to transform CSV file to java objects.

Returns:

CSV transformer instance