io.sphere.sdk.meta

Class TestingDocumentation

Table of Contents

• Client test doubles for unit tests
• Detailed example for creating test doubles

java.lang.Object

io.sphere.sdk.meta.TestingDocumentation

public final class TestingDocumentation
extends Object

Client test doubles for unit tests

Since the clients are interfaces you can implement them to provide test doubles.

Here are some example to provide fake client responses in tests:

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.

//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.

Detailed example for creating test doubles

Go to impex playground and get some product data as String

So you have this:

	{
	"offset": 0,
	"count": 5,
	"total": 5,
	"results": [
	{
	"id": "8665d91a-eab0-45a8-a378-e6603d66d084",
	"version": 4,
	"productType": {
	"typeId": "product-type",
	"id": "c6af7304-4e35-48d6-8687-66ca2dab5dbb"
	},
	"name": {
	"en": "GIRLS HARTBREAK CREW"
	},
	"description": {
	"en": "Sample description"
	},
	"categories": [
	{
	"typeId": "category",
	"id": "eab84062-f4d7-4dd6-a576-ce5c10923e68"
	}
	],
	"slug": {
	"en": "girls-hartbreak-crew1417714797195"
	},
	"masterVariant": {
	"id": 1,
	"sku": "sku_GIRLS_HARTBREAK_CREW_variant1_1417714797195",
	"prices": [
	{
	"value": {
	"currencyCode": "EUR",
	"centAmount": 3400
	},
	"id": "1513154a-5cc9-4b2f-88a3-4e096ae92f0e"
	}
	],
	"images": [
	{
	"url": "https://www.commercetools.com/cli/data/253234387_1.jpg",
	"dimensions": {
	"w": 1400,
	"h": 1400
	}
	}
	],
	"attributes": []
	},
	"variants": [],
	"searchKeywords": {},
	"hasStagedChanges": true,
	"published": true,
	"taxCategory": {
	"typeId": "tax-category",
	"id": "0b423f46-124e-4db5-b16a-1d68afabe640"
	},
	"createdAt": "2014-12-04T17:39:57.214Z",
	"lastModifiedAt": "2015-05-23T09:28:02.086Z"
	},
	{
	"id": "347caac1-daa2-4e31-bc95-e237ba1e2b91",
	"version": 4,
	"productType": {
	"typeId": "product-type",
	"id": "c6af7304-4e35-48d6-8687-66ca2dab5dbb"
	},
	"name": {
	"en": "WB ATHLETIC TANK"
	},
	"description": {
	"en": "Sample description"
	},
	"categories": [
	{
	"typeId": "category",
	"id": "0ff5fd1d-f7c9-4ba3-a3dc-d74c417526c6"
	}
	],
	"slug": {
	"en": "wb-athletic-tank1417714797219"
	},
	"masterVariant": {
	"id": 1,
	"sku": "sku_WB_ATHLETIC_TANK_variant1_1417714797219",
	"prices": [
	{
	"value": {
	"currencyCode": "EUR",
	"centAmount": 8400
	},
	"id": "403f7308-f786-4fd3-9d98-2ccf4cb6f590"
	}
	],
	"images": [
	{
	"url": "https://www.commercetools.com/cli/data/253265444_1.jpg",
	"dimensions": {
	"w": 1400,
	"h": 1400
	}
	}
	],
	"attributes": []
	},
	"variants": [],
	"searchKeywords": {},
	"hasStagedChanges": true,
	"published": true,
	"taxCategory": {
	"typeId": "tax-category",
	"id": "0b423f46-124e-4db5-b16a-1d68afabe640"
	},
	"createdAt": "2014-12-04T17:39:57.234Z",
	"lastModifiedAt": "2015-05-23T09:28:02.108Z"
	},
	{
	"id": "f7edccd2-95d7-4fea-b511-ae5b3e309c7d",
	"version": 4,
	"productType": {
	"typeId": "product-type",
	"id": "c6af7304-4e35-48d6-8687-66ca2dab5dbb"
	},
	"name": {
	"en": "MB SOFTSHELL LINER"
	},
	"description": {
	"en": "Sample description"
	},
	"categories": [
	{
	"typeId": "category",
	"id": "3f3d7425-b1df-473b-9425-4cddba412f3e"
	}
	],
	"slug": {
	"en": "mb-softshell-liner1417714797242"
	},
	"masterVariant": {
	"id": 1,
	"sku": "sku_MB_SOFTSHELL_LINER_variant1_1417714797242",
	"prices": [
	{
	"value": {
	"currencyCode": "EUR",
	"centAmount": 10000
	},
	"id": "b6ff373f-506e-46b1-af00-8ef0c7fd2e64"
	}
	],
	"images": [
	{
	"url": "https://www.commercetools.com/cli/data/254391631_1.jpg",
	"dimensions": {
	"w": 1400,
	"h": 1400
	}
	}
	],
	"attributes": []
	},
	"variants": [],
	"searchKeywords": {},
	"hasStagedChanges": true,
	"published": true,
	"taxCategory": {
	"typeId": "tax-category",
	"id": "0b423f46-124e-4db5-b16a-1d68afabe640"
	},
	"createdAt": "2014-12-04T17:39:57.271Z",
	"lastModifiedAt": "2015-05-23T09:28:02.130Z"
	},
	{
	"id": "ff0c34c3-bd33-4991-89f5-dfa96b69b26c",
	"version": 4,
	"productType": {
	"typeId": "product-type",
	"id": "c6af7304-4e35-48d6-8687-66ca2dab5dbb"
	},
	"name": {
	"en": "MB PREMIUM TECH T"
	},
	"description": {
	"en": "Sample description"
	},
	"categories": [
	{
	"typeId": "category",
	"id": "eab84062-f4d7-4dd6-a576-ce5c10923e68"
	}
	],
	"slug": {
	"en": "mb-premium-tech-t1417714797277"
	},
	"masterVariant": {
	"id": 1,
	"sku": "sku_MB_PREMIUM_TECH_T_variant1_1417714797277",
	"prices": [
	{
	"value": {
	"currencyCode": "EUR",
	"centAmount": 10000
	},
	"id": "02e4c5ea-89aa-45d7-b571-3761ddc1a302"
	}
	],
	"images": [
	{
	"url": "https://www.commercetools.com/cli/data/253245821_1.jpg",
	"dimensions": {
	"w": 1400,
	"h": 1400
	}
	}
	],
	"attributes": []
	},
	"variants": [],
	"searchKeywords": {},
	"hasStagedChanges": true,
	"published": true,
	"taxCategory": {
	"typeId": "tax-category",
	"id": "0b423f46-124e-4db5-b16a-1d68afabe640"
	},
	"createdAt": "2014-12-04T17:39:57.296Z",
	"lastModifiedAt": "2015-05-23T09:28:02.152Z"
	},
	{
	"id": "461e2e52-50c9-4d77-a2f2-1cb77b601556",
	"version": 4,
	"productType": {
	"typeId": "product-type",
	"id": "c6af7304-4e35-48d6-8687-66ca2dab5dbb"
	},
	"name": {
	"en": "SAPPHIRE"
	},
	"description": {
	"en": "Sample description"
	},
	"categories": [
	{
	"typeId": "category",
	"id": "3f3d7425-b1df-473b-9425-4cddba412f3e"
	}
	],
	"slug": {
	"en": "sapphire1417714797145"
	},
	"masterVariant": {
	"id": 1,
	"sku": "sku_SAPPHIRE_variant1_1417714797145",
	"prices": [
	{
	"value": {
	"currencyCode": "EUR",
	"centAmount": 2800
	},
	"id": "b6fbf092-55eb-40ac-9ca9-336ca401b252"
	}
	],
	"images": [
	{
	"url": "https://www.commercetools.com/cli/data/252542005_1.jpg",
	"dimensions": {
	"w": 1400,
	"h": 1400
	}
	}
	],
	"attributes": []
	},
	"variants": [],
	"searchKeywords": {},
	"hasStagedChanges": true,
	"published": true,
	"taxCategory": {
	"typeId": "tax-category",
	"id": "0b423f46-124e-4db5-b16a-1d68afabe640"
	},
	"createdAt": "2014-12-04T17:39:57.189Z",
	"lastModifiedAt": "2015-05-23T09:28:02.058Z"
	}
	]
	}

