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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
# SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from gvm.errors import InvalidArgument, RequiredArgument
from gvm.protocols.gmp.requests.v224 import UserAuthType, Users
class UsersTestCase(unittest.TestCase):
def test_get_users(self):
request = Users().get_users()
self.assertEqual(bytes(request), b"<get_users/>")
def test_get_users_with_filter_string(self):
request = Users().get_users(filter_string="foo=bar")
self.assertEqual(bytes(request), b'<get_users filter="foo=bar"/>')
def test_get_users_with_filter_id(self):
request = Users().get_users(filter_id="f1")
self.assertEqual(bytes(request), b'<get_users filt_id="f1"/>')
def test_create_user(self):
request = Users().create_user(name="foo")
self.assertEqual(
bytes(request), b"<create_user><name>foo</name></create_user>"
)
def test_create_user_with_password(self):
request = Users().create_user(name="foo", password="bar")
self.assertEqual(
bytes(request),
b"<create_user><name>foo</name><password>bar</password></create_user>",
)
def test_create_user_with_hosts(self):
request = Users().create_user(
name="foo", hosts=["h1", "h2"], hosts_allow=True
)
self.assertEqual(
bytes(request),
b"<create_user>"
b"<name>foo</name>"
b'<hosts allow="1">h1,h2</hosts>'
b"</create_user>",
)
request = Users().create_user(
name="foo", hosts=["h1", "h2"], hosts_allow=False
)
self.assertEqual(
bytes(request),
b"<create_user>"
b"<name>foo</name>"
b'<hosts allow="0">h1,h2</hosts>'
b"</create_user>",
)
def test_create_user_with_role_ids(self):
request = Users().create_user(name="foo", role_ids=["r1", "r2"])
self.assertEqual(
bytes(request),
b"<create_user>"
b"<name>foo</name>"
b'<role id="r1"/>'
b'<role id="r2"/>'
b"</create_user>",
)
def test_create_user_missing_name(self):
with self.assertRaises(RequiredArgument):
Users().create_user("")
with self.assertRaises(RequiredArgument):
Users().create_user(None)
def test_modify_user(self):
request = Users().modify_user(user_id="u1")
self.assertEqual(bytes(request), b'<modify_user user_id="u1"/>')
def test_modify_user_missing_user_id(self):
with self.assertRaises(RequiredArgument):
Users().modify_user(user_id=None)
with self.assertRaises(RequiredArgument):
Users().modify_user(user_id="")
def test_modify_user_with_new_name(self):
request = Users().modify_user(user_id="u1", name="foo")
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><new_name>foo</new_name></modify_user>',
)
def test_modify_user_with_new_comment(self):
request = Users().modify_user(user_id="u1", comment="foo")
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><comment>foo</comment></modify_user>',
)
def test_modify_user_with_role_ids(self):
request = Users().modify_user(user_id="u1", role_ids=[])
self.assertEqual(bytes(request), b'<modify_user user_id="u1"/>')
request = Users().modify_user(user_id="u1", role_ids=["r1"])
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><role id="r1"/></modify_user>',
)
request = Users().modify_user(user_id="u1", role_ids=["r1", "r2"])
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><role id="r1"/><role id="r2"/></modify_user>',
)
def test_modify_user_with_group_ids(self):
request = Users().modify_user(user_id="u1", group_ids=[])
self.assertEqual(bytes(request), b'<modify_user user_id="u1"/>')
request = Users().modify_user(user_id="u1", group_ids=["g1"])
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><groups><group id="g1"/></groups></modify_user>',
)
request = Users().modify_user(user_id="u1", group_ids=["g1", "g2"])
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><groups><group id="g1"/><group id="g2"/></groups></modify_user>',
)
def test_modify_user_with_password(self):
request = Users().modify_user(user_id="u1", password="bar")
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1"><password>bar</password></modify_user>',
)
def test_modify_user_with_auth_source(self):
request = Users().modify_user(
user_id="u1", auth_source=UserAuthType.LDAP_CONNECT
)
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1">'
b"<sources><source>ldap_connect</source></sources>"
b"</modify_user>",
)
request = Users().modify_user(user_id="u1", auth_source="ldap_connect")
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1">'
b"<sources><source>ldap_connect</source></sources>"
b"</modify_user>",
)
def test_modify_user_invalid_auth_source(self):
with self.assertRaises(InvalidArgument):
Users().modify_user(user_id="u1", auth_source="foo")
def test_modify_user_with_hosts(self):
request = Users().modify_user(
user_id="u1", hosts=["h1", "h2"], hosts_allow=True
)
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1">'
b'<hosts allow="1">h1,h2</hosts>'
b"</modify_user>",
)
request = Users().modify_user(
user_id="u1", hosts=["h1", "h2"], hosts_allow=False
)
self.assertEqual(
bytes(request),
b'<modify_user user_id="u1">'
b'<hosts allow="0">h1,h2</hosts>'
b"</modify_user>",
)
def test_clone_user(self):
request = Users().clone_user(user_id="u1")
self.assertEqual(
bytes(request), b"<create_user><copy>u1</copy></create_user>"
)
def test_clone_user_missing_user_id(self):
with self.assertRaises(RequiredArgument):
Users().clone_user(user_id=None)
with self.assertRaises(RequiredArgument):
Users().clone_user(user_id="")
def test_delete_user_with_user_id(self):
request = Users().delete_user("u1")
self.assertEqual(bytes(request), b'<delete_user user_id="u1"/>')
def test_delete_user_with_name(self):
request = Users().delete_user(name="foo")
self.assertEqual(bytes(request), b'<delete_user name="foo"/>')
def test_delete_user_with_inheritor_id(self):
request = Users().delete_user("u1", inheritor_id="u2")
self.assertEqual(
bytes(request), b'<delete_user user_id="u1" inheritor_id="u2"/>'
)
def test_delete_user_with_inheritor_name(self):
request = Users().delete_user("u1", inheritor_name="foo")
self.assertEqual(
bytes(request), b'<delete_user user_id="u1" inheritor_name="foo"/>'
)
def test_delete_user_missing_user_id_and_name(self):
with self.assertRaises(RequiredArgument):
Users().delete_user(None)
with self.assertRaises(RequiredArgument):
Users().delete_user("")
with self.assertRaises(RequiredArgument):
Users().delete_user(user_id="", name="")
def test_get_user(self):
request = Users().get_user("u1")
self.assertEqual(bytes(request), b'<get_users user_id="u1"/>')
def test_get_user_missing_user_id(self):
with self.assertRaises(RequiredArgument):
Users().get_user(user_id=None)
with self.assertRaises(RequiredArgument):
Users().get_user("")
|