com.qmetry.qaf.automation.testng.dataprovider.QAFInetrceptableDataProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of qaf Show documentation
Show all versions of qaf Show documentation
Functional test automation framework for web, mobile-web, mobile native and web-service
/*******************************************************************************
* Copyright (c) 2019 Infostretch Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
******************************************************************************/
package com.qmetry.qaf.automation.testng.dataprovider;
import static com.qmetry.qaf.automation.core.ConfigurationManager.getBundle;
import static org.apache.commons.lang.StringUtils.isBlank;
import static org.apache.commons.lang.StringUtils.isNotBlank;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import org.apache.commons.configuration.ConfigurationConverter;
import org.apache.commons.lang.text.StrSubstitutor;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.impl.LogFactoryImpl;
import org.json.JSONObject;
import org.testng.ITestContext;
import org.testng.ITestNGMethod;
import org.testng.annotations.DataProvider;
import org.testng.internal.Configuration;
import org.testng.internal.MethodInvocationHelper;
import org.testng.internal.annotations.IAnnotationFinder;
import com.google.gson.Gson;
import com.google.gson.JsonSyntaxException;
import com.qmetry.qaf.automation.core.ConfigurationManager;
import com.qmetry.qaf.automation.data.DataBean;
import com.qmetry.qaf.automation.keys.ApplicationProperties;
import com.qmetry.qaf.automation.step.client.TestNGScenario;
import com.qmetry.qaf.automation.testng.DataProviderException;
import com.qmetry.qaf.automation.testng.dataprovider.QAFDataProvider.params;
import com.qmetry.qaf.automation.util.CSVUtil;
import com.qmetry.qaf.automation.util.ClassUtil;
import com.qmetry.qaf.automation.util.DatabaseUtil;
import com.qmetry.qaf.automation.util.ExcelUtil;
import com.qmetry.qaf.automation.util.JSONUtil;
import com.qmetry.qaf.automation.util.ListUtils;
import com.qmetry.qaf.automation.util.PoiExcelUtil;
import com.qmetry.qaf.automation.util.StringUtil;
/**
* @author Chirag.Jayswal
*
*/
public class QAFInetrceptableDataProvider {
private static final Log logger = LogFactoryImpl.getLog(QAFInetrceptableDataProvider.class);
/**
*
* @param method
* @param c
* @return
*/
@DataProvider(name = QAFDataProvider.NAME_PARALLEL, parallel = true)
public static Iterator interceptedParallelDataProvider(ITestNGMethod method, ITestContext c) {
return interceptedDataProvider(method, c);
}
/**
*
* @param method
* @param c
* @return
*/
@DataProvider(name = QAFDataProvider.NAME)
public static Iterator interceptedDataProvider(ITestNGMethod method, ITestContext c) {
TestNGScenario scenario = (TestNGScenario) method;
@SuppressWarnings("unchecked")
Map parameters = (Map) getParameters(scenario);
// update resolved meta-data should reflect in report
Map metadata = scenario.getMetaData();
metadata.putAll(parameters);
// Intercepter registered using property 'qaf.listeners'
Set intercepters = getIntercepters();
for (QAFDataProviderIntercepter intercepter : intercepters) {
intercepter.beforeFech(scenario, c);
}
List dataList = null;
String dataProvider = (String) metadata.get(params.DATAPROVIDER.name());
boolean hasCustomDataProvider = null!=dataProvider && !dataProvider.startsWith(QAFDataProvider.NAME);
if (hasCustomDataProvider) {
// get data provider from description!...
String dataProviderClass = (String) metadata.get(params.DATAPROVIDERCLASS.name());
Iterator testData = invokeCustomDataProvider(method, c, dataProvider, dataProviderClass);
dataList = ListUtils.toList(testData);
} else {
Object[][] testData = getData(metadata);
dataList = ListUtils.toList(testData);
}
List data = process(scenario, dataList);
// listeners
List interceptedData = intercept(scenario, c, data,intercepters);
return interceptedData.iterator();
}
private static List intercept(TestNGScenario scenario, ITestContext context, List testdata, Set intercepters) {
// Intercepter registered using property 'qaf.listeners'
for (QAFDataProviderIntercepter intercepter : intercepters) {
testdata = intercepter.intercept(scenario, context, testdata);
}
int from = 1;
int to = testdata.size();
Map metadata = scenario.getMetaData();
if (metadata.containsKey(params.FROM.name()) || metadata.containsKey(params.TO.name())) {
if (metadata.containsKey(params.TO.name()) && (int) metadata.get(params.TO.name()) < to) {
to = (int) metadata.get(params.TO.name());
}
if (metadata.containsKey(params.FROM.name()) && (int) metadata.get(params.FROM.name())>from) {
from = (int) metadata.get(params.FROM.name());
}
return testdata.subList(from-1, to);
}
if (metadata.containsKey(params.INDICES.name())) {
List indices = (List) metadata.get(params.INDICES.name());
List filteredList = new ArrayList();
for (Object i : indices) {
filteredList.add(testdata.get((int) i));
}
return filteredList;
}
return testdata;
}
private static Map getParameters(TestNGScenario scenario) {
Map methodParameters = scenario.getMetaData();
String description = scenario.getDescription();
if (isNotBlank(description) && JSONUtil.isValidJsonString(description)) {
Map paramsFromDesc = new JSONObject(description).toMap();
description =(String) paramsFromDesc.remove("description");
methodParameters.putAll(paramsFromDesc);
scenario.setDescription(description);
}
// highest priority test data overridden through property with test name prefix
String testParameters = getConfigParameters(scenario.getMethodName() + ".testdata");
if(isBlank(testParameters)){
//second priority overridden through property "global.testdata"
testParameters = getConfigParameters("global.testdata");
if(isBlank(testParameters)){
//default provided with test case
testParameters = new JSONObject(methodParameters).toString();
}
}
String cls = scenario.getConstructorOrMethod().getMethod().getDeclaringClass().getSimpleName();
String mtd = scenario.getMethodName();
testParameters = testParameters.replace("${class}", cls);
testParameters = testParameters.replace("${method}", mtd);
testParameters = StrSubstitutor.replace(testParameters, methodParameters);
testParameters = getBundle().getSubstitutor().replace(testParameters);
try {
return new JSONObject(testParameters).toMap();
} catch (JsonSyntaxException e) {
// old way of setting global data or testdata using key=value
return StringUtil.toMap(testParameters, true);
}
}
@SuppressWarnings("unchecked")
private static List process(TestNGScenario scenario, List data) {
Class[] paramTypes = scenario.getConstructorOrMethod().getParameterTypes();
List testdata = new ArrayList(data);
// list of only map object
if (null != testdata && !testdata.isEmpty() && testdata.get(0).length == 1
&& Map.class.isAssignableFrom(testdata.get(0)[0].getClass())) {
try {
// filter records using key include/exclude if provided in data
String filter = (String) scenario.getMetaData().get("filter");
if (StringUtil.isNotBlank(filter)) {
// resolve parameters
TreeMap parametes = new TreeMap(String.CASE_INSENSITIVE_ORDER);
parametes.putAll(scenario.getMetaData());
parametes.put("method", scenario.getMethodName());
parametes.put("class", scenario.getConstructorOrMethod().getMethod().getDeclaringClass().getSimpleName());
filter = StrSubstitutor.replace(filter, parametes);
filter = getBundle().getSubstitutor().replace(filter);
logger.info("Applying Filter " + filter);
int i =0;
Iterator iter = testdata.iterator();
while (iter.hasNext()) {
// consider column values as context variables
Map record = (Map) iter.next()[0];
boolean include = StringUtil.eval(filter, record);
i=i+1;
if (!include) {
logger.debug("removing " + record);
iter.remove();
}else{
record.put("__baseindex", i);
}
}
}
} catch (Exception e) {
throw new DataProviderException("Unable to apply filter on data-set", e);
}
// process parameters
for (int i = 0; i < testdata.size(); i++) {
Map record = (Map) testdata.get(i)[0];
if (paramTypes.length > 1) {
Object[] values = record.values().toArray();
if (paramTypes.length == values.length && paramTypes[0].isAssignableFrom(values[0].getClass())) {
testdata.set(i, values);
} else {
Object[] params = new Object[paramTypes.length];
for (int pi = 0; pi < paramTypes.length; pi++) {
try {
if (values.length > pi && paramTypes[pi].isAssignableFrom(values[pi].getClass())) {
params[pi] = values[pi];
} else if (DataBean.class.isAssignableFrom(paramTypes[pi])) {
DataBean bean = (DataBean) paramTypes[pi].getDeclaredConstructor().newInstance();
bean.fillData(record);
params[pi] = bean;
} else {
Gson gson = new Gson();
String seralizedObj = gson.toJson(record);
params[pi] = gson.fromJson(seralizedObj, paramTypes[pi]);
}
} catch (Exception e) {
throw new DataProviderException("Unable to populate data" + paramTypes, e);
}
}
testdata.set(i, params);
}
} else if (!Map.class.isAssignableFrom(paramTypes[0])) {
if (DataBean.class.isAssignableFrom(paramTypes[0])) {
try {
DataBean bean = (DataBean) paramTypes[0].getDeclaredConstructor().newInstance();
bean.fillData(record);
testdata.set(i, new Object[] { bean });
} catch (Exception e) {
throw new DataProviderException("Unable to populate databean", e);
}
} else {
Gson gson = new Gson();
String seralizedObj = gson.toJson(record);
Object obj = new Gson().fromJson(seralizedObj, paramTypes[0]);
testdata.set(i, new Object[] { obj });
}
} else {
record.put("__index", i + 1);
}
}
}
return testdata;
}
/**
*
* @param metadata
* @return
*/
public static Object[][] getData(Map metadata) {
String query = (String) metadata.get(params.SQLQUERY.name());
if (isNotBlank(query)) {
return DatabaseUtil.getRecordDataAsMap(query);
}
String jsonTable = (String) metadata.get(params.JSON_DATA_TABLE.name());
if (isNotBlank(jsonTable)) {
return JSONUtil.getJsonArrayOfMaps(jsonTable);
}
String file = (String) metadata.get(params.DATAFILE.name());
String key = (String) metadata.get(params.KEY.name());
if (isNotBlank(file)) {
if (file.endsWith("json")) {
return JSONUtil.getJsonArrayOfMaps(file);
}
if (file.endsWith("xml")) {
List mapData = DataProviderUtil.getDataSetAsMap(key, file);
return mapData.toArray(new Object[][] {});
}
if (file.endsWith("xls")) {
if (isNotBlank(key)) {
return ExcelUtil.getTableDataAsMap(file, ((String) metadata.get(params.KEY.name())),
(String) metadata.get(params.SHEETNAME.name()));
}
return ExcelUtil.getExcelDataAsMap(file, (String) metadata.get(params.SHEETNAME.name()));
}
if (file.endsWith("xlsx")) {
if (isNotBlank(key)) {
return PoiExcelUtil.getTableDataAsMap(file, ((String) metadata.get(params.KEY.name())),
(String) metadata.get(params.SHEETNAME.name()));
}
return PoiExcelUtil.getExcelDataAsMap(file, (String) metadata.get(params.SHEETNAME.name()));
}
// csv, text
List csvData = CSVUtil.getCSVDataAsMap(file);
return csvData.toArray(new Object[][] {});
}
if (isNotBlank(key)) {
List mapData = DataProviderUtil.getDataSetAsMap(key, "");
return mapData.toArray(new Object[][] {});
}
throw new RuntimeException("No data provider found");
}
private static Iterator invokeCustomDataProvider(ITestNGMethod tm, ITestContext c, String dp,
String dpc) {
String methodClass = tm.getConstructorOrMethod().getDeclaringClass().getName();
if (isBlank(dpc)) {
dpc = getBundle().getString("global.dataproviderclass", getBundle().getString("dataproviderclass",methodClass));
}
if (isNotBlank(dpc)) {
Method m;
try {
m = getDataProviderMethod(dp, dpc);
} catch (Exception e) {
m = getDataProviderMethod(dp, methodClass);
}
Object instanceToUse = m.getDeclaringClass().equals(tm.getConstructorOrMethod().getDeclaringClass()) ? tm.getInstance()
: ClassUtil.newInstanceOrNull(m.getDeclaringClass());
return InvocatoinHelper.invokeDataProvider(instanceToUse, m, tm, c, null,
new Configuration().getAnnotationFinder());
} else {
throw new DataProviderException(
"Data-provider class not found. Please provide fully qualified class name as dataProviderClass");
}
}
private static Method getDataProviderMethod(String dp, String dpc) {
try {
Class dpClass = Class.forName(dpc);
Set dpMethods = ClassUtil.getAllMethodsWithAnnotation(dpClass, DataProvider.class);
for (Method m : dpMethods) {
DataProvider dpObj = ClassUtil.getAnnotation(m, DataProvider.class);
if (dp.equalsIgnoreCase(dpObj.name())) {
// this is the mehod we are lo
return m;
}
}
} catch (ClassNotFoundException e) {
throw new DataProviderException("Data-provider class " + dpc
+ " not found. Please provide fully qualified class name as dataProviderClass");
}
throw new DataProviderException("Data-provider: '" + dp + "' not found in class: '" + dpc
+ "'. Please provide valid data provider name as dataProvider");
}
private static class InvocatoinHelper extends MethodInvocationHelper {
protected static Iterator invokeDataProvider(Object instance, Method dataProvider,
ITestNGMethod method, ITestContext testContext, Object fedInstance,
IAnnotationFinder annotationFinder) {
return MethodInvocationHelper.invokeDataProvider(instance, dataProvider, method, testContext, fedInstance,
annotationFinder);
}
}
private static Set getIntercepters() {
Set intercepters = new LinkedHashSet();
String[] listners = ConfigurationManager.getBundle().getStringArray(ApplicationProperties.QAF_LISTENERS.key);
for (String listener : listners) {
try {
Class listenerClass = Class.forName(listener);
if (QAFDataProviderIntercepter.class.isAssignableFrom(listenerClass)) {
QAFDataProviderIntercepter intercepter = (QAFDataProviderIntercepter) listenerClass.getDeclaredConstructor().newInstance();
intercepters.add(intercepter);
}
} catch (Exception e) {
}
}
return intercepters;
}
private static String getConfigParameters(String key){
if(getBundle().containsKey(key) || !getBundle().subset(key).isEmpty()){
org.apache.commons.configuration.Configuration config = getBundle().subset(key);
if(config.isEmpty()){
return getBundle().getString(key);
}
return new JSONObject(ConfigurationConverter.getMap(config)).toString();
}
return "";
}
}