如何在Python中模拟SendGrid方法

我试图在Flask view函数中模拟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('your_app.views.SendGridClient.send')
def test_add_user_page_loads(self, mocked_send):

因此，要查看mock.patch，它应该如下所示：

from module_holding_your_class import SendGridClient

@mock.patch('your_app.views.SendGridClient.send')
def test_add_user_page_loads(self, mocked_send):

如您所见，您是从test.py运行的，因此您的导入是从那里引用的。在这里，我建议您根据实际运行代码的位置来运行测试，这样您就不必乱搞导入了

此外，您正在模拟在views.py中调用的

send

这应该行得通。让我知道进展如何

额外信息：模拟类的实例 因此，基于您的代码，如果您实际模拟了类的一个实例，可能会对您更有利。通过这种方式，您可以非常轻松地在

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)

根据您提供的代码，我不确定

邮件

返回的确切内容。我假设它是

邮件

的对象。如果是这样，那么上面的测试用例就足够了。但是，如果您希望测试

消息

本身的内容，并确保每个对象属性中的数据都是正确的，我强烈建议您分离unittests，以便在

邮件

类中处理它，并确保数据按预期运行

其思想是，您的

add\u user

方法不应该关心验证该数据。只是对该对象进行了调用

此外，在send方法本身内部，您可以在那里进一步进行unittest，以确保您输入到该方法的数据得到相应的处理。这会让你的生活更轻松

例子 下面是一个我测试过的例子，我希望这将有助于进一步澄清这一点。您可以将其复制粘贴到编辑器中并运行它。注意我使用的

\uuuuu main\uuuuu

，这是为了表明我在哪里进行模拟。在这种情况下，它是

\uuuuu main\uuuu

此外，我还会研究

副作用

和

返回值

（请看我的示例），以了解两者之间的不同行为<代码>副作用将返回执行的内容。在本例中，您希望看到在执行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()

---

这太完美了，谢谢！我没有意识到我需要引用在views.py中导入的实际方法。是否有办法捕获sg.send（message）消息部分的数据？@Casey请告诉我您对我的更新的看法。这里只是一个关于你想如何看待你的信息内容的旁注。您应该了解如何使用fixture来设置示例模板，并确保您的方法根据您的期望相应地处理数据。让我知道这是否有意义。这是有意义的，非常有用。“我还在弄清楚如何组织我的测试，所以我会考虑将我的初始用户设置转移到夹具中。”Casey。看一看，我做了另一个更新。当您想要测试“消息”数据时，它实际上会帮助您。你可以用另一种方式来考虑。您可以测试以确保使用正确的参数调用了

Mail

。因此，如果您查看我更新的示例并查看

def test\u它们的测试用例

。你会看到我在做什么。我只是测试该类是否使用正确的参数调用。我认为这对你也会有帮助。