MockWebServer for JUnit 5
=========================

This module integrates mockwebserver3.MockWebServer with JUnit 5.

To use, first add this library as a test dependency:

```
testImplementation("com.squareup.okhttp3:mockwebserver3-junit5:5.1.0")
```

Annotate fields in test classes with `@StartStop`. The server will be started and shut down
automatically.

```
class MyTest {

  @StartStop

import mockwebserver3.MockResponse;
import mockwebserver3.MockWebServer;
import okhttp3.Headers;
import org.junit.Test;

import java.io.IOException;

/**
 * Unit test for simple App.
 */
public class AppTest {
  private final MockWebServer mockWebServer = new MockWebServer();

  @Test
  public void testApp() throws IOException {
    mockWebServer.enqueue(new MockResponse(200, Headers.of(), "Hello, Maven!"));

import org.junit.jupiter.api.extension.ExtendWith

/**
 * Runs MockWebServer for the duration of a test method or test class.
 *
 * In Java JUnit 5 tests (ie. tests annotated `@org.junit.jupiter.api.Test`), use this by defining a
 * field with the `@StartStop` annotation:
 *
 * ```java
 * @StartStop public final MockWebServer server = new MockWebServer();
 * ```
 *
 * Or for Kotlin:
 *
 * ```kotlin

import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.mockwebserver.MockResponse
import okhttp3.mockwebserver.MockWebServer
import okhttp3.tls.HandshakeCertificates
import okhttp3.tls.internal.TlsUtil

class DevServer {
  val handshakeCertificates = TlsUtil.localhost()

  val server =
    MockWebServer().apply {
      useHttps(handshakeCertificates.sslSocketFactory(), false)

      enqueue(

import okhttp3.OkHttpClient
import okhttp3.OkHttpClientTestRule
import okhttp3.Request
import okhttp3.RequestBody
import okhttp3.Response
import okhttp3.mockwebserver.MockResponse
import okhttp3.mockwebserver.MockWebServer
import okhttp3.mockwebserver.SocketPolicy
import okhttp3.testing.PlatformRule
import okio.Buffer
import okio.BufferedSink
import org.junit.jupiter.api.AfterEach
import org.junit.jupiter.api.BeforeEach

import java.util.Collections;
import okhttp3.OkHttpClient;
import okhttp3.Protocol;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.mockwebserver.MockResponse;
import okhttp3.mockwebserver.MockWebServer;

/**
 * Create UNIX domain sockets for MockWebServer and OkHttp and connect 'em together. Note that we
 * cannot do TLS over domain sockets.
 */
public class ClientAndServer {
  public void run() throws Exception {

MockWebServer for JUnit 4
=========================

This module integrates mockwebserver3.MockWebServer with JUnit 4.

To use, first add this library as a test dependency:

```
testImplementation("com.squareup.okhttp3:mockwebserver3-junit4:5.1.0")
```

Then in tests annotated `@org.junit.Test`, you may declare a field with the `@Rule` annotation:

```
@Rule public final MockWebServerRule serverRule = new MockWebServerRule();
```

import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManagerFactory;
import okhttp3.mockwebserver.Dispatcher;
import okhttp3.mockwebserver.MockResponse;
import okhttp3.mockwebserver.MockWebServer;
import okhttp3.mockwebserver.RecordedRequest;
import okio.Buffer;
import okio.Okio;

public class SampleServer extends Dispatcher {
  private final SSLContext sslContext;

 */
package okhttp3.recipes;

import java.net.InetAddress;
import okhttp3.Call;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.mockwebserver.MockResponse;
import okhttp3.mockwebserver.MockWebServer;
import okhttp3.tls.HandshakeCertificates;
import okhttp3.tls.HeldCertificate;

/**
 * Create an HTTPS server with a self-signed certificate that OkHttp trusts.
 */

### Example

Use MockWebServer the same way that you use mocking frameworks like
[Mockito](https://github.com/mockito/mockito):

1. Script the mocks.
2. Run application code.
3. Verify that the expected requests were made.

Here's a complete example:

### Java
```java
public void test() throws Exception {
  // Create a MockWebServer. These are lean enough that you can create a new