File: test_reports.py

package info (click to toggle)
python-gvm 26.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,220 kB
  • sloc: python: 45,844; makefile: 18
file content (227 lines) | stat: -rw-r--r-- 7,662 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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later

import unittest

from gvm.errors import RequiredArgument
from gvm.protocols.gmp.requests.v224 import Reports

REPORT_XML_STRING = (
    '<report id="67a62fb7-b238-4f0e-bc48-59bde8939cdc">'
    '<results max="1" start="1">'
    '<result id="f180b40f-49dd-4856-81ed-8c1195afce80">'
    "<severity>0.0</severity>"
    '<nvt oid="1.3.6.1.4.1.25623.1.0.10330"/>'
    "<host>132.67.253.114</host>"
    "</result></results></report>"
)


class ReportsTestCase(unittest.TestCase):
    def test_delete_report(self):
        request = Reports.delete_report("report_id")
        self.assertEqual(
            bytes(request),
            b'<delete_report report_id="report_id"/>',
        )

    def test_delete_report_missing_report_id(self):
        with self.assertRaises(RequiredArgument):
            Reports.delete_report(None)

        with self.assertRaises(RequiredArgument):
            Reports.delete_report("")

    def test_get_report(self):
        request = Reports.get_report("report_id")
        self.assertEqual(
            bytes(request),
            b'<get_reports report_id="report_id" details="1"/>',
        )

    def test_get_report_with_filter_string(self):
        request = Reports.get_report("report_id", filter_string="filter_string")
        self.assertEqual(
            bytes(request),
            b'<get_reports report_id="report_id" filter="filter_string" details="1"/>',
        )

    def test_get_report_with_filter_id(self):
        request = Reports.get_report("report_id", filter_id="filter_id")
        self.assertEqual(
            bytes(request),
            b'<get_reports report_id="report_id" filt_id="filter_id" details="1"/>',
        )

    def test_get_report_with_delta_report_id(self):
        request = Reports.get_report(
            "report_id", delta_report_id="delta_report_id"
        )
        self.assertEqual(
            bytes(request),
            b'<get_reports report_id="report_id" delta_report_id="delta_report_id" details="1"/>',
        )

    def test_get_report_with_report_format_id(self):
        request = Reports.get_report(
            "report_id", report_format_id="report_format_id"
        )
        self.assertEqual(
            bytes(request),
            b'<get_reports report_id="report_id" format_id="report_format_id" details="1"/>',
        )

    def test_get_report_with_ignore_pagination(self):
        request = Reports.get_report("report_id", ignore_pagination=True)
        self.assertEqual(
            bytes(request),
            b'<get_reports report_id="report_id" ignore_pagination="1" details="1"/>',
        )

    def test_get_report_missing_report_id(self):
        with self.assertRaises(RequiredArgument):
            Reports.get_report(None)

        with self.assertRaises(RequiredArgument):
            Reports.get_report("")

    def test_get_reports(self):
        request = Reports.get_reports()
        self.assertEqual(
            bytes(request),
            b"<get_reports/>",
        )

    def test_get_reports_with_filter_string(self):
        request = Reports.get_reports(filter_string="filter_string")
        self.assertEqual(
            bytes(request),
            b'<get_reports report_filter="filter_string"/>',
        )

    def test_get_reports_with_filter_id(self):
        request = Reports.get_reports(filter_id="filter_id")
        self.assertEqual(
            bytes(request),
            b'<get_reports report_filt_id="filter_id"/>',
        )

    def test_get_reports_with_note_details(self):
        request = Reports.get_reports(note_details=True)
        self.assertEqual(
            bytes(request),
            b'<get_reports note_details="1"/>',
        )

        request = Reports.get_reports(note_details=False)
        self.assertEqual(
            bytes(request),
            b'<get_reports note_details="0"/>',
        )

    def test_get_reports_with_override_details(self):
        request = Reports.get_reports(override_details=True)
        self.assertEqual(
            bytes(request),
            b'<get_reports override_details="1"/>',
        )

        request = Reports.get_reports(override_details=False)
        self.assertEqual(
            bytes(request),
            b'<get_reports override_details="0"/>',
        )

    def test_get_reports_with_details(self):
        request = Reports.get_reports(details=True)
        self.assertEqual(
            bytes(request),
            b'<get_reports details="1"/>',
        )

        request = Reports.get_reports(details=False)
        self.assertEqual(
            bytes(request),
            b'<get_reports details="0"/>',
        )

    def test_get_reports_with_ignore_pagination(self):
        request = Reports.get_reports(ignore_pagination=True)
        self.assertEqual(
            bytes(request),
            b'<get_reports ignore_pagination="1"/>',
        )

        request = Reports.get_reports(ignore_pagination=False)
        self.assertEqual(
            bytes(request),
            b'<get_reports ignore_pagination="0"/>',
        )

    def test_import_report(self):
        request = Reports.import_report(REPORT_XML_STRING, "task_id")
        self.assertEqual(
            bytes(request),
            b"<create_report>"
            b'<task id="task_id"/>'
            b'<report id="67a62fb7-b238-4f0e-bc48-59bde8939cdc">'
            b'<results max="1" start="1">'
            b'<result id="f180b40f-49dd-4856-81ed-8c1195afce80">'
            b"<severity>0.0</severity>"
            b'<nvt oid="1.3.6.1.4.1.25623.1.0.10330"/>'
            b"<host>132.67.253.114</host>"
            b"</result></results></report>"
            b"</create_report>",
        )

    def test_import_report_with_in_assets(self):
        request = Reports.import_report(
            REPORT_XML_STRING, "task_id", in_assets=False
        )
        self.assertEqual(
            bytes(request),
            b"<create_report>"
            b'<task id="task_id"/>'
            b"<in_assets>0</in_assets>"
            b'<report id="67a62fb7-b238-4f0e-bc48-59bde8939cdc">'
            b'<results max="1" start="1">'
            b'<result id="f180b40f-49dd-4856-81ed-8c1195afce80">'
            b"<severity>0.0</severity>"
            b'<nvt oid="1.3.6.1.4.1.25623.1.0.10330"/>'
            b"<host>132.67.253.114</host>"
            b"</result></results></report>"
            b"</create_report>",
        )

        request = Reports.import_report(
            REPORT_XML_STRING, "task_id", in_assets=True
        )
        self.assertEqual(
            bytes(request),
            b"<create_report>"
            b'<task id="task_id"/>'
            b"<in_assets>1</in_assets>"
            b'<report id="67a62fb7-b238-4f0e-bc48-59bde8939cdc">'
            b'<results max="1" start="1">'
            b'<result id="f180b40f-49dd-4856-81ed-8c1195afce80">'
            b"<severity>0.0</severity>"
            b'<nvt oid="1.3.6.1.4.1.25623.1.0.10330"/>'
            b"<host>132.67.253.114</host>"
            b"</result></results></report>"
            b"</create_report>",
        )

    def test_import_report_missing_report(self):
        with self.assertRaises(RequiredArgument):
            Reports.import_report(None, "task_id")

        with self.assertRaises(RequiredArgument):
            Reports.import_report("", "task_id")

    def test_import_report_missing_task_id(self):
        with self.assertRaises(RequiredArgument):
            Reports.import_report("report", None)

        with self.assertRaises(RequiredArgument):
            Reports.import_report("report", "")