Skip to content

Commit 2f83fe1

Browse files
JesseKlaasseJesseKlaasse
authored
Add patch and protected branch update (#870)
* feat: add support for patch method in API * feat: implement update functionality for protected branches in API * refactor: refactor access level updates for protected branches in API * fix: add missing items in PublicAPI.Unshipped.txt * test: enhance ProtectedBranchTests to validate protected branch update * fix: update new AccessLevelInfo properties to nullable types * test: fix tests * test: re-enable NGitLabRetry for ProtectBranch_Test
1 parent 9426510 commit 2f83fe1

10 files changed

+222
-18
lines changed

‎NGitLab.Mock/Clients/ProtectedBranchClient.cs

+89
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System;
2+
using System.Collections.Generic;
23
using System.Linq;
34
using NGitLab.Models;
45

@@ -67,4 +68,92 @@ public void UnprotectBranch(string branchName)
6768
}
6869
}
6970
}
71+
72+
public Models.ProtectedBranch UpdateProtectedBranch(string branchName, ProtectedBranchUpdate protectedBranchUpdate)
73+
{
74+
using (Context.BeginOperationScope())
75+
{
76+
var project = GetProject(_projectId, ProjectPermission.Edit);
77+
var protectedBranch = project.ProtectedBranches.First(b => b.Name.Equals(branchName, StringComparison.Ordinal));
78+
79+
if (protectedBranchUpdate.CodeOwnerApprovalRequired is not null)
80+
{
81+
protectedBranch.CodeOwnerApprovalRequired = protectedBranchUpdate.CodeOwnerApprovalRequired.Value;
82+
}
83+
84+
if (protectedBranchUpdate.AllowForcePush is not null)
85+
{
86+
protectedBranch.AllowForcePush = protectedBranchUpdate.AllowForcePush.Value;
87+
}
88+
89+
if (protectedBranchUpdate.AllowedToMerge is not null)
90+
{
91+
UpdateAccessLevels(
92+
protectedBranchUpdate.AllowedToMerge,
93+
(id, level) => protectedBranch.MergeAccessLevels.First(l => l.Id == id).AccessLevel = level,
94+
newAccessLevel => protectedBranch.MergeAccessLevels = protectedBranch.MergeAccessLevels.Concat([newAccessLevel]).ToArray(),
95+
id => protectedBranch.MergeAccessLevels = protectedBranch.MergeAccessLevels.Where(l => l.Id != id).ToArray()
96+
);
97+
}
98+
99+
if (protectedBranchUpdate.AllowedToPush is not null)
100+
{
101+
UpdateAccessLevels(
102+
protectedBranchUpdate.AllowedToPush,
103+
(id, level) => protectedBranch.PushAccessLevels.First(l => l.Id == id).AccessLevel = level,
104+
newAccessLevel => protectedBranch.PushAccessLevels = protectedBranch.PushAccessLevels.Concat([newAccessLevel]).ToArray(),
105+
id => protectedBranch.PushAccessLevels = protectedBranch.PushAccessLevels.Where(l => l.Id != id).ToArray()
106+
);
107+
}
108+
109+
return protectedBranch.ToProtectedBranchClient();
110+
}
111+
}
112+
113+
private void UpdateAccessLevels(IEnumerable<AccessLevelUpdate> accessLevels, Action<int, AccessLevel> updateAccessLevel, Action<AccessLevelInfo> addAccessLevel, Action<int> removeAccessLevel)
114+
{
115+
foreach (var accessLevel in accessLevels)
116+
{
117+
UpdateAccessLevel(updateAccessLevel, addAccessLevel, removeAccessLevel, accessLevel);
118+
}
119+
}
120+
121+
private static void UpdateAccessLevel(Action<int, AccessLevel> updateAccessLevel, Action<AccessLevelInfo> addAccessLevel, Action<int> removeAccessLevel,
122+
AccessLevelUpdate accessLevel)
123+
{
124+
if (accessLevel.Id is not null && accessLevel.Destroy is true)
125+
{
126+
removeAccessLevel(accessLevel.Id.Value);
127+
return;
128+
}
129+
130+
if (accessLevel.Id is not null && accessLevel.Destroy is false && accessLevel.AccessLevel is not null)
131+
{
132+
updateAccessLevel(accessLevel.Id.Value, accessLevel.AccessLevel.Value);
133+
return;
134+
}
135+
136+
if (accessLevel.Id is not null || accessLevel.Destroy is not false) return;
137+
138+
var newAccessLevel = new AccessLevelInfo();
139+
140+
if (accessLevel.AccessLevel is not null)
141+
{
142+
accessLevel.AccessLevel = accessLevel.AccessLevel.Value;
143+
}
144+
145+
accessLevel.Description = accessLevel.Description;
146+
147+
if (accessLevel.GroupId is not null)
148+
{
149+
accessLevel.GroupId = accessLevel.GroupId.Value;
150+
}
151+
152+
if (accessLevel.UserId is not null)
153+
{
154+
accessLevel.UserId = accessLevel.UserId.Value;
155+
}
156+
157+
addAccessLevel(newAccessLevel);
158+
}
70159
}

‎NGitLab.Tests/ProtectedBranchTests.cs

+42-17
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
using System.Threading.Tasks;
1+
using System;
2+
using System.Linq;
3+
using System.Threading.Tasks;
24
using NGitLab.Models;
35
using NGitLab.Tests.Docker;
46
using NUnit.Framework;
@@ -14,53 +16,76 @@ public async Task ProtectBranch_Test()
1416
using var context = await GitLabTestContext.CreateAsync();
1517
var project = context.CreateProject(initializeWithCommits: true);
1618
var branchClient = context.Client.GetRepository(project.Id).Branches;
17-
var branch = branchClient.Create(new BranchCreate { Name = "protectedBranch", Ref = project.DefaultBranch });
19+
var branch = branchClient.Create(new BranchCreate { Name = $"protectedBranch-{Guid.NewGuid()}", Ref = project.DefaultBranch });
1820
var protectedBranchClient = context.Client.GetProtectedBranchClient(project.Id);
1921
var branchProtect = new BranchProtect(branch.Name)
2022
{
2123
PushAccessLevel = AccessLevel.Maintainer,
2224
MergeAccessLevel = AccessLevel.NoAccess,
2325
AllowForcePush = true,
24-
AllowedToPush = new[]
25-
{
26-
new AccessLevelInfo
27-
{
28-
AccessLevel = AccessLevel.Admin,
29-
Description = "Admin",
30-
},
31-
},
26+
AllowedToPush = new[] { new AccessLevelInfo { AccessLevel = AccessLevel.Admin, Description = "Admin", }, },
27+
AllowedToMerge = new[] { new AccessLevelInfo { AccessLevel = AccessLevel.Admin, Description = "Admin", }, },
3228
AllowedToUnprotect = new[]
3329
{
34-
new AccessLevelInfo
35-
{
36-
AccessLevel = AccessLevel.Admin,
37-
Description = "Example",
38-
},
30+
new AccessLevelInfo { AccessLevel = AccessLevel.Admin, Description = "Example", },
3931
},
4032
};
4133

4234
// Protect branch
4335
ProtectedBranchAndBranchProtectAreEquals(branchProtect, protectedBranchClient.ProtectBranch(branchProtect));
4436

4537
// Get branch
46-
ProtectedBranchAndBranchProtectAreEquals(branchProtect, protectedBranchClient.GetProtectedBranch(branch.Name));
38+
var existingBranch = protectedBranchClient.GetProtectedBranch(branch.Name);
39+
ProtectedBranchAndBranchProtectAreEquals(branchProtect, existingBranch);
4740

4841
// Get branches
4942
Assert.That(protectedBranchClient.GetProtectedBranches(), Is.Not.Empty);
5043
var protectedBranches = protectedBranchClient.GetProtectedBranches(branch.Name);
5144
Assert.That(protectedBranches, Is.Not.Empty);
5245
ProtectedBranchAndBranchProtectAreEquals(branchProtect, protectedBranches[0]);
5346

47+
// Update protected branch - test delete and update
48+
var protectedBranchUpdate = new ProtectedBranchUpdate
49+
{
50+
AllowForcePush = false,
51+
AllowedToPush = new[]
52+
{
53+
new AccessLevelUpdate { Id = existingBranch.PushAccessLevels.First(l => l.AccessLevel == AccessLevel.Admin).Id, Destroy = true, }, // This existing one should be deleted
54+
},
55+
AllowedToMerge = new[]
56+
{
57+
new AccessLevelUpdate { Id = existingBranch.MergeAccessLevels.First(l => l.AccessLevel == AccessLevel.Admin).Id, AccessLevel = AccessLevel.Maintainer } // The existing one should be updated
58+
}
59+
};
60+
var updatedBranch = protectedBranchClient.UpdateProtectedBranch(branch.Name, protectedBranchUpdate);
61+
Assert.That(updatedBranch.AllowForcePush, Is.EqualTo(protectedBranchUpdate.AllowForcePush));
62+
Assert.That(updatedBranch.PushAccessLevels.Count(l => l.AccessLevel == AccessLevel.Admin), Is.EqualTo(0));
63+
Assert.That(updatedBranch.MergeAccessLevels.Count(l => l.AccessLevel == AccessLevel.Admin), Is.EqualTo(0));
64+
Assert.That(updatedBranch.MergeAccessLevels.Count(l => l.AccessLevel == AccessLevel.Maintainer), Is.EqualTo(1));
65+
66+
// Update protected branch - test create
67+
protectedBranchUpdate = new ProtectedBranchUpdate
68+
{
69+
AllowedToPush = new[]
70+
{
71+
new AccessLevelUpdate { AccessLevel = AccessLevel.Admin }, // This one should be created
72+
}
73+
};
74+
updatedBranch = protectedBranchClient.UpdateProtectedBranch(branch.Name, protectedBranchUpdate);
75+
Assert.That(updatedBranch.PushAccessLevels.Count(l => l.AccessLevel == AccessLevel.Admin), Is.EqualTo(1));
76+
5477
// Unprotect branch
5578
protectedBranchClient.UnprotectBranch(branch.Name);
5679
Assert.That(protectedBranchClient.GetProtectedBranches(branch.Name), Is.Empty);
5780
}
5881

59-
private static void ProtectedBranchAndBranchProtectAreEquals(BranchProtect branchProtect, ProtectedBranch protectedBranch)
82+
private static void ProtectedBranchAndBranchProtectAreEquals(BranchProtect branchProtect,
83+
ProtectedBranch protectedBranch)
6084
{
6185
Assert.That(protectedBranch.Name, Is.EqualTo(branchProtect.BranchName));
6286
Assert.That(protectedBranch.PushAccessLevels[0].AccessLevel, Is.EqualTo(branchProtect.PushAccessLevel));
6387
Assert.That(protectedBranch.MergeAccessLevels[0].AccessLevel, Is.EqualTo(branchProtect.MergeAccessLevel));
6488
Assert.That(protectedBranch.AllowForcePush, Is.EqualTo(branchProtect.AllowForcePush));
89+
Assert.That(protectedBranch.CodeOwnerApprovalRequired, Is.EqualTo(branchProtect.CodeOwnerApprovalRequired));
6590
}
6691
}

‎NGitLab/IProtectedBranchClient.cs

+2
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ public interface IProtectedBranchClient
1111
ProtectedBranch GetProtectedBranch(string branchName);
1212

1313
ProtectedBranch[] GetProtectedBranches(string search = null);
14+
15+
ProtectedBranch UpdateProtectedBranch(string branchName, ProtectedBranchUpdate protectedBranchUpdate);
1416
}

‎NGitLab/Impl/API.cs

+2
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ public API(GitLabCredentials credentials, RequestOptions options)
3636

3737
public IHttpRequestor Head() => CreateRequestor(MethodType.Head);
3838

39+
public IHttpRequestor Patch() => CreateRequestor(MethodType.Patch);
40+
3941
protected virtual IHttpRequestor CreateRequestor(MethodType methodType)
4042
{
4143
string token;

‎NGitLab/Impl/HttpRequestor.GitLabRequest.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ private sealed class GitLabRequest
3434
public WebHeaderCollection Headers { get; } = [];
3535

3636
private bool HasOutput
37-
=> (Method == MethodType.Delete || Method == MethodType.Post || Method == MethodType.Put)
37+
=> (Method == MethodType.Delete || Method == MethodType.Post || Method == MethodType.Put || Method == MethodType.Patch)
3838
&& Data != null;
3939

4040
public GitLabRequest(Uri url, MethodType method, object data, string apiToken, RequestOptions options = null)

‎NGitLab/Impl/ProtectedBranchClient.cs

+3
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,7 @@ public ProtectedBranch GetProtectedBranch(string branchName)
2525

2626
public ProtectedBranch[] GetProtectedBranches(string search = null)
2727
=> _api.Get().To<ProtectedBranch[]>(Utils.AddParameter(_protectedBranchesUrl, "search", search));
28+
29+
public ProtectedBranch UpdateProtectedBranch(string branchName, ProtectedBranchUpdate protectedBranchUpdate)
30+
=> _api.Patch().With(protectedBranchUpdate).To<ProtectedBranch>($"{_protectedBranchesUrl}/{Uri.EscapeDataString(branchName)}");
2831
}

‎NGitLab/Models/AccessLevelInfo.cs

+9
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,18 @@ namespace NGitLab.Models;
44

55
public class AccessLevelInfo
66
{
7+
[JsonPropertyName("id")]
8+
public int? Id { get; set; }
9+
710
[JsonPropertyName("access_level")]
811
public AccessLevel AccessLevel { get; set; }
912

1013
[JsonPropertyName("access_level_description")]
1114
public string Description { get; set; }
15+
16+
[JsonPropertyName("user_id")]
17+
public int? UserId { get; set; }
18+
19+
[JsonPropertyName("group_id")]
20+
public int? GroupId { get; set; }
1221
}

‎NGitLab/Models/AccessLevelUpdate.cs

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
using System.Text.Json.Serialization;
2+
3+
namespace NGitLab.Models;
4+
5+
public sealed class AccessLevelUpdate
6+
{
7+
[JsonPropertyName("id")]
8+
public int? Id { get; set; }
9+
10+
[JsonPropertyName("_destroy")]
11+
public bool? Destroy { get; set; }
12+
13+
[JsonPropertyName("access_level")]
14+
public AccessLevel? AccessLevel { get; set; }
15+
16+
[JsonPropertyName("access_level_description")]
17+
public string Description { get; set; }
18+
19+
[JsonPropertyName("user_id")]
20+
public int? UserId { get; set; }
21+
22+
[JsonPropertyName("group_id")]
23+
public int? GroupId { get; set; }
24+
}

‎NGitLab/Models/ProtectedBranchUpdate.cs

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
using System.Text.Json.Serialization;
2+
3+
namespace NGitLab.Models;
4+
5+
public sealed class ProtectedBranchUpdate
6+
{
7+
[JsonPropertyName("allowed_to_push")]
8+
public AccessLevelUpdate[] AllowedToPush { get; set; }
9+
10+
[JsonPropertyName("allowed_to_merge")]
11+
public AccessLevelUpdate[] AllowedToMerge { get; set; }
12+
13+
[JsonPropertyName("allow_force_push")]
14+
public bool? AllowForcePush { get; set; }
15+
16+
[JsonPropertyName("code_owner_approval_required")]
17+
public bool? CodeOwnerApprovalRequired { get; set; }
18+
}

‎NGitLab/PublicAPI.Unshipped.txt

