All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.qmetry.qaf.automation.step.client.CustomStep Maven / Gradle / Ivy

Go to download

Functional test automation framework for web, mobile-web, mobile native and web-service

There is a newer version: 4.0.0-RC3
Show newest version
/*******************************************************************************
 * QMetry Automation Framework provides a powerful and versatile platform to author 
 * Automated Test Cases in Behavior Driven, Keyword Driven or Code Driven approach
 *                
 * Copyright 2016 Infostretch Corporation
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * 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
 *
 * You should have received a copy of the GNU General Public License along with this program in the name of LICENSE.txt in the root folder of the distribution. If not, see https://opensource.org/licenses/gpl-3.0.html
 *
 * See the NOTICE.TXT file in root folder of this source files distribution 
 * for additional information regarding copyright ownership and licenses
 * of other open source software / files used by QMetry Automation Framework.
 *
 * For any inquiry or need additional information, please contact [email protected]
 *******************************************************************************/


package com.qmetry.qaf.automation.step.client;

import static com.qmetry.qaf.automation.core.ConfigurationManager.getBundle;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang.text.StrSubstitutor;

import com.google.gson.Gson;
import com.qmetry.qaf.automation.core.CheckpointResultBean;
import com.qmetry.qaf.automation.core.LoggingBean;
import com.qmetry.qaf.automation.core.MessageTypes;
import com.qmetry.qaf.automation.core.QAFTestBase;
import com.qmetry.qaf.automation.core.TestBaseProvider;
import com.qmetry.qaf.automation.step.BaseTestStep;
import com.qmetry.qaf.automation.step.StepExecutionTracker;
import com.qmetry.qaf.automation.step.StepInvocationException;
import com.qmetry.qaf.automation.step.StringTestStep;
import com.qmetry.qaf.automation.step.TestStep;
import com.qmetry.qaf.automation.step.TestStepCompositer;
import com.qmetry.qaf.automation.step.client.text.BDDDefinitionHelper;
import com.qmetry.qaf.automation.step.client.text.BDDDefinitionHelper.ParamType;

/**
 * com.qmetry.qaf.automation.exceltest.CustomStep.java
 * 
 * @author chirag.jayswal
 */
public class CustomStep extends BaseTestStep implements TestStepCompositer {
	private Collection steps;
	private String def;

