org.kiwiproject.test.okhttp3.mockwebserver.MockWebServers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kiwi-test Show documentation

Kiwi Test is a test utility library.

There is a newer version: 3.7.0

package org.kiwiproject.test.okhttp3.mockwebserver;

import lombok.experimental.UtilityClass;
import okhttp3.mockwebserver.MockWebServer;

import java.net.URI;

/**
 * Static test utilities related to {@link MockWebServer}.
 * 
 * Note that MockWebServer (com.squareup.okhttp3:mockwebserver) and OkHttp
 * dependencies must be available at runtime. OkHttp is a transitive dependency
 * of mockwebserver, so you should only need to add mockwebserver.
 */
@UtilityClass
public class MockWebServers {

    /**
     * Create a {@link URI} which can be used to make HTTP (or HTTPS) requests
     * to the given {@link MockWebServer}.
     * 
     * Appends the given path to the server base URL.
     *
     * @param server the {@link MockWebServer}
     * @param path   the path relative to the server's base URI
     * @return a {@link URI} to connect to the server, with the given path
     */
    public static URI uri(MockWebServer server, String path) {
        return URI.create(server.url(path).toString());
    }
}