io.sphere.sdk.client

Class TestDoubleSphereClientFactory

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.TestDoubleSphereClientFactory

public final class TestDoubleSphereClientFactory
extends Base

A factory to instantiate test double SphereClients clients which use CompletionStage as future implementation.

Method Summary

Modifier and Type	Method and Description
static SphereClient	createHttpTestDouble(Function<HttpRequestIntent,HttpResponse> function) Creates a test double for a Composable Commerce client which enables to fake http responses from the API.
static SphereClient	createObjectTestDouble(Function<HttpRequestIntent,Object> function) Creates a test double for a Composable Commerce client which enables to fake the results of the client as Java object.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createHttpTestDouble

public static SphereClient createHttpTestDouble(Function<HttpRequestIntent,HttpResponse> function)

Creates a test double for a Composable Commerce client which enables to fake http responses from the API. The client does not need an internet connection.

final SphereClient client = TestDoubleSphereClientFactory.createHttpTestDouble(httpRequest -> {
    final HttpResponse response;
    if (httpRequest.getPath().contains("/categories")) {
        //JSON representation is often useful to deal with errors, but this time again a happy path example
        //alternatively you can provide the String from a file in the classpath
        response = HttpResponse.of(200, "{\n" +
                "    \"offset\" : 0,\n" +
                "    \"count\" : 1,\n" +
                "    \"total\" : 1,\n" +
                "    \"results\" : [ {\n" +
                "        \"id\" : \"5ebe6dc9-ba32-4030-9f3e-eee0137a1274\",\n" +
                "        \"version\" : 1,\n" +
                "        \"name\" : {\n" +
                "            \"en\" : \"TestSnowboard equipment\"\n" +
                "        },\n" +
                "        \"slug\" : {\n" +
                "            \"en\" : \"snowboard-equipment\"\n" +
                "        },\n" +
                "        \"ancestors\" : [ ],\n" +
                "        \"orderHint\" : \"0.000014020459255201865700631\",\n" +
                "        \"createdAt\" : \"2014-06-06T09:12:05.520Z\",\n" +
                "        \"lastModifiedAt\" : \"2014-06-06T09:12:05.520Z\"\n" +
                "    }]\n" +
                "}");
    } else {
        //here you can put if else blocks for further preconfigured responses
        throw new UnsupportedOperationException("I'm not prepared for this request: " + httpRequest);
    }
    return response;
});
See the test code.

Parameters:

function - a function which returns a matching object for a Composable Commerce request.

Returns:

sphere client test double

createObjectTestDouble

public static SphereClient createObjectTestDouble(Function<HttpRequestIntent,Object> function)

Creates a test double for a Composable Commerce client which enables to fake the results of the client as Java object. The client does not need an internet connection.

//deserializes an object stored from JSON
final SphereClient client = TestDoubleSphereClientFactory.createObjectTestDouble(httpRequest -> {
    final Object result;
    if (httpRequest.getPath().contains("/categories")) {
        //in Play projects the file is in "test/resources/categories.json"
        final PagedQueryResult<Category> queryResult = SphereJsonUtils.readObjectFromResource("categories.json", CategoryQuery.resultTypeReference());
        result = queryResult;
    } else {
        throw new UnsupportedOperationException("I'm not prepared for this request: " + httpRequest);
    }
    return result;
});
See the test code.

Parameters:

function - a function which returns a matching http request for a Composable Commerce request.

Returns:

sphere client test double