WebApi的一种集成测试写法(in-memory)

 

大家是如何对webApi写测试的呢？

1.利用Fiddler直接做请求，观察response的内容。

2.利用Httpclient做请求，断言response的内容。

3.直接调用webApi的action,这种方式的测试跟真实的调用还是有一定差距，不够完美。

接下来我介绍一种webApi的in-memory调用方法，也能够达到对webApi的测试，并且由于是in-memory调用，效率也比较高，非常适写单元测试。本文参考了In memory client, host and integration testing of your Web API service。

一、首先写一个OrderController用来做测试用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public class OrderController : ApiController
    {
        // GET api/order
        public Order Get()
        {
            return new Order(){Id = 1,Descriptions = "descriptions",Name = "name"};
        }
 
        // GET api/order/5
        public string Get(int id)
        {
            return "value";
        }
 
        // POST api/order
        public Order Post(Order order)
        {
            return order;
        }
 
        // DELETE api/order/5
        public void Delete(int id)
        {
        }
    }

二、WebApi的请求过程

webApi的核心是对消息的管道处理，整个核心是有一系列消息处理器(HttpMessageHandler)首尾连接的双向管道，管道头为HttpServer,管道尾为HttpControllerDispatcher,HttpControllerDispatcher负责对controller的激活和action的执行，然后相应的消息逆向流出管道。

所以我们可以利用HttpMessageInvoker将一个请求消息HttpRequestMessage发送到管道中，最后收到的消息HttpResponseMessage就代表一个真实的请求响应。

三、Get请求的测试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[Test]
public void GetTest()
{
    string baseAddress = "http://localhost:33203/";
 
    HttpConfiguration config = new HttpConfiguration();
    WebApiConfig.Register(config);
    config.IncludeErrorDetailPolicy = IncludeErrorDetailPolicy.Always;
    HttpServer server = new HttpServer(config);
    HttpMessageInvoker messageInvoker = new HttpMessageInvoker(server);
    CancellationTokenSource cts = new CancellationTokenSource();
    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, baseAddress + "api/order");
 
    using (HttpResponseMessage response = messageInvoker.SendAsync(request, cts.Token).Result)
    {
        var content = response.Content.ReadAsStringAsync().Result;
        var result = JsonConvert.DeserializeObject<Order>(content);
 
        result.Name.Should().Be("name");
    }
}

四、Post请求的测试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[Test]
public void PostTest()
{
    string baseAddress = "http://localhost:33203/";
 
    HttpConfiguration config = new HttpConfiguration();
    WebApiConfig.Register(config);
    config.IncludeErrorDetailPolicy = IncludeErrorDetailPolicy.Always;
    HttpServer server = new HttpServer(config);
    HttpMessageInvoker messageInvoker = new HttpMessageInvoker(server);
    CancellationTokenSource cts = new CancellationTokenSource();
    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, baseAddress + "api/order");
    var order = new Order() { Id = 1, Name = "orderName", Descriptions = "orderDescriptions" };
    request.Content = new ObjectContent<Order>(order, new JsonMediaTypeFormatter());
    using (HttpResponseMessage response = messageInvoker.SendAsync(request, cts.Token).Result)
    {
        var content = JsonConvert.SerializeObject(order, new JsonSerializerSettings() { ContractResolver = new CamelCasePropertyNamesContractResolver() });
        response.Content.ReadAsStringAsync().Result.Should().Be(content);
    }
}

四、重构

