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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
# SPDX-FileCopyrightText: 2025 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from gvm.errors import RequiredArgument
from gvm.protocols.gmp.requests.v226 import ReportConfigs, ReportFormatType
from gvm.protocols.gmp.requests.v226._report_configs import (
ReportConfigParameter,
)
class ReportConfigsTestCase(unittest.TestCase):
def test_create_report_config(self):
request = ReportConfigs.create_report_config(
"report-config1", "report_format_id"
)
self.assertEqual(
bytes(request),
b"<create_report_config>"
b"<name>report-config1</name>"
b'<report_format id="report_format_id"/>'
b"</create_report_config>",
)
def test_create_report_config_with_comment(self):
request = ReportConfigs.create_report_config(
"report-config1", "report_format_id", comment="foo"
)
self.assertEqual(
bytes(request),
b"<create_report_config>"
b"<name>report-config1</name>"
b'<report_format id="report_format_id"/>'
b"<comment>foo</comment>"
b"</create_report_config>",
)
def test_create_report_config_with_params(self):
request = ReportConfigs.create_report_config(
"report-config1",
"report_format_id",
params=[
ReportConfigParameter("name", "value"),
ReportConfigParameter("name2", "value2", use_default=True),
ReportConfigParameter("name3", use_default=True),
],
)
self.assertEqual(
bytes(request),
b"<create_report_config>"
b"<name>report-config1</name>"
b'<report_format id="report_format_id"/>'
b'<param><name>name</name><value use_default="0">value</value></param>'
b'<param><name>name2</name><value use_default="1"/></param>'
b'<param><name>name3</name><value use_default="1"/></param>'
b"</create_report_config>",
)
def test_create_report_config_missing_name(self):
with self.assertRaises(RequiredArgument):
ReportConfigs.create_report_config(None, "report_format_id")
with self.assertRaises(RequiredArgument):
ReportConfigs.create_report_config("", "report_format_id")
def test_create_report_config_missing_report_format_id(self):
with self.assertRaises(RequiredArgument):
ReportConfigs.create_report_config("foo", None)
with self.assertRaises(RequiredArgument):
ReportConfigs.create_report_config("foo", "")
def test_clone_report_config(self):
request = ReportConfigs.clone_report_config("report_config_id")
self.assertEqual(
bytes(request),
b"<create_report_config>"
b"<copy>report_config_id</copy>"
b"</create_report_config>",
)
request = ReportConfigs.clone_report_config(ReportFormatType.PDF)
self.assertEqual(
bytes(request),
b"<create_report_config>"
b"<copy>c402cc3e-b531-11e1-9163-406186ea4fc5</copy>"
b"</create_report_config>",
)
def test_clone_report_config_missing_report_config_id(self):
with self.assertRaises(RequiredArgument):
ReportConfigs.clone_report_config(None)
with self.assertRaises(RequiredArgument):
ReportConfigs.clone_report_config("")
def test_delete_report_config(self):
request = ReportConfigs.delete_report_config("report_config_id")
self.assertEqual(
bytes(request),
b'<delete_report_config report_config_id="report_config_id" ultimate="0"/>',
)
request = ReportConfigs.delete_report_config(ReportFormatType.PDF)
self.assertEqual(
bytes(request),
b'<delete_report_config report_config_id="c402cc3e-b531-11e1-9163-406186ea4fc5" ultimate="0"/>',
)
def test_delete_report_config_with_ultimate(self):
request = ReportConfigs.delete_report_config(
"report_config_id", ultimate=True
)
self.assertEqual(
bytes(request),
b'<delete_report_config report_config_id="report_config_id" ultimate="1"/>',
)
request = ReportConfigs.delete_report_config(
ReportFormatType.PDF, ultimate=False
)
self.assertEqual(
bytes(request),
b'<delete_report_config report_config_id="c402cc3e-b531-11e1-9163-406186ea4fc5" ultimate="0"/>',
)
def test_delete_report_config_missing_report_config_id(self):
with self.assertRaises(RequiredArgument):
ReportConfigs.delete_report_config(None)
with self.assertRaises(RequiredArgument):
ReportConfigs.delete_report_config("")
def test_get_report_configs(self):
request = ReportConfigs.get_report_configs()
self.assertEqual(
bytes(request),
b"<get_report_configs/>",
)
def test_get_report_configs_with_filter_string(self):
request = ReportConfigs.get_report_configs(
filter_string="filter_string"
)
self.assertEqual(
bytes(request),
b'<get_report_configs filter="filter_string"/>',
)
def test_get_report_configs_with_filter_id(self):
request = ReportConfigs.get_report_configs(filter_id="filter_id")
self.assertEqual(
bytes(request),
b'<get_report_configs filt_id="filter_id"/>',
)
def test_get_report_configs_with_details(self):
request = ReportConfigs.get_report_configs(details=True)
self.assertEqual(
bytes(request),
b'<get_report_configs details="1"/>',
)
request = ReportConfigs.get_report_configs(details=False)
self.assertEqual(
bytes(request),
b'<get_report_configs details="0"/>',
)
def test_get_report_configs_with_trash(self):
request = ReportConfigs.get_report_configs(trash=True)
self.assertEqual(
bytes(request),
b'<get_report_configs trash="1"/>',
)
request = ReportConfigs.get_report_configs(trash=False)
self.assertEqual(
bytes(request),
b'<get_report_configs trash="0"/>',
)
def test_get_report_config(self):
request = ReportConfigs.get_report_config("report_config_id")
self.assertEqual(
bytes(request),
b'<get_report_configs report_config_id="report_config_id" details="1"/>',
)
def test_get_report_config_missing_report_config_id(self):
with self.assertRaises(RequiredArgument):
ReportConfigs.get_report_config(None)
with self.assertRaises(RequiredArgument):
ReportConfigs.get_report_config("")
def test_modify_report_config(self):
request = ReportConfigs.modify_report_config("report_config_id")
self.assertEqual(
bytes(request),
b'<modify_report_config report_config_id="report_config_id"/>',
)
def test_modify_report_config_with_name(self):
request = ReportConfigs.modify_report_config(
"report_config_id", name="foo"
)
self.assertEqual(
bytes(request),
b'<modify_report_config report_config_id="report_config_id">'
b"<name>foo</name>"
b"</modify_report_config>",
)
def test_modify_report_config_with_comment(self):
request = ReportConfigs.modify_report_config(
"report_config_id", comment="foo"
)
self.assertEqual(
bytes(request),
b'<modify_report_config report_config_id="report_config_id">'
b"<comment>foo</comment>"
b"</modify_report_config>",
)
def test_modify_report_config_with_params(self):
request = ReportConfigs.modify_report_config(
"report_config_id",
params=[
ReportConfigParameter("name", "value"),
ReportConfigParameter("name2", "value2", use_default=True),
ReportConfigParameter("name3", use_default=True),
],
)
self.assertEqual(
bytes(request),
b'<modify_report_config report_config_id="report_config_id">'
b'<param><name>name</name><value use_default="0">value</value></param>'
b'<param><name>name2</name><value use_default="1"/></param>'
b'<param><name>name3</name><value use_default="1"/></param>'
b"</modify_report_config>",
)
def test_modify_report_config_missing_report_config_id(self):
with self.assertRaises(RequiredArgument):
ReportConfigs.modify_report_config(None)
with self.assertRaises(RequiredArgument):
ReportConfigs.modify_report_config("")
|
