CODEWITHSUNDEEP
selenium-webdriverenumscucumbercucumber-jvmcucumber-java
Devang
Devang

Reputation: 385

Is it possible to pass Java-Enum as argument from cucumber feature file

I am currently using selenium with Java,And want to implement cucumber to make test script more readable. Currently facing issue while passing argument to java method where Enum is expected as parameter. I would also like to know if there are any other known limitations of cucumber-java before migrating current framework.

Upvotes: 11

Views: 24193

Answers (5)

times29
times29

Reputation: 3373

Example:

package com.example;

import io.cucumber.java.ParameterType;
import io.cucumber.java.en.Given;

public class StepDefinitions {

    @ParameterType("FOO|BAR")
    public Book book(String bookName) {
        return Book.valueOf(bookName);
    }   

    @Given("{book} is my favorite book")
    public void this_is_my_favorite_book(Book book) {
        // step implementation
    }
}

Make sure the name of the method annotated with @ParameterType matches the name of your placeholder in the step (book).

Upvotes: 0

AmanicA
AmanicA

Reputation: 5495

First register a transformer based on an ObjectMapper, then you can just use enums as would be expected.

private final ObjectMapper objectMapper = new ObjectMapper().registerModule(new JavaTimeModule());

@DefaultParameterTransformer
@DefaultDataTableEntryTransformer
@DefaultDataTableCellTransformer
public Object defaultTransformer(Object fromValue, Type toValueType) {
    JavaType javaType = objectMapper.constructType(toValueType);
    return objectMapper.convertValue(fromValue, javaType);
}

Scenario: No.6 Parameter scenario enum
    Given the professor level is ASSOCIATE


@Given("the professor level is {}")
public void theProfessorLevelIs(ProfLevels level) {
    System.out.println(level);
    System.out.println("");
}

public enum ProfLevels {
    ASSISTANT, ASSOCIATE, PROFESSOR
}

Source

Upvotes: 4

Brian Hong
Brian Hong

Reputation: 1084

This youtube lecture of about 11 minutes gives a good way of doing it. https://www.youtube.com/watch?v=_N_ca6lStrU

For example,

// enum, obviously in a separate file,
public enum MessageBarButtonType {
    Speak, Clear, Delete, Share
}

// method for parameter type. if you want to use a different method name, you could do @ParameterType(name="newMethodName", value="Speak|Clear|Delete|Share") according to the video.
@ParameterType("Speak|Clear|Delete|Share")
public MessageBarButtonType MessageBarButtonType(String buttonType) {
  return MessageBarButtonType.valueOf(buttonType);
}

// use like this. the name inside {} should match the name of method, though I just used the type name.
@Then("Select message bar {MessageBarButtonType} button")
public void select_message_bar_button(MessageBarButtonType buttonType) {
  ...
}

Upvotes: 7

Hemantkumar Chigadani
Hemantkumar Chigadani

Reputation: 1

This is no more supported in latest io.cucumber maven group https://github.com/cucumber/cucumber-jvm/issues/1393

Upvotes: -1

N..
N..

Reputation: 956

The answer is: Yes

You can use all kind of different types in your scenario: primitive types, own classes (POJOs), enums, ...

Scenario :

Feature: Setup Enum and Print value
      In order to manage my Enum
      As a System Admin
      I want to get the Enum

      Scenario: Verify Enum Print
      When I supply enum value "GET"

Step definition code :

import cucumber.api.java.en.When;

public class EnumTest {

    @When("^I supply enum value \"([^\"]*)\"$")
    public void i_supply_enum_value(TestEnum arg1) throws Throwable {
        testMyEnum(arg1);
    }

    public enum TestEnum {
        GET,
        POST,
        PATCH
    }

    protected void testMyEnum(TestEnum testEnumValue) {

        switch (testEnumValue) {
            case GET:
                System.out.println("Enum Value GET");
                break;
            case POST:
                System.out.println("Enum Value POST");
                break;
            default:
                System.out.println("Enum Value PATCH");
                break;
        }

    }

}

Let me know how you are doing. I could try to help you.

Upvotes: 8

Related Questions