可以看到这两个测试大部分的代码是相同的，都是用来发送请求。因此我们提取一个webApiTestBase类，该基类可以提供InvokeGetRequest,InvokePostRequest,InvokePutRequest等方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
public abstract class ApiTestBase
    {
        public abstract string GetBaseAddress();
 
        protected TResult InvokeGetRequest<TResult>(string api)
        {
            using (var invoker = CreateMessageInvoker())
            {
                using (var cts = new CancellationTokenSource())
                {
                    var request = new HttpRequestMessage(HttpMethod.Get, GetBaseAddress() + api);
                    using (HttpResponseMessage response = invoker.SendAsync(request, cts.Token).Result)
                    {
                        var result = response.Content.ReadAsStringAsync().Result;
                        return JsonConvert.DeserializeObject<TResult>(result);
                    }
                }
            }
        }
 
        protected TResult InvokePostRequest<TResult, TArguemnt>(string api, TArguemnt arg)
        {
            var invoker = CreateMessageInvoker();
            using (var cts = new CancellationTokenSource())
            {
                var request = new HttpRequestMessage(HttpMethod.Post, GetBaseAddress() + api);
                request.Content = new ObjectContent<TArguemnt>(arg, new JsonMediaTypeFormatter());
                using (HttpResponseMessage response = invoker.SendAsync(request, cts.Token).Result)
                {
                    var result = response.Content.ReadAsStringAsync().Result;
                    return JsonConvert.DeserializeObject<TResult>(result);
                }
            }
        }
 
        private HttpMessageInvoker CreateMessageInvoker()
        {
            var config = new HttpConfiguration();
            WebApiConfig.Register(config);
            var server = new HttpServer(config);
            var messageInvoker = new HttpMessageInvoker(server);
            return messageInvoker;
        }
    }

有了这个基类，我们写测试只需要重写方法GetBaseAddress()，然后直接调用基类方法并进行断言即可

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
[TestFixture]
    public class OrderApiTests:ApiTestBase
    {
        public override string GetBaseAddress()
        {
            return "http://localhost:33203/";
        }
 
        [Test]
        public void Should_get_order_successfully()
        {
            var result = InvokeGetRequest<Order>("api/order");
 
            result.Name.Should().Be("name");
            result.Descriptions.Should().Be("descriptions");
            result.Id.Should().Be(1);
        }
 
        [Test]
        public void Should_post_order_successfully()
        {
            var newOrder=new Order(){Name = "newOrder",Id = 100,Descriptions = "new-order-description"};
 
            var result = InvokePostRequest<Order,Order>("api/order", newOrder);
 
            result.Name.Should().Be("newOrder");
            result.Id.Should().Be(100);
            result.Descriptions.Should().Be("new-order-description");
        }
    }

是不是干净多了。

这种in-memory的测试方案有什么优点和缺点呢？

优点：

1.模拟真实调用，需要传入api地址即可得到结果，由于整个调用是in-memory的，所有效率很高，很适合集成测试。

2.整个测试时可以调试的，可以直接从单元测试调试进去，如果你写一个httpClient的测试，需要把webApi启动起来，然后。。。麻烦

缺点：我觉得原文作者说的那些缺点都可以忽略不计^_^

