File: test_pretty_print.py

package info (click to toggle)
python-gvm 26.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,132 kB
  • sloc: python: 44,662; makefile: 18
file content (169 lines) | stat: -rw-r--r-- 4,993 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# SPDX-FileCopyrightText: 2019-2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#

import sys
import unittest
from io import StringIO
from unittest.mock import patch

from pontos.testing import temp_directory

from gvm.errors import InvalidArgumentType
from gvm.xml import parse_xml, pretty_print


class PrettyPrintTestCase(unittest.TestCase):
    def test_pretty_print_to_file(self):
        xml_str = '<test><this><with id="a">and text</with></this></test>'
        elem = parse_xml(xml_str)
        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
        )

        with temp_directory() as temp_dir:
            test_file = temp_dir / "test.file"
            with test_file.open("w", encoding="utf-8") as f:
                pretty_print(elem, file=f)

            xml_string = test_file.read_text(encoding="utf-8")

        self.assertEqual(xml_string, expected_xml_string)

    def test_pretty_print_to_stringio(self):
        xml_str = '<test><this><with id="a">and text</with></this></test>'
        elem = parse_xml(xml_str)
        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
        )

        stringio = StringIO()
        pretty_print(elem, file=stringio)

        xml_string = stringio.getvalue()

        self.assertEqual(xml_string, expected_xml_string)

    # I don't know why: But this test is only working if sys.stdout is passed.
    # But printing to sys.stdout is working, too using the default argument ...
    @patch("sys.stdout", new_callable=StringIO)
    def test_pretty_print_to_stdout(self, mock_stdout):
        xml_str = '<test><this><with id="a">and text</with></this></test>'
        elem = parse_xml(xml_str)
        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
        )

        pretty_print(elem, sys.stdout)
        xml_string = mock_stdout.getvalue()

        self.assertEqual(xml_string, expected_xml_string)

    def test_pretty_print_with_string(self):
        xml_str = '<test><this><with id="a">and text</with></this></test>'

        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
        )

        stringio = StringIO()
        pretty_print(xml_str, file=stringio)

        xml_string = stringio.getvalue()

        self.assertEqual(xml_string, expected_xml_string)

    @patch("sys.stdout", new_callable=StringIO)
    def test_pretty_print_with_string_to_stdout(self, mock_stdout):
        xml_str = '<test><this><with id="a">and text</with></this></test>'

        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
        )

        pretty_print(xml_str, sys.stdout)
        xml_string = mock_stdout.getvalue()

        self.assertEqual(xml_string, expected_xml_string)

    def test_pretty_print_with_dict(self):
        xml_str = '<test><this><with id="a">and text</with></this></test>'
        elem = parse_xml(xml_str)
        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
        )

        stringio = StringIO()
        pretty_print([elem, elem], file=stringio)

        xml_string = stringio.getvalue()

        self.assertEqual(xml_string, expected_xml_string)

    def test_pretty_print_with_dict_str(self):
        xml_str = '<test><this><with id="a">and text</with></this></test>'
        no_xml = "</test>"
        elem = parse_xml(xml_str)
        expected_xml_string = (
            "<test>\n"
            "  <this>\n"
            '    <with id="a">and text</with>\n'
            "  </this>\n"
            "</test>\n"
            "</test>\n"
        )

        stringio = StringIO()
        pretty_print([elem, no_xml], file=stringio)

        xml_string = stringio.getvalue()

        self.assertEqual(xml_string, expected_xml_string)

    def test_pretty_print_no_xml(self):
        number = 1
        stringio = StringIO()

        with self.assertRaises(InvalidArgumentType):
            pretty_print(number, file=stringio)

    def test_pretty_print_type_error(self):
        xml_str = '<test><this><with id="a">and text</with></this></test>'
        elem = parse_xml(xml_str)

        with self.assertRaises(TypeError):
            pretty_print(elem, file="string")


if __name__ == "__main__":
    unittest.main()