Behavior driven integration with Cucumber & Citrus

@cucumberbdd#Devoxx @citrus_test
Behavior Driven
Integration
with Cucumber and Citrus
Christoph Deppisch
ConSol Software GmbH

https://cucumber.io
https://citrusframework.org

Behavior Driven
Development

Communication

=
DOMAIN EXPERTS DEVELOPMENT

Explaining the
behavior

Concrete
Examples

Gherkin
Given a certain context
When some event happens
Then an outcome should occur

Demo application

Feature: Create voting 
 
As a user I want to create new votings. Each voting is given default vote  
options. 
 
Scenario: Default voting options 
Given voting title "Do you like Devoxx?" 
When I create new voting 
Then voting should have 2 options 
And voting should have option "yes" 
And voting should have option "no"
And voting title should be "Do you like Devoxx?“
Feature specification

Feature: Create voting 
 
As a user I want to create new votings. Each voting is given default vote  
options. The user should be able to set custom vote options. 
 
Scenario: Default voting options 
Given voting title "Do you like Devoxx?" 
When I create new voting 
Then voting should have 2 options 
And voting should have option "yes" 
And voting should have option "no"
And voting title should be "Do you like Devoxx?" 
 
Scenario: Custom voting options 
When I create new voting "What type of Devoxx ticket do you have?" 
And voting options are "University:Conference:Combi" 
Then voting title should be "What type of Devoxx ticket do you have?" 
And voting should have options 
| University | 
| Conference | 
| Combi |
Feature specification

@RunWith(Cucumber.class) 
public class VotingFeatureTest { 
}
JUnit Cucumber test
voting-close.feature
voting-create.feature
voting-results.feature
public class VotingSteps {
@Given("^New default voting$")
public void defaultVoting() { ... }
@When("^I create new voting "(.+)"$")
public void createVotingWithTitle(String title) { ... }
@Then("^voting should have (d+) options$")
public void votingShouldHaveOptions(int optionCount) { ... }  
}

@When("^I create new voting "(.+)"$") 
public void createVotingWithTitle(String title) { 
votingId = UUID.randomUUID(); 
Voting voting = new Voting(votingId, title); 
votingService.add(voting); 
}
Step definitions
@Then("^voting should have (d+) options$") 
public void votingShouldHaveOptions(int optionCount) { 
Assert.assertEquals(optionCount, 
votingService.get(votingId).getOptions().size()); 
}
When I create new voting "What type of Devoxx ticket do you have?“
Then voting should have 3 options

@Then("^(?:the )?voting should have options$") 
public void votingShouldHaveOptions(DataTable dataTable) { 
List<String> options = dataTable.asList(String.class); 
 
votingShouldHaveOptions(options.size()); 
 
for(String option : options) { 
votingShouldHaveOption(option); 
} 
}
Data tables
Then voting should have options 
| University | 
| Conference | 
| Combi |

Demo

Feature: Show voting results 
 
As a user I want to vote for an option. All voting results are stored 
and the user should be able to get top vote option for each voting. 
 
Background: 
Given I create new voting "Do you like Devoxx?" 
And voting options are "yes:no" 
 
Scenario: Initial vote results 
Then votes of option "yes" should be 0 
And votes of option "no" should be 0 
 
Scenario: Get vote results 
When I vote for "yes" 
Then votes of option "yes" should be 1 
And votes of option "no" should be 0 
And top vote should be "yes"
Background

Feature: Show voting results 
 
As a user I want to vote for an option. All voting results are stored 
and the user should be able to get top vote option for each voting. 
 
Scenario Outline: Get vote results
Given I create new voting "<title>" 
When I vote for "yes" <yes_votes> times
And I vote for "no" <no_votes> times 
Then votes of option "yes" should be <yes_votes> 
And votes of option "no" should be <no_votes> 
And top vote should be "<top_vote>"
Examples: 
| title | yes_votes | no_votes | top_vote | 
| Did you enjoy the salad? | 12 | 5 | yes | 
| Did you enjoy the crab sandwich? | 1 | 25 | no |
Scenario Outline

Messaging
Integration

Client VotingApp
Http REST
JMS
Reporting
MailServer
JMS
SMTP

