com.github.becausetesting.cucumber.BecauseCucumberHook Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons Show documentation
A common libraries used for testing framework.
There is a newer version: 1.1.3
package com.github.becausetesting.cucumber;

import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;

import org.apache.log4j.Logger;
import org.openqa.selenium.WebDriver;

import com.github.becausetesting.reflections.RefelectionUtils;

import gherkin.formatter.Formatter;
import gherkin.formatter.Reporter;
import gherkin.formatter.model.Feature;
import gherkin.formatter.model.Scenario;
/*
 * 
 * this interface is used for user to do some customization behavors in cucumber running
 * 
 * you can use these variables:
 *  public static AtomicInteger failedStepsCount;
	public static AtomicInteger skippedStepsCount;
	public static AtomicInteger undefinedStepsCount;
	public static AtomicInteger passStepsCount;

	public static AtomicInteger failedScenariosCount;
	public static AtomicInteger skippedScenariosCount;
	public static AtomicInteger undefinedScenariosCount;
	public static AtomicInteger passScenariosCount;

	private static String cucumberErrorMessage = "";
	
 */
/**
 * ClassName: BecauseCucumberHook  
 * Function: TODO ADD FUNCTION.  
 * Reason: TODO ADD REASON 
 * date: Apr 23, 2016 6:11:20 PM  
 * @author [email protected]
 * @version 1.0.0
 * @since JDK 1.8
 */
public interface BecauseCucumberHook {

	public static Logger logger=Logger.getLogger(BecauseCucumberHook.class);
	
	/**
	 * beforeRun: like create test plan 
	 * @author [email protected]
	 * @since JDK 1.8
	 */
	public void beforeRun(); 
	/**
	 * afterRun: like close test plan 
	 * @author [email protected]
	 * @since JDK 1.8
	 */
	public void afterRun(); 
	
	
	/**
	 * beforeEachScenario:before start the cucumber scenario
	 * @author [email protected]
	 * @param scenario the parameter for cucumber scenario.
	 * @since JDK 1.8
	 */
	public void beforeEachScenario(Scenario scenario);  //start the selenium 
	/**
	 * afterEachScenario: after finished the cucumber scenario
	 * @author [email protected]
	 * @param scenario the parameter for cucumber scenario.
	 * @since JDK 1.8
	 */
	public void afterEachScenario(Scenario scenario); // upload the result into test tool
	
	
	/**
	 * beforeEachFeature: before each cucumber feature is running
	 * @author [email protected]
	 * @param feature the feature for cucumber feature.
	 * @since JDK 1.8
	 */
	public void beforeEachFeature(Feature feature); // upload the tese cases into test run
	
	/**
	 * setCucumberReportFormatters use to set different format
	 * e.g :
	 *  html:target/cucumber/cucumber-html-report
	 *  json:target/cucumber/cucumber-json-report/cucumber.json
	 *  junit:target/cucumber/cucumber-junit-report/cucumber.xml
	 *  testng:target/cucumber/cucumber-testng-report/cucumber.xml
	 *  rerun:target/cucumber/cucumber-failed-report/failed,rerun.txt
	 *  pretty
	 * 
	 * @author [email protected]
	 * @return
	 * @since JDK 1.8
	 */
	public List setCucumberReportFormatters();
	
	/**
	 * setCucumberStepDefinitionPaths to use to set cucumber step definition path:
	 * we had set these paths as default path to search the step definition,
	 * 1. classpath:
	 * 2. com.github.becausetesting.cucumber.selenium
	 * so actually you no need to set the step definition path here ,just leave it as empty.
	 * @author [email protected]
	 * @return
	 * @since JDK 1.8
	 * @deprecated
	 */
	public List setCucumberStepDefinitionPaths();
	/**
	 * setCucumberPropertyFilePath: set the path
	 * @author [email protected]
	 * @return set the cucumber files
	 * @since JDK 1.8
	 */
	public List setCucumberFeatureFilePaths(); // set the feature file path	
	
	/**
	 * @return the cucumber tags you specified.
	 */
	public List setCucumberTags();

	/**
	 * setSeleniumDriver: if user selenium driver or not
	 * @author [email protected]
	 * @return the selenium driver {@link WebDriver}
	 * @since JDK 1.8
	 */
	public WebDriver setSeleniumDriver(); // if needs to use the selenium integration for testing
	
}