Set Up Cucumber with Eclipse

Cucumber is a popular plugin that can be installed within the Eclipse IDE, it is a plugin that is written in Gherkin which is a much more simple coding language with a basic syntax that includes simple grammar. Cucumber is written originally in Ruby language but it can be used for testing various types of programming languages such as Java, Ruby, C# as well as python. so it is important to understand how we can set up cucumber with Eclipse.

Note: It is important to first setup and successfully install the eclipse IDE, if you have not installed the eclipse IDE then read the following article to install it first:

How to Download and Install Eclipse on Windows?

Once the eclipse IDE is ready and running then go to the next step.

Steps to Set Up Cucumber with Eclipse

Following are the steps required for setting up cucumber in the Eclipse software:

Step 1: Create Other File:

The first step is to create a project, for this go to file > new > other.

Step 2: Select Maven Project:

Once the selection wizard appears, select the Maven project because the cucumber is setup in eclipse using the maven.

Step 3: Skip Archetype Selection:

In the next step, make sure to tick the unchecked box which says create a simple project as this will allow us to skip unnecessary options which are not required for this setup.

Step 4: Add Project Details:

Next step is to add the project details, here you will have to enter the group ID and artifact ID, you can either add your own or use the same names as below:

Step 5: Add Dependency Code:

Next step is to add the dependency code for the pom.xml file so that all of the required resources can be downloaded to set up the cucumber with eclipse successfully.

Note: pom.xml file is a built in file so there is no need to create it.

For this to go to src > pom.xml file and add the following code in the file:

http://maven.apache.org/xsd/maven-4.0.0.xsd

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0">
    
    <modelVersion>4.0.0</modelVersion>

    <groupId>CucumberJavaProject</groupId>
    <artifactId>CucumberJavaProject</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>io.cucumber</groupId>
            <artifactId>cucumber-java</artifactId>
            <version>7.12.0</version>
        </dependency>
        <dependency>
            <groupId>io.cucumber</groupId>
            <artifactId>cucumber-junit</artifactId>
            <version>7.12.0</version>
        </dependency>
    </dependencies>
</project>

The code is also represented in the image below:

Step 6: Wait for download to finish:

Once you save the above pom.xml file, it will start downloading the necessary dependencies so wait for the dependencies to be downloaded, the progress of this download will be shown in the bottom (as seen in the image below):

Step 7: Create New Folder:

Once the download for dependencies is complete, we will have to create a new folder to store the feature file for cucumber, for this go to file > new > folder:

Step 8: Add Folder Name:

Once you click on the new folder button, it will simply ask you the name of the folder (do not make any other changes) simply add the name for the folder as "Features" and click on finish button.

Step 9: Create Features File:

Now once the features folder is created, simply right click on the folder from the left folder menu and right select new > file option.

After this simply add the following name for the feature file (make sure to include the file extension as feature)

Then click on the "Finish" option.

Step 10: Install Cucumber Plugin:

Once the feature file is also created, we can begin installing the cucumber plugin. for this go to help > eclipse marketplace and search for the cucumber plugin and click on the install button.

Step 11: Create New Class:

Once the cucumber plugin is installed, we can create a new class to check whether the plugin is installed successfully or not, for this go to file > new > class:

Step 12: Add Class Details:

Next step is to add the details for the java class, include details such as package and name for the java class.

Step 13: Add Code for Testing:

Once the class is created, we will add the following code which includes accessing packages from the cucumber to test whether it is successfully set up or not:

package com.test;

import org.junit.runner.RunWith;
import io.cucumber.junit.CucumberOptions;
import io.cucumber.junit.Cucumber;

@RunWith(Cucumber.class)
@CucumberOptions(
    features = "Features", // folder name
    glue = "stepDefinition" // package name
)
public class TestRunner {
}

Now once the code is written in the class file, simply go to run > run as > JUnit Test.

This will run the test with cucumber in eclipse and it will give the following output:

As we can see that the test output shows that 1 out of 1 test ran successfully, this means that the cucumber is set up with eclipse successfully.

Conclusion

We can set up the cucumber with eclipse with the help of the cucumber plugin which is available in the eclipse marketplace, this will give us access to the cucumber packages using the pom.xml file which we can use to run and execute test easily and we can use the cucumber in order to write the test cases in easy to understand English language and run them using the eclipse IDE.