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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
|
import pytest
import gitlab
def test_groups(gl):
# TODO: This one still needs lots of work
user = gl.users.create(
{
"email": "user@test.com",
"username": "user",
"name": "user",
"password": "E4596f8be406Bc3a14a4ccdb1df80587#!1",
}
)
user2 = gl.users.create(
{
"email": "user2@test.com",
"username": "user2",
"name": "user2",
"password": "E4596f8be406Bc3a14a4ccdb1df80587#!#2",
}
)
group1 = gl.groups.create(
{"name": "gitlab-test-group1", "path": "gitlab-test-group1"}
)
group2 = gl.groups.create(
{"name": "gitlab-test-group2", "path": "gitlab-test-group2"}
)
p_id = gl.groups.list(search="gitlab-test-group2")[0].id
group3 = gl.groups.create(
{"name": "gitlab-test-group3", "path": "gitlab-test-group3", "parent_id": p_id}
)
group4 = gl.groups.create(
{"name": "gitlab-test-group4", "path": "gitlab-test-group4"}
)
assert {group1, group2, group3, group4} <= set(gl.groups.list())
assert gl.groups.list(search="gitlab-test-group1")[0].id == group1.id
assert group3.parent_id == p_id
assert group2.subgroups.list()[0].id == group3.id
assert group2.descendant_groups.list()[0].id == group3.id
filtered_groups = gl.groups.list(skip_groups=[group3.id, group4.id])
assert group3 not in filtered_groups
assert group4 not in filtered_groups
filtered_groups = gl.groups.list(skip_groups=[group3.id])
assert group3 not in filtered_groups
assert group4 in filtered_groups
group1.members.create(
{"access_level": gitlab.const.AccessLevel.OWNER, "user_id": user.id}
)
group1.members.create(
{"access_level": gitlab.const.AccessLevel.GUEST, "user_id": user2.id}
)
group2.members.create(
{"access_level": gitlab.const.AccessLevel.OWNER, "user_id": user2.id}
)
group4.share(group1.id, gitlab.const.AccessLevel.DEVELOPER)
group4.share(group2.id, gitlab.const.AccessLevel.MAINTAINER)
# Reload group4 to have updated shared_with_groups
group4 = gl.groups.get(group4.id)
assert len(group4.shared_with_groups) == 2
group4.unshare(group1.id)
# Reload group4 to have updated shared_with_groups
group4 = gl.groups.get(group4.id)
assert len(group4.shared_with_groups) == 1
# User memberships (admin only)
memberships1 = user.memberships.list()
assert len(memberships1) == 1
memberships2 = user2.memberships.list()
assert len(memberships2) == 2
membership = memberships1[0]
assert membership.source_type == "Namespace"
assert membership.access_level == gitlab.const.AccessLevel.OWNER
project_memberships = user.memberships.list(type="Project")
assert len(project_memberships) == 0
group_memberships = user.memberships.list(type="Namespace")
assert len(group_memberships) == 1
with pytest.raises(gitlab.GitlabListError) as e:
membership = user.memberships.list(type="Invalid")
assert "type does not have a valid value" in str(e.value)
with pytest.raises(gitlab.GitlabListError) as e:
user.memberships.list(sudo=user.name)
assert "403 Forbidden" in str(e.value)
# Administrator belongs to the groups
assert len(group1.members.list()) == 3
assert len(group2.members.list()) == 2
# Test `user_ids` array
result = group1.members.list(user_ids=[user.id, 99999])
assert len(result) == 1
assert result[0].id == user.id
group1.members.delete(user.id)
assert group1.members_all.list()
member = group1.members.get(user2.id)
member.access_level = gitlab.const.AccessLevel.OWNER
member.save()
member = group1.members.get(user2.id)
assert member.access_level == gitlab.const.AccessLevel.OWNER
gl.auth()
group2.members.delete(gl.user.id)
def test_group_labels(group):
group.labels.create({"name": "foo", "description": "bar", "color": "#112233"})
label = group.labels.get("foo")
assert label.description == "bar"
label.description = "baz"
label.save()
label = group.labels.get("foo")
assert label.description == "baz"
assert label in group.labels.list()
label.new_name = "Label:that requires:encoding"
label.save()
assert label.name == "Label:that requires:encoding"
label = group.labels.get("Label:that requires:encoding")
assert label.name == "Label:that requires:encoding"
label.delete()
def test_group_avatar_upload(gl, group, fixture_dir):
"""Test uploading an avatar to a group."""
# Upload avatar
with open(fixture_dir / "avatar.png", "rb") as avatar_file:
group.avatar = avatar_file
group.save()
# Verify the avatar was set
updated_group = gl.groups.get(group.id)
assert updated_group.avatar_url is not None
def test_group_avatar_remove(gl, group, fixture_dir):
"""Test removing an avatar from a group."""
# First set an avatar
with open(fixture_dir / "avatar.png", "rb") as avatar_file:
group.avatar = avatar_file
group.save()
# Now remove the avatar
group.avatar = ""
group.save()
# Verify the avatar was removed
updated_group = gl.groups.get(group.id)
assert updated_group.avatar_url is None
@pytest.mark.gitlab_premium
@pytest.mark.xfail(reason="/ldap/groups endpoint not documented")
def test_ldap_groups(gl):
assert isinstance(gl.ldapgroups.list(), list)
@pytest.mark.gitlab_premium
def test_group_ldap_links(group):
ldap_cn = "common-name"
ldap_provider = "ldap-provider"
ldap_cn_link = group.ldap_group_links.create(
{"provider": ldap_provider, "group_access": 30, "cn": ldap_cn}
)
ldap_filter_link = group.ldap_group_links.create(
{"provider": ldap_provider, "group_access": 30, "filter": "(cn=Common Name)"}
)
ldap_links = group.ldap_group_links.list()
assert ldap_cn_link.cn == ldap_links[0].cn
assert ldap_filter_link.filter == ldap_links[1].filter
with pytest.raises(gitlab.GitlabCreateError):
# todo - can we configure dummy LDAP in the container?
group.ldap_sync()
ldap_filter_link.delete()
group.ldap_group_links.delete(provider=ldap_provider, cn=ldap_cn)
with pytest.raises(gitlab.GitlabListError, match="No linked LDAP groups found"):
group.ldap_group_links.list()
def test_group_notification_settings(group):
settings = group.notificationsettings.get()
settings.level = "disabled"
settings.save()
settings = group.notificationsettings.get()
assert settings.level == "disabled"
def test_group_badges(group):
badge_image = "http://example.com"
badge_link = "http://example/img.svg"
badge = group.badges.create({"link_url": badge_link, "image_url": badge_image})
assert badge in group.badges.list()
badge.image_url = "http://another.example.com"
badge.save()
badge = group.badges.get(badge.id)
assert badge.image_url == "http://another.example.com"
badge.delete()
def test_group_milestones(group):
milestone = group.milestones.create({"title": "groupmilestone1"})
assert milestone in group.milestones.list()
milestone.due_date = "2020-01-01T00:00:00Z"
milestone.save()
milestone.state_event = "close"
milestone.save()
milestone = group.milestones.get(milestone.id)
assert milestone.state == "closed"
assert not milestone.issues()
assert not milestone.merge_requests()
def test_group_custom_attributes(gl, group):
attrs = group.customattributes.list()
assert not attrs
attr = group.customattributes.set("key", "value1")
assert group in gl.groups.list(custom_attributes={"key": "value1"})
assert attr.key == "key"
assert attr.value == "value1"
assert attr in group.customattributes.list()
attr = group.customattributes.set("key", "value2")
attr = group.customattributes.get("key")
assert attr.value == "value2"
assert attr in group.customattributes.list()
attr.delete()
def test_group_subgroups_projects(gl, user):
# TODO: fixture factories
group1 = gl.groups.list(search="group1")[0]
group2 = gl.groups.list(search="group2")[0]
group3 = gl.groups.create(
{"name": "subgroup1", "path": "subgroup1", "parent_id": group1.id}
)
group4 = gl.groups.create(
{"name": "subgroup2", "path": "subgroup2", "parent_id": group2.id}
)
gr1_project = gl.projects.create({"name": "gr1_project", "namespace_id": group1.id})
gr2_project = gl.projects.create({"name": "gr2_project", "namespace_id": group3.id})
assert group3.parent_id == group1.id
assert group4.parent_id == group2.id
assert gr1_project.namespace["id"] == group1.id
assert gr2_project.namespace["parent_id"] == group1.id
gr1_project.delete()
gr2_project.delete()
group3.delete()
group4.delete()
@pytest.mark.gitlab_premium
def test_group_wiki(group):
content = "Group Wiki page content"
wiki = group.wikis.create({"title": "groupwikipage", "content": content})
assert wiki in group.wikis.list()
wiki = group.wikis.get(wiki.slug)
assert wiki.content == content
wiki.content = "new content"
wiki.save()
wiki.delete()
@pytest.mark.gitlab_premium
def test_group_hooks(group):
hook = group.hooks.create({"url": "http://hook.url"})
assert hook in group.hooks.list()
hook.note_events = True
hook.save()
hook = group.hooks.get(hook.id)
assert hook.note_events is True
hook.delete()
def test_group_protected_branches(group, gitlab_version):
# Updating a protected branch at the group level is possible from Gitlab 15.9
# https://docs.gitlab.com/api/group_protected_branches/
can_update_prot_branch = gitlab_version.major > 15 or (
gitlab_version.major == 15 and gitlab_version.minor >= 9
)
p_b = group.protectedbranches.create(
{"name": "*-stable", "allow_force_push": False}
)
assert p_b.name == "*-stable"
assert not p_b.allow_force_push
assert p_b in group.protectedbranches.list()
if can_update_prot_branch:
p_b.allow_force_push = True
p_b.save()
p_b = group.protectedbranches.get("*-stable")
if can_update_prot_branch:
assert p_b.allow_force_push
p_b.delete()
def test_group_transfer(gl, group):
transfer_group = gl.groups.create(
{"name": "transfer-test-group", "path": "transfer-test-group"}
)
transfer_group = gl.groups.get(transfer_group.id)
assert transfer_group.parent_id != group.id
transfer_group.transfer(group.id)
transferred_group = gl.groups.get(transfer_group.id)
assert transferred_group.parent_id == group.id
transfer_group.transfer()
transferred_group = gl.groups.get(transfer_group.id)
assert transferred_group.path == transferred_group.full_path
@pytest.mark.gitlab_premium
@pytest.mark.xfail(reason="need to setup an identity provider or it's mock")
def test_group_saml_group_links(group):
group.saml_group_links.create(
{"saml_group_name": "saml-group-1", "access_level": 10}
)
@pytest.mark.gitlab_premium
def test_group_service_account(group):
service_account = group.service_accounts.create(
{"name": "gitlab-service-account", "username": "gitlab-service-account"}
)
assert service_account.name == "gitlab-service-account"
assert service_account.username == "gitlab-service-account"
|