view raw product-projection-query-result.json hosted with ❤ by GitHub

And you can extract the data of one product:

	{
	"id": "8665d91a-eab0-45a8-a378-e6603d66d084",
	"version": 4,
	"productType": {
	"typeId": "product-type",
	"id": "c6af7304-4e35-48d6-8687-66ca2dab5dbb"
	},
	"name": {
	"en": "GIRLS HARTBREAK CREW"
	},
	"description": {
	"en": "Sample description"
	},
	"categories": [
	{
	"typeId": "category",
	"id": "eab84062-f4d7-4dd6-a576-ce5c10923e68"
	}
	],
	"slug": {
	"en": "girls-hartbreak-crew1417714797195"
	},
	"masterVariant": {
	"id": 1,
	"sku": "sku_GIRLS_HARTBREAK_CREW_variant1_1417714797195",
	"prices": [
	{
	"value": {
	"currencyCode": "EUR",
	"centAmount": 3400
	},
	"id": "1513154a-5cc9-4b2f-88a3-4e096ae92f0e"
	}
	],
	"images": [
	{
	"url": "https://www.commercetools.com/cli/data/253234387_1.jpg",
	"dimensions": {
	"w": 1400,
	"h": 1400
	}
	}
	],
	"attributes": []
	},
	"variants": [],
	"searchKeywords": {},
	"hasStagedChanges": true,
	"published": true,
	"taxCategory": {
	"typeId": "tax-category",
	"id": "0b423f46-124e-4db5-b16a-1d68afabe640"
	},
	"createdAt": "2014-12-04T17:39:57.214Z",
	"lastModifiedAt": "2015-05-23T09:28:02.086Z"
	}

view raw product-projection.json hosted with ❤ by GitHub

With a function like

import org.apache.commons.io.IOUtils;

public final class ResourceUtil {
    private ResourceUtil() {
    }

    public static String stringFromResource(final String resourcePath) throws Exception {
        return IOUtils.toString(Thread.currentThread().getContextClassLoader().getResourceAsStream(resourcePath), "UTF-8");
    }

}
See the test code.

you can obtain a String from a resource file in the classpath of the test and replace values optionally:

final String originalProductProjectionJsonString = ResourceUtil.stringFromResource("product-projection.json");
final String newProductId = "8b2f45fa-fb1e-48dc-a601-ab0ea9f493df";
final String newSlug = "whatever-slug";
final String productProjectionJson = originalProductProjectionJsonString
        .replace("8665d91a-eab0-45a8-a378-e6603d66d084", newProductId)
        .replace("girls-hartbreak-crew1417714797195", newSlug)
        //example for key and value replace
        .replace("\"hasStagedChanges\": true", "\"hasStagedChanges\": false");
final ProductProjection productProjection = SphereJsonUtils.readObject(productProjectionJson, ProductProjection.typeReference());
assertThat(productProjection.getId()).isEqualTo(newProductId);
assertThat(productProjection.getSlug().get(Locale.ENGLISH)).isEqualTo(newSlug);
assertThat(productProjection.hasStagedChanges()).isFalse();
See the test code.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait