Skip to content

Commit

Permalink
* added byte[] body
Browse files Browse the repository at this point in the history 
* updated readme
  • Loading branch information
@StefH
StefH committed Jan 19, 2017
1 parent 8dfcf72 commit 1b2e536
Show file tree
Hide file tree
Showing 10 changed files with 353 additions and 184 deletions.
210 changes: 114 additions & 96 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,87 +5,136 @@ A C# .NET version based on https://github.com/alexvictoor/WireMock which tries t

[![Version](https://img.shields.io/nuget/v/System.Linq.Dynamic.Core.svg)](https://www.nuget.org/packages/System.Linq.Dynamic.Core)

The following frameworks are supported:
- net45
Based on class HttpListener from the .net framework, it is very lightweight and have no external dependencies.

## Start a server
First thing first, to start a server it is as easy as calling a static method, and your done!
```csharp
var server = FluentMockServer.Start();
```
You can pass as an argument a port number but if you do not an available port will be chosen for you. Hence the above line of code start aserver bounded to locahost a random port.
To know on which port your server is listening, just use server property *Port*.

## Stubbing
A core feature of WireMock is the ability to return canned HTTP responses for requests matching criteria.

WireMock allows to get an HTTP server in a glance.
### Basic stubbing
The following code will configure a response with a status of 200 to be returned when the relative URL exactly matches /some/thing (including query parameters). The body of the response will be “Hello world!” and a Content-Type header will be sent with a value of text-plain.

A fluent API allows to specify the behavior of the server and hence easily stub and mock webservices and REST ressources.
```csharp
var server = FluentMockServer.Start();
server
.Given(
Requests.WithUrl("/*")
Request.WithUrl("/some/thing").UsingGet()
)
.RespondWith(
Responses
Response
.WithStatusCode(200)
.WithBody(@"{ ""msg"": ""Hello world!""}")
.WithHeader("Content-Type", "text/plain")
.WithBody("Hello world!")
);
```
HTTP methods currently supported are: GET, POST, PUT, DELETE, HEAD. You can specify ANY (`.UsingAny`) if you want the stub mapping to match on any request method.

Based on class HttpListener from the .net framework, it is very lightweight and have no external dependencies.

# WireMock API in a nutshell
A response body in binary format can be specified as a `byte[]` via an overloaded `WithBody()`:

## Start a server
First thing first, to start a server it is as easy as calling a static method, and your done!
```csharp
var server = FluentMockServer.Start();
```
You can pass as an argument a port number but if you do not an available port will be chosen for you. Hence the above line of code start aserver bounded to locahost a random port.
To know on which port your server is listening, just use server property *Port*.

## Configure routes and behaviors
By default the server returns a dummy message with a 404 status code for all requests. To define a route, you need to specify request for this route and the response you want the server to return. This can be done in a fluent way using classes *Requests* and *Responses* as shown in the example below:
```csharp
server
.Given(
Requests.WithUrl("/api").UsingGet()
Request.WithUrl("/some/thing").UsingGet()
)
.RespondWith(
Responses
.WithStatusCode(200)
.WithBody(@"{ ""result"": ""Some data""}")
);
Response
.WithBody(new byte[] { 48, 65, 6c, 6c, 6f })
);
```

The above example is pretty simple. You can be much more selective routing requests according to url patterns, HTTP verbs, request headers and also body contents. Regarding responses, you can specify response headers, status code and body content.
Below a more exhaustive example:

### Response Templating
Response headers and bodies can optionally be rendered using [Handlebars.Net](https://github.com/rexm/Handlebars.Net) templates.
This enables attributes of the request to be used in generating the response e.g. to pass the value of a request ID header as a response header or render an identifier from part of the URL in the response body. To use this functionality, add `.WithTransformer()` to the response builder.

Example:
```csharp
var server = FluentMockServer.Start();
server
.Given(
Requests
.WithUrl("/api")
.UsingPost()
.WithHeader("X-version", "42")
.WithBody(@"{ ""msg"": "Hello Body, I will be stripped anyway!!" }");
Request.WithUrl("/some/thing").UsingGet()
)
.RespondWith(
Responses
Response
.WithStatusCode(200)
.WithHeader("content-type", "application/json")
.WithBody(@"{ ""result"": ""Some data""}")
);
.WithHeader("Content-Type", "text/plain")
.WithBody("Hello world! Your path is {{request.path}.")
.WithTransformer()
);
```

## Verify interactions
#### The request model
The model of the request is supplied to the header and body templates. The following request attributes are available:

* `request.url` - URL path and query
* `request.path` - URL path
* `request.path.[<n>]` - URL path segment (zero indexed) e.g. request.path.[2]
* `request.query.<key>`- First value of a query parameter e.g. request.query.search
* `request.query.<key>.[<n>]`- nth value of a query parameter (zero indexed) e.g. request.query.search.[5]
* `request.headers.<key>` - First value of a request header e.g. request.headers.X-Request-Id
* `request.headers.[<key>]` - Header with awkward characters e.g. request.headers.[$?blah]
* `request.headers.<key>.[<n>]` - nth value of a header (zero indexed) e.g. request.headers.ManyThings.[1]
* `request.cookies.<key>` - Value of a request cookie e.g. request.cookies.JSESSIONID
* `request.body` - Request body text (avoid for non-text bodies)

##### Handlebars helpers
All of the standard helpers (template functions) provided by the C# Handlebars implementation plus all of the string helpers are available e.g.
`{{capitalize request.query.search}}`

### Stub priority
*TODO*

### Verify interactions
The server keeps a log of the received requests. You can use this log to verify the interactions that have been done with the server during a test.
To get all the request received by the server, you just need to read property *RequestLogs*:
```csharp
var allRequests = server.RequestLogs;
```
If you need to be more specific on the requests that have been send to the server, you can use the very same fluent API that allows to define routes:
```csharp
var customerReadRequests
= server.SearchLogsFor(
Requests
.WithUrl("/api/customer*")
.UsingGet()
);
var customerReadRequests = server.SearchLogsFor(
Request.WithUrl("/api/customer*").UsingGet()
);
```

# WireMock with your favourite test framework
### Simulating delays
A server can be configured with a global delay that will be applied to all requests. To do so you need to call method FluentMockServer.AddRequestProcessingDelay() as below:
```csharp
var server = FluentMockServer.Start();

// add a delay of 30 seconds for all requests
server.AddRequestProcessingDelay(TimeSpan.FromSeconds(30));
```

Delays can also be configured at route level:
```csharp
var server = FluentMockServer.Start();
server
.Given(Request.WithUrl("/slow"))
.RespondWith(
Responses
.WithStatusCode(200)
.WithBody(@"{ ""msg"": ""Hello I'm a little bit slow!"" }")
.AfterDelay(TimeSpan.FromSeconds(10)
)
);
```

### Reset
The WireMock server can be reset at any time, removing all stub mappings and deleting the request log. If you’re using either of the UnitTest rules this will happen automatically at the start of every test case. However you can do it yourself via a call to `server.Reset()`.

### Getting all currently registered stub mappings
All stub mappings can be fetched in C# by calling `server.ListAllStubMappings()`.

## WireMock with your favourite test framework

Obviously you can use your favourite test framework and use WireMock within your tests. In order to avoid flaky tests you should:
- let WireMock choose dynamicaly ports. It might seem common sens, avoid hard coded ports in your tests!
Expand All @@ -102,42 +151,38 @@ public void StartMockServer()
[Test]
public async void Should_respond_to_request()
{
// given
_sut = new SomeComponentDoingHttpCalls();

_server
.Given(
Requests
.WithUrl("/foo")
.UsingGet())
.RespondWith(
Responses
.WithStatusCode(200)
.WithBody(@"{ ""msg"": ""Hello world!"" }")
);

// when
var response
= _sut.DoSomething();
// given
_sut = new SomeComponentDoingHttpCalls();

_server
.Given(Request.WithUrl("/foo").UsingGet())
.RespondWith(
Response
.WithStatusCode(200)
.WithBody(@"{ ""msg"": ""Hello world!"" }")
);

// when
var response = _sut.DoSomething();

// then
Check.That(response).IsEqualTo(EXPECTED_RESULT);

// then
Check.That(response).IsEqualTo(EXPECTED_RESULT);
// and optionnaly
Check.That(_server.SearchLogsFor(Requests.WithUrl("/error*")).IsEmpty();
// and optionnaly
Check.That(_server.SearchLogsFor(Request.WithUrl("/error*")).IsEmpty();
}

...

[TearDown]
public void ShutdownServer()
{
_server.Stop();
}
```



# WireMock as a standalone process

## WireMock as a standalone process
This is quite straight forward to launch a mock server within a console application. Below a simple "main" method that takes as a parameter from the commandline a port number and then start a mock server that will respond "Hello World" on every request:
```csharp
static void Main(string[] args)
Expand Down Expand Up @@ -197,40 +242,13 @@ static void Main(string[] args)
}
```

# SSL
## SSL
You can start a standalone mock server listening for HTTPS requests. To do so, there is just a flag to set when creating the server:
```csharp
var server = FluentMockServer.Start(port: 8443, ssl: true);
```
Obviously you need a certificate registered on your box, properly associated with your application and the port number that will be used. This is not really specific to WireMock, not very straightforward and hence the following stackoverflow thread might come handy: [Httplistener with https support](http://stackoverflow.com/questions/11403333/httplistener-with-https-support)
# Simulating delays
A server can be configured with a global delay that will be applied to all requests. To do so you need to call method FluentMockServer.AddRequestProcessingDelay() as below:
```csharp
var server = FluentMockServer.Start();
server.AddRequestProcessingDelay(TimeSpan.FromSeconds(30)); // add a delay of 30s for all requests
```

Delays can also be configured at route level:
```csharp
server
.Given(
Requests
.WithUrl("/slow")
)
.RespondWith(
Responses
.WithStatusCode(200)
.WithBody(@"{ ""msg"": ""Hello I'am a little bit slow!"" }")
.AfterDelay(TimeSpan.FromSeconds(10)
)
);
```

# Simulating faults
## Simulating faults

Currently not done - need to get rid of HttpListener and use lower level TcpListener in order to be able to implement this properly

# Advanced usage

TBD
23 changes: 13 additions & 10 deletions src/WireMock/HttpListenerRequestMapper.cs
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Diagnostics.CodeAnalysis;
using System;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Net;
Expand Down Expand Up @@ -31,14 +32,14 @@ public class HttpListenerRequestMapper
/// </returns>
public RequestMessage Map(HttpListenerRequest listenerRequest)
{
string path = listenerRequest.Url.AbsolutePath;
string query = listenerRequest.Url.Query;
Uri url = listenerRequest.Url;
string verb = listenerRequest.HttpMethod;
string body = GetRequestBody(listenerRequest);
byte[] body = GetRequestBody(listenerRequest);
string bodyAsString = body != null ? listenerRequest.ContentEncoding.GetString(body) : null;
var listenerHeaders = listenerRequest.Headers;
var headers = listenerHeaders.AllKeys.ToDictionary(k => k, k => listenerHeaders[k]);

return new RequestMessage(path, query, verb, body, headers);
return new RequestMessage(url, verb, body, bodyAsString, headers);
}

/// <summary>
Expand All @@ -50,20 +51,22 @@ public RequestMessage Map(HttpListenerRequest listenerRequest)
/// <returns>
/// The <see cref="string"/>.
/// </returns>
private string GetRequestBody(HttpListenerRequest request)
private byte[] GetRequestBody(HttpListenerRequest request)
{
if (!request.HasEntityBody)
{
return null;
}

using (var body = request.InputStream)
using (var bodyStream = request.InputStream)
{
using (var reader = new StreamReader(body, request.ContentEncoding))
using (var memoryStream = new MemoryStream())
{
return reader.ReadToEnd();
bodyStream.CopyTo(memoryStream);

return memoryStream.ToArray();
}
}
}
}
}
}
Loading

0 comments on commit 1b2e536

Please sign in to comment.