Make Selenium Easy

Cucumber Tutorial 2 – Setup a Basic Maven-Cucumber 5 -TestNG Project in Eclipse

*****Updated with latest version of Cucumber 5 *********

Cucumber 6 is on the way but many are still using Cucumber 1 ( info.cukes version). So in this post, I am going to explain An end to end basic Cucumber 5 maven project setup with Junit in Eclipse.

Step 1:- Setup Eclipse

Eclipse is an integrated development environment which can be used to develop Java programs. I am not going to explain installation of Eclipse in this post. It is very straight forward and little google can help you much better. If you have any difficulty in installation , feel free to contact me though mail.

We need two plugins for Eclipse in order to work with Cucumber projects:-

  1. Natural
  2. Cucumber Eclipse Plugin

Natural plugin is helpful in editing and maintaining BDD/ATDD files. The currently supported languages are Cucumber (Gherkin syntax) and JBehave.

Cucumber Eclipse Plugin is helpful as content assistance for feature file , syntax highlighting, pretty formatting and step definition wizard.

To install above plugins, go to Eclipse Marketplace (Help -> Eclipse Marketplace) . Now search both plugins one by one and click “Install” button. Plugin installation requires restart of Eclipse. I will suggest you to install both plugins one by one and restart eclipse.

Step 2 :- Create a Maven project and add required dependencies

You just need two dependencies for Cucumber-TestNG project”:-

  1. Cucumber-Java
  2. Cucumber-TestNG

Note:- Keep version of Cucumber-Java and Cucumber-TestNG same.

I believe creating a maven project in Eclipse will not be tough job for you. If you face any problem, refer this post.

Add above dependencies ( For this post, I am using Cucumber 4) in your pom.xml. Your pom.xml should look like as below:-

You could see an extra <properties> tag in above example. That is to set Java version as 1.8 for this project. By default you see 1.5 Java version when you create a new maven project.

Step 3:- Create a feature file

Now create a simple feature file “src/test/resources“. A feature file has a file extension as “.feature“. This feature file contains acceptance scenarios in Gherkin language.

I have created a very simple feature file as below:-

Step 4:- Generate Step definition

Right click on above feature file and Select “Run As – > Cucumber Feature”. It will generate step definitions of above steps. You will get output in console as below:-

You see a line in above output as “You can implement missing steps with the snippets below:“. Copy everything after that line and paste in to Java class. Create a package say “stepDefintions” under “src/test/java” and create a Java class say ““. Paste generated step definition in this class.

Since we need to provide our own definition to step, I added a normal print statement in each step definition methods as below:-

Step 5:- Run Feature file

Now you are all set to run your test. Remember you need to run feature file not step definition file. You don’t need runner file as well. In fact, you don’t even require Junit or TestNG as of now. Just right click on feature file and select “Run As – > Cucumber Feature“. You will see output as below:-

Step 6:- Run Feature file using Runner class

Runner class is useful to run multiple feature files and you can do a lot of configurations. We will see those in upcoming post. As of now we are covering only a basic setup.

Create a package named say “runnerFiles” under “src/test/java“. Create a runner java class now as ““. You must create runner class name ending with word “Test” so that it can picked automatically while running through maven.

Content of Runner file will be as below:

Like JUnit, There is no @RunWith Annotation. We just need to extend AbstractTestNGCucumberTests to our runner class. AbstractTestNGCucumberTests class Runs each cucumber scenario found in the features as separated test. In @CucumberOptions annotation, feature attribute is used to pass path of feature file and glue attribute is to give path of step definitions. There are many if and but with this but stick to it as of now.

Now run above runner file as “Run As – > TestNG Test“. You should output as below:-

Note- You must install TestNG plugin in eclipse to run as a TestNG test.

Step 7:- Run Feature file using maven commands

Right click on Project or pom.xml and select Run As -> Maven test. It will pick Runner class ending with “Test” and execute feature file during test phase of maven life cycle. You will see output contains:-

You can clone sample project from here.

If you have any doubt, feel free to comment below.
If you like my posts, please like, comment, share and subscribe.

You can find all Selenium related post here.
You can find all API manual and automation related posts here.
You can find frequently asked Java Programs here.

Author: Amod Mahajan

A software Tester who is paid to judge products developed by others. Currently getting paid in American Dollars. Writing technical posts and creating YouTube videos are my hobbies.

2 thoughts on “Cucumber Tutorial 2 – Setup a Basic Maven-Cucumber 5 -TestNG Project in Eclipse

  1. Woww!!! after searching soo many sites, i found this with very clear explanation and updated code.
    Thank you sooo much

Leave a Reply

Please wait...

Subscribe to new posts to become automation expert

Want to be notified when my new post is published? Get my posts in your inbox.

Cucumber Tutorial 2 – Setup a Basic Maven-Cucumber 5 -TestNG Project in Eclipse

by Amod Mahajan time to read: 6 min
%d bloggers like this: