TestHttpServer (Atlassian Unit-Test Toolkit 2.3.0 API)

java.lang.Object
- com.atlassian.utt.http.TestHttpServer

```
public class TestHttpServer
extends Object
```
A simple embedded HTTP server test fixture. Use this to test code that performs HTTP requests, when you want to verify that the requests are really being sent with the correct headers and content rather than mocking out the HTTP client.
In the following example, if the test passes, you know that myXmlClient made a GET request to the correct URI and sent the appropriate Accept header; if the request did not have the expected URI or header, the test server would return a 500 error instead of the expected content.
```
     server.respondIf(
         allOf(method().is("GET"),
               uri().is(URI.create("/resource")),
               header("Accept").is(contains("application/xml"))),
         status(200).
               body(MY_XML_CONTENT).
               header("Content-Type", "application/xml"));
     assertThat(myXmlClient.makeGetRequestTo(server.getBaseUri().resolve("/resource")),
         returnsExpectedXmlContent());
 
```
Since:

1.1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TestHttpServer.RequestProperties` Simple abstraction of an HTTP request, used for matching requests with `respondIf(org.hamcrest.Matcher<com.atlassian.utt.http.TestHttpServer.RequestProperties>, com.atlassian.utt.http.TestHttpServer.ResponseProperties)`.
`static class`	`TestHttpServer.ResponseProperties` A simple abstraction of an HTTP response, used for configuring the test server.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASIC_AUTH_CHALLENGE` Use this constant with `authChallenge(java.lang.String)` or `proxyAuthChallenge(java.lang.String)` in a test response to simulate a basicauth challenge.
`static String`	`DIGEST_AUTH_CHALLENGE` Use this constant with `authChallenge(java.lang.String)` or `proxyAuthChallenge(java.lang.String)` in a test response to simulate a digest authentication challenge.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TestHttpServer.ResponseProperties`	`authChallenge(String challengeHeaderValue)` Constructs a `TestHttpServer.ResponseProperties` instance with a 401 (unauthorized) status and a `WWW-Authenticate` header.
`static TestHttpServer`	`create(int port)` Creates a new test server instance.
`URI`	`getBaseUri()`
`boolean`	`isPrintUnexpectedRequests()` Returns true if unmatched HTTP requests will be logged to the console.
`static TestHttpServer.ResponseProperties`	`proxyAuthChallenge(String challengeHeaderValue)` Constructs a `TestHttpServer.ResponseProperties` instance with a 407 (proxy authorization) status and a `Proxy-Authenticate` header.
`static NamedFunction<TestHttpServer,Iterable<? extends TestHttpServer.RequestProperties>>`	`requests()` Use this to construct a Hamcrest matcher for the list of all requests that the test server has received.
`void`	`reset()` Clears the lists of expected requests and received requests.
`TestHttpServer`	`respondIf(org.hamcrest.Matcher<TestHttpServer.RequestProperties> pattern, TestHttpServer.ResponseProperties r)` Configures the embedded server to send a specific response whenever it receives a request that meets certain conditions.
`void`	`setPrintUnexpectedRequests(boolean flag)` Specifies whether unmatched HTTP requests should be logged to the console, in addition to the server's usual behavior of returning a 500 error.
`void`	`start()` Starts the embedded server.
`static TestHttpServer.ResponseProperties`	`status(int status)` Constructs a `TestHttpServer.ResponseProperties` instance with a specific HTTP status code.
`void`	`stop()` Stops the embedded server immediately, releasing all HTTP worker threads.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BASIC_AUTH_CHALLENGE
```
public static final String BASIC_AUTH_CHALLENGE
```
    Use this constant with authChallenge(java.lang.String) or proxyAuthChallenge(java.lang.String) in a test response to simulate a basicauth challenge.
    
    See Also:
    
    Constant Field Values
  - DIGEST_AUTH_CHALLENGE
```
public static final String DIGEST_AUTH_CHALLENGE
```
    Use this constant with authChallenge(java.lang.String) or proxyAuthChallenge(java.lang.String) in a test response to simulate a digest authentication challenge.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
public static TestHttpServer create(int port)
                             throws IOException
```
    Creates a new test server instance.
    
    Parameters:
    
    port - the port to listen on
    
    Throws:
    
    IOException
  - getBaseUri
```
public URI getBaseUri()
```
  - start
```
public void start()
```
    Starts the embedded server.
  - stop
```
public void stop()
```
    Stops the embedded server immediately, releasing all HTTP worker threads.
  - isPrintUnexpectedRequests
```
public boolean isPrintUnexpectedRequests()
```
    Returns true if unmatched HTTP requests will be logged to the console.
  - setPrintUnexpectedRequests
```
public void setPrintUnexpectedRequests(boolean flag)
```
    Specifies whether unmatched HTTP requests should be logged to the console, in addition to the server's usual behavior of returning a 500 error. The default is false.
  - reset
```
public void reset()
```
    Clears the lists of expected requests and received requests.
  - respondIf
```
public TestHttpServer respondIf(org.hamcrest.Matcher<TestHttpServer.RequestProperties> pattern,
                                TestHttpServer.ResponseProperties r)
```
    Configures the embedded server to send a specific response whenever it receives a request that meets certain conditions.
    If the server receives a request that does not match any of the matchers previously specified with respondIf, it will return a 500 error; the response body will include a description of the incorrect request.
    
    Parameters:
    
    pattern - a Hamcrest matcher that will match the desired request
    
    r - properties of the response to send
    
    Returns:
    
    the same server instance
  - status
```
public static TestHttpServer.ResponseProperties status(int status)
```
    Constructs a TestHttpServer.ResponseProperties instance with a specific HTTP status code. To specify additional properties of the response, call TestHttpServer.ResponseProperties.body and/or TestHttpServer.ResponseProperties.header(java.lang.String, java.lang.String) on the returned response object.
  - authChallenge
```
public static TestHttpServer.ResponseProperties authChallenge(String challengeHeaderValue)
```
    Constructs a TestHttpServer.ResponseProperties instance with a 401 (unauthorized) status and a WWW-Authenticate header. Use this to test authentication behavior of your client code.
    
    Parameters:
    
    challengeHeaderValue - the value of the Authenticate header
  - proxyAuthChallenge
```
public static TestHttpServer.ResponseProperties proxyAuthChallenge(String challengeHeaderValue)
```
    Constructs a TestHttpServer.ResponseProperties instance with a 407 (proxy authorization) status and a Proxy-Authenticate header. Use this to test HTTP proxy behavior of your client code.
    
    Parameters:
    
    challengeHeaderValue - the value of the Proxy-Authenticate header
  - requests
```
public static NamedFunction<TestHttpServer,Iterable<? extends TestHttpServer.RequestProperties>> requests()
```
    Use this to construct a Hamcrest matcher for the list of all requests that the test server has received. For example:
```
     doSomethingThatShouldMakeAPostRequest();
     assertThat(server, requests().is(contains(
         allOf(method().is("POST"),
               uri().is(URI.create("/resource")),
               requestBody().is("I should have posted this")
         )));
 
```
    See Also:
    
    NamedFunction

Class TestHttpServer

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BASIC_AUTH_CHALLENGE

DIGEST_AUTH_CHALLENGE

Method Detail

create

getBaseUri

start

stop

isPrintUnexpectedRequests

setPrintUnexpectedRequests

reset

respondIf

status

authChallenge

proxyAuthChallenge

requests