com.paypal.selion.platform.dataprovider.impl

Class YamlDataProviderImpl

java.lang.Object

com.paypal.selion.platform.dataprovider.impl.YamlDataProviderImpl

All Implemented Interfaces:

SeLionDataProvider

public final class YamlDataProviderImpl
extends Object
implements SeLionDataProvider

This class provides several methods to retrieve test data from yaml files. Users can get data returned in an Object 2D array by loading the yaml file with Snakeyaml. If the entire yaml file is not needed then specific data entries can be retrieved by indexes. If the yaml file is formatted to return a LinkedHashMap data type from Snakeyaml, user can get an Object 2D array containing data for select keys or get the entire contents of the yaml file in a Hashtable instead of an Object 2D array.

Constructor Summary

Constructors

Constructor and Description
YamlDataProviderImpl(DataResource resource)

Method Summary

Modifier and Type	Method and Description
Object[][]	getAllData() Converts a yaml file into an Object 2D array for TestNG Dataprovider consumption.
Hashtable<String,Object>	getDataAsHashtable() Gets yaml data and returns in a hashtable instead of an Object 2D array.
Iterator<Object[]>	getDataByFilter(DataProviderFilter dataFilter) Gets yaml data by applying the given filter.
Object[][]	getDataByIndex(int[] indexes) Generates an object array in iterator as TestNG DataProvider from the YAML data filtered per given indexes.
Object[][]	getDataByIndex(String indexes) Gets yaml data for requested indexes.
Object[][]	getDataByKeys(String[] keys) Gets yaml data by key identifiers.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlDataProviderImpl

public YamlDataProviderImpl(DataResource resource)

Method Detail

getAllData

public Object[][] getAllData()
                      throws IOException

Converts a yaml file into an Object 2D array for TestNG Dataprovider consumption. User-defined objects can be passed in to be added/mapped into the Snakeyaml constructor.

YAML file example: Block List Of Strings

 -US - GB - AU
 

Object array returned:

 Object[0][0] = US
 Object[1][0] = GB
 Object[2][0] = AU
 

Test method signature example:

 public void testExample(String countryCode)
 

YAML file example: Inline List Of Strings

 [US, GB, AU]
 

Object array returned:

 Object[0][0] = US
 Object[1][0] = GB
 Object[2][0] = AU
 

Test method signature example:

 public void testExample(String countryCode)
 

YAML file example: Block List of Inline Associative Arrays

 - {name: 1, userEmail: user1@paypal.com, userId: 10686626}
 - {name: 2, email: user2@paypal.com, userId: 10686627}

 

Object array returned (LinkedHashMap):

 Object[0][0] = {name=1, email=user1@paypal.com, userId=10686626}
 Object[1][0] = {name=2, email=user2@paypal.com, userId=10686627}
 

Test method signature example:

 public void testExample(LinkedHashMap test)
 

YAML file example: Block Associative Arrays of Associative Arrays

 test1:
     name: 1
     email: user1@paypal.com
     userId: 10686626
 test2:
     name: 2
     email: user2@paypal.com
     userId: 10686627
 

Object array returned (contains LinkedHashMap):

 Object[0][0] = {name=1, email=user1@paypal.com, userId=10686626}
 Object[1][0] = {name=2, email=user2@paypal.com, userId=10686627}
 

Test method signature example:

 public void testExample(LinkedHashMap test)
 

YAML file example: Document separated Inline Associative Arrays

 ---
 {name: 1, email: user1@paypal.com, userId: 10686626}
 ---
 {name: 2, email: user2@paypal.com, userId: 10686627}
 

Object array returned (contains LinkedHashMap):

 Object[0][0] = {name=1, email=user1@paypal.com, userId=10686626}
 Object[1][0] = {name=2, email=user2@paypal.com, userId=10686627}
 

Test method signature example:

 public void testExample(LinkedHashMap test)
 

Abstract User-Defined Objects