	public CustomStep(String name, String description, Collection steps) {
		super(name, description);
		this.steps = steps;
		this.def = description;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see com.qmetry.qaf.automation.step.TestStep#execute(java.lang.Object[])
	 */
	@Override
	protected Object doExecute() {
		try {
			Object res = null;
			processStepParams();

			int executionIndx = 0;
			TestStep[] stepsToExecute = steps.toArray(new TestStep[steps.size()]);

			for (executionIndx = 0; executionIndx < stepsToExecute.length;) {
				TestStep currTestStep = stepsToExecute[executionIndx];
				((StringTestStep) currTestStep).initStep();

				StepExecutionTracker stepExecutionTracker = currTestStep.getStepExecutionTracker();

				if (null != stepExecutionTracker) {
					// quick-fix by Amit for ISFW-163
					stepExecutionTracker.getContext().putAll(getStepExecutionTracker().getContext());
					stepExecutionTracker.getContext().put("testStepCompositer", this);

					stepExecutionTracker.setStepCompositer(this);
					stepExecutionTracker.setStepIndex(executionIndx);
					stepExecutionTracker.setNextStepIndex(++executionIndx);
				} else {
					++executionIndx;
					QAFTestBase stb = TestBaseProvider.instance().get();

					CheckpointResultBean stepResultBean = new CheckpointResultBean();
					stepResultBean.setMessage(currTestStep.getDescription() + " :: Not Found.");
					stepResultBean.setType(MessageTypes.Warn);
					stb.getCheckPointResults().add(stepResultBean);

					LoggingBean comLoggingBean = new LoggingBean(currTestStep.getName(),
							new String[] { Arrays.toString(currTestStep.getActualArgs()) }, "Error: Step Not Found");
					stb.getLog().add(comLoggingBean);

					throw new StepInvocationException(currTestStep,
							"Test Step (" + currTestStep.getDescription()
									+ ") Not Found.\n Please provide implementation or check 'step.provider.pkg' property value points to appropriate package.",
							true);
				}
				res = currTestStep.execute();

				// next index can be modified form tracker in before or after
				// step
				executionIndx = stepExecutionTracker.getNextStepIndex();

			}
			return res;
		} catch (Throwable e) {
			throw new StepInvocationException(this, e);
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see com.qmetry.qaf.automation.step.TestStep#getName()
	 */
	@Override
	public String getName() {
		return name;
	}

	@Override
	public String getSignature() {
		return "Custom-Step[" + name + ":" + getFileName() + "#" + getLineNumber() + "] - " + getDescription();
	}

	@SuppressWarnings({ "unchecked" })
	public void processStepParams() {
		// process parameters in step;
		if ((actualArgs != null) && (actualArgs.length > 0)) {
			Map paramMap = getStepExecutionTracker().getContext();
			List paramNames = BDDDefinitionHelper.getArgNames(def);

			System.out.println(paramNames);
			for (int i = 0; i < actualArgs.length; i++) {
				String paramName = paramNames.get(i).trim();
				// remove starting { and ending } from parameter name
				paramName = paramName.substring(1, paramName.length() - 1).split(":", 2)[0];

				// in case of data driven test args[0] should not be overriden
				// with steps args[0]
				if ((actualArgs[i] instanceof String)) {

					String pstr = (String) actualArgs[i];

					if (pstr.startsWith("${") && pstr.endsWith("}")) {
						String pname = pstr.substring(2, pstr.length() - 1);
						actualArgs[i] = paramMap.containsKey(pstr) ? paramMap.get(pstr)
								: paramMap.containsKey(pname) ? paramMap.get(pname)
										: getBundle().containsKey(pstr) ? getBundle().getObject(pstr)
												: getBundle().getObject(pname);
					} else if (pstr.indexOf("$") >= 0) {
						pstr = getBundle().getSubstitutor().replace(pstr);
						actualArgs[i] = StrSubstitutor.replace(pstr, paramMap);
					}
					// continue;
					ParamType ptype = ParamType.getType(pstr);
					if (ptype.equals(ParamType.MAP)) {
						Map kv = new Gson().fromJson(pstr, Map.class);
						paramMap.put(paramName, kv);
						for (String key : kv.keySet()) {
							paramMap.put(paramName + "." + key, kv.get(key));
						}
					} else if (ptype.equals(ParamType.LIST)) {
						List lst = new Gson().fromJson(pstr, List.class);
						paramMap.put(paramName, lst);
						for (int li = 0; li < lst.size(); li++) {
							paramMap.put(paramName + "[" + li + "]", lst.get(li));
						}
					}
				}

				paramMap.put("${args[" + i + "]}", actualArgs[i]);
				paramMap.put("args[" + i + "]", actualArgs[i]);
				paramMap.put(paramName, actualArgs[i]);

			}

			description = StrSubstitutor.replace(description, paramMap);

			for (TestStep step : steps) {
				((StringTestStep) step).initStep();
				if ((step.getActualArgs() != null) && (step.getActualArgs().length > 0)) {
					for (int j = 0; j < step.getActualArgs().length; j++) {

						if (paramMap.containsKey(step.getActualArgs()[j])) {
							step.getActualArgs()[j] = paramMap.get(step.getActualArgs()[j]);
						} else {
							step.getActualArgs()[j] = StrSubstitutor.replace(step.getActualArgs()[j], paramMap);
						}

					}
				} else if (step.getName().indexOf("$") >= 0) {
					// bdd?
					String name = StrSubstitutor.replace(step.getName(), paramMap);

					((BaseTestStep) step).setName(name);
				}
			}
		}
	}

	@Override
	public TestStep clone() {
		ArrayList stepsClone = new ArrayList();
		for (TestStep ts : steps) {
			stepsClone.add(ts.clone());
		}
		CustomStep cloneObj = new CustomStep(name, description, stepsClone);
		cloneObj.setFileName(getFileName());
		cloneObj.setLineNumber(getLineNumber());
		cloneObj.setThreshold(getThreshold());
		cloneObj.setMetaData(getMetaData());
		if (null != actualArgs) {
			cloneObj.actualArgs = actualArgs.clone();
		}
		return cloneObj;
	}

	@Override
	public Collection getSteps() {
		return steps;
	}

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy