Mock server is an implementation of HttpCalloutMock which can help you make your mocks more organized. I wrote a post to compare the MockServer approach with HttpCalloutMock implementation. You can take a look at it to get the idea of how to use it or you can follow the docs below.
Server constructor takes no params. Also, you can set it as a mock right away:
// Instantiating a server
sfcraft_MockServer server = new sfcraft_MockServer();
// Setting server as mock
server.setAsMock();Then you need to add resources to endpoints (see below on how to create resources):
server.addEndpoint('http://example.com', rootResource);
server.addEndpoint('http://example.com/users', usersResource);By default they all will respond with provided 200 responses. You need explicitly ask server to respond differently:
server.getServerResource('http://example.com').respondWith(400);Resource attached to the endpoint must have the asked for status code. Otherwise you'll get a MockServerException.
You can also chain response codes:
server.getServerResource('http://example.com')
.respondOnceWith(400)
.respondOnceWith(500)
.respondWith(200);You can omit .respondWith(200). The resource will fallback to code 200 in case it runs out of overrides.
First instantiate a new API resource
sfcraft_MockAPIResource resource = new sfcraft_MockAPIResource();Then you can add responses to it. To add a response you need to provide method, code, and response body.
// Successful POST response
resource.setResponse(
'POST',
200,
successResponseObject
);
// Failed GET response
resource.setResponse(
'POST',
405,
failResponseObject
);You can provide either response objects to set response:
public class DemoResponse implements sfcraft_MockableHttpResponse {
public String toResponseBody() {
return JSON.serialize(this);
}
}
...
resource.setResponse(
'POST',
200,
new DemoResponse()
);or plain strings
resource.setResponse(
'POST',
200,
'status: ok'
);You can also specify headers for responses if you have any logic based on those:
resource.setResponse(
'POST',
200,
'status: ok',
new Map<String, String> {
'Content-Type' => 'plain/text'
}
);You can validate that request is built correctly. This might be helpful to test headers, e.g. Authorization, Content-Type, etc. To preform assertiong on the request you need to implement a sfcraft_RequestAsserter interface. Here's a sample of an assertion that checks Content-Type header.
private class ContentTypeAssertion implements sfcraft_RequestAsserter {
private String expectedContentType;
public ContentTypeAssertion(String expectedContentType) {
this.expectedContentType = expectedContentType;
}
public void assertRequest(HttpRequest req) {
String contentType = req.getHeader('Content-Type');
System.assert(String.isNotBlank(), 'Content-Type header is not set')
System.assertEquals(this.expectedContentType, contentType, 'Content-Type is different from expected');
}
}Then you need to add these assertions to a resource:
sfcraft_MockAPIResource resource = new sfcraft_MockAPIResource();
resource.addAssertion(new ContentTypeJsonAssertion('application/json'));You can add as many assertions as you want. They are executed in the order you add them.
sfcraft_MockAPIResource resource = new sfcraft_MockAPIResource();
resource.addAssertion(new AuthorizationAssertion());
resource.addAssertion(new ContentTypeJsonAssertion('application/json'));
resource.addAssertion(new BodyParamsAssertion());
resource.addAssertion(new SomeOtherAssertion());@isTest
private class BasicUsage {
@isTest
private static void howToUseMockServer() {
// Create resourse. Resource is basically an endpoint on your real server
sfcraft_MockAPIResource resource = new sfcraft_MockAPIResource();
// Setting up a success response.
DemoResponse responseObject = new DemoResponse();
resource.setResponse(
'POST',
200,
responseObject
);
// Instantiating a server
sfcraft_MockServer server = new sfcraft_MockServer();
// Setting server as mock
server.setAsMock();
// Adding resource to server
server.addEndpoint('http://example.com', resource);
Test.startTest();
HttpRequest req = new HttpRequest();
req.setEndpoint('http://example.com?id=1234');
req.setMethod('GET');
HttpResponse response = new Http().send(req);
Test.stopTest();
// By default server always returns 200
System.assertEquals(200, response.getStatusCode());
System.assertEquals(responseObject.toResponseBody(), response.getBody());
}
public class DemoResponse implements sfcraft_MockableHttpResponse {
public String status;
public DemoResponse(String status) {
this.status = status;
}
public String toResponseBody() {
return JSON.serialize(this);
}
}
}For more usage examples take a look at the test classes. The lib is developed via TDD, which makes tests behave as specs.
The mock server framework consists of the following main parts:
sfcraft_MockServerclass - the actual mock server.sfcraft_MockAPIResourceclass - a class which actually represents a single resource that has handles responses. Not attached to a specific endpoint.sfcraft_ServerEndpointResourceclass - a class which actually represents a connection between API resource and endpoint. Dictates which code should a resource respond with. So you can have a single resource with the same responses, but different behavoiur in terms of endpoint and response codes.sfcraft_RequestAsserterinterface - implement it and add to a resource to run assertion "on server side".sfcraft_MockableHttpResponseinterface - implement it by class that represents you server response. E.g. you parse body into a classServerResponseBody. Then you need to implement thesfcraft_MockableHttpResponseby it to be teach thesfcraft_MockServerto respond with it.sfcraft_MockServerException- exception that is thrown bysfcraft_MockServerin case something went wrong, e.g. misconfiguration.
All classes except Exception are marked as isTest. It is only used once actually to allow MockServer construct sfcraft_ServerEndpointResource without exposing its constructor. Just not to encourage peopl to construct those themselves. They are of no use outside the server as far as I'm concerned
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent