如何在Python中模拟SendGrid方法
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了如何在Python中模拟SendGrid方法，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含6390字，纯文字阅读大概需要10分钟。
内容图文
我正在尝试在我的Flask视图函数中模拟SendGrid方法,以便它在测试期间不发送电子邮件.当我运行下面的代码时,我得到一个错误’ImportError：没有名为sg的模块’.如何正确配置’sg’方法,以便在测试中找到它？
# test_helpers.py
from unittest import TestCase
from views import app
class PhotogTestCase(TestCase):
def setUp(self):
app.config['WTF_CSRF_ENABLED'] = False
app.config['TESTING'] = True
self.app = app
self.client = app.test_client()
# test_views.py
import mock
from test_helpers import PhotogTestCase
import sendgrid
class TestAddUser(PhotogTestCase):
sg = sendgrid.SendGridClient(app.config['SENDGRID_API_KEY'])
@mock.patch('sg.send')
def test_add_user_page_loads(self, mocked_send):
mocked_send.return_value = None # Do nothing on send
resp = self.client.post('/add_user', data={
'email': 'joe@hotmail.com'
}, follow_redirects=True)
assert 'Wow' in resp.data
# views.py
import sendgrid
from itsdangerous import URLSafeTimedSerializer
from flask import Flask, redirect, render_template, \
request, url_for, flash, current_app, abort
from flask.ext.stormpath import login_required
from forms import RegistrationForm, AddContactForm, \
AddUserForm
@app.route('/add_user', methods=['GET', 'POST'])
@login_required
def add_user():
"""
Send invite email with token to invited user
"""
form = AddUserForm()
if form.validate_on_submit():
# token serializer
ts = URLSafeTimedSerializer(app.config['SECRET_KEY'])
email = request.form['email']
tenant_id = user.custom_data['tenant_id']
# create token containing email and tenant_id
token = ts.dumps([email, tenant_id])
# create url with token, e.g. /add_user_confirm/asdf-asd-fasdf
confirm_url = url_for(
'add_user_confirm',
token=token,
_external=True)
try:
# sendgrid setup
sg = sendgrid.SendGridClient(
app.config['SENDGRID_API_KEY'],
raise_errors=True
)
# email setup
message = sendgrid.Mail(
to=request.form['email'],
subject='Account Invitation',
html='You have been invited to set up an account on PhotogApp. Click here: ' + confirm_url,
from_email='support@photogapp.com'
)
# send email
status, msg = sg.send(message)
flash('Invite sent successfully.')
return render_template('dashboard/add_user_complete.html')
return render_template('dashboard/add_user.html', form=form)
解决方法:
说明
必须针对您测试的位置实施模拟,而不是实现方法的位置.或者,在您的情况下,从unittest模拟sg对象将不起作用.
所以,我不确定你的项目结构是什么.但希望这个例子有所帮助.
您需要确保您还引用了要模拟的类的适当位置,以正确模拟其方法.
解
那么,让我们假设您正在从test.py运行测试：
test.py
your_app/
views.py
tests/
all_your_tests.py
在views.py中,您导入的发送方式如下：
from module_holding_your_class import SendGridClient
所以,看看你的mock.patch,它应该是这样的：
@mock.patch('your_app.views.SendGridClient.send')
def test_add_user_page_loads(self, mocked_send):
如您所见,您从test.py运行,因此您的导入是从那里引用的.这就是我建议你在实际运行实际代码的地方运行测试的地方,这样你就不必乱用你的导入了.
此外,您正在模拟您在views.py中调用的发送.
这应该工作.让我知道这是怎么回事.
额外信息：模拟类的实例
因此,根据您的代码,如果您实际模拟了类的实例,那么对您来说可能会更有益.这样,您可以非常轻松地在SendGridClient实例的单个模拟中测试所有方法,甚至是Mail.这样,您可以专注于方法的显式行为,而无需担心外部功能.
要完成模拟类的实例(或者在你的情况下是两个),你将不得不做这样的事情(内联解释)
*此具体示例未经测试,可能不完整.目标是让您了解如何操作模拟和数据以帮助您进行测试.
再往下面,我有一个经过充分测试的例子来玩.*
@mock.patch('your_app.views.Mail')
@mock.patch('your_app.views.SendGridClient')
def test_add_user_page_loads(self, m_sendgridclient, m_mail):
# get an instance of Mock()
mock_sgc_obj = mock.Mock()
mock_mail_obj = mock.Mock()
# the return of your mocked SendGridClient will now be a Mock()
m_sendgridclient.return_value = mock_sgc_obj
# the return of your mocked Mail will now be a Mock()
m_mail.return_value = mock_mail_obj
# Make your actual call
resp = self.client.post('/add_user', data={
'email': 'joe@hotmail.com'
}, follow_redirects=True)
# perform all your tests
# example
self.assertEqual(mock_sgc_obj.send.call_count, 1)
# make sure that send was also called with an instance of Mail.
mock_sgc_obj.assert_called_once_with(mock_mail_obj)
根据您提供的代码,我不确定Mail究竟返回了什么.我假设它是Mail的一个对象.如果是这种情况,那么上述测试用例就足够了.但是,如果您要测试消息本身的内容并确保每个对象属性中的数据都是正确的,我强烈建议将您的单元测试分开以在Mail类中处理它,并确保数据的行为符合预期.
这个想法是你的add_user方法不应该关心验证那些数据.就是用对象调用了.
此外,在send方法本身内部,您可以在其中进一步进行单元测试,以确保相应地处理您输入到方法的数据.这会让你的生活更轻松.
例
这是我在一起测试的一个例子,我希望这将有助于进一步澄清这一点.您可以将其粘贴到编辑器中并运行它.注意我对__main__的使用,它是指示我在哪里嘲笑.在这种情况下,它是__main__.
另外,我会使用side_effect和return_value(查看我的示例)来查看两者之间的不同行为. side_effect将返回被执行的内容.在您的情况下,您希望看到执行方法send时会发生什么.
每个单元测试都以不同的方式进行模拟,并展示您可以应用的不同用例.
import unittest
from unittest import mock
class Doo(object):
def __init__(self, stuff="", other_stuff=""):
pass
class Boo(object):
def d(self):
return 'the d'
def e(self):
return 'the e'
class Foo(object):
data = "some data"
other_data = "other data"
def t(self):
b = Boo()
res = b.d()
b.e()
return res
def do_it(self):
s = Stuff('winner')
s.did_it(s)
def make_a_doo(self):
Doo(stuff=self.data, other_stuff=self.other_data)
class Stuff(object):
def __init__(self, winner):
self.winner = winner
def did_it(self, a_var):
return 'a_var'
class TestIt(unittest.TestCase):
def setUp(self):
self.f = Foo()
@mock.patch('__main__.Boo.d')
def test_it(self, m_d):
'''
note in this test, one of the methods is not mocked.
'''
#m_d.return_value = "bob"
m_d.side_effect = lambda: "bob"
res = self.f.t()
self.assertEqual(res, "bob")
@mock.patch('__main__.Boo')
def test_them(self, m_boo):
mock_boo_obj = mock.Mock()
m_boo.return_value = mock_boo_obj
self.f.t()
self.assertEqual(mock_boo_obj.d.call_count, 1)
self.assertEqual(mock_boo_obj.e.call_count, 1)
@mock.patch('__main__.Stuff')
def test_them_again(self, m_stuff):
mock_stuff_obj = mock.Mock()
m_stuff.return_value = mock_stuff_obj
self.f.do_it()
mock_stuff_obj.did_it.assert_called_once_with(mock_stuff_obj)
self.assertEqual(mock_stuff_obj.did_it.call_count, 1)
@mock.patch('__main__.Doo')
def test_them(self, m_doo):
self.f.data = "fake_data"
self.f.other_data = "some_other_fake_data"
self.f.make_a_doo()
m_doo.assert_called_once_with(
stuff="fake_data", other_stuff="some_other_fake_data"
)
if __name__ == '__main__':
unittest.main()
内容总结
以上是互联网集市为您收集整理的如何在Python中模拟SendGrid方法全部内容，希望文章能够帮你解决如何在Python中模拟SendGrid方法所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。