JarCastingRAML Mock Server
Description
This tool is designed to allow validation of RAML API specifications against your own descriptors in a MockServer setup.
Utilising both the MockServer toolset and the RAML Java Parser, it provides abilities to define RAML specifications that you can ensure that MockServer Expectations that are hit actually meet the API specifications specified by the remote service.
Supported RAML Versions
Currently, this library supports RAML 0.8 only.
Dependency
<dependency>
<groupId>net.ozwolf</groupId>
<artifactId>raml-mock-server</artifactId>
<version>${current.version}</version>
</dependency>
Content Validation
This library currently validates specified request and response content if the Content-Type header is compatible with application/json and if the RAML specification has an appropriate schema defined for the content.
This validation is provided by the JSON Schema Validator tool.
Methods To Check
By default, the obeyedBy check will only check interactions on GET, POST, PUT and DELETE methods. If you want to include other interactions such as HEAD, OPTIONS, etc., then simply include those in the obeyedBy call.
For example, .obeyedBy(client, "HEAD", "OPTIONS")
Examples
JUnit Class Rule
public class MyJunitTest {
@Rule
public final MockServerRule server = new MockServerRule(5000);
@ClassRule
public final static RamlSpecificationsRule SPECIFICATIONS = new RamlSpecificationsRule()
.withSpecifications(
new ClassPathSpecification("my-local-service", "apispecs/apispecs.yml"),
new RemoteSpecification("my-remote-service", "http://remote.site.com/apispecs.zip", ZipArchiveHandler.handler("target/specifications/my-remote-service", "apispecs.raml"))
);
@Test
public void shouldInteractWithRemoteServiceCorrectly() {
MockServiceClient client = new MockServiceClient("localhost", 5000);
client.when(
request()
.withPath("/hello/world")
.withMethod("GET")
.withHeaders(
new Header(HttpHeaders.ACCEPT, "text/plain")
)
).respond(
response()
.withStatusCode(200)
.withHeaders(
new Header(HttpHeaders.CONTENT_TYPE, "text/plain")
)
.withBody("Hello World!")
)
Client testClient = Client.create(new DefaultClientConfig());
ClientResponse response = testClient.resource("http://localhost:5000/hello/world")
.header(HttpHeaders.ACCEPT, "text/plain")
.get(ClientResponse.class);
try {
assertThat(response.getHeaders().getFirst(HttpHeaders.CONTENT_TYPE), is("text/plain"));
assertThat(response.getEntity(String.class), is("Hello World!"));
} finally {
response.close();
}
RamlSpecification.Result result = SPECIFICATIONS.get("my-remote-service").obeyedBy(client);
assertTrue(result.getFormattedErrorMessage(), result.isValid());
}
}
Direct Specification Usage
public class MyDirectSpecificationUsage {
@Rule
public final MockServerRule server = new MockServerRule(5000);
private final static RamlSpecification MY_LOCAL_SERVICE = new ClassPathSpecification("my-local-service", "apispecs/apispecs.yml");
@BeforeClass
public static void setUpClass(){
MY_LOCAL_SERVICE.initialize();
}
@Test
public void shouldInteractWithRemoteServiceCorrectly() {
MockServiceClient client = new MockServiceClient("localhost", 5000);
client.when(
request()
.withPath("/hello/world")
.withMethod("GET")
.withHeaders(
new Header(HttpHeaders.ACCEPT, "text/plain")
)
).respond(
response()
.withStatusCode(200)
.withHeaders(
new Header(HttpHeaders.CONTENT_TYPE, "text/plain")
)
.withBody("Hello World!")
)
Client testClient = Client.create(new DefaultClientConfig());
ClientResponse response = testClient.resource("http://localhost:5000/hello/world")
.header(HttpHeaders.ACCEPT, "text/plain")
.get(ClientResponse.class);
try {
assertThat(response.getHeaders().getFirst(HttpHeaders.CONTENT_TYPE), is("text/plain"));
assertThat(response.getEntity(String.class), is("Hello World!"));
} finally {
response.close();
}
RamlSpecification.Result result = MY_LOCAL_SERVICE.obeyedBy(client);
assertTrue(result.getFormattedErrorMessage(), result.isValid());
}
}
Specification Result Output
The RamlSpecification.Result.getFormattedErrorMessage() output is designed to be human-readable in a JUnit output. It's output will look something like the following:
Expectation(s) did not meet RAML specification requirements:
[ expectation ] [ PUT ] [ /hello/Sarah/greetings ]
[ request ] [ security ] Missing required security credentials. Must use one of [ my-token, basic ].
[ request ] [ uri ] [ name ] Value of [ Sarah ] does not meet API requirements.
[ request ] [ body ] object has missing required properties (["greeting"])
[ response ] [ body ] object has missing required properties (["name"])
Other Documentation
Please see the following documentation for other information:
