Closed
Description
As far as documentation goes, the fact that jackson json library is used and DataTableType can have multiple return types, it's not that obvious why DocStringType has only 1 return type for all feature files/project?
Given the following example:
Scenario: Test whether DocStringType allows conversion of 2 different types of records
Given I have the following cars
"""json
[
{
"name": "Murcielago",
"brand": "Lamborghini"
},
{
"name": "Sandero",
"brand": "Dacia"
}
]
"""
And one animal I like
"""json
{
"name": "Lion",
"domesticated": false
}
"""public class DemoStepDef {
@DocStringType(contentType = "json")
public List<Car> convertCars(String json) throws JsonProcessingException {
return new ObjectMapper().readValue(json,
new TypeReference<List<Car>>() {});
}
@DocStringType(contentType = "json")
public Animal convertAnimal(String json) throws JsonProcessingException {
return new ObjectMapper().readValue(json,
new TypeReference<Animal>() {});
}
@Given("I have the following cars")
public void i_have_cars(List<Car> cars) {
System.out.println(cars);
}
@And("one animal I like")
public void one_animal_I_like(Animal animal) {
System.out.println(animal);
}
}
public class Animal {
private String name;
private boolean domesticated;
// setters and getters omitted
}
public class Car {
private String name;
private String brand;
// setters and getters omitted
}Gives the following error:
**Caused by: io.cucumber.docstring.CucumberDocStringException: There is already docstring type registered for 'json' and com.lumeon.cpm.models.records.Animal.**
My feeling is that if jackson library is allowed for DocStringType annotation, then we should be able to leverage the full potential of it, and not be forced to have JsonNode as the only option. Having extra intermediary methods to convert to the actual types needed for the step definitions.
Work-around at the moment:
public class DemoThatWorksStepDef {
@DocStringType(contentType = "json")
public JsonNode json(String json) throws JsonProcessingException {
return new ObjectMapper().readTree(json);
}
public List<Car> convertCars(JsonNode jsonNode) throws IOException {
return new ObjectMapper().readValue(jsonNode.traverse(),
new TypeReference<List<Car>>() {});
}
public Animal convertAnimal(JsonNode jsonNode) throws IOException {
return new ObjectMapper().readValue(jsonNode.traverse(),
new TypeReference<Animal>() {});
}
@Given("I have the following cars")
public void i_have_cars(JsonNode jsonNode) throws IOException {
System.out.println(convertCars(jsonNode));
}
@And("one animal I like")
public void one_animal_I_like(JsonNode jsonNode) throws IOException {
System.out.println(convertAnimal(jsonNode));
}
}