Testing

Testing

REST框架包括几个帮助类,可以扩展Django现有的测试框架,并改进对API请求的支持。

APIRequestFactory

扩展 Django 现有的 RequestFactory class.

Creating test requests

APIRequestFactory类支持与Django标准的RequestFactory类几乎相同的API。这意味着标准的.get(), .post(), .put(), .patch(), .delete(), .head() 和.options()方法都是可用的。

from rest_framework.test import APIRequestFactory

# Using the standard RequestFactory API to create a form POST request
factory = APIRequestFactory()
request = factory.post('/notes/', {'title': 'new idea'})
Using the format argument

创建请求体的方法,例如post, put 和 patch,包含一个 format 参数,这使得使用除多表单数据之外的内容类型可以轻松生成请求。 例如:

# Create a JSON POST request
factory = APIRequestFactory()
request = factory.post('/notes/', {'title': 'new idea'}, format='json')

默认可使用的格式有 'multipart''json'。为了与Django现有的 RequestFactory 兼容,默认格式为 'multipart'
要支持更广泛的请求格式或更改默认格式,请参阅配置部分.

Explicitly encoding the request body

如果请求体中需要明确的编码,你可以设置 content_type 标志。例如:

request = factory.post('/notes/', json.dumps({'title': 'new idea'}), content_type='application/json')
PUT and PATCH with form data

Django RequestFactory和REST框架APIRequestFactory之间值得注意的一个区别是,多表单数据将被编码用于除.post()以外的方法。
例如,使用APIRequestFactory,您可以像这样做一个PUT的表单请求:

factory = APIRequestFactory()
request = factory.put('/notes/547/', {'title': 'remember to email dave'})

使用Django的RequestFactory,您需要自己对数据进行显式编码:

from django.test.client import encode_multipart, RequestFactory

factory = RequestFactory()
data = {'title': 'remember to email dave'}
content = encode_multipart('BoUnDaRyStRiNg', data)
content_type = 'multipart/form-data; boundary=BoUnDaRyStRiNg'
request = factory.put('/notes/547/', content, content_type=content_type)

Forcing authentication

当直接使用请求工厂测试视图时,能够直接验证请求通常很方便,而不必构建正确的身份验证凭据。
要强制验证请求,请使用force_authenticate()方法。

from rest_framework.test import force_authenticate

factory = APIRequestFactory()
user = User.objects.get(username='olivia')
view = AccountDetail.as_view()

# Make an authenticated request to the view...
request = factory.get('/accounts/django-superstars/')
force_authenticate(request, user=user)
response = view(request)`

该方法的签名是 force_authenticate(request,user = None,token = None)。 进行调用时,可以设置用户和令牌中的一个或两者。

例如,当使用令牌进行强制身份验证时,可能会执行以下操作:

user = User.objects.get(username='olivia')
request = factory.get('/accounts/django-superstars/')
force_authenticate(request, user=user, token=user.token)

Note:当使用 APIRequestFactory时,返回的是Django标准的 HttpRequest,而不是Rest framwork 的Request对象,该对象只有在生成视图时生成。
这意味着直接在请求对象上设置属性可能并不总是具有你所期望的效果。 例如,直接设置.token将不起作用,直接使用.user只会在会话认证认证时有用。

# Request will only authenticate if `SessionAuthentication` is in use.
request = factory.get('/accounts/django-superstars/')
request.user = user
response = view(request)

Forcing CSRF validation

默认情况下,使用APIRequestFactory创建的请求在传递到REST框架视图时不会应用CSRF验证。 如果需要明确地打开CSRF验证,可以在实例化工厂时设置enforce_csrf_checks标志。

factory = APIRequestFactory(enforce_csrf_checks=True)

Note:值得注意的是,Django的标准RequestFactory不需要包含此选项,因为当使用常规Django时,CSRF验证发生在中间件中,直接测试视图时不会运行。 当使用REST框架时,CSRF验证在视图中进行,因此请求工厂需要禁用视图级别的CSRF检查。

APIClient

扩展了 Django 现有的 Client class.

Making requests

APIClinet 类支持与 Django标准的Client类相同的接口。这意味标准的.get(), .post(), .put(), .patch(), .delete(), .head() 和 .options() 方法都是可用的。例如:

from rest_framework.test import APIClient

client = APIClient()
client.post('/notes/', {'title': 'new idea'}, format='json')

要支持更广泛的请求格式或者改变默认格式,请参阅配置部分

Authenticating

.login(**kwargs)
登录方法的功能与Django的常规Client类完全相同。 这允许您针对包括SessionAuthentication在内的任何视图验证请求。

# Make all requests in the context of a logged in session.
client = APIClient()
client.login(username='lauren', password='secret')

登出是通常调用 logout 方法。

# Log out
client.logout()

登录方法适用于测试使用会话认证的API,例如包含AJAX与API交互的网站。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,258评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,335评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,225评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,126评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,140评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,098评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,018评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,857评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,298评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,518评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,400评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,993评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,638评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,661评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • Django: csrf防御机制 csrf攻击过程 1.用户C打开浏览器,访问受信任网站A,输入用户名和密码请求登...
    lijun_m阅读 1,057评论 0 0
  • RxSwift_v1.0笔记——16 Testing with RxTest 100分 以上这是给你的,为了表扬你...
    大灰很阅读 1,266评论 0 1
  • Unit Test What 什么是单元测试 Why 为什么要做单元测试 How 怎么做单元测试 What is ...
    Qingzh阅读 522评论 0 1
  • Hit-testing翻译为中文是"命中测试",是确定touch-point是否在一个View内的过程,最终命中的...
    iOneWay阅读 1,195评论 1 8