io.sphere.sdk.test.IntegrationTest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-lib Show documentation
test-lib
The newest version!
package io.sphere.sdk.test;

import io.sphere.sdk.client.*;
import io.sphere.sdk.client.SphereRequest;
import org.junit.AfterClass;
import org.junit.BeforeClass;

import java.util.Optional;

public abstract class IntegrationTest {

    private static final String JVM_SDK_IT_SERVICE_URL = "JVM_SDK_IT_SERVICE_URL";
    private static final String JVM_SDK_IT_AUTH_URL = "JVM_SDK_IT_AUTH_URL";
    private static final String JVM_SDK_IT_CLIENT_SECRET = "JVM_SDK_IT_CLIENT_SECRET";
    private static final String JVM_SDK_IT_CLIENT_ID = "JVM_SDK_IT_CLIENT_ID";
    private static final String JVM_SDK_IT_PROJECT_KEY = "JVM_SDK_IT_PROJECT_KEY";
    private static volatile int threadCountAtStart;
    private static TestClient client;

    protected synchronized static TestClient client() {
        if (client == null) {
            final SphereClientFactory factory = SphereClientFactory.of();
            final SphereClientConfig config = SphereClientConfig.of(projectKey(), clientId(), clientSecret(), authUrl(), apiUrl());
            final SphereAccessTokenSupplier tokenSupplier = SphereAccessTokenSupplierFactory.of().createSupplierOfOneTimeFetchingToken(config);
            final SphereClient underlying = factory.createClient(config, tokenSupplier);
            final SphereClient underlyingWithDeprecationExceptions = DeprecationExceptionSphereClientDecorator.of(underlying);
            client = new TestClient(underlyingWithDeprecationExceptions);
        }
        return client;
    }

    protected static SphereClientConfig getSphereConfig() {
        return SphereClientConfig.of(projectKey(), clientId(), clientSecret(), authUrl(), apiUrl());
    }

    private static String getValueForEnvVar(final String key) {
        return Optional.ofNullable(System.getenv(key))
                .orElseThrow(() -> new RuntimeException(
                        "Missing environment variable " + key + ", please provide the following environment variables from a NEW TEST PROJECT (you can keep it for further tests):\n" +
                        "export JVM_SDK_IT_SERVICE_URL=\"https://api.sphere.io\"\n" +
                        "export JVM_SDK_IT_AUTH_URL=\"https://auth.sphere.io\"\n" +
                        "export JVM_SDK_IT_PROJECT_KEY=\"YOUR project key\"\n" +
                        "export JVM_SDK_IT_CLIENT_ID=\"YOUR client id\"\n" +
                        "export JVM_SDK_IT_CLIENT_SECRET=\"YOUR client secret\""));
    }

    protected static String apiUrl() {
        return getValueForEnvVar(JVM_SDK_IT_SERVICE_URL);
    }

    protected static String authUrl() {
        return getValueForEnvVar(JVM_SDK_IT_AUTH_URL);
    }

    protected static String clientSecret() {
        return getValueForEnvVar(JVM_SDK_IT_CLIENT_SECRET);
    }

    protected static String clientId() {
        return getValueForEnvVar(JVM_SDK_IT_CLIENT_ID);
    }

    protected static String projectKey() {
        return getValueForEnvVar(JVM_SDK_IT_PROJECT_KEY);
    }

    protected static  T execute(final SphereRequest sphereRequest) {
        try {
            return client().execute(sphereRequest);
        } catch (final TestClientException e) {
            if (e.getCause() != null && e.getCause() instanceof RuntimeException) {
                throw (RuntimeException) e.getCause();
            } else {
                throw e;
            }
        }
    }

    @BeforeClass
    public synchronized static void setup() {
        threadCountAtStart = countThreads();
    }

    @AfterClass
    public synchronized static void shutdownClient() {
        if (client != null) {
            client.close();
            client = null;
            final int threadsNow = countThreads();
            final long bufferForGcThreadAndSbt = 3;
            final long allowedThreadCount = threadCountAtStart + bufferForGcThreadAndSbt;
            if (threadsNow > allowedThreadCount) {
                throw new RuntimeException("Thread leak! After client shutdown created threads are still alive. Threads now: " + threadsNow + " Threads before: " + threadCountAtStart);
            }
        }
    }

    protected static int countThreads() {
        return Thread.activeCount();
    }
}