Fix #705

ubisoft · Dec 20, 2024 · 4500aa6 · 4500aa6
1 parent d5740e3
commit 4500aa6
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 0 deletions.
diff --git a/NGitLab.Mock/Clients/CommitClient.cs b/NGitLab.Mock/Clients/CommitClient.cs
@@ -67,4 +67,9 @@ public JobStatus GetJobStatus(string branchName)
             return GitLabCollectionResponse.Create(relatedMerqueRequests);
         }
     }
+
+    public Commit Revert(CommitRevert revert)
+    {
+        throw new NotImplementedException();
+    }
 }
diff --git a/NGitLab.Tests/CommitsTests.cs b/NGitLab.Tests/CommitsTests.cs
@@ -119,6 +119,54 @@ public async Task Test_can_cherry_pick_commit()
         Assert.That(latestCommit.Id, Is.EqualTo(cherryPickedCommit.Id));
     }
 
+    [Test]
+    [NGitLabRetry]
+    public async Task Test_can_revert_commit()
+    {
+        // Arrange
+        using var context = await GitLabTestContext.CreateAsync();
+        var project = context.CreateProject();
+
+        var testBranchName = "revert-test";
+
+        var repositoryClient = context.Client.GetRepository(project.Id);
+        repositoryClient.Branches.Create(new BranchCreate
+        {
+            Name = testBranchName,
+            Ref = project.DefaultBranch,
+        });
+
+        var commitClient = context.Client.GetCommits(project.Id);
+        var testCommit = commitClient.Create(new CommitCreate
+        {
+            Branch = testBranchName,
+            CommitMessage = "This commit will be reverted",
+            Actions =
+            [
+                new()
+                {
+                    Action = "update",
+                    Content = "Testing commit revert",
+                    FilePath = "README.md",
+                },
+            ],
+        });
+
+        var compareResults = repositoryClient.Compare(new CompareQuery(project.DefaultBranch, testBranchName));
+        Assert.That(compareResults.Diff, Has.Length.EqualTo(1));
+
+        // Act
+        var revertedCommit = commitClient.Revert(new CommitRevert
+        {
+            Branch = testBranchName,
+            Sha = testCommit.Id,
+        });
+
+        // Assert
+        compareResults = repositoryClient.Compare(new CompareQuery(project.DefaultBranch, testBranchName));
+        Assert.That(compareResults.Diff, Is.Empty);
+    }
+
     [TestCase(false)]
     [TestCase(true)]
     [NGitLabRetry]

diff --git a/NGitLab/ICommitClient.cs b/NGitLab/ICommitClient.cs
@@ -27,6 +27,12 @@ public interface ICommitClient
     /// </summary>
     Commit CherryPick(CommitCherryPick cherryPick);
 
+
+    /// <summary>
+    /// Reverts a specific branch commit
+    /// </summary>
+    Commit Revert(CommitRevert revert);
+
     /// <summary>
     /// Get merge requests related to a commit
     /// </summary>

diff --git a/NGitLab/Impl/CommitClient.cs b/NGitLab/Impl/CommitClient.cs
@@ -55,4 +55,9 @@ public GitLabCollectionResponse<MergeRequest> GetRelatedMergeRequestsAsync(Relat
     {
         return _api.Get().GetAllAsync<MergeRequest>(_repoPath + $"/commits/{query.Sha}/merge_requests");
     }
+
+    public Commit Revert(CommitRevert revert)
+    {
+        return _api.Post().With(revert).To<Commit>($"{_repoPath}/commits/{revert.Sha}/revert");
+    }
 }
diff --git a/NGitLab/Models/CommitRevert.cs b/NGitLab/Models/CommitRevert.cs
@@ -0,0 +1,18 @@
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
+
+namespace NGitLab.Models;
+
+public class CommitRevert
+{
+    [Required]
+    [JsonIgnore]
+    public Sha1 Sha { get; set; }
+
+    [Required]
+    [JsonPropertyName("branch")]
+    public string Branch { get; set; }
+
+    [JsonPropertyName("dry_run")]
+    public bool? DryRun { get; set; }
+}
diff --git a/NGitLab/PublicAPI.Unshipped.txt b/NGitLab/PublicAPI.Unshipped.txt
@@ -132,6 +132,7 @@ NGitLab.ICommitClient.Create(NGitLab.Models.CommitCreate commit) -> NGitLab.Mode
 NGitLab.ICommitClient.GetCommit(string ref) -> NGitLab.Models.Commit
 NGitLab.ICommitClient.GetJobStatus(string branchName) -> NGitLab.JobStatus
 NGitLab.ICommitClient.GetRelatedMergeRequestsAsync(NGitLab.Models.RelatedMergeRequestsQuery query) -> NGitLab.GitLabCollectionResponse<NGitLab.Models.MergeRequest>
+NGitLab.ICommitClient.Revert(NGitLab.Models.CommitRevert revert) -> NGitLab.Models.Commit
 NGitLab.ICommitStatusClient
 NGitLab.ICommitStatusClient.AddOrUpdate(NGitLab.Models.CommitStatusCreate status) -> NGitLab.Models.CommitStatusCreate
 NGitLab.ICommitStatusClient.AllBySha(string commitSha) -> System.Collections.Generic.IEnumerable<NGitLab.Models.CommitStatus>
@@ -475,6 +476,7 @@ NGitLab.Impl.CommitClient.Create(NGitLab.Models.CommitCreate commit) -> NGitLab.
 NGitLab.Impl.CommitClient.GetCommit(string ref) -> NGitLab.Models.Commit
 NGitLab.Impl.CommitClient.GetJobStatus(string branchName) -> NGitLab.JobStatus
 NGitLab.Impl.CommitClient.GetRelatedMergeRequestsAsync(NGitLab.Models.RelatedMergeRequestsQuery query) -> NGitLab.GitLabCollectionResponse<NGitLab.Models.MergeRequest>
+NGitLab.Impl.CommitClient.Revert(NGitLab.Models.CommitRevert revert) -> NGitLab.Models.Commit
 NGitLab.Impl.CommitStatusClient
 NGitLab.Impl.CommitStatusClient.AddOrUpdate(NGitLab.Models.CommitStatusCreate status) -> NGitLab.Models.CommitStatusCreate
 NGitLab.Impl.CommitStatusClient.AllBySha(string commitSha) -> System.Collections.Generic.IEnumerable<NGitLab.Models.CommitStatus>
@@ -1530,6 +1532,14 @@ NGitLab.Models.CommitRefType
 NGitLab.Models.CommitRefType.All = 0 -> NGitLab.Models.CommitRefType
 NGitLab.Models.CommitRefType.Branch = 1 -> NGitLab.Models.CommitRefType
 NGitLab.Models.CommitRefType.Tag = 2 -> NGitLab.Models.CommitRefType
+NGitLab.Models.CommitRevert
+NGitLab.Models.CommitRevert.Branch.get -> string
+NGitLab.Models.CommitRevert.Branch.set -> void
+NGitLab.Models.CommitRevert.CommitRevert() -> void
+NGitLab.Models.CommitRevert.DryRun.get -> bool?
+NGitLab.Models.CommitRevert.DryRun.set -> void
+NGitLab.Models.CommitRevert.Sha.get -> NGitLab.Sha1
+NGitLab.Models.CommitRevert.Sha.set -> void
 NGitLab.Models.CommitStats
 NGitLab.Models.CommitStats.Additions.get -> int
 NGitLab.Models.CommitStats.Additions.set -> void