Cucumber Installation

In previous post we have just seen introduction about Cucumber, now we will see in details how to do setup.

 Pre-requisite. 
Install JDK
Install and configure Maven
Install and configure Eclipse (with plugins)
Set up selenium web driver component

Agenda

Here we will write our first cucumber script and run through runner class .



  1. Download Cucumber Jars from Maven dependencies
  2. cucumber-jvm and other dependent jars
  3. Project structure
  4. Cucumber first feature
  5. Write step definitions (automation code)
  6.  Runner class
  7. Results

  1. Download Cucumber Jars from Maven dependencies

This is the easiest way to configure the other way is to download all one by one jar from maven repository. 

 There are few prerequisites for setting up cucumber in eclipse.
  1. Install Maven in Eclipse IDE
  2. Create a New Maven Project in Eclipse

Once Maven is installed on eclipse and a Maven project is created, the next step is to add cucumber dependencies on the project. SO  we need to add dependencies in POM.xml file to point all the jars like 
  1.  cucumber-core
  2. cucumber-java
  3. cucumber-junit
  4. cucumber-jvm-deps
  5. cucumber-reporting
  6. gherkin
  7. junit

Please update the pom.xml as shown below. and also make sure that to paste from properties tag. 
<properties>
<cucumber-jvm.version>1.2.2</cucumber-jvm.version>
<selenium.version>2.52.0</selenium.version>
<junit.version>4.11</junit.version>
<cucumber.reporting.version>0.0.23</cucumber.reporting.version>
<maven.cucumber.reporting.version>0.0.6</maven.cucumber.reporting.version>
</properties>
<build>
<testResources>
<testResource>
<directory>src/test/resources</directory>
<includes>
<include>log4j.properties</include>
</includes>
</testResource>
</testResources>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.2.2</version>
<executions>
<execution>
<phase>integration-test</phase>
<goals>
<goal>java</goal>
</goals>
</execution>
</executions>
<configuration>
<executableDependency>
<groupId>info.cukes</groupId>
<artifactId>cucumber-core</artifactId>
</executableDependency>
<mainClass>cucumber.api.cli.Main</mainClass>
<arguments>
<argument>--format</argument>
<argument>junit:target/cucumber-junit-report/allcukes.xml</argument>
<argument>--format</argument>
<argument>pretty</argument>
<argument>--format</argument>
<argument>html:target/cucumber-html-report</argument>
<argument>--tags</argument>
<argument>@smoketest</argument>
<argument>--glue</argument>
<argument>com/</argument>
<argument>src/</argument>
</arguments>
</configuration>
<dependencies>
<dependency>
<groupId>info.cukes</groupId>
<artifactId>cucumber-core</artifactId>
<version>1.2.2</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>net.masterthought</groupId>
<artifactId>maven-cucumber-reporting</artifactId>
<version>${maven.cucumber.reporting.version}</version>
<executions>
<execution>
<id>execution</id>
<phase>verify</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<projectname>TestProject</projectname>
<outputdirectory>${project.build.directory}/cucumber-html-reports</outputdirectory>
<cucumberoutput>${project.build.directory}/target/cucumber.json</cucumberoutput>
<enableflashcharts></enableflashcharts>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>info.cukes</groupId>
<artifactId>cucumber-picocontainer</artifactId>
<version>${cucumber-jvm.version}</version>
</dependency>
<dependency>
<groupId>info.cukes</groupId>
<artifactId>cucumber-junit</artifactId>
<version>${cucumber-jvm.version}</version>
</dependency>
<dependency>
<groupId>org.seleniumhq.selenium</groupId>
<artifactId>selenium-java</artifactId>
<version>${selenium.version}</version>
</dependency>
<dependency>
<groupId>org.seleniumhq.selenium</groupId>
<artifactId>selenium-support</artifactId>
<version>${selenium.version}</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
</dependency>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>6.9.10</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.14</version>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>net.masterthought</groupId>
<artifactId>maven-cucumber-reporting</artifactId>
<version>${maven.cucumber.reporting.version}</version>
</dependency>
<dependency>
<groupId>net.masterthought</groupId>
<artifactId>cucumber-reporting</artifactId>
<version>${cucumber.reporting.version}</version>
</dependency>
<dependency>
<groupId>net.masterthought</groupId>
<artifactId>cucumber-sandwich</artifactId>
<version>0.0.2</version>
</dependency>
</dependencies>
view raw cucumberinstalpom.xml hosted with ❤ by GitHub



3. TO understand project structure 

  • src/main/java: This will ideally contain source code
  • src/test/java: This will contain all java code that runs automation
  • src/test/resources: This will contain our feature files
  • features: This folder contains all the feature files

4 . To create first cucumber feature file 

 under src/test/resource folder create feature file. 
if folder not exists please create a source folder like this



and in the popup name the folder as -> src/test/resources 


Create a feature file as sample.feature under this folder as show in below snapshot from project right click and navigate to File in popup below show enter the file name. 

Then copy paste this feature file snippet. 
@smokeTest
Feature: To test my cucumber test is running
I want to run a sample feature file.
Scenario: cucumber setup
Given sample feature file is ready
When I run the feature file
Then run should be successful
view raw featurefile.txt hosted with ❤ by GitHub




5. Create Step definition for the corresponding feature file
right click on the src/test/java and create a new class as stepDefinition with below content 
package MavenTest.DemoMavenCucumber;
import cucumber.api.java.en.Given;
import cucumber.api.java.en.Then;
import cucumber.api.java.en.When;
public class stepDefinition {
@Given("^sample feature file is ready$")
public void givenStatment(){
System.out.println("Given statement executed successfully");
}
@When("^I run the feature file$")
public void whenStatement(){
System.out.println("When statement execueted successfully");
}
@When("^I run2 the feature file$")
public void whenStatement2(){
System.out.println("When statement execueted successfully");
}
@Then("^run should be successful$")
public void thenStatment(){
System.out.println("Then statement executed successfully");
}
}
view raw 1.stepdefinition.java hosted with ❤ by GitHub
6. Under the same folder structure we need to create runner class to run the cucumber scripts.
package MavenTest.DemoMavenCucumber;
import org.junit.runner.RunWith;
import cucumber.api.CucumberOptions;
import cucumber.api.junit.Cucumber;
@RunWith(Cucumber.class)
@CucumberOptions(
features = "yourprojectpath/src/test/resources",
plugin = {"pretty", "html:target/cucumber-html-report"},
tags = {}
)
public class RunCukesTest {
}
view raw 2.Runner.java hosted with ❤ by GitHub



7. Right click on class RunCukesTest and run as Junit Test







7. Go to target -> cucumber-html-report and the report should look like this.





That;s it, you are done with the basic cucumber setup till report.

 Thanks
Subscribe to: Posts (Atom)