VotingApp
Http REST
JMS
JMS
SMTP

cucumber.api.java.ObjectFactory=cucumber.runtime.java.CitrusObjectFactory
Citrus & Cucumber
@RunWith(Cucumber.class) 
public class VotingRestFeatureIT { 
}
cucumber.properties

Feature: Voting Http REST API 
 
Background: 
Given Voting list is empty 
And New voting "Do you like Belgian beer?" 
 
Scenario: Top vote 
When client creates the voting 
And client votes for "no" 
Then votes should be 
| yes | 0 | 
| no | 1 | 
And top vote should be "no" 
 
Scenario: Close voting 
Given reporting is enabled 
When client creates the voting 
And client votes for "yes" 3 times 
And client votes for "no" 2 times 
And client closes the voting 
Then participants should receive reporting mail 
""" 
Dear participants, 
 
the voting '${title}' came to an end. 
 
The top answer is 'yes'! 
 
Have a nice day! 
Your Voting-App Team 
"""
Messaging feature

public class VotingRestSteps { 
 
@CitrusEndpoint 
private HttpClient votingClient;
@CitrusEndpoint 
private MailServer mailServer;
 
@CitrusResource 
private TestRunner runner; 
 
@Given("^Voting list is empty$") 
public void clear() { 
runner.http(action -> action.client(votingClient) 
.send() 
.delete("/voting")); 
 
runner.http(action -> action.client(votingClient) 
.receive() 
.response(HttpStatus.OK)); 
}
}
Endpoint Injection

@Configuration 
public class CitrusEndpointConfig { 
 
@Bean 
public HttpClient votingClient() { 
return CitrusEndpoints.http() 
.client() 
.requestUrl("http://localhost:8080/rest/services") 
.build(); 
} 
 
@Bean 
public MailServer mailServer() { 
return CitrusEndpoints.mail() 
.server() 
.port(2222) 
.autoStart(true) 
.autoAccept(true) 
.build(); 
} 
}
Endpoint Configuration

Citrus endpoints
Component Description
citrus-http Http REST client and server
citrus-jms JMS queue or topic destination
citrus-ws SOAP client and server
citrus-mail SMTP mail client and server
citrus-docker Docker container management
citrus-camel Apache Camel endpoint
citrus-selenium Selenium browser endpoint
citrus-vertx Vert.x endpoint
citrus-kubernetes Kubernetes client
…

@Then("^participants should receive reporting mail$") 
public void shouldReceiveReportingMail(String mailBody) {
 
runner.receive(action -> action.endpoint(mailServer) 
.message(MailMessage.request() 
.from("voting@example.org") 
.to("participants@example.org") 
.subject("Voting results") 
.body(mailBody, "text/plain; charset=us-ascii")));
runner.send(action -> action.endpoint(mailServer) 
.message(MailMessage.response(250, „OK"));
 
}
Mail SMTP messaging

@Bean 
public JmsEndpoint reportingEndpoint() { 
return CitrusEndpoints.jms() 
.asynchronous() 
.connectionFactory(connectionFactory()) 
.destination("jms.voting.report") 
.build(); 
}
JMS messaging
@CitrusEndpoint(name = "reportingEndpoint") 
private JmsEndpoint reportingEndpoint;
@Then("^reporting should receive vote results$") 
public void shouldReceiveReport(DataTable dataTable) { 
runner.createVariable("results", buildOptionsAsJsonArray(dataTable)); 
 
runner.receive(action -> action.endpoint(reportingEndpoint) 
.messageType(MessageType.JSON) 
.payload("{"id":"${id}","title":"${title}","options":${results}}")); 
}

Reading & information
https://cucumber.io
https://citrusframework.org
Demo Sources
https://github.com/christophd/citrus-demo-devoxx-be
Citrus Cucumber Extension
https://citrusframework.org/reference/html/#cucumber

ThankYou!

Behavior driven integration with Cucumber & Citrus

Recommended

Recommended

More Related Content

Similar to Behavior driven integration with Cucumber & Citrus

Similar to Behavior driven integration with Cucumber & Citrus (20)

Recently uploaded

Recently uploaded (20)

Behavior driven integration with Cucumber & Citrus