forked from python-gitlab/python-gitlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpython_test_v4.py
More file actions
1017 lines (890 loc) · 31.2 KB
/
python_test_v4.py
File metadata and controls
1017 lines (890 loc) · 31.2 KB
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import base64
import os
import time
import requests
import gitlab
LOGIN = "root"
PASSWORD = "5iveL!fe"
SSH_KEY = (
"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDZAjAX8vTiHD7Yi3/EzuVaDChtih"
"79HyJZ6H9dEqxFfmGA1YnncE0xujQ64TCebhkYJKzmTJCImSVkOu9C4hZgsw6eE76n"
"+Cg3VwEeDUFy+GXlEJWlHaEyc3HWioxgOALbUp3rOezNh+d8BDwwqvENGoePEBsz5l"
"a6WP5lTi/HJIjAl6Hu+zHgdj1XVExeH+S52EwpZf/ylTJub0Bl5gHwf/siVE48mLMI"
"sqrukXTZ6Zg+8EHAIvIQwJ1dKcXe8P5IoLT7VKrbkgAnolS0I8J+uH7KtErZJb5oZh"
"S4OEwsNpaXMAr+6/wWSpircV2/e7sFLlhlKBC4Iq1MpqlZ7G3p foo@bar"
)
DEPLOY_KEY = (
"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDFdRyjJQh+1niBpXqE2I8dzjG"
"MXFHlRjX9yk/UfOn075IdaockdU58sw2Ai1XIWFpZpfJkW7z+P47ZNSqm1gzeXI"
"rtKa9ZUp8A7SZe8vH4XVn7kh7bwWCUirqtn8El9XdqfkzOs/+FuViriUWoJVpA6"
"WZsDNaqINFKIA5fj/q8XQw+BcS92L09QJg9oVUuH0VVwNYbU2M2IRmSpybgC/gu"
"uWTrnCDMmLItksATifLvRZwgdI8dr+q6tbxbZknNcgEPrI2jT0hYN9ZcjNeWuyv"
"rke9IepE7SPBT41C+YtUX4dfDZDmczM1cE0YL/krdUCfuZHMa4ZS2YyNd6slufc"
"vn bar@foo"
)
GPG_KEY = """-----BEGIN PGP PUBLIC KEY BLOCK-----
mQENBFn5mzYBCADH6SDVPAp1zh/hxmTi0QplkOfExBACpuY6OhzNdIg+8/528b3g
Y5YFR6T/HLv/PmeHskUj21end1C0PNG2T9dTx+2Vlh9ISsSG1kyF9T5fvMR3bE0x
Dl6S489CXZrjPTS9SHk1kF+7dwjUxLJyxF9hPiSihFefDFu3NeOtG/u8vbC1mewQ
ZyAYue+mqtqcCIFFoBz7wHKMWjIVSJSyTkXExu4OzpVvy3l2EikbvavI3qNz84b+
Mgkv/kiBlNoCy3CVuPk99RYKZ3lX1vVtqQ0OgNGQvb4DjcpyjmbKyibuZwhDjIOh
au6d1OyEbayTntd+dQ4j9EMSnEvm/0MJ4eXPABEBAAG0G0dpdGxhYlRlc3QxIDxm
YWtlQGZha2UudGxkPokBNwQTAQgAIQUCWfmbNgIbAwULCQgHAgYVCAkKCwIEFgID
AQIeAQIXgAAKCRBgxELHf8f3hF3yB/wNJlWPKY65UsB4Lo0hs1OxdxCDqXogSi0u
6crDEIiyOte62pNZKzWy8TJcGZvznRTZ7t8hXgKFLz3PRMcl+vAiRC6quIDUj+2V
eYfwaItd1lUfzvdCaC7Venf4TQ74f5vvNg/zoGwE6eRoSbjlLv9nqsxeA0rUBUQL
LYikWhVMP3TrlfgfduYvh6mfgh57BDLJ9kJVpyfxxx9YLKZbaas9sPa6LgBtR555
JziUxHmbEv8XCsUU8uoFeP1pImbNBplqE3wzJwzOMSmmch7iZzrAwfN7N2j3Wj0H
B5kQddJ9dmB4BbU0IXGhWczvdpxboI2wdY8a1JypxOdePoph/43iuQENBFn5mzYB
CADnTPY0Zf3d9zLjBNgIb3yDl94uOcKCq0twNmyjMhHzGqw+UMe9BScy34GL94Al
xFRQoaL+7P8hGsnsNku29A/VDZivcI+uxTx4WQ7OLcn7V0bnHV4d76iky2ufbUt/
GofthjDs1SonePO2N09sS4V4uK0d5N4BfCzzXgvg8etCLxNmC9BGt7AaKUUzKBO4
2QvNNaC2C/8XEnOgNWYvR36ylAXAmo0sGFXUsBCTiq1fugS9pwtaS2JmaVpZZ3YT
pMZlS0+SjC5BZYFqSmKCsA58oBRzCxQz57nR4h5VEflgD+Hy0HdW0UHETwz83E6/
U0LL6YyvhwFr6KPq5GxinSvfABEBAAGJAR8EGAEIAAkFAln5mzYCGwwACgkQYMRC
x3/H94SJgwgAlKQb10/xcL/epdDkR7vbiei7huGLBpRDb/L5fM8B5W77Qi8Xmuqj
cCu1j99ZCA5hs/vwVn8j8iLSBGMC5gxcuaar/wtmiaEvT9fO/h6q4opG7NcuiJ8H
wRj8ccJmRssNqDD913PLz7T40Ts62blhrEAlJozGVG/q7T3RAZcskOUHKeHfc2RI
YzGsC/I9d7k6uxAv1L9Nm5F2HaAQDzhkdd16nKkGaPGR35cT1JLInkfl5cdm7ldN
nxs4TLO3kZjUTgWKdhpgRNF5hwaz51ZjpebaRf/ZqRuNyX4lIRolDxzOn/+O1o8L
qG2ZdhHHmSK2LaQLFiSprUkikStNU9BqSQ==
=5OGa
-----END PGP PUBLIC KEY BLOCK-----"""
AVATAR_PATH = os.path.join(os.path.dirname(__file__), "avatar.png")
# token authentication from config file
gl = gitlab.Gitlab.from_config(config_files=["/tmp/python-gitlab.cfg"])
gl.auth()
assert isinstance(gl.user, gitlab.v4.objects.CurrentUser)
# markdown
html = gl.markdown("foo")
assert "foo" in html
success, errors = gl.lint("Invalid")
assert success is False
assert errors
# sidekiq
out = gl.sidekiq.queue_metrics()
assert isinstance(out, dict)
assert "pages" in out["queues"]
out = gl.sidekiq.process_metrics()
assert isinstance(out, dict)
assert "hostname" in out["processes"][0]
out = gl.sidekiq.job_stats()
assert isinstance(out, dict)
assert "processed" in out["jobs"]
out = gl.sidekiq.compound_metrics()
assert isinstance(out, dict)
assert "jobs" in out
assert "processes" in out
assert "queues" in out
# settings
settings = gl.settings.get()
settings.default_projects_limit = 42
settings.save()
settings = gl.settings.get()
assert settings.default_projects_limit == 42
# users
new_user = gl.users.create(
{
"email": "foo@bar.com",
"username": "foo",
"name": "foo",
"password": "foo_password",
"avatar": open(AVATAR_PATH, "rb"),
}
)
avatar_url = new_user.avatar_url.replace("gitlab.test", "localhost:8080")
uploaded_avatar = requests.get(avatar_url).content
assert uploaded_avatar == open(AVATAR_PATH, "rb").read()
users_list = gl.users.list()
for user in users_list:
if user.username == "foo":
break
assert new_user.username == user.username
assert new_user.email == user.email
new_user.block()
new_user.unblock()
# user projects list
assert len(new_user.projects.list()) == 0
# events list
new_user.events.list()
foobar_user = gl.users.create(
{
"email": "foobar@example.com",
"username": "foobar",
"name": "Foo Bar",
"password": "foobar_password",
}
)
assert gl.users.list(search="foobar")[0].id == foobar_user.id
expected = [new_user, foobar_user]
actual = list(gl.users.list(search="foo"))
assert len(expected) == len(actual)
assert len(gl.users.list(search="asdf")) == 0
foobar_user.bio = "This is the user bio"
foobar_user.save()
# GPG keys
gkey = new_user.gpgkeys.create({"key": GPG_KEY})
assert len(new_user.gpgkeys.list()) == 1
# Seems broken on the gitlab side
# gkey = new_user.gpgkeys.get(gkey.id)
gkey.delete()
assert len(new_user.gpgkeys.list()) == 0
# SSH keys
key = new_user.keys.create({"title": "testkey", "key": SSH_KEY})
assert len(new_user.keys.list()) == 1
key.delete()
assert len(new_user.keys.list()) == 0
# emails
email = new_user.emails.create({"email": "foo2@bar.com"})
assert len(new_user.emails.list()) == 1
email.delete()
assert len(new_user.emails.list()) == 0
# custom attributes
attrs = new_user.customattributes.list()
assert len(attrs) == 0
attr = new_user.customattributes.set("key", "value1")
assert len(gl.users.list(custom_attributes={"key": "value1"})) == 1
assert attr.key == "key"
assert attr.value == "value1"
assert len(new_user.customattributes.list()) == 1
attr = new_user.customattributes.set("key", "value2")
attr = new_user.customattributes.get("key")
assert attr.value == "value2"
assert len(new_user.customattributes.list()) == 1
attr.delete()
assert len(new_user.customattributes.list()) == 0
# impersonation tokens
user_token = new_user.impersonationtokens.create(
{"name": "token1", "scopes": ["api", "read_user"]}
)
l = new_user.impersonationtokens.list(state="active")
assert len(l) == 1
user_token.delete()
l = new_user.impersonationtokens.list(state="active")
assert len(l) == 0
l = new_user.impersonationtokens.list(state="inactive")
assert len(l) == 1
new_user.delete()
foobar_user.delete()
assert len(gl.users.list()) == 3 + len(
[u for u in gl.users.list() if u.username == "ghost"]
)
# current user mail
mail = gl.user.emails.create({"email": "current@user.com"})
assert len(gl.user.emails.list()) == 1
mail.delete()
assert len(gl.user.emails.list()) == 0
# current user GPG keys
gkey = gl.user.gpgkeys.create({"key": GPG_KEY})
assert len(gl.user.gpgkeys.list()) == 1
# Seems broken on the gitlab side
gkey = gl.user.gpgkeys.get(gkey.id)
gkey.delete()
assert len(gl.user.gpgkeys.list()) == 0
# current user key
key = gl.user.keys.create({"title": "testkey", "key": SSH_KEY})
assert len(gl.user.keys.list()) == 1
key.delete()
assert len(gl.user.keys.list()) == 0
# templates
assert gl.dockerfiles.list()
dockerfile = gl.dockerfiles.get("Node")
assert dockerfile.content is not None
assert gl.gitignores.list()
gitignore = gl.gitignores.get("Node")
assert gitignore.content is not None
assert gl.gitlabciymls.list()
gitlabciyml = gl.gitlabciymls.get("Nodejs")
assert gitlabciyml.content is not None
assert gl.licenses.list()
license = gl.licenses.get(
"bsd-2-clause", project="mytestproject", fullname="mytestfullname"
)
assert "mytestfullname" in license.content
# groups
user1 = gl.users.create(
{
"email": "user1@test.com",
"username": "user1",
"name": "user1",
"password": "user1_pass",
}
)
user2 = gl.users.create(
{
"email": "user2@test.com",
"username": "user2",
"name": "user2",
"password": "user2_pass",
}
)
group1 = gl.groups.create({"name": "group1", "path": "group1"})
group2 = gl.groups.create({"name": "group2", "path": "group2"})
p_id = gl.groups.list(search="group2")[0].id
group3 = gl.groups.create({"name": "group3", "path": "group3", "parent_id": p_id})
assert len(gl.groups.list()) == 3
assert len(gl.groups.list(search="oup1")) == 1
assert group3.parent_id == p_id
assert group2.subgroups.list()[0].id == group3.id
group1.members.create({"access_level": gitlab.const.OWNER_ACCESS, "user_id": user1.id})
group1.members.create({"access_level": gitlab.const.GUEST_ACCESS, "user_id": user2.id})
group2.members.create({"access_level": gitlab.const.OWNER_ACCESS, "user_id": user2.id})
# User memberships (admin only)
memberships1 = user1.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.OWNER_ACCESS
project_memberships = user1.memberships.list(type="Project")
assert len(project_memberships) == 0
group_memberships = user1.memberships.list(type="Namespace")
assert len(group_memberships) == 1
try:
membership = user1.memberships.list(type="Invalid")
except gitlab.GitlabListError as e:
error_message = e.error_message
assert error_message == "type does not have a valid value"
try:
user1.memberships.list(sudo=user1.name)
except gitlab.GitlabListError as e:
error_message = e.error_message
assert error_message == "403 Forbidden"
# Administrator belongs to the groups
assert len(group1.members.list()) == 3
assert len(group2.members.list()) == 2
group1.members.delete(user1.id)
assert len(group1.members.list()) == 2
assert len(group1.members.all())
member = group1.members.get(user2.id)
member.access_level = gitlab.const.OWNER_ACCESS
member.save()
member = group1.members.get(user2.id)
assert member.access_level == gitlab.const.OWNER_ACCESS
group2.members.delete(gl.user.id)
# group custom attributes
attrs = group2.customattributes.list()
assert len(attrs) == 0
attr = group2.customattributes.set("key", "value1")
assert len(gl.groups.list(custom_attributes={"key": "value1"})) == 1
assert attr.key == "key"
assert attr.value == "value1"
assert len(group2.customattributes.list()) == 1
attr = group2.customattributes.set("key", "value2")
attr = group2.customattributes.get("key")
assert attr.value == "value2"
assert len(group2.customattributes.list()) == 1
attr.delete()
assert len(group2.customattributes.list()) == 0
# group notification settings
settings = group2.notificationsettings.get()
settings.level = "disabled"
settings.save()
settings = group2.notificationsettings.get()
assert settings.level == "disabled"
# group badges
badge_image = "http://example.com"
badge_link = "http://example/img.svg"
badge = group2.badges.create({"link_url": badge_link, "image_url": badge_image})
assert len(group2.badges.list()) == 1
badge.image_url = "http://another.example.com"
badge.save()
badge = group2.badges.get(badge.id)
assert badge.image_url == "http://another.example.com"
badge.delete()
assert len(group2.badges.list()) == 0
# group milestones
gm1 = group1.milestones.create({"title": "groupmilestone1"})
assert len(group1.milestones.list()) == 1
gm1.due_date = "2020-01-01T00:00:00Z"
gm1.save()
gm1.state_event = "close"
gm1.save()
gm1 = group1.milestones.get(gm1.id)
assert gm1.state == "closed"
assert len(gm1.issues()) == 0
assert len(gm1.merge_requests()) == 0
# group variables
group1.variables.create({"key": "foo", "value": "bar"})
g_v = group1.variables.get("foo")
assert g_v.value == "bar"
g_v.value = "baz"
g_v.save()
g_v = group1.variables.get("foo")
assert g_v.value == "baz"
assert len(group1.variables.list()) == 1
g_v.delete()
assert len(group1.variables.list()) == 0
# group labels
# group1.labels.create({"name": "foo", "description": "bar", "color": "#112233"})
# g_l = group1.labels.get("foo")
# assert g_l.description == "bar"
# g_l.description = "baz"
# g_l.save()
# g_l = group1.labels.get("foo")
# assert g_l.description == "baz"
# assert len(group1.labels.list()) == 1
# g_l.delete()
# assert len(group1.labels.list()) == 0
# hooks
hook = gl.hooks.create({"url": "http://whatever.com"})
assert len(gl.hooks.list()) == 1
hook.delete()
assert len(gl.hooks.list()) == 0
# projects
admin_project = gl.projects.create({"name": "admin_project"})
gr1_project = gl.projects.create({"name": "gr1_project", "namespace_id": group1.id})
gr2_project = gl.projects.create({"name": "gr2_project", "namespace_id": group2.id})
sudo_project = gl.projects.create({"name": "sudo_project"}, sudo=user1.name)
assert len(gl.projects.list(owned=True)) == 2
assert len(gl.projects.list(search="admin")) == 1
# test pagination
l1 = gl.projects.list(per_page=1, page=1)
l2 = gl.projects.list(per_page=1, page=2)
assert len(l1) == 1
assert len(l2) == 1
assert l1[0].id != l2[0].id
# group custom attributes
attrs = admin_project.customattributes.list()
assert len(attrs) == 0
attr = admin_project.customattributes.set("key", "value1")
assert len(gl.projects.list(custom_attributes={"key": "value1"})) == 1
assert attr.key == "key"
assert attr.value == "value1"
assert len(admin_project.customattributes.list()) == 1
attr = admin_project.customattributes.set("key", "value2")
attr = admin_project.customattributes.get("key")
assert attr.value == "value2"
assert len(admin_project.customattributes.list()) == 1
attr.delete()
assert len(admin_project.customattributes.list()) == 0
# project pages domains
domain = admin_project.pagesdomains.create({"domain": "foo.domain.com"})
assert len(admin_project.pagesdomains.list()) == 1
assert len(gl.pagesdomains.list()) == 1
domain = admin_project.pagesdomains.get("foo.domain.com")
assert domain.domain == "foo.domain.com"
domain.delete()
assert len(admin_project.pagesdomains.list()) == 0
# project content (files)
admin_project.files.create(
{
"file_path": "README",
"branch": "master",
"content": "Initial content",
"commit_message": "Initial commit",
}
)
readme = admin_project.files.get(file_path="README", ref="master")
readme.content = base64.b64encode(b"Improved README").decode()
time.sleep(2)
readme.save(branch="master", commit_message="new commit")
readme.delete(commit_message="Removing README", branch="master")
admin_project.files.create(
{
"file_path": "README.rst",
"branch": "master",
"content": "Initial content",
"commit_message": "New commit",
}
)
readme = admin_project.files.get(file_path="README.rst", ref="master")
# The first decode() is the ProjectFile method, the second one is the bytes
# object method
assert readme.decode().decode() == "Initial content"
blame = admin_project.files.blame(file_path="README.rst", ref="master")
data = {
"branch": "master",
"commit_message": "blah blah blah",
"actions": [{"action": "create", "file_path": "blah", "content": "blah"}],
}
admin_project.commits.create(data)
assert "@@" in admin_project.commits.list()[0].diff()[0]["diff"]
# commit status
commit = admin_project.commits.list()[0]
# size = len(commit.statuses.list())
# status = commit.statuses.create({"state": "success", "sha": commit.id})
# assert len(commit.statuses.list()) == size + 1
# assert commit.refs()
# assert commit.merge_requests()
# commit comment
commit.comments.create({"note": "This is a commit comment"})
# assert len(commit.comments.list()) == 1
# commit discussion
count = len(commit.discussions.list())
discussion = commit.discussions.create({"body": "Discussion body"})
# assert len(commit.discussions.list()) == (count + 1)
d_note = discussion.notes.create({"body": "first note"})
d_note_from_get = discussion.notes.get(d_note.id)
d_note_from_get.body = "updated body"
d_note_from_get.save()
discussion = commit.discussions.get(discussion.id)
# assert discussion.attributes["notes"][-1]["body"] == "updated body"
d_note_from_get.delete()
discussion = commit.discussions.get(discussion.id)
# assert len(discussion.attributes["notes"]) == 1
# Revert commit
revert_commit = commit.revert(branch="master")
expected_message = 'Revert "{}"\n\nThis reverts commit {}'.format(
commit.message, commit.id
)
assert revert_commit["message"] == expected_message
try:
commit.revert(branch="master")
# Only here to really ensure expected error without a full test framework
raise AssertionError("Two revert attempts should raise GitlabRevertError")
except gitlab.GitlabRevertError:
pass
# housekeeping
admin_project.housekeeping()
# repository
tree = admin_project.repository_tree()
assert len(tree) != 0
assert tree[0]["name"] == "README.rst"
blob_id = tree[0]["id"]
blob = admin_project.repository_raw_blob(blob_id)
assert blob.decode() == "Initial content"
archive1 = admin_project.repository_archive()
archive2 = admin_project.repository_archive("master")
assert archive1 == archive2
snapshot = admin_project.snapshot()
# project file uploads
filename = "test.txt"
file_contents = "testing contents"
uploaded_file = admin_project.upload(filename, file_contents)
assert uploaded_file["alt"] == filename
assert uploaded_file["url"].startswith("/uploads/")
assert uploaded_file["url"].endswith("/" + filename)
assert uploaded_file["markdown"] == "[{}]({})".format(
uploaded_file["alt"], uploaded_file["url"]
)
# environments
admin_project.environments.create(
{"name": "env1", "external_url": "http://fake.env/whatever"}
)
envs = admin_project.environments.list()
assert len(envs) == 1
env = envs[0]
env.external_url = "http://new.env/whatever"
env.save()
env = admin_project.environments.list()[0]
assert env.external_url == "http://new.env/whatever"
env.stop()
env.delete()
assert len(admin_project.environments.list()) == 0
# Project clusters
admin_project.clusters.create(
{
"name": "cluster1",
"platform_kubernetes_attributes": {
"api_url": "http://url",
"token": "tokenval",
},
}
)
clusters = admin_project.clusters.list()
assert len(clusters) == 1
cluster = clusters[0]
cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"}
cluster.save()
cluster = admin_project.clusters.list()[0]
assert cluster.platform_kubernetes["api_url"] == "http://newurl"
cluster.delete()
assert len(admin_project.clusters.list()) == 0
# Group clusters
group1.clusters.create(
{
"name": "cluster1",
"platform_kubernetes_attributes": {
"api_url": "http://url",
"token": "tokenval",
},
}
)
clusters = group1.clusters.list()
assert len(clusters) == 1
cluster = clusters[0]
cluster.platform_kubernetes_attributes = {"api_url": "http://newurl"}
cluster.save()
cluster = group1.clusters.list()[0]
assert cluster.platform_kubernetes["api_url"] == "http://newurl"
cluster.delete()
assert len(group1.clusters.list()) == 0
# project events
admin_project.events.list()
# forks
fork = admin_project.forks.create({"namespace": user1.username})
p = gl.projects.get(fork.id)
assert p.forked_from_project["id"] == admin_project.id
forks = admin_project.forks.list()
assert fork.id in map(lambda p: p.id, forks)
# project hooks
hook = admin_project.hooks.create({"url": "http://hook.url"})
assert len(admin_project.hooks.list()) == 1
hook.note_events = True
hook.save()
hook = admin_project.hooks.get(hook.id)
assert hook.note_events is True
hook.delete()
# deploy keys
deploy_key = admin_project.keys.create({"title": "foo@bar", "key": DEPLOY_KEY})
project_keys = list(admin_project.keys.list())
assert len(project_keys) == 1
sudo_project.keys.enable(deploy_key.id)
assert len(sudo_project.keys.list()) == 1
sudo_project.keys.delete(deploy_key.id)
assert len(sudo_project.keys.list()) == 0
# labels
# label1 = admin_project.labels.create({"name": "label1", "color": "#778899"})
# label1 = admin_project.labels.list()[0]
# assert len(admin_project.labels.list()) == 1
# label1.new_name = "label1updated"
# label1.save()
# assert label1.name == "label1updated"
# label1.subscribe()
# assert label1.subscribed == True
# label1.unsubscribe()
# assert label1.subscribed == False
# label1.delete()
# milestones
m1 = admin_project.milestones.create({"title": "milestone1"})
assert len(admin_project.milestones.list()) == 1
m1.due_date = "2020-01-01T00:00:00Z"
m1.save()
m1.state_event = "close"
m1.save()
m1 = admin_project.milestones.get(m1.id)
assert m1.state == "closed"
assert len(m1.issues()) == 0
assert len(m1.merge_requests()) == 0
# issues
issue1 = admin_project.issues.create({"title": "my issue 1", "milestone_id": m1.id})
issue2 = admin_project.issues.create({"title": "my issue 2"})
issue3 = admin_project.issues.create({"title": "my issue 3"})
assert len(admin_project.issues.list()) == 3
issue3.state_event = "close"
issue3.save()
assert len(admin_project.issues.list(state="closed")) == 1
assert len(admin_project.issues.list(state="opened")) == 2
assert len(admin_project.issues.list(milestone="milestone1")) == 1
assert m1.issues().next().title == "my issue 1"
size = len(issue1.notes.list())
note = issue1.notes.create({"body": "This is an issue note"})
assert len(issue1.notes.list()) == size + 1
emoji = note.awardemojis.create({"name": "tractor"})
assert len(note.awardemojis.list()) == 1
emoji.delete()
assert len(note.awardemojis.list()) == 0
note.delete()
assert len(issue1.notes.list()) == size
assert isinstance(issue1.user_agent_detail(), dict)
assert issue1.user_agent_detail()["user_agent"]
assert issue1.participants()
assert type(issue1.closed_by()) == list
assert type(issue1.related_merge_requests()) == list
# issues labels and events
label2 = admin_project.labels.create({"name": "label2", "color": "#aabbcc"})
issue1.labels = ["label2"]
issue1.save()
events = issue1.resourcelabelevents.list()
assert events
event = issue1.resourcelabelevents.get(events[0].id)
assert event
size = len(issue1.discussions.list())
discussion = issue1.discussions.create({"body": "Discussion body"})
assert len(issue1.discussions.list()) == size + 1
d_note = discussion.notes.create({"body": "first note"})
d_note_from_get = discussion.notes.get(d_note.id)
d_note_from_get.body = "updated body"
d_note_from_get.save()
discussion = issue1.discussions.get(discussion.id)
assert discussion.attributes["notes"][-1]["body"] == "updated body"
d_note_from_get.delete()
discussion = issue1.discussions.get(discussion.id)
assert len(discussion.attributes["notes"]) == 1
# tags
tag1 = admin_project.tags.create({"tag_name": "v1.0", "ref": "master"})
assert len(admin_project.tags.list()) == 1
tag1.set_release_description("Description 1")
tag1.set_release_description("Description 2")
assert tag1.release["description"] == "Description 2"
tag1.delete()
# project snippet
admin_project.snippets_enabled = True
admin_project.save()
snippet = admin_project.snippets.create(
{
"title": "snip1",
"file_name": "foo.py",
"content": "initial content",
"visibility": gitlab.v4.objects.VISIBILITY_PRIVATE,
}
)
assert snippet.user_agent_detail()["user_agent"]
size = len(snippet.discussions.list())
discussion = snippet.discussions.create({"body": "Discussion body"})
assert len(snippet.discussions.list()) == size + 1
d_note = discussion.notes.create({"body": "first note"})
d_note_from_get = discussion.notes.get(d_note.id)
d_note_from_get.body = "updated body"
d_note_from_get.save()
discussion = snippet.discussions.get(discussion.id)
assert discussion.attributes["notes"][-1]["body"] == "updated body"
d_note_from_get.delete()
discussion = snippet.discussions.get(discussion.id)
assert len(discussion.attributes["notes"]) == 1
snippet.file_name = "bar.py"
snippet.save()
snippet = admin_project.snippets.get(snippet.id)
assert snippet.content().decode() == "initial content"
assert snippet.file_name == "bar.py"
size = len(admin_project.snippets.list())
snippet.delete()
assert len(admin_project.snippets.list()) == (size - 1)
# triggers
tr1 = admin_project.triggers.create({"description": "trigger1"})
assert len(admin_project.triggers.list()) == 1
tr1.delete()
# variables
v1 = admin_project.variables.create({"key": "key1", "value": "value1"})
assert len(admin_project.variables.list()) == 1
v1.value = "new_value1"
v1.save()
v1 = admin_project.variables.get(v1.key)
assert v1.value == "new_value1"
v1.delete()
# branches and merges
to_merge = admin_project.branches.create({"branch": "branch1", "ref": "master"})
admin_project.files.create(
{
"file_path": "README2.rst",
"branch": "branch1",
"content": "Initial content",
"commit_message": "New commit in new branch",
}
)
mr = admin_project.mergerequests.create(
{"source_branch": "branch1", "target_branch": "master", "title": "MR readme2"}
)
# discussion
size = len(mr.discussions.list())
discussion = mr.discussions.create({"body": "Discussion body"})
assert len(mr.discussions.list()) == size + 1
d_note = discussion.notes.create({"body": "first note"})
d_note_from_get = discussion.notes.get(d_note.id)
d_note_from_get.body = "updated body"
d_note_from_get.save()
discussion = mr.discussions.get(discussion.id)
assert discussion.attributes["notes"][-1]["body"] == "updated body"
d_note_from_get.delete()
discussion = mr.discussions.get(discussion.id)
assert len(discussion.attributes["notes"]) == 1
# mr labels and events
mr.labels = ["label2"]
mr.save()
events = mr.resourcelabelevents.list()
assert events
event = mr.resourcelabelevents.get(events[0].id)
assert event
# rebasing
assert mr.rebase()
# basic testing: only make sure that the methods exist
mr.commits()
mr.changes()
assert mr.participants()
mr.merge()
admin_project.branches.delete("branch1")
try:
mr.merge()
except gitlab.GitlabMRClosedError:
pass
# protected branches
p_b = admin_project.protectedbranches.create({"name": "*-stable"})
assert p_b.name == "*-stable"
p_b = admin_project.protectedbranches.get("*-stable")
# master is protected by default when a branch has been created
assert len(admin_project.protectedbranches.list()) == 2
admin_project.protectedbranches.delete("master")
p_b.delete()
assert len(admin_project.protectedbranches.list()) == 0
# stars
admin_project.star()
assert admin_project.star_count == 1
admin_project.unstar()
assert admin_project.star_count == 0
# project boards
# boards = admin_project.boards.list()
# assert(len(boards))
# board = boards[0]
# lists = board.lists.list()
# begin_size = len(lists)
# last_list = lists[-1]
# last_list.position = 0
# last_list.save()
# last_list.delete()
# lists = board.lists.list()
# assert(len(lists) == begin_size - 1)
# project badges
badge_image = "http://example.com"
badge_link = "http://example/img.svg"
badge = admin_project.badges.create({"link_url": badge_link, "image_url": badge_image})
assert len(admin_project.badges.list()) == 1
badge.image_url = "http://another.example.com"
badge.save()
badge = admin_project.badges.get(badge.id)
assert badge.image_url == "http://another.example.com"
badge.delete()
assert len(admin_project.badges.list()) == 0
# project wiki
wiki_content = "Wiki page content"
wp = admin_project.wikis.create({"title": "wikipage", "content": wiki_content})
assert len(admin_project.wikis.list()) == 1
wp = admin_project.wikis.get(wp.slug)
assert wp.content == wiki_content
# update and delete seem broken
# wp.content = 'new content'
# wp.save()
# wp.delete()
# assert(len(admin_project.wikis.list()) == 0)
# namespaces
ns = gl.namespaces.list(all=True)
assert len(ns) != 0
ns = gl.namespaces.list(search="root", all=True)[0]
assert ns.kind == "user"
# features
# Disabled as this fails with GitLab 11.11
# feat = gl.features.set("foo", 30)
# assert feat.name == "foo"
# assert len(gl.features.list()) == 1
# feat.delete()
# assert len(gl.features.list()) == 0
# broadcast messages
msg = gl.broadcastmessages.create({"message": "this is the message"})
msg.color = "#444444"
msg.save()
msg_id = msg.id
msg = gl.broadcastmessages.list(all=True)[0]
assert msg.color == "#444444"
msg = gl.broadcastmessages.get(msg_id)
assert msg.color == "#444444"
msg.delete()
assert len(gl.broadcastmessages.list()) == 0
# notification settings
settings = gl.notificationsettings.get()
settings.level = gitlab.NOTIFICATION_LEVEL_WATCH
settings.save()
settings = gl.notificationsettings.get()
assert settings.level == gitlab.NOTIFICATION_LEVEL_WATCH
# services
service = admin_project.services.get("asana")
service.api_key = "whatever"
service.save()
service = admin_project.services.get("asana")
assert service.active == True
service.delete()
service = admin_project.services.get("asana")
assert service.active == False
# snippets
snippets = gl.snippets.list(all=True)
assert len(snippets) == 0
snippet = gl.snippets.create(
{"title": "snippet1", "file_name": "snippet1.py", "content": "import gitlab"}
)
snippet = gl.snippets.get(snippet.id)
snippet.title = "updated_title"
snippet.save()
snippet = gl.snippets.get(snippet.id)
assert snippet.title == "updated_title"
content = snippet.content()
assert content.decode() == "import gitlab"
assert snippet.user_agent_detail()["user_agent"]
snippet.delete()
snippets = gl.snippets.list(all=True)
assert len(snippets) == 0
# user activities
gl.user_activities.list(query_parameters={"from": "2019-01-01"})
# events
gl.events.list()
# rate limit
settings = gl.settings.get()
settings.throttle_authenticated_api_enabled = True
settings.throttle_authenticated_api_requests_per_period = 1
settings.throttle_authenticated_api_period_in_seconds = 3
settings.save()
projects = list()
for i in range(0, 20):
projects.append(gl.projects.create({"name": str(i) + "ok"}))
error_message = None
for i in range(20, 40):
try:
projects.append(
gl.projects.create({"name": str(i) + "shouldfail"}, obey_rate_limit=False)
)
except gitlab.GitlabCreateError as e:
error_message = e.error_message
break
assert "Retry later" in error_message
settings.throttle_authenticated_api_enabled = False
settings.save()
[current_project.delete() for current_project in projects]
# project import/export
ex = admin_project.exports.create()
ex.refresh()
count = 0
while ex.export_status != "finished":
time.sleep(1)
ex.refresh()
count += 1
if count == 10:
raise Exception("Project export taking too much time")
with open("/tmp/gitlab-export.tgz", "wb") as f:
ex.download(streamed=True, action=f.write)
output = gl.projects.import_project(
open("/tmp/gitlab-export.tgz", "rb"), "imported_project", name="Imported Project"
)
project_import = gl.projects.get(output["id"], lazy=True).imports.get()
assert project_import.path == "imported_project"
assert project_import.name == "Imported Project"
count = 0
while project_import.import_status != "finished":
time.sleep(1)
project_import.refresh()
count += 1
if count == 10:
raise Exception("Project import taking too much time")
# project releases
release_test_project = gl.projects.create(
{"name": "release-test-project", "initialize_with_readme": True}
)
release_name = "Demo Release"
release_tag_name = "v1.2.3"
release_description = "release notes go here"
release_test_project.releases.create(
{
"name": release_name,
"tag_name": release_tag_name,
"description": release_description,
"ref": "master",
}
)
assert len(release_test_project.releases.list()) == 1
# get single release
retrieved_project = release_test_project.releases.get(release_tag_name)
assert retrieved_project.name == release_name
assert retrieved_project.tag_name == release_tag_name