+32
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,7 @@ NGitLab.Impl.API.ConnectionToken.set -> void
462462
NGitLab.Impl.API.Delete() -> NGitLab.IHttpRequestor
463463
NGitLab.Impl.API.Get() -> NGitLab.IHttpRequestor
464464
NGitLab.Impl.API.Head() -> NGitLab.IHttpRequestor
465+
NGitLab.Impl.API.Patch() -> NGitLab.IHttpRequestor
465466
NGitLab.Impl.API.Post() -> NGitLab.IHttpRequestor
466467
NGitLab.Impl.API.Put() -> NGitLab.IHttpRequestor
467468
NGitLab.Impl.API.RequestOptions.get -> NGitLab.RequestOptions
@@ -1080,6 +1081,7 @@ NGitLab.IProtectedBranchClient.GetProtectedBranch(string branchName) -> NGitLab.
10801081
NGitLab.IProtectedBranchClient.GetProtectedBranches(string search = null) -> NGitLab.Models.ProtectedBranch[]
10811082
NGitLab.IProtectedBranchClient.ProtectBranch(NGitLab.Models.BranchProtect branchProtect) -> NGitLab.Models.ProtectedBranch
10821083
NGitLab.IProtectedBranchClient.UnprotectBranch(string branchName) -> void
1084+
NGitLab.IProtectedBranchClient.UpdateProtectedBranch(string branchName, NGitLab.Models.ProtectedBranchUpdate protectedBranchUpdate) -> NGitLab.Models.ProtectedBranch
10831085
NGitLab.IProtectedTagClient
10841086
NGitLab.IProtectedTagClient.GetProtectedTag(string name) -> NGitLab.Models.ProtectedTag
10851087
NGitLab.IProtectedTagClient.GetProtectedTagAsync(string name, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<NGitLab.Models.ProtectedTag>
@@ -1243,6 +1245,26 @@ NGitLab.Models.AccessLevelInfo.AccessLevel.set -> void
12431245
NGitLab.Models.AccessLevelInfo.AccessLevelInfo() -> void
12441246
NGitLab.Models.AccessLevelInfo.Description.get -> string
12451247
NGitLab.Models.AccessLevelInfo.Description.set -> void
1248+
NGitLab.Models.AccessLevelInfo.GroupId.get -> int?
1249+
NGitLab.Models.AccessLevelInfo.GroupId.set -> void
1250+
NGitLab.Models.AccessLevelInfo.Id.get -> int?
1251+
NGitLab.Models.AccessLevelInfo.Id.set -> void
1252+
NGitLab.Models.AccessLevelInfo.UserId.get -> int?
1253+
NGitLab.Models.AccessLevelInfo.UserId.set -> void
1254+
NGitLab.Models.AccessLevelUpdate
1255+
NGitLab.Models.AccessLevelUpdate.AccessLevel.get -> NGitLab.Models.AccessLevel?
1256+
NGitLab.Models.AccessLevelUpdate.AccessLevel.set -> void
1257+
NGitLab.Models.AccessLevelUpdate.AccessLevelUpdate() -> void
1258+
NGitLab.Models.AccessLevelUpdate.Description.get -> string
1259+
NGitLab.Models.AccessLevelUpdate.Description.set -> void
1260+
NGitLab.Models.AccessLevelUpdate.Destroy.get -> bool?
1261+
NGitLab.Models.AccessLevelUpdate.Destroy.set -> void
1262+
NGitLab.Models.AccessLevelUpdate.GroupId.get -> int?
1263+
NGitLab.Models.AccessLevelUpdate.GroupId.set -> void
1264+
NGitLab.Models.AccessLevelUpdate.Id.get -> int?
1265+
NGitLab.Models.AccessLevelUpdate.Id.set -> void
1266+
NGitLab.Models.AccessLevelUpdate.UserId.get -> int?
1267+
NGitLab.Models.AccessLevelUpdate.UserId.set -> void
12461268
NGitLab.Models.ApprovalRule
12471269
NGitLab.Models.ApprovalRule.ApprovalRule() -> void
12481270
NGitLab.Models.ApprovalRule.ApprovalsRequired.get -> int
@@ -3939,6 +3961,16 @@ NGitLab.Models.ProtectedBranch.Name.set -> void
39393961
NGitLab.Models.ProtectedBranch.ProtectedBranch() -> void
39403962
NGitLab.Models.ProtectedBranch.PushAccessLevels.get -> NGitLab.Models.AccessLevelInfo[]
39413963
NGitLab.Models.ProtectedBranch.PushAccessLevels.set -> void
3964+
NGitLab.Models.ProtectedBranchUpdate
3965+
NGitLab.Models.ProtectedBranchUpdate.AllowedToMerge.get -> NGitLab.Models.AccessLevelUpdate[]
3966+
NGitLab.Models.ProtectedBranchUpdate.AllowedToMerge.set -> void
3967+
NGitLab.Models.ProtectedBranchUpdate.AllowedToPush.get -> NGitLab.Models.AccessLevelUpdate[]
3968+
NGitLab.Models.ProtectedBranchUpdate.AllowedToPush.set -> void
3969+
NGitLab.Models.ProtectedBranchUpdate.AllowForcePush.get -> bool?
3970+
NGitLab.Models.ProtectedBranchUpdate.AllowForcePush.set -> void
3971+
NGitLab.Models.ProtectedBranchUpdate.CodeOwnerApprovalRequired.get -> bool?
3972+
NGitLab.Models.ProtectedBranchUpdate.CodeOwnerApprovalRequired.set -> void
3973+
NGitLab.Models.ProtectedBranchUpdate.ProtectedBranchUpdate() -> void
39423974
NGitLab.Models.ProtectedTag
39433975
NGitLab.Models.ProtectedTag.CreateAccessLevels.get -> NGitLab.Models.AccessLevelInfo[]
39443976
NGitLab.Models.ProtectedTag.CreateAccessLevels.set -> void

0 commit comments

Comments
 (0)