Add implementation for updatePullRequest for GitHub forge

Author: alejandrohdezma

modules/core/src/main/scala/org/scalasteward/core/forge/github/GitHubApiAlg.scala

@@ -69,8 +69,24 @@ final class GitHubApiAlg[F[_]](
       number: PullRequestNumber,
       repo: Repo,
       data: NewPullRequestData
-  ): F[PullRequestOut] =
-    F.raiseError(new NotImplementedError(s"updatePullRequest($number, $repo, $data)"))
+  ): F[PullRequestOut] = {
+    val payload = UpdatePullRequestPayload.from(data)
+
+    val update = client
+      .patchWithBody[PullRequestOut, UpdatePullRequestPayload](
+        uri = url.pull(repo, number),
+        body = payload,
+        modify = modify(repo)
+      )
+      .adaptErr(SecondaryRateLimitExceeded.fromThrowable)
+
+    for {
+      pullRequestOut <- update
+      _ <- F.whenA(data.labels.nonEmpty)(labelPullRequest(repo, number, data.labels))
+      _ <- F.whenA(data.assignees.nonEmpty)(addAssignees(repo, number, data.assignees))
+      _ <- F.whenA(data.reviewers.nonEmpty)(addReviewers(repo, number, data.reviewers))
+    } yield pullRequestOut
+  }
 
   /** https://developer.github.com/v3/repos/branches/#get-branch */
   override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =

modules/core/src/main/scala/org/scalasteward/core/forge/github/UpdatePullRequestPayload.scala

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2018-2023 Scala Steward contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.scalasteward.core.forge.github
+
+import io.circe.Encoder
+import io.circe.generic.semiauto.deriveEncoder
+import org.scalasteward.core.forge.data.NewPullRequestData
+
+final case class UpdatePullRequestPayload(
+    title: String,
+    body: String
+)
+object UpdatePullRequestPayload {
+  implicit val encoder: Encoder[UpdatePullRequestPayload] = deriveEncoder
+
+  def from(newPullRequestData: NewPullRequestData): UpdatePullRequestPayload =
+    UpdatePullRequestPayload(
+      title = newPullRequestData.title,
+      body = newPullRequestData.body
+    )
+}

modules/core/src/test/scala/org/scalasteward/core/forge/github/GitHubApiAlgTest.scala

@@ -1,7 +1,9 @@
 package org.scalasteward.core.forge.github
 
-import cats.syntax.semigroupk._
+import cats.effect.IO
+import cats.syntax.all._
 import io.circe.literal._
+import io.circe.Json
 import munit.CatsEffectSuite
 import org.http4s.circe._
 import org.http4s.dsl.Http4sDsl
