Django Testing——检查重定向视图的消息

Question

我一直在为我的一个django应用程序编写测试，并且一直在寻找解决这个问题相当长的一段时间了。我有一个视图，在不同的情况下使用django.contrib.messages发送消息。视图如下所示。

from django.contrib import messages
from django.shortcuts import redirect
import custom_messages
def some_view(request):
    """ This is a sample view for testing purposes.
    """
    some_condition = models.SomeModel.objects.get_or_none(
        condition=some_condition)
    if some_condition:
        messages.success(request, custom_message.SUCCESS)
    else:
        messages.error(request, custom_message.ERROR)
    redirect(some_other_view)

现在，当测试这个视图时，client.get的响应不包含包含messages的context字典，因为这个视图使用了重定向。对于呈现模板的视图，我们可以使用messages = response.context.get('messages')访问消息列表。我们如何获得访问messages的视图重定向?

Answer 1

在client.get()调用中使用follow=True选项，客户端将遵循重定向。然后，您可以测试消息是否在您重定向到的视图的上下文中。

def test_some_view(self):
    # use follow=True to follow redirect
    response = self.client.get('/some-url/', follow=True)
    # don't really need to check status code because assertRedirects will check it
    self.assertEqual(response.status_code, 200)
    self.assertRedirects(response, '/some-other-url/')
    # get message from context and check that expected text is there
    message = list(response.context.get('messages'))[0]
    self.assertEqual(message.tags, "success")
    self.assertTrue("success text" in message.message)

Answer 2

您可以使用get_messages()作为响应。wsgi_request像这样(在Django 1.10中测试过):

from django.contrib.messages import get_messages  
...
def test_view(self):
    response = self.client.get('/some-url/') # you don't need follow=True
    self.assertRedirects(response, '/some-other-url/')
    # each element is an instance of  django.contrib.messages.storage.base.Message
    all_messages = [msg for msg in get_messages(response.wsgi_request)]
    # here's how you test the first message
    self.assertEqual(all_messages[0].tags, "success")
    self.assertEqual(all_messages[0].message, "you have done well")

Answer 3

如果您的视图正在重定向，并且在对测试客户机的请求中使用follow=true，则上述操作不起作用。最后，我编写了一个辅助函数来获取随响应发送的第一条(在我的例子中是唯一一条)消息。

@classmethod
def getmessage(cls, response):
    """Helper method to return message from response """
    for c in response.context:
        message = [m for m in c.get('messages')][0]
        if message:
            return message

将它包含在测试类中，并像这样使用:

message = self.getmessage(response)

其中response是你从get或post到Client得到的值。

这有点脆弱，但希望它能为其他人节省一些时间。

Answer 4

我在使用第三方应用程序时遇到了同样的问题。

如果你想从另一个视图中返回HttpResponseRedict(你不能从其中访问上下文)的视图中获取消息，你可以使用get_messages(request)

from django.contrib.messages import get_messages  
storage = get_messages(request)  
for message in storage:  
    do_something_with_the_message(message)  

这将清除消息存储，因此如果您希望稍后从模板访问消息，请添加:

storage.used = False

Answer 5

另一种模拟消息的方法(不需要遵循重定向):

from mock import ANY, patch
from django.contrib import messages
@patch('myapp.views.messages.add_message')
def test_some_view(self, mock_add_message):
    r = self.client.get('/some-url/')
    mock_add_message.assert_called_once_with(ANY, messages.ERROR, 'Expected message.')  # or assert_called_with, assert_has_calls...