User-defined objects can be passed into this method so the type can be mapped in the Snakeyaml constructor with a new tag. Tag is automatically set to the simple name of the class. If there are multiple objects with the same simple name, then the full path must be used in the yaml file to differentiate between the two.


A proper JavaBean must be defined for the user-defined object or else an exception will be thrown while attempting to load the yaml file.

YAML file example: List of MyObject

 - !!com.paypal.test.resources.MyObject
     name: 1
     email: user1@paypal.com
     userId: 10686626
 - !!com.paypal.test.resources.MyObject
     name: 2
     email: user2@paypal.com
     userId: 10686626
 

YAML file example: List of MyObject mapped with tag "MyObject"

 - !MyObject
     name: 1
     email: user1@paypal.com
     userId: 10686626
 - !MyObject
     name: 2
     email: user2@paypal.com
     userId: 10686626
 

Object array returned:

 Object[1][0] = com.paypal.test.dataobject.MyObject@54bb7759
 Object[2][0] = com.paypal.test.dataobject.MyObject@5f989f84
 

Test method signature example:

 public void testExample(MyObject myObject)
 

For sample yaml formats, use utility methods:

• DataProviderHelper.serializeObjectToYamlString(Object)
• DataProviderHelper.serializeObjectToYamlStringAsList(Object...)
• DataProviderHelper.serializeObjectToYamlStringAsMap(Object...)
• DataProviderHelper.serializeObjectToYamlStringAsDocuments(Object...)

Specified by:

getAllData in interface SeLionDataProvider

Returns:

Object[][] two dimensional object to be used with TestNG DataProvider

Throws:

IOException

getDataByFilter

public Iterator<Object[]> getDataByFilter(DataProviderFilter dataFilter)
                                   throws IOException

Gets yaml data by applying the given filter. Throws DataProviderException when unexpected error occurs during processing of YAML file data by filter

Specified by:

getDataByFilter in interface SeLionDataProvider

Parameters:

dataFilter - an implementation class of DataProviderFilter

Returns:

An iterator over a collection of Object Array to be used with TestNG DataProvider

Throws:

IOException

getDataByKeys

public Object[][] getDataByKeys(String[] keys)

Gets yaml data by key identifiers. Only compatible with a yaml file formatted to return a map.

YAML file example:

 test1:
     name: 1
     email: user1@paypal.com
     userId: 10686626
 test2:
     name: 2
     email: user2@paypal.com
     userId: 10686627
 

Specified by:

getDataByKeys in interface SeLionDataProvider

Parameters:

keys - A String array that represents the keys.

Returns:

Object[][] two dimensional object to be used with TestNG DataProvider

getDataAsHashtable

public Hashtable<String,Object> getDataAsHashtable()

Gets yaml data and returns in a hashtable instead of an Object 2D array. Only compatible with a yaml file formatted to return a map.

YAML file example:

 test1:
     name: 1
     email: user1@paypal.com
     userId: 10686626
 test2:
     name: 2
     email: user2@paypal.com
     userId: 10686627
 

Specified by:

getDataAsHashtable in interface SeLionDataProvider

Returns:

yaml data in form of a Hashtable.

getDataByIndex

public Object[][] getDataByIndex(String indexes)
                          throws IOException,
                                 DataProviderException

Gets yaml data for requested indexes.

Specified by:

getDataByIndex in interface SeLionDataProvider

Parameters:

indexes - the input string represent the indexes to be parse

Returns:

Object[][] Two dimensional object to be used with TestNG DataProvider

Throws:

IOException

DataProviderException

getDataByIndex

public Object[][] getDataByIndex(int[] indexes)
                          throws IOException

Generates an object array in iterator as TestNG DataProvider from the YAML data filtered per given indexes. This method may throw DataProviderException when an unexpected error occurs during data provision from YAML file.

Specified by:

getDataByIndex in interface SeLionDataProvider

Parameters:

indexes - The indexes for which data is to be fetched as a conforming string pattern.

Returns:

An Object[][] object to be used with TestNG DataProvider.

Throws:

IOException