@@ -66,7 +68,19 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
           }]"""
       )
 
-    case PATCH -> Root / "repos" / "fthomas" / "base.g8" / "pulls" / IntVar(_) =>
+    case req @ PATCH -> Root / "repos" / "fthomas" / "base.g8" / "pulls" / IntVar(42) =>
+      req.as[Json].flatMapF(_.hcursor.get[String]("title").liftTo[IO]).flatMap { title =>
+        Ok(
+          json"""{
+            "html_url": "https://github.com/octocat/Hello-World/pull/42",
+            "state": "open",
+            "number": 42,
+            "title": $title
+          }"""
+        )
+      }
+
+    case PATCH -> Root / "repos" / "fthomas" / "base.g8" / "pulls" / IntVar(1347) =>
       Ok(
         json"""{
             "html_url": "https://github.com/octocat/Hello-World/pull/1347",
@@ -115,6 +129,14 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
             "title": "new-feature"
             } """)
 
+    case PATCH -> Root / "repos" / "fthomas" / "cant-assign-reviewers" / "pulls" / "42" =>
+      Created(json"""  {
+            "html_url": "https://github.com/fthomas/cant-assign-reviewers/pull/42",
+            "state": "open",
+            "number": 42,
+            "title": "updated-title"
+            } """)
+
     case POST -> Root / "repos" / "fthomas" / "cant-add-labels" / "pulls" =>
       Created(json"""  {
             "html_url": "https://github.com/octocat/Hello-World/pull/13",
@@ -123,6 +145,14 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
             "title": "can't add labels to me"
             } """)
 
+    case PATCH -> Root / "repos" / "fthomas" / "cant-add-labels" / "pulls" / "42" =>
+      Created(json"""  {
+            "html_url": "https://github.com/fthomas/cant-add-labels/pull/42",
+            "state": "open",
+            "number": 42,
+            "title": "can't add labels to me"
+            } """)
+
     case POST -> Root / "repos" / "fthomas" / "base.g8" / "issues" / IntVar(_) / "labels" =>
       // Response taken from https://docs.github.com/en/rest/reference/issues#labels, is ignored
       Created(json"""[
@@ -136,6 +166,9 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
             "default": true
           }]""")
 
+    case POST -> Root / "repos" / "fthomas" / "cant-add-labels" / "issues" / "42" / "labels" =>
+      BadRequest("can't add labels")
+
     case POST -> Root / "repos" / "fthomas" / "cant-add-labels" / "issues" / "13" / "labels" =>
       BadRequest("can't add labels")
 
@@ -155,6 +188,11 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
         / "pulls" / IntVar(_) / "requested_reviewers" =>
       BadRequest()
 
+    case PATCH ->
+        Root / "repos" / "fthomas" / "cant-assign-reviewers"
+        / "pulls" / IntVar(_) / "requested_reviewers" =>
+      BadRequest()
+
     case _ => NotFound()
   }
   private val state = MockState.empty.copy(clientResponses = auth <+> httpApp)
@@ -284,6 +322,31 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
     assertIO(pr, pullRequest)
   }
 
+  test("updatePullRequest") {
+    val data = NewPullRequestData(
+      title = "updated-title",
+      body = "body",
+      head = "aaa",
+      base = Branch("master"),
+      labels = Nil,
+      assignees = Nil,
+      reviewers = Nil
+    )
+
+    val number = PullRequestNumber(42)
+
+    val pr = gitHubApiAlg.updatePullRequest(number, repo, data).runA(state)
+
+    val expected = PullRequestOut(
+      uri"https://github.com/octocat/Hello-World/pull/42",
+      PullRequestState.Open,
+      number,
+      "updated-title"
+    )
+
+    assertIO(pr, expected)
+  }
+
   test("createPullRequest with assignees and reviewers") {
     val data = NewPullRequestData(
       title = "new-feature",
@@ -298,6 +361,31 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
     assertIO(pr, pullRequest)
   }
 
+  test("updatePullRequest with assignees and reviewers") {
+    val data = NewPullRequestData(
+      title = "updated-title",
+      body = "body",
+      head = "aaa",
+      base = Branch("master"),
+      labels = Nil,
+      assignees = List("foo"),
+      reviewers = List("bar")
+    )
+
+    val number = PullRequestNumber(42)
+
+    val pr = gitHubApiAlg.updatePullRequest(number, repo, data).runA(state)
+
+    val expected = PullRequestOut(
+      uri"https://github.com/octocat/Hello-World/pull/42",
+      PullRequestState.Open,
+      number,
+      "updated-title"
+    )
+
+    assertIO(pr, expected)
+  }
+
   test("createPullRequest with assignees and reviewers should not fail if can't assign") {
     val data = NewPullRequestData(
       title = "new-feature",
@@ -321,6 +409,34 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
     assertIO(pullRequestOut, expectedPullRequestOut)
   }
 
+  test("updatePullRequest with assignees and reviewers should not fail if can't assign") {
+    val data = NewPullRequestData(
+      title = "updated-title",
+      body = "body",
+      head = "aaa",
+      base = Branch("master"),
+      labels = Nil,
+      assignees = List("foo"),
+      reviewers = List("bar")
+    )
+
+    val number = PullRequestNumber(42)
+
+    val pr =
+      gitHubApiAlg
+        .updatePullRequest(number, repo.copy(repo = "cant-assign-reviewers"), data)
+        .runA(state)
+
+    val expected = PullRequestOut(
+      uri"https://github.com/fthomas/cant-assign-reviewers/pull/42",
+      PullRequestState.Open,
+      number,
+      "updated-title"
+    )
+
+    assertIO(pr, expected)
+  }
+
   test("createPullRequest with labels") {
     val data = NewPullRequestData(
       title = "new-feature",
@@ -335,6 +451,31 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
     assertIO(pr, pullRequest)
   }
 
+  test("updatePullRequest with labels") {
+    val data = NewPullRequestData(
+      title = "updated-title",
+      body = "body",
+      head = "aaa",
+      base = Branch("master"),
+      labels = List("foo", "bar"),
+      assignees = Nil,
+      reviewers = Nil
+    )
+
+    val number = PullRequestNumber(42)
+
+    val pr = gitHubApiAlg.updatePullRequest(number, repo, data).runA(state)
+
+    val expected = PullRequestOut(
+      uri"https://github.com/octocat/Hello-World/pull/42",
+      PullRequestState.Open,
+      number,
+      "updated-title"
+    )
+
+    assertIO(pr, expected)
+  }
+
   test("createPullRequest should fail when can't add labels") {
     val data = NewPullRequestData(
       title = "new-feature",
@@ -362,6 +503,38 @@ class GitHubApiAlgTest extends CatsEffectSuite with Http4sDsl[MockEff] {
     assertIO(error, Right(expectedError))
   }
 
+  test("updatePullRequest should fail when can't add labels") {
+    val data = NewPullRequestData(
+      title = "updated-title",
+      body = "body",
+      head = "aaa",
+      base = Branch("master"),
+      labels = List("foo", "bar"),
+      assignees = Nil,
+      reviewers = Nil
+    )
+
+    val number = PullRequestNumber(42)
+
+    val error =
+      gitHubApiAlg
+        .updatePullRequest(number, repo.copy(repo = "cant-add-labels"), data)
+        .runA(state)
+        .attempt
+        .map(_.swap.map(_.getMessage))
+
+    val expectedError =
+      """|uri: http://example.com/repos/fthomas/cant-add-labels/issues/42/labels
+         |method: POST
+         |status: 400 Bad Request
+         |headers:
+         |  Content-Type: text/plain; charset=UTF-8
+         |  Content-Length: 16
+         |body: can't add labels""".stripMargin
+
+    assertIO(error, Right(expectedError))
+  }
+
   test("listPullRequests") {
     val prs = gitHubApiAlg.listPullRequests(repo, "master", Branch("master")).runA(state)
     assertIO(prs, List(pullRequest))