The Project | About Us | Contribute | Donations | License
HOME My courses Completed
◄ Previous
◄

Creating Your First Cucumber Project

Next ►
►

In this section, we will guide you through the process of setting up and creating your first Cucumber project. This will involve setting up the necessary environment, creating a basic project structure, and writing a simple feature file to get you started with Behavior-Driven Development (BDD) using Cucumber and Gherkin.

Step-by-Step Guide

  1. Setting Up Your Development Environment

Before creating your first Cucumber project, ensure that your development environment is properly set up. This includes:

  • Java Development Kit (JDK): Cucumber requires Java to run. Make sure you have JDK 8 or higher installed.
  • Build Tool: We will use Maven for this tutorial. Ensure Maven is installed and configured on your system.
  • IDE: An Integrated Development Environment like IntelliJ IDEA or Eclipse is recommended for ease of development.

  1. Creating a New Maven Project

  1. Open your IDE and create a new Maven project.

  2. Configure the project:

    • Group ID: com.example
    • Artifact ID: cucumber-project
    • Version: 1.0-SNAPSHOT

  3. Add Cucumber dependencies to your pom.xml file:

<dependencies>
    <!-- Cucumber Java -->
    <dependency>
        <groupId>io.cucumber</groupId>
        <artifactId>cucumber-java</artifactId>
        <version>7.0.0</version>
    </dependency>
    <!-- Cucumber JUnit -->
    <dependency>
        <groupId>io.cucumber</groupId>
        <artifactId>cucumber-junit</artifactId>
        <version>7.0.0</version>
        <scope>test</scope>
    </dependency>
    <!-- JUnit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
    </dependency>
</dependencies>

  1. Creating the Project Structure

Create the following directory structure in your project:

src
└── test
    ├── java
    │   └── com
    │       └── example
    │           └── stepdefinitions
    └── resources
        └── features

  1. Writing Your First Feature File

  1. Create a new file in the src/test/resources/features directory named example.feature.
  2. Write a simple Gherkin scenario in the example.feature file:
Feature: Example feature

  Scenario: Simple addition
    Given I have a calculator
    When I add 2 and 3
    Then the result should be 5

  1. Implementing Step Definitions

  1. Create a new Java class in the src/test/java/com/example/stepdefinitions directory named CalculatorSteps.java.
  2. Implement the step definitions for the feature file:
package com.example.stepdefinitions;

import io.cucumber.java.en.Given;
import io.cucumber.java.en.When;
import io.cucumber.java.en.Then;
import static org.junit.Assert.assertEquals;

public class CalculatorSteps {
    private int result;
    private Calculator calculator;

    @Given("I have a calculator")
    public void i_have_a_calculator() {
        calculator = new Calculator();
    }

    @When("I add {int} and {int}")
    public void i_add_and(int num1, int num2) {
        result = calculator.add(num1, num2);
    }

    @Then("the result should be {int}")
    public void the_result_should_be(int expectedResult) {
        assertEquals(expectedResult, result);
    }
}
  1. Create a simple Calculator class to support the step definitions:
package com.example.stepdefinitions;

public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
}

  1. Running Your Cucumber Tests

  1. Create a test runner class in the src/test/java directory:
package com.example;

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

@RunWith(Cucumber.class)
@CucumberOptions(features = "src/test/resources/features", glue = "com.example.stepdefinitions")
public class RunCucumberTest {
}
  1. Run the test runner class to execute your Cucumber tests. You should see the output indicating that the scenario has passed.

Conclusion

Congratulations! You have successfully created your first Cucumber project. You learned how to set up a Maven project, write a simple Gherkin feature file, implement step definitions, and run your Cucumber tests. This foundational knowledge will be crucial as you progress to more complex scenarios and features in BDD with Cucumber and Gherkin. In the next section, we will delve deeper into understanding feature files and their structure.

◄ Previous
◄
Next ►
►
The Project | About Us | Contribute | Donations | License
© Copyright 2024. All rights reserved