django单元测试

 

 

django 单元测试小结

django 测试

---

从前很少写单元测试了，特别是web应用。最近不知不觉喜欢起来这个事情了，发现单元测试对于软件的模块，正交性有很大促进作用，因为函数，模块写的不合理，单元测试写起来就麻烦的多呀。公司的项目一直都是用Django，所以写点django单元测试的小总结，记录为主，备查。

 

测试的场景

框架Django1.8 测试工具 unittest, 要记得给test设置一个独特的settings。

1. 测试请求 也就是测试整个view部分 官方案例 其中可能会遇到登录，或者时session怎么模拟的问题

2. 测试带有orm的模块

3. 需要mock的测试，比较多的情况是有第三方API调用, 发邮件，发短信这种

unittest提供的断言种类挺多,但是经常用的也就几个 self.assertContains, self.assertEqual, self.assertTrue

顺便提下有用的选项(我这里是单独给测试写了一个settings), 为了提高测试速度，可以把用不到的中间件，installed_apps之类的多余配置给去掉。

 

1. 测试全部用例
2. python manage.py test --setting settings_test
4. 测试某个APP
5. python manage.py test appname --setting settings_test
7. 测试某个app下的TeseCase类
8. python manage.py test alarm.tests.ModelTestCase--setting settings_test
10. -v {1,2,3}数字越大，显示的输出越详细，测试的日志信息
11. python manage.py test --setting settings_test -v3
13. 其他的选项请查看--help
14. python manage.py test --help

 

用请求测试 views函数

DJANGO中提供了Client类来模拟http请求，可以模拟不同的method，然后就是请求参数的模拟，用起来很方面。

 

1. #coding:utf-8
2. from django.test importTestCase,Client
4. from sendviews import*
5. from core.tests import create_user
8. classSendviewsTestCase(TestCase):
10. def setUp(self):
11. self.user = create_user()
12. self.device =Device(hostname="CN-BJ-0000-00",
13. mac="ff:ff:ff:ff:ff:ff", user=self.user).save()
15. def test_creat_sms(self):
16. c =Client()
17. rep = c.post("/acquireportal/createsms",{"phone":"13988902345",
18. "ssid":"erya",
19. "dmac":"ff:ff:ff:ff:ff:ff"})
20. # 测试http请求的返回码是否正确
21. self.assertEqual(rep.status_code,200)
22. # 测试response的内容是否包含字符串
23. self.assertContains(rep,"OK")
24. # 测试response的内容是否包含字符串 方法二
25. self.assertTrue('OK'in rep.content)

• 操作 session，例如用户登录，特殊的session值

 

1. from django.test importClient
3. def init_client(user):
4. client =Client()
5. client.login(username=user.username, password="lzz")
6. s = client.session
7. s['cur_user_id']= user.id
8. s.save()
9. return client

• 增加header

 

1. from django.test.utils import setup_test_environment
2. setup_test_environment()
3. from django.test.client importClient
4. c =Client()
6. # get 请求，带参数，并增加header
7. c.get('/some/path/',{'qs_param':'foo'},**{'HTTP_USER_AGENT':'silly-human','REMOTE_ADDR':'127.0.0.1'})
9. #get 请求，没有带参数，自定义headers
10. c.get('/some/path/',**{'HTTP_USER_AGENT':'silly-human','REMOTE_ADDR':'127.0.0.1'})

• 使用 RequestFactory 对象来进行测试，不是从 http client来发起，某些情况会用到

 

1. from django.test importTestCase,RequestFactory
2. from django.http importHttpResponse
3. from util.sign import generate_sign, validate_sign
4. from util.decorators import apiauth_required, SIGN_KEY
6. @apiauth_required()
7. def simpleapi(request):
8. returnHttpResponse('ok')
11. classDecoratorsTestCase(TestCase):
13. def setUp(self):
14. self.factory =RequestFactory()
16. def test_apiauth(self):
17. # create request object
18. key = SIGN_KEY
19. query_string ={u"name": u"lzz", u"age": u"20", u"data": u"[python, java, golang, lua]"}
20. token = generate_sign(query_string, key)
21. query_string.update({u"sign": token})
22. req =self.factory.post("/api/test", data=query_string)
23. response = simpleapi(req)
24. self.assertEqual(response.status_code,200)

• HTML 文本测试，使用 constants 来判断并不是个好的选择，可以用render之后的字符串对比。

对于需要登陆的view，有client也比较容易操作，还有一些特殊的session的检测等, 我这里做了一个简单的封装

 

1. from django.test importClient
3. def init_client(user):
4. client =Client()
5. client.login(username=user.username, password="lzz")
6. s = client.session
7. s['cur_user_id']= user.id
8. s.save()
9. return client

 

带有mock的测试

对模块中的方法mock或者是对一个对象中的方法进行mock。真对测试函数中一些无法直接测试的函数设置默认的返回值, py3标准库中已经有了mock模块，py2需要自己安装, 推荐教程 使用Pyhton Mock进行单元测试1。 下面是个实际的代码片段。

 

1. import mock
2. from django.test importTestCase
3. from core.models importTenant
4. from alarm.models import*
5. from.controler importTenantAlarm
7. classModelTestCase(TestCase):
8. def setUp(self):
9. self.tenant =Tenant.objects.create(domainname="erya", comname=u"尔雅")
11. @mock.patch.object(TenantAlarm,"sendAlarm")
12. def test_record_alarm(self, mock_method):
13. # record_alarm 这个中会调用sendAlarm方法
14. mock_method.return_value =None
15. content ="ccccc"
16. atype =0
17. rec_uid =0
18. Alarm().record_alarm(content=content, atype=0,
19. rec_tid=self.tenant.id)
22. classTenantAlarmTestCase(TestCase):
23. def setUp(self):
24. self.tenant =Tenant.objects.create(domainname="erya", comname=u"尔雅")
26. @mock.patch.object(TenantAlarm,"sendSMS", return_value=None)
27. @mock.patch.object(TenantAlarm,"sendEmail", return_value=None)
28. def test_send_alarm(self, method1, method2):
29. content = u"报警了"
30. ta =TenantAlarm(self.tenant.id, content,{u'SMS':0, u'EMAIL':0})
31. ta.sendAlarm()
33. @mock.patch('util.sendsms_com.send', return_value=1)
34. def test_sendsms(self, send):
35. ta =TenantAlarm(self.tenant.id,self.content,{u'SMS':0, u'EMAIL':0})
36. ta.sendSMS()
37. self.assertEqual(0,Account.objects.get(tenant=self.tenant).sms_num)
38. self.account.sms_num =100
39. self.account.save()
40. ta.sendSMS()
41. self.assertEqual(99,Account.objects.get(tenant=self.tenant).sms_num)

 

coverage

coverage是一个检查单元测试覆盖率的工具，django的文档中也有简要的说明coverage的集成 文档地址

 

1. #测试并收集测试信息
2. coverage run --source='.' manage.py test --setting mandela.settings_test
3. #查看测试结果
4. coverage report -m
5. NameStmtsMissCoverMissing
6. ----------------------------------------------------------------------------------------
7. acquireportal/__init__.py 00100%
8. acquireportal/controler.py 654728%22-56,60-71,76-79
9. acquireportal/migrations/0001_initial.py 60100%
10. acquireportal/migrations/0002_auto_20160622_1059.py 60100%
11. acquireportal/migrations/0003_auto_20160622_1100.py 50100%
12. ....
14. ----------------------------------------------------------------------------------------
15. TOTAL 8013585827%

覆盖率挺低的