CRSF令牌干扰TDD - 是否存在存储csrf输出的变量?

时间:2016-02-23 16:03:52

标签: python django tdd csrf django-csrf

所以,我在Django中返回了一个失败的测试,当时将预期的html与实际的html与表单输入进行比较,所以我打印出结果并意识到差异是由{% csrf_token %}引起的相当简单的行,如下所示:

<input type='hidden' name='csrfmiddlewaretoken' value='hrPLKVOlhAIXmxcHI4XaFjqgEAMCTfUa' />

所以,我希望得到一个简单的答案,但我找不到它: 如何渲染csrf_token的结果以用于测试?

这是测试设置和失败:

def test_home_page_returns_correct_html_with_POST(self):
        request = HttpRequest()
        request.method = 'POST'
        request.POST['item_text'] = 'A new list item'

        response = home_page(request)

        self.assertIn('A new list item', response.content.decode())

        expected_html = render_to_string(
        'home.html',
        {'new_item_text': 'A new list item'},
******this is where I'm hoping for a simple one-line mapping******

    )
    self.assertEqual(response.content.decode(), expected_html)

这是来自views.py的渲染:

def home_page(request):
    return render(request, 'home.html', {
        'new_item_text': request.POST.get('item_text'),
    })

当我使用python manage.py test

运行测试时,测试失败了
FAIL: test_home_page_returns_correct_html_with_POST (lists.tests.HomePageTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:\Users\Me\PycharmProjects\superlists\lists\tests.py", line 29, in test_home_page_returns_correct_html_with_POST
    self.assertEqual(response.content.decode(), expected_html)
AssertionError: '<!DO[298 chars]     <input type=\'hidden\' name=\'csrfmiddlew[179 chars]tml>' != '<!DO[298 chars]     \n    </form>\n\n    <table
 id="id_list_t[82 chars]tml>'

----------------------------------------------------------------------

5 个答案:

答案 0 :(得分:5)

根据您提供的代码段判断,您似乎正在阅读“使用Python进行测试驱动开发”一书中的示例,但未使用Django 1.8。

本书谷歌小组讨论中的这篇文章解决了测试失败的问题,正如您所经历的那样:

https://groups.google.com/forum/#!topic/obey-the-testing-goat-book/fwY7ifEWKMU/discussion

此GitHub问题(来自本书的官方存储库)描述了与您的问题一致的修复:

https://github.com/hjwp/book-example/issues/8

答案 1 :(得分:3)

如果可以的话,我想使用the built-in Django test client提出一种更好的方法来执行此测试。这将为您处理所有CSRF检查,并且更易于使用。它看起来像这样:

def test_home_page_returns_correct_html_with_POST(self):
    url = reverse('your_home_page_view_url_name')
    response = self.client.post(url, {'item_text': 'A new list item'})
    self.assertContains(response, 'A new list item')

请注意,这也使用assertContains,这是一个断言provided by the Django test suite

答案 2 :(得分:2)

如果您使用Django TestCase类,CSRF令牌是您可用的模板上下文数据的一部分:

response = self.client.get(url)
print(response.context)

https://docs.djangoproject.com/en/1.9/topics/testing/tools/#django.test.Response

关键是csrf_token

https://docs.djangoproject.com/en/1.9/_modules/django/template/context_processors/

编辑: 正如您所问,如何将测试中呈现的HTML与测试服务器的输出进行比较:

由于您在模板中使用{% csrf_token %},因此无法在render_to_string方法的响应上下文中提供CSRF令牌,以使其使用相同的值。相反,您必须在render_to_string的结果中替换它,可能首先使用selenium查找输入元素(使其成为测试本身)。但是,这项测试的有用性值得怀疑。它只会有助于确保存在CSRF令牌,但无论如何都已在常规工作模式下检查服务器。

基本上,你应该测试你在代码中直接影响的任何东西,而不是Django魔法所提供的任何东西。例如。如果你正在进行自定义表单验证,你应该测试它,而不是Django给你带来的任何验证。如果要在ListViews中更改查询集(自定义过滤等)或在DetailViews中更改get_object(),则应根据自定义代码检查生成的列表和404错误。

答案 3 :(得分:0)

我也遇到了这个问题(根据该书的第二版,使用了最新的python 3.6.12和django 1.11.29)。

我的解决方案没有回答您的问题“我如何呈现令牌”,但确实回答了“我如何通过将呈现的模板与返回的视图响应进行比较的测试”。

我使用了以下代码:

class HomePageTest(TestCase):
    def remove_csrf_tag(self, text):
        '''Remove csrf tag from text'''
        return re.sub(r'<[^>]*csrfmiddlewaretoken[^>]*>', '', text)

    def test_home_page_is_about_todo_lists(self):
        # Make an HTTP request
        request = HttpRequest()

        # Call home page view function
        response = home_page(request)

        # Assess if response contains the HTML we're looking for

        # First read and open the template file ..
        expected_content = render_to_string('lists/home.html', request=request)

        print(len(response.content.decode()))

        # .. then check if response is equal to template file
        # (note that response is in bytecode, hence decode() method)
        self.assertEqual(
            self.remove_csrf_tag(response.content.decode()),
            self.remove_csrf_tag(expected_content),
        )

PS:我基于this answer.

答案 4 :(得分:0)

我遇到了类似的问题,所以做了一个函数来返回所有的 csrf 令牌。

def test_home_page_returns_correct_html(self):
    request = HttpRequest()

    # Removes all the csrf token strings
    def rem_csrf_token(string):
        # Will contain everything before the token
        startStr = ''
        # Will contain everything after the token
        endStr = ''
        # Will carrry the final output
        finalStr = string

        # The approach is to keep finding the csrf token and remove it from the final string until there is no
        # more token left and the str.index() method raises value arror
        try:
            while True:
                # The beginning of the csrf token
                ind = finalStr.index('<input type="hidden" name="csrfmiddlewaretoken"')
                # The token end index
                ind2 = finalStr.index('">', ind, finalStr.index('</form>'))

                # Slicing the start and end string
                startStr = finalStr[:ind]
                endStr = finalStr[ind2+2:]

                # Saving the final value (after removing one csrf token) and looping again
                finalStr = startStr +endStr
        except ValueError:
            # It will only be returned after all the tokens have been removed :)
            return finalStr

    response = home_page(request)
    expected_html = render_to_string('lists/home.html')
    csrf_free_response = rem_csrf_token(response.content.decode())

    self.assertEqual(csrf_free_response,
                    expected_html, f'{expected_html}\n{csrf_free_response}')