cucumber-micronaut

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Features
  • Build
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

A lightweight library for using dependency injection in cucumber steps for Micronaut based project.

Built With

• Java 11
• Micronaut
• Maven

Getting Started

Features

• Cucumber steps dependency injection using the Micronaut dependency injection mechanism. Only constructor dependency injection is supported

• Bean discovery by type

• Bean discovery by name. See micronaut @Named annotation usage.

• Bean discovery by parameterized type

Build

1. Clone the repo

[email protected]:david-romero/cucumber-micronaut.git

2. Build the library

mvn clean package

Installation

1. Clone the repo

[email protected]:david-romero/shared-payments.git

2. Install the library

mvn clean install

Usage

Dependency

Add the maven dependency

  <dependency>
    <groupId>com.davromalc</groupId>
    <artifactId>cucumber-micronaut</artifactId>
    <version>0.1.0</version>
  </dependency>

Configuration

The Micronaut Object Factory needs to be configured as cucumber object factory.

import com.davromalc.cucumber.micronaut.MicronautObjectFactory;
import io.cucumber.junit.Cucumber;
import io.cucumber.junit.CucumberOptions;
import io.cucumber.junit.CucumberOptions.SnippetType;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class) //Cucumber does not support JUnit 5 yet
@CucumberOptions(
    plugin = {"pretty", "html:target/features"},
    glue = {"com.davromalc.cucumber.micronaut.examples.acceptance"},
    objectFactory = MicronautObjectFactory.class,
    features = "classpath:features", snippets = SnippetType.CAMELCASE)
public class CucumberRunnerITCase {

}

Steps usage

1. Beans definitions

import javax.inject.Singleton;

@Singleton
public class World {
  
}

@Singleton
final class AddFriend implements UseCase<AddFriendParams, User> {

  private final FriendRepository friendRepository;

  public AddFriend(FriendRepository friendRepository) {
    this.friendRepository = friendRepository;
  }

  @Override
  public Either<Validation, User> execute(AddFriendParams params) {
     //Implementation...
  }
}

2. Step implementation

package com.davromalc.cucumber.micronaut.examples.acceptance.steps;

public class AddFriendStep {

  private final UseCase<AddFriendParams, User> addFriend;

  private final FriendRepository friendRepository;

  private final World world;

  public AddFriendStep(@Named("addFriend") UseCase<AddFriendParams, User> addFriend, FriendRepository friendRepository,
      World world) {
    this.addFriend = addFriend;
    this.friendRepository = friendRepository;
    this.world = world;
  }

  @Given("a new friend with name {string}")
  public void aNewFriendWithName(String friendName) {
    world.setFriendParams(new AddFriendParams(friendName));
  }


  @When("the friend is added")
  public void theFriendIsAdded() {
    addFriend.execute(world.getFriendParams());
  }

  @Then("the new friend {string} has been saved")
  public void theNewFriendHasBeenSaved(String newFriendName) {
    final Optional<String> newFriendNameFromDatabase = friendRepository.findByName(newFriendName)
        .map(User::getName)
        .filter(newFriendName::equals)
        .findAny();
    assertThat(newFriendNameFromDatabase)
        .matches(Optional::isPresent)
        .get()
        .asString()
        .isEqualTo(newFriendName);
  }
}

For more examples, please refer to the Examples Repository

Roadmap

See the open issues for a list of proposed features (and known issues).

Proposed features

• Releasing with GitHun Actions

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache License. See LICENSE for more information.

Contact

David Romero - @davromalc

Project Link: https://github.com/david-romero/cucumber-micronaut