File: test_create_agent_group_task.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 (213 lines) | stat: -rw-r--r-- 7,088 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
# SPDX-FileCopyrightText: 2018-2025 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#

from collections import OrderedDict

from gvm.errors import InvalidArgument, RequiredArgument


class GmpCreateAgentGroupTaskTestMixin:
    def test_create_agent_group_task(self):
        self.gmp.create_agent_group_task(
            name="foo", agent_group_id="ag1", scanner_id="s1"
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b"</create_task>"
        )

    def test_create_agent_group_task_missing_name(self):
        with self.assertRaises(RequiredArgument):
            self.gmp.create_agent_group_task(
                name=None, agent_group_id="ag1", scanner_id="s1"
            )
        with self.assertRaises(RequiredArgument):
            self.gmp.create_agent_group_task(
                name="", agent_group_id="ag1", scanner_id="s1"
            )

    def test_create_agent_group_task_missing_agent_group_id(self):
        with self.assertRaises(RequiredArgument):
            self.gmp.create_agent_group_task(
                name="foo", agent_group_id=None, scanner_id="s1"
            )
        with self.assertRaises(RequiredArgument):
            self.gmp.create_agent_group_task(
                name="foo", agent_group_id="", scanner_id="s1"
            )

    def test_create_agent_group_task_missing_scanner_id(self):
        with self.assertRaises(RequiredArgument):
            self.gmp.create_agent_group_task(
                name="foo", agent_group_id="ag1", scanner_id=None
            )
        with self.assertRaises(RequiredArgument):
            self.gmp.create_agent_group_task(
                name="foo", agent_group_id="ag1", scanner_id=""
            )

    def test_create_agent_group_task_with_comment(self):
        self.gmp.create_agent_group_task(
            name="foo",
            agent_group_id="ag1",
            scanner_id="s1",
            comment="my comment",
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b"<comment>my comment</comment>"
            b"</create_task>"
        )

    def test_create_agent_group_task_with_alerts(self):
        self.gmp.create_agent_group_task(
            name="foo",
            agent_group_id="ag1",
            scanner_id="s1",
            alert_ids=["a1", "a2"],
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b'<alert id="a1"/>'
            b'<alert id="a2"/>'
            b"</create_task>"
        )

    def test_create_agent_group_task_with_empty_alerts(self):
        self.gmp.create_agent_group_task(
            name="foo", agent_group_id="ag1", scanner_id="s1", alert_ids=[]
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b"</create_task>"
        )

    def test_create_agent_group_task_with_schedule(self):
        self.gmp.create_agent_group_task(
            name="foo", agent_group_id="ag1", scanner_id="s1", schedule_id="s1"
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b'<schedule id="s1"/>'
            b"</create_task>"
        )

    def test_create_agent_group_task_with_schedule_periods(self):
        self.gmp.create_agent_group_task(
            name="foo",
            agent_group_id="ag1",
            scanner_id="s1",
            schedule_id="s1",
            schedule_periods=5,
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b'<schedule id="s1"/>'
            b"<schedule_periods>5</schedule_periods>"
            b"</create_task>"
        )

    def test_create_agent_group_task_with_invalid_schedule_periods(self):
        with self.assertRaises(InvalidArgument):
            self.gmp.create_agent_group_task(
                name="foo",
                agent_group_id="ag1",
                scanner_id="s1",
                schedule_id="s1",
                schedule_periods="invalid",
            )

        with self.assertRaises(InvalidArgument):
            self.gmp.create_agent_group_task(
                name="foo",
                agent_group_id="ag1",
                scanner_id="s1",
                schedule_id="s1",
                schedule_periods=-1,
            )

    def test_create_agent_group_task_with_alterable(self):
        self.gmp.create_agent_group_task(
            name="foo", agent_group_id="ag1", scanner_id="s1", alterable=True
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b"<alterable>1</alterable>"
            b"</create_task>"
        )

    def test_create_agent_group_task_with_observers(self):
        self.gmp.create_agent_group_task(
            name="foo",
            agent_group_id="ag1",
            scanner_id="s1",
            observers=["u1", "u2"],
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b"<observers>u1,u2</observers>"
            b"</create_task>"
        )

    def test_create_agent_group_task_with_preferences(self):
        self.gmp.create_agent_group_task(
            name="foo",
            agent_group_id="ag1",
            scanner_id="s1",
            preferences=OrderedDict([("pref1", "val1"), ("pref2", "val2")]),
        )

        self.connection.send.has_been_called_with(
            b"<create_task>"
            b"<name>foo</name>"
            b"<usage_type>scan</usage_type>"
            b'<agent_group id="ag1"/>'
            b'<scanner id="s1"/>'
            b"<preferences>"
            b"<preference><scanner_name>pref1</scanner_name><value>val1</value></preference>"
            b"<preference><scanner_name>pref2</scanner_name><value>val2</value></preference>"
            b"</preferences>"
            b"</create_task>"
        )