Fix Commit Status inconsistencies

Author: louis-z

NGitLab.Mock/Clients/CommitStatusClient.cs

@@ -15,7 +15,7 @@ public CommitStatusClient(ClientContext context, ProjectId projectId)
         _projectId = Server.AllProjects.FindProject(projectId.ValueAsString()).Id;
     }
 
-    CommitStatusCreate ICommitStatusClient.AddOrUpdate(CommitStatusCreate status)
+    Models.CommitStatus ICommitStatusClient.AddOrUpdate(CommitStatusCreate status)
     {
         using (Context.BeginOperationScope())
         {
@@ -32,10 +32,9 @@ CommitStatusCreate ICommitStatusClient.AddOrUpdate(CommitStatusCreate status)
             commitStatus.Coverage = status.Coverage;
             commitStatus.Ref = status.Ref;
             commitStatus.Sha = status.CommitSha;
-            commitStatus.Status = status.Status;
             commitStatus.TargetUrl = status.TargetUrl;
 
-            return commitStatus.ToClientCommitStatusCreate();
+            return commitStatus.ToClientCommitStatus();
         }
 
         static bool Equals(CommitStatus a, CommitStatusCreate b)

NGitLab.Mock/CommitStatus.cs

@@ -1,6 +1,4 @@
-using NGitLab.Models;
-
-namespace NGitLab.Mock;
+namespace NGitLab.Mock;
 
 public sealed class CommitStatus : GitLabObject
 {
@@ -20,21 +18,6 @@ public sealed class CommitStatus : GitLabObject
 
     public int? Coverage { get; set; }
 
-    public CommitStatusCreate ToClientCommitStatusCreate()
-    {
-        return new CommitStatusCreate
-        {
-            Name = Name,
-            TargetUrl = TargetUrl,
-            Status = Status,
-            Ref = Ref,
-            CommitSha = Sha,
-            Description = Description,
-            State = Status,
-            Coverage = Coverage,
-        };
-    }
-
     public Models.CommitStatus ToClientCommitStatus()
     {
         return new Models.CommitStatus

NGitLab.Mock/PublicAPI.Unshipped.txt

@@ -84,7 +84,6 @@ NGitLab.Mock.CommitStatus.Status.set -> void
 NGitLab.Mock.CommitStatus.TargetUrl.get -> string
 NGitLab.Mock.CommitStatus.TargetUrl.set -> void
 NGitLab.Mock.CommitStatus.ToClientCommitStatus() -> NGitLab.Models.CommitStatus
-NGitLab.Mock.CommitStatus.ToClientCommitStatusCreate() -> NGitLab.Models.CommitStatusCreate
 NGitLab.Mock.CommitStatusCollection
 NGitLab.Mock.CommitStatusCollection.CommitStatusCollection(NGitLab.Mock.GitLabObject parent) -> void
 NGitLab.Mock.Config.GitLabCollection<TItem, TParent>

NGitLab.Tests/CommitStatusTests.cs

@@ -60,7 +60,7 @@ public async Task Test_AddingCommitStatusesWithDifferentNamesOnSameCommit_Succee
         var commitStatus2 = context.CommitStatusClient.AddOrUpdate(commitStatusCreate);
 
         // Assert
-        var properties = typeof(CommitStatusCreate).GetProperties();
+        var properties = typeof(CommitStatus).GetProperties();
 
         // All properties should be the same except 'Name' & 'Id'
         foreach (var property in properties)
@@ -141,7 +141,7 @@ public async Task Test_QueryByName(string nameToLookUp, bool expectToFind)
         string commitStatusName = null;
         for (var i = 0; i < 10; i++)
         {
-            commitStatusName = $"Commit Status {Guid.NewGuid().ToString("N")}";
+            commitStatusName = $"Commit Status {Guid.NewGuid():N}";
             var commitStatusCreate = context.SetUpCommitStatusCreate("running", commitStatusName);
             _ = context.CommitStatusClient.AddOrUpdate(commitStatusCreate);
         }
@@ -200,21 +200,21 @@ public static async Task<CommitStatusTestContext> Create()
             return new CommitStatusTestContext(context, project, commit, client);
         }
 
-        public CommitStatusCreate AddOrUpdateCommitStatus(string state = "success", int? coverage = null)
+        public CommitStatus AddOrUpdateCommitStatus(string state = "success", int? coverage = null)
         {
             var commitStatusCreate = SetUpCommitStatusCreate(state, coverage: coverage);
 
-            var createdCommitStatus = CommitStatusClient.AddOrUpdate(commitStatusCreate);
+            var commitStatus = CommitStatusClient.AddOrUpdate(commitStatusCreate);
 
-            Assert.That(createdCommitStatus.Ref, Is.EqualTo(commitStatusCreate.Ref));
-            Assert.That(createdCommitStatus.Coverage, Is.EqualTo(commitStatusCreate.Coverage));
-            Assert.That(createdCommitStatus.Description, Is.EqualTo(commitStatusCreate.Description));
-            Assert.That(createdCommitStatus.Status, Is.EqualTo(commitStatusCreate.State));
-            Assert.That(createdCommitStatus.Name, Is.EqualTo(commitStatusCreate.Name));
-            Assert.That(createdCommitStatus.TargetUrl, Is.EqualTo(commitStatusCreate.TargetUrl));
-            Assert.That(createdCommitStatus.CommitSha, Is.EqualTo(commitStatusCreate.CommitSha).IgnoreCase);
+            Assert.That(commitStatus.Ref, Is.EqualTo(commitStatusCreate.Ref));
+            Assert.That(commitStatus.Coverage, Is.EqualTo(commitStatusCreate.Coverage));
+            Assert.That(commitStatus.Description, Is.EqualTo(commitStatusCreate.Description));
+            Assert.That(commitStatus.Status, Is.EqualTo(commitStatusCreate.State));
+            Assert.That(commitStatus.Name, Is.EqualTo(commitStatusCreate.Name));
+            Assert.That(commitStatus.TargetUrl, Is.EqualTo(commitStatusCreate.TargetUrl));
+            Assert.That(commitStatus.CommitSha, Is.EqualTo(commitStatusCreate.CommitSha).IgnoreCase);
 
-            return createdCommitStatus;
+            return commitStatus;
         }
 
         public CommitStatusCreate SetUpCommitStatusCreate(string state, string name = null, int? coverage = 100)

NGitLab/ICommitStatusClient.cs

@@ -15,5 +15,5 @@ public interface ICommitStatusClient
     /// <remarks>
     /// Refer to <see href="https://docs.gitlab.com/ee/api/commits.html#set-the-pipeline-status-of-a-commit">"Set the pipeline status of a commit" GitLab doc</see>
     /// </remarks>
-    CommitStatusCreate AddOrUpdate(CommitStatusCreate status);
+    CommitStatus AddOrUpdate(CommitStatusCreate status);
 }

NGitLab/Impl/CommitStatusClient.cs

@@ -25,7 +25,7 @@ public GitLabCollectionResponse<CommitStatus> GetAsync(string commitSha, CommitS
         return _api.Get().GetAllAsync<CommitStatus>(url);
     }
 
-    public CommitStatusCreate AddOrUpdate(CommitStatusCreate status) => _api.Post().With(status).To<CommitStatusCreate>($"{_statusCreatePath}/{status.CommitSha}");
+    public CommitStatus AddOrUpdate(CommitStatusCreate status) => _api.Post().With(status).To<CommitStatus>($"{_statusCreatePath}/{status.CommitSha}");
 
     private string GetCommitStatusesPath(string commitSha) => $"{_projectPath}/repository/commits/{commitSha.ToLowerInvariant()}/statuses";
 

NGitLab/Models/CommitStatusCreate.cs

@@ -9,14 +9,11 @@ namespace NGitLab.Models;
 /// </summary>
 public class CommitStatusCreate
 {
-    [JsonPropertyName("sha")]
+    [JsonIgnore]
     public string CommitSha { get; set; }
 
     [JsonPropertyName("state")]
-    public string State { get; set; }
-
-    [JsonPropertyName("status")]
-    public string Status { get; set; }
+    public required string State { get; set; }
 
     [JsonPropertyName("ref")]
     public string Ref { get; set; }

NGitLab/PublicAPI.Unshipped.txt

@@ -136,7 +136,7 @@ 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.AddOrUpdate(NGitLab.Models.CommitStatusCreate status) -> NGitLab.Models.CommitStatus
 NGitLab.ICommitStatusClient.AllBySha(string commitSha) -> System.Collections.Generic.IEnumerable<NGitLab.Models.CommitStatus>
 NGitLab.ICommitStatusClient.GetAsync(string commitSha, NGitLab.Models.CommitStatusQuery query = null) -> NGitLab.GitLabCollectionResponse<NGitLab.Models.CommitStatus>
 NGitLab.IContributorClient
@@ -488,7 +488,7 @@ 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.AddOrUpdate(NGitLab.Models.CommitStatusCreate status) -> NGitLab.Models.CommitStatus
 NGitLab.Impl.CommitStatusClient.AllBySha(string commitSha) -> System.Collections.Generic.IEnumerable<NGitLab.Models.CommitStatus>
 NGitLab.Impl.CommitStatusClient.CommitStatusClient(NGitLab.Impl.API api, NGitLab.Models.ProjectId projectId) -> void
 NGitLab.Impl.CommitStatusClient.GetAsync(string commitSha, NGitLab.Models.CommitStatusQuery query = null) -> NGitLab.GitLabCollectionResponse<NGitLab.Models.CommitStatus>
@@ -1607,8 +1607,6 @@ NGitLab.Models.CommitStatusCreate.Ref.get -> string
 NGitLab.Models.CommitStatusCreate.Ref.set -> void
 NGitLab.Models.CommitStatusCreate.State.get -> string
 NGitLab.Models.CommitStatusCreate.State.set -> void
-NGitLab.Models.CommitStatusCreate.Status.get -> string
-NGitLab.Models.CommitStatusCreate.Status.set -> void
 NGitLab.Models.CommitStatusCreate.TargetUrl.get -> string
 NGitLab.Models.CommitStatusCreate.TargetUrl.set -> void
 NGitLab.Models.CommitStatusQuery