WebApi的一种集成测试写法(in-memory)的更多相关文章

  1. SQL Server 存储过程中处理多个查询条件的几种常见写法分析，我们该用那种写法

    本文出处: http://www.cnblogs.com/wy123/p/5958047.html 最近发现还有不少做开发的小伙伴,在写存储过程的时候,在参考已有的不同的写法时,往往很迷茫,不知道各种 ...

  2. 查询分页的几种Sql写法

    查询分页的几种Sql写法 摘自:http://www.cnblogs.com/zcttxs/archive/2012/04/01/2429151.html 1.创建测试环境,(插入100万条数据大概耗 ...

  3. 转--Android按钮单击事件的四种常用写法总结

    这篇文章主要介绍了Android按钮单击事件的四种常用写法总结,比较了常见的四种写法的优劣,有不错的参考借鉴价值,需要的朋友可以参考下     很多学习Android程序设计的人都会发现每个人对代码的 ...

  4. 代码片段--Makefile之大型工程项目子目录Makefile的一种通用写法

    转载:http://blog.csdn.net/mo_hui123456/article/details/8929615 管理Linux环境下的C/C++大型项目,如果有一个智能的Build Syst ...

  5. Makefile之大型工程项目子目录Makefile的一种通用写法

    管理Linux环境下的C/C++大型项目,如果有一个智能的Build System会起到事半功倍的效果,本文描述Linux环境下大型工程项目子目录Makefile的一种通用写法,使用该方法,当该子目录 ...

  6. Makefile之大型工程项目子目录Makefile的一种通用写法【转】

    转自:http://www.cnblogs.com/skyofbitbit/p/3680753.html 管理Linux环境下的C/C++大型项目,如果有一个智能的Build System会起到事半功 ...

  7. Android按钮单击事件的四种常用写法

    这篇文章主要介绍了Android按钮单击事件的四种常用写法总结,比较了常见的四种写法的优劣,有不错的参考借鉴价值,需要的朋友可以参考下 很多学习Android程序设计的人都会发现每个人对代码的写法都有 ...

  8. SQL Server 存储过程的几种常见写法分析，我们该用那种写法

    本文出处: http://www.cnblogs.com/wy123/p/5958047.html 最近发现还有不少做开发的小伙伴,在写存储过程的时候,在参考已有的不同的写法时,往往很迷茫,不知道各种 ...

  9. js中的三种函数写法

    js中的三种函数写法 <script type="text/javascript"> //普通的声明方式 function myFun(m,n){ alert(m+n) ...

随机推荐

  1. Android 4.0新组件：GridLayout详细说明

    于Android 4.0(API 14)它提供了一个新的组件GridLayout,它继承自Linearlayout,用于执行网络格样式布局. 在某些方面,GridLayout与TableLayout和 ...

  2. Scripting Java #3：Groovy与invokedynamic

    只需看看今天Groovy语言实现机制.在此之前,是第一个推倒静态类型与动态类型语言在实现上面的一些差异. 静态类型 vs. 动态类型 看以下这个简单的栗子. def addtwo(a, b) { re ...

  3. 输入框 js正则推断输入

    1.文本框仅仅能输入数字代码(小数点也不能输入)  <input onkeyup="this.value=this.value.replace(/\D/g,'')" onaf ...

  4. android-adb通用

  5. DataGridView大扩展——显示行号

    原文 DataGridView大扩展——显示行号 在DataGridView 的实际使用中,经常需要标示出行号,这样可以比较醒目地看到当前信息.不过DataGridView 在绘制 DataGridV ...

  6. Android 深入解析光传感器（二）

    光线传感器演示1        讲了一大堆的理论,那么以下的样例就来展示一下光线感应器的使用.为什么充分展现光感的用法,我这个样例写的很easy,仅仅写了使用光感必须的代码,然后用了几个textVie ...

  7. 带项目的一些体会以及合格的 Leader 应该具备什么特质？(转)

    许多项目有这样几种 Leader: 1. 泛泛而谈型 很多时候 Leader 仅仅给出一个大方向,提一些高屋建瓴的理论方向,事情还是交由普通开发人员去做.完了可能又会回头埋怨开发人员的水平不行,没有达 ...

  8. JAVA实现DAO基本层CRUD操作

    随着shh2各种操作方便框架.越来越多JAVA WEB效率,可是,假设在不了解这些框架使用的场合的情况下,一拿到项目就盲目地选择这些框架进行系统架构的搭建,就有可能造成非常多不是必需的资源浪费. 在项 ...

  9. Mac OS X Yosemite安装Hadoop 2.6记录

    整个安装过程分为四部分: 一.  安装Homebrew 二.  ssh localhost 三. 安装Hadoop已经进行配置文件设置 (伪分布式) 四. 执行栗子 一. 安装Homebrew 採用H ...

  10. Project_2007关键

    本人今天成功用这个密钥,安装project2007. 分享给着急的小伙伴们. W2JJW-4KYDP-2YMKW-FX36H-QYVD8 版权声明:本文博客原创文章.博客,未经同意,不得转载.