make the new field in MergeRequestPayload optional

Author: Ender Tunc

modules/core/src/main/scala/org/scalasteward/core/forge/gitlab/GitLabApiAlg.scala

@@ -40,7 +40,7 @@ final private[gitlab] case class MergeRequestPayload(
     assignee_ids: Option[List[Int]],
     reviewer_ids: Option[List[Int]],
     target_project_id: Long,
-    remove_source_branch: Boolean,
+    remove_source_branch: Option[Boolean],
     source_branch: String,
     target_branch: Branch
 )
@@ -63,7 +63,7 @@ private[gitlab] object MergeRequestPayload {
       reviewer_ids = Option.when(reviewers.nonEmpty)(reviewers),
       labels = Option.when(data.labels.nonEmpty)(data.labels),
       target_project_id = projectId,
-      remove_source_branch = removeSourceBranch,
+      remove_source_branch = Option.when(removeSourceBranch)(removeSourceBranch),
       source_branch = data.head,
       target_branch = data.base
     )
@@ -138,7 +138,9 @@ private[gitlab] object GitLabJsonCodec {
     }
 
   implicit val projectIdDecoder: Decoder[ProjectId] = deriveDecoder
-  implicit val mergeRequestPayloadEncoder: Encoder[MergeRequestPayload] = deriveEncoder
+  implicit val mergeRequestPayloadEncoder: Encoder[MergeRequestPayload] =
+    deriveEncoder[MergeRequestPayload].mapJson(_.dropNullValues)
+
   implicit val updateStateEncoder: Encoder[UpdateState] = Encoder.instance { newState =>
     val encoded = newState.state match {
       case PullRequestState.Open   => "open"

modules/core/src/test/scala/org/scalasteward/core/forge/gitlab/GitLabApiAlgTest.scala

@@ -122,25 +122,61 @@ class GitLabApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
 
   private val gitlabApiAlg = ForgeSelection.forgeApiAlg[MockEff](
     config.forgeCfg.copy(tpe = ForgeType.GitLab),
-    GitLabCfg(mergeWhenPipelineSucceeds = false, requiredReviewers = None),
+    GitLabCfg(
+      mergeWhenPipelineSucceeds = false,
+      requiredReviewers = None,
+      removeSourceBranch = false
+    ),
     user
   )
 
   private val gitlabApiAlgNoFork = ForgeSelection.forgeApiAlg[MockEff](
     config.forgeCfg.copy(tpe = ForgeType.GitLab, doNotFork = true),
-    GitLabCfg(mergeWhenPipelineSucceeds = false, requiredReviewers = None),
+    GitLabCfg(
+      mergeWhenPipelineSucceeds = false,
+      requiredReviewers = None,
+      removeSourceBranch = false
+    ),
+    user
+  )
+
+  private val gitlabApiAlgAutoMerge = ForgeSelection.forgeApiAlg[MockEff](
+    config.forgeCfg.copy(tpe = ForgeType.GitLab, doNotFork = true),
+    GitLabCfg(
+      mergeWhenPipelineSucceeds = true,
+      requiredReviewers = None,
+      removeSourceBranch = false
+    ),
+    user
+  )
+
+  private val gitlabApiAlgRemoveSourceBranch = ForgeSelection.forgeApiAlg[MockEff](
+    config.forgeCfg.copy(tpe = ForgeType.GitLab, doNotFork = true),
+    GitLabCfg(
+      mergeWhenPipelineSucceeds = false,
+      requiredReviewers = None,
+      removeSourceBranch = true
+    ),
     user
   )
 
   private val gitlabApiAlgLessReviewersRequired = ForgeSelection.forgeApiAlg[MockEff](
     config.forgeCfg.copy(tpe = ForgeType.GitLab, doNotFork = true),
-    GitLabCfg(mergeWhenPipelineSucceeds = true, requiredReviewers = Some(0)),
+    GitLabCfg(
+      mergeWhenPipelineSucceeds = true,
+      requiredReviewers = Some(0),
+      removeSourceBranch = false
+    ),
     user
   )
 
   private val gitlabApiAlgWithAssigneeAndReviewers = ForgeSelection.forgeApiAlg[MockEff](
     config.forgeCfg.copy(tpe = ForgeType.GitLab, doNotFork = true),
-    GitLabCfg(mergeWhenPipelineSucceeds = true, requiredReviewers = Some(0)),
+    GitLabCfg(
+      mergeWhenPipelineSucceeds = true,
+      requiredReviewers = Some(0),
+      removeSourceBranch = false
+    ),
     user
   )
 
@@ -232,7 +268,7 @@ class GitLabApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
   }
 
   test("createPullRequest -- auto merge") {
-    val prOut = gitlabApiAlgNoFork
+    val prOut = gitlabApiAlgAutoMerge
       .createPullRequest(Repo("foo", "bar"), newPRData)
       .runA(state)
 
@@ -345,6 +381,21 @@ class GitLabApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
     assertIO(prOut, expected)
   }
 
+  test("createPullRequest -- remove source branch") {
+    val prOut = gitlabApiAlgRemoveSourceBranch
+      .createPullRequest(Repo("foo", "bar"), newPRData)
+      .runA(state)
+
+    val expected = PullRequestOut(
+      uri"https://gitlab.com/foo/bar/merge_requests/150",
+      PullRequestState.Open,
+      PullRequestNumber(150),
+      "title"
+    )
+
+    assertIO(prOut, expected)
+  }
+
   test("referencePullRequest") {
     val reference = gitlabApiAlg.referencePullRequest(PullRequestNumber(1347))
     assertEquals(reference, "!1347")

modules/core/src/test/scala/org/scalasteward/core/forge/gitlab/MergeRequestPayloadTest.scala

@@ -22,15 +22,13 @@ class MergeRequestPayloadTest extends FunSuite {
   private val projectId = 321L
 
   test("asJson") {
-    val obtained = MergeRequestPayload(id, projectId, data, Map.empty).asJson
+    val obtained =
+      MergeRequestPayload(id, projectId, data, Map.empty, removeSourceBranch = false).asJson
     val expected =
       json"""{
                "id" : "123",
                "title" : "Test MR title",
                "description" : "Test MR body",
-               "labels" : null,
-               "assignee_ids" : null,
-               "reviewer_ids" : null,
                "target_project_id" : 321,
                "source_branch" : "source",
                "target_branch" : "master"
@@ -39,15 +37,18 @@ class MergeRequestPayloadTest extends FunSuite {
   }
 
   test("asJson for draft MR") {
-    val obtained = MergeRequestPayload(id, projectId, data.copy(draft = true), Map.empty).asJson
+    val obtained = MergeRequestPayload(
+      id,
+      projectId,
+      data.copy(draft = true),
+      Map.empty,
+      removeSourceBranch = false
+    ).asJson
     val expected =
       json"""{
                "id" : "123",
                "title" : "Draft: Test MR title",
                "description" : "Test MR body",
-               "labels" : null,
-               "assignee_ids" : null,
-               "reviewer_ids" : null,
                "target_project_id" : 321,
                "source_branch" : "source",
                "target_branch" : "master"
@@ -57,15 +58,19 @@ class MergeRequestPayloadTest extends FunSuite {
 
   test("asJson with labels") {
     val obtained =
-      MergeRequestPayload(id, projectId, data.copy(labels = List("foo", "bar")), Map.empty).asJson
+      MergeRequestPayload(
+        id,
+        projectId,
+        data.copy(labels = List("foo", "bar")),
+        Map.empty,
+        removeSourceBranch = false
+      ).asJson
     val expected =
       json"""{
                "id" : "123",
                "title" : "Test MR title",
                "description" : "Test MR body",
                "labels" : [ "foo", "bar" ],
-               "assignee_ids" : null,
-               "reviewer_ids" : null,
                "target_project_id" : 321,
                "source_branch" : "source",
                "target_branch" : "master"
@@ -78,14 +83,14 @@ class MergeRequestPayloadTest extends FunSuite {
       id = id,
       projectId = projectId,
       data = data.copy(assignees = List("foo"), reviewers = List("bar")),
-      usernamesToUserIdsMapping = Map("foo" -> 1, "bar" -> 2)
+      usernamesToUserIdsMapping = Map("foo" -> 1, "bar" -> 2),
+      removeSourceBranch = false
     ).asJson
     val expected =
       json"""{
                "id" : "123",
                "title" : "Test MR title",
                "description" : "Test MR body",
-               "labels" : null,
                "assignee_ids": [ 1 ],
                "reviewer_ids": [ 2 ],
                "target_project_id" : 321,
@@ -94,4 +99,25 @@ class MergeRequestPayloadTest extends FunSuite {
              }"""
     assertEquals(obtained, expected)
   }
+
+  test("asJson with remove source branch") {
+    val obtained = MergeRequestPayload(
+      id = id,
+      projectId = projectId,
+      data = data,
+      usernamesToUserIdsMapping = Map.empty,
+      removeSourceBranch = true
+    ).asJson
+    val expected =
+      json"""{
+               "id" : "123",
+               "title" : "Test MR title",
+               "description" : "Test MR body",
+               "target_project_id" : 321,
+               "remove_source_branch": true,
+               "source_branch" : "source",
+               "target_branch" : "master"
+             }"""
+    assertEquals(obtained, expected)
+  }
 }