diff options
| author | Tom Christie | 2013-05-29 08:57:11 +0100 |
|---|---|---|
| committer | Tom Christie | 2013-05-29 08:57:11 +0100 |
| commit | cb49c5d3c01493ddb9b06b8ab0bdcca01cb7c633 (patch) | |
| tree | f1bd3680c6fdce39ec300f661f89928a2034fae9 /rest_framework/tests/test_description.py | |
| parent | 100a168a0b9e65ab6a0e975e83bdf8251711a59e (diff) | |
| download | django-rest-framework-cb49c5d3c01493ddb9b06b8ab0bdcca01cb7c633.tar.bz2 | |
Rename test modules to 1.6 style
Diffstat (limited to 'rest_framework/tests/test_description.py')
| -rw-r--r-- | rest_framework/tests/test_description.py | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/rest_framework/tests/test_description.py b/rest_framework/tests/test_description.py new file mode 100644 index 00000000..52c1a34c --- /dev/null +++ b/rest_framework/tests/test_description.py @@ -0,0 +1,108 @@ +# -- coding: utf-8 -- + +from __future__ import unicode_literals +from django.test import TestCase +from rest_framework.views import APIView +from rest_framework.compat import apply_markdown +from rest_framework.utils.formatting import get_view_name, get_view_description + +# We check that docstrings get nicely un-indented. +DESCRIPTION = """an example docstring +==================== + +* list +* list + +another header +-------------- + + code block + +indented + +# hash style header #""" + +# If markdown is installed we also test it's working +# (and that our wrapped forces '=' to h2 and '-' to h3) + +# We support markdown < 2.1 and markdown >= 2.1 +MARKED_DOWN_lt_21 = """<h2>an example docstring</h2> +<ul> +<li>list</li> +<li>list</li> +</ul> +<h3>another header</h3> +<pre><code>code block +</code></pre> +<p>indented</p> +<h2 id="hash_style_header">hash style header</h2>""" + +MARKED_DOWN_gte_21 = """<h2 id="an-example-docstring">an example docstring</h2> +<ul> +<li>list</li> +<li>list</li> +</ul> +<h3 id="another-header">another header</h3> +<pre><code>code block +</code></pre> +<p>indented</p> +<h2 id="hash-style-header">hash style header</h2>""" + + +class TestViewNamesAndDescriptions(TestCase): + def test_view_name_uses_class_name(self): + """ + Ensure view names are based on the class name. + """ + class MockView(APIView): + pass + self.assertEqual(get_view_name(MockView), 'Mock') + + def test_view_description_uses_docstring(self): + """Ensure view descriptions are based on the docstring.""" + class MockView(APIView): + """an example docstring + ==================== + + * list + * list + + another header + -------------- + + code block + + indented + + # hash style header #""" + + self.assertEqual(get_view_description(MockView), DESCRIPTION) + + def test_view_description_supports_unicode(self): + """ + Unicode in docstrings should be respected. + """ + + class MockView(APIView): + """Проверка""" + pass + + self.assertEqual(get_view_description(MockView), "Проверка") + + def test_view_description_can_be_empty(self): + """ + Ensure that if a view has no docstring, + then it's description is the empty string. + """ + class MockView(APIView): + pass + self.assertEqual(get_view_description(MockView), '') + + def test_markdown(self): + """ + Ensure markdown to HTML works as expected. + """ + if apply_markdown: + gte_21_match = apply_markdown(DESCRIPTION) == MARKED_DOWN_gte_21 + lt_21_match = apply_markdown(DESCRIPTION) == MARKED_DOWN_lt_21 + self.assertTrue(gte_21_match or lt_21_match) |
