SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add support for restdocs in a crude way

Browse Source
This commit is contained in:
Dave Syer
2016-07-25 16:53:45 +01:00
parent 4fbd4daa4f
commit 1a8c1214c4
119 changed files with 2962 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
samples/standalone/restdocs/http-server/src/assembly/stub.xml Normal file
View File

@@ -0,0 +1,33 @@
<assembly
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
<id>stubs</id>
<formats>
<format>jar</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>src/main/java</directory>
<outputDirectory>/</outputDirectory>
<includes>
<include>**/model/Fraud*.*</include>
</includes>
</fileSet>
<fileSet>
<directory>${project.build.directory}/classes</directory>
<outputDirectory>/</outputDirectory>
<includes>
<include>**/model/Fraud*.*</include>
</includes>
</fileSet>
<fileSet>
<directory>${project.build.directory}/snippets/stubs</directory>
<outputDirectory>META-INF/wiremock/mappings/${project.artifactId}</outputDirectory>
<includes>
<include>**/*</include>
</includes>
</fileSet>
</fileSets>
</assembly>

17
samples/standalone/restdocs/http-server/src/main/java/com/example/fraud/Application.java Normal file
View File

@@ -0,0 +1,17 @@
package com.example.fraud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

45
samples/standalone/restdocs/http-server/src/main/java/com/example/fraud/FraudDetectionController.java Normal file
View File

@@ -0,0 +1,45 @@
package com.example.fraud;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.example.fraud.model.FraudCheck;
import com.example.fraud.model.FraudCheckResult;
import com.example.fraud.model.FraudCheckStatus;
import java.math.BigDecimal;
import static org.springframework.web.bind.annotation.RequestMethod.PUT;
@RestController
public class FraudDetectionController {
private static final String FRAUD_SERVICE_JSON_VERSION_1 = "application/vnd.fraud.v1+json";
private static final String NO_REASON = null;
private static final String AMOUNT_TOO_HIGH = "Amount too high";
private static final BigDecimal MAX_AMOUNT = new BigDecimal("5000");
// tag::server_api[]
@RequestMapping(
value = "/fraudcheck",
method = PUT,
consumes = FRAUD_SERVICE_JSON_VERSION_1,
produces = FRAUD_SERVICE_JSON_VERSION_1)
public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) {
// end::server_api[]
// tag::new_impl[]
if (amountGreaterThanThreshold(fraudCheck)) {
return new FraudCheckResult(FraudCheckStatus.FRAUD, AMOUNT_TOO_HIGH);
}
// end::new_impl[]
// tag::initial_impl[]
return new FraudCheckResult(FraudCheckStatus.OK, NO_REASON);
// end::initial_impl[]
}
private boolean amountGreaterThanThreshold(FraudCheck fraudCheck) {
return MAX_AMOUNT.compareTo(fraudCheck.getLoanAmount()) < 0;
}
}

29
samples/standalone/restdocs/http-server/src/main/java/com/example/fraud/model/FraudCheck.java Normal file
View File

@@ -0,0 +1,29 @@
package com.example.fraud.model;
import java.math.BigDecimal;
public class FraudCheck {
private String clientId;
private BigDecimal loanAmount;
public FraudCheck() {
}
public String getClientId() {
return clientId;
}
public void setClientId(String clientId) {
this.clientId = clientId;
}
public BigDecimal getLoanAmount() {
return loanAmount;
}
public void setLoanAmount(BigDecimal loanAmount) {
this.loanAmount = loanAmount;
}
}

32
samples/standalone/restdocs/http-server/src/main/java/com/example/fraud/model/FraudCheckResult.java Normal file
View File

@@ -0,0 +1,32 @@
package com.example.fraud.model;
public class FraudCheckResult {
private FraudCheckStatus fraudCheckStatus;
private String rejectionReason;
public FraudCheckResult() {
}
public FraudCheckResult(FraudCheckStatus fraudCheckStatus, String rejectionReason) {
this.fraudCheckStatus = fraudCheckStatus;
this.rejectionReason = rejectionReason;
}
public FraudCheckStatus getFraudCheckStatus() {
return fraudCheckStatus;
}
public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) {
this.fraudCheckStatus = fraudCheckStatus;
}
public String getRejectionReason() {
return rejectionReason;
}
public void setRejectionReason(String rejectionReason) {
this.rejectionReason = rejectionReason;
}
}

5
samples/standalone/restdocs/http-server/src/main/java/com/example/fraud/model/FraudCheckStatus.java Normal file
View File

@@ -0,0 +1,5 @@
package com.example.fraud.model;
public enum FraudCheckStatus {
OK, FRAUD
}

1
samples/standalone/restdocs/http-server/src/main/resources/application.yml Normal file
View File

@@ -0,0 +1 @@
server.port=8085

75
samples/standalone/restdocs/http-server/src/test/java/com/example/fraud/StubGeneratorTests.java Normal file
View File

@@ -0,0 +1,75 @@
package com.example.fraud;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import java.math.BigDecimal;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.json.AutoConfigureJsonTesters;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.json.JacksonTester;
import org.springframework.cloud.contract.wiremock.WireMockSnippet;
import org.springframework.http.MediaType;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import com.example.fraud.model.FraudCheck;
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@AutoConfigureRestDocs(outputDir = "target/snippets")
@AutoConfigureMockMvc
@AutoConfigureJsonTesters
@DirtiesContext
public class StubGeneratorTests {
@Autowired
private MockMvc mockMvc;
@Autowired
private WireMockSnippet snippet;
private JacksonTester<FraudCheck> json;
@Test
public void shouldMarkClientAsFraud() throws Exception {
FraudCheck fraudCheck = new FraudCheck();
fraudCheck.setClientId("1234567890");
fraudCheck.setLoanAmount(BigDecimal.valueOf(99999.0));
mockMvc.perform(MockMvcRequestBuilders.put("/fraudcheck")
.contentType(MediaType.valueOf("application/vnd.fraud.v1+json"))
.content(json.write(fraudCheck).getJson()))
.andExpect(MockMvcResultMatchers.jsonPath("$.fraudCheckStatus")
.value("FRAUD"))
.andExpect(MockMvcResultMatchers.jsonPath("$.rejectionReason")
.value("Amount too high"))
.andDo(snippet.content().jsonPath("$.clientId").jsonPath("$[?(@.loanAmount > 1000)]")
.contentType(MediaType.valueOf("application/vnd.fraud.v1+json")))
.andDo(document("markClientAsFraud"));
}
@Test
public void shouldMarkClientAsNotFraud() throws Exception {
FraudCheck fraudCheck = new FraudCheck();
fraudCheck.setClientId("1234567890");
fraudCheck.setLoanAmount(BigDecimal.valueOf(1));
mockMvc.perform(MockMvcRequestBuilders.put("/fraudcheck")
.contentType(MediaType.valueOf("application/vnd.fraud.v1+json"))
.content(json.write(fraudCheck).getJson()))
.andExpect(MockMvcResultMatchers.jsonPath("$.fraudCheckStatus")
.value("OK"))
.andExpect(MockMvcResultMatchers.jsonPath("$.rejectionReason")
.doesNotExist())
.andDo(snippet.content().jsonPath("$.clientId").jsonPath("$[?(@.loanAmount <= 1000)]")
.contentType(MediaType.valueOf("application/vnd.fraud.v1+json")))
.andDo(document("markClientAsNotFraud"));
}
}

31
samples/standalone/restdocs/http-server/src/test/resources/contracts/shouldMarkClientAsFraud.groovy Normal file
View File

@@ -0,0 +1,31 @@
package contracts
org.springframework.cloud.contract.spec.Contract.make {
request {
method 'PUT'
url '/fraudcheck'
body("""
{
"clientId":"${value(consumer(regex('[0-9]{10}')))}",
"loanAmount":99999}
"""
)
headers {
header('Content-Type', 'application/vnd.fraud.v1+json')
}
}
response {
status 200
body( """{
"fraudCheckStatus": "FRAUD",
"rejectionReason": "Amount too high"
}""")
headers {
header('Content-Type': value(
producer(regex('application/vnd.fraud.v1.json.*')),
consumer('application/vnd.fraud.v1+json'))
)
}
}
}

33
samples/standalone/restdocs/http-server/src/test/resources/contracts/shouldMarkClientAsNotFraud.groovy Normal file
View File

@@ -0,0 +1,33 @@
package contracts
org.springframework.cloud.contract.spec.Contract.make {
request {
method 'PUT'
url '/fraudcheck'
body("""
{
"clientId":"${value(consumer(regex('[0-9]{10}')), producer('1234567890'))}",
"loanAmount":123.123
}
"""
)
headers {
header('Content-Type', 'application/vnd.fraud.v1+json')
}
}
response {
status 200
body(
fraudCheckStatus: "OK",
rejectionReason: $(consumer(null), producer(execute('assertThatRejectionReasonIsNull($it)')))
)
headers {
header('Content-Type': value(
producer(regex('application/vnd.fraud.v1.json.*')),
consumer('application/vnd.fraud.v1+json'))
)
}
}
}