File: _test_renderers.py

package info (click to toggle)
python-djangorestframework-yaml 3.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 268 kB
  • sloc: python: 483; makefile: 11
file content (113 lines) | stat: -rw-r--r-- 3,362 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
from decimal import Decimal
from io import BytesIO

from django.test import TestCase
from rest_framework.relations import Hyperlink

from rest_framework_yaml.parsers import YAMLParser
from rest_framework_yaml.renderers import YAMLRenderer


class _YAMLRendererTests(TestCase):
    """Tests specific to the YAML Renderer."""

    def test_render(self) -> None:
        """
        Rendering test.

        Given:
            - A simple dict with a list of strings
            - The YAML representation of that dict as a string
        Do:
            - Render the dict to YAML
        Expect:
            - The YAML string to be the same as the original YAML string
        """
        _yaml_repr = "foo:\n- bar\n- baz\n"

        obj = {"foo": ["bar", "baz"]}

        renderer = YAMLRenderer()
        content = renderer.render(obj, "application/yaml")

        self.assertEqual(content.decode("utf-8"), _yaml_repr)

    def test_render_and_parse(self) -> None:
        """
        Rendering and parsing test.

        Given:
            - A simple dict with a list of strings
        Do:
            - Render the dict to YAML
            - Parse the YAML back to a dict
        Expect:
            - The parsed dict to be the same as the original dict
        """
        obj = {"foo": ["bar", "baz"]}

        renderer = YAMLRenderer()
        parser = YAMLParser()

        content = renderer.render(obj, "application/yaml")
        data = parser.parse(BytesIO(content))
        self.assertEqual(obj, data)

    def test_render_decimal(self) -> None:
        """
        YAML decimal rendering test.

        Given:
            - A dict with a decimal
        Do:
            - Render the dict to YAML
        Expect:
            - The YAML string to contain the decimal as a string
        """
        renderer = YAMLRenderer()
        content = renderer.render(
            {"field": Decimal("111.2")},
            "application/yaml",
        )
        self.assertIn("field: '111.2'", content.decode("utf-8"))

    def test_render_hyperlink(self) -> None:
        """
        YAML Hyperlink rendering test.

        Given:
            - A dict with a Hyperlink
        Do:
            - Render the dict to YAML
        Expect:
            - The YAML string to contain the Hyperlink as a string
        """
        renderer = YAMLRenderer()
        content = renderer.render(
            {"field": Hyperlink("http://pépé.com?great-answer=42", "test")},
            "application/yaml",
        )
        self.assertIn(
            "field: http://pépé.com?great-answer=42",
            content.decode("utf-8"),
        )

    def test_proper_encoding(self) -> None:
        """
        YAML encoding test.

        Given:
            - A dict with a list of strings with non-ascii characters
        Do:
            - Render the dict to YAML
        Expect:
            - The YAML string to be the same as the original YAML string.
            - The YAML string to be encoded in utf-8 and
              contain the non-ascii characters.

        """
        _yaml_repr = "countries:\n- United Kingdom\n- France\n- España"
        obj = {"countries": ["United Kingdom", "France", "España"]}
        renderer = YAMLRenderer()
        content = renderer.render(obj, "application/yaml")
        self.assertEqual(content.strip(), _yaml_repr.encode("utf-8"))