Upgrading to Wiremock 3 and rewriting a couple Wiremock kotest tests into JUnit for ease

gradle.properties

@@ -2,7 +2,7 @@ kotlin_version=1.9.22
 kotest_version=5.8.1
 spockVersion=2.3-groovy-3.0
 strikt_version=0.34.1
-wiremockVersion=2.35.2
+wiremockVersion=3.0.1
 
 github_api_version=1.321
 logbackVersion=1.5.5

server/notification/github/build.gradle

@@ -17,5 +17,9 @@ dependencies {
 
     testImplementation "com.github.tomakehurst:wiremock-jre8:$wiremockVersion"
 
+    testImplementation(platform('org.junit:junit-bom:5.10.2'))
+    testImplementation('org.junit.jupiter:junit-jupiter')
+    testRuntimeOnly('org.junit.platform:junit-platform-launcher')
+
     testFixturesImplementation "com.github.tomakehurst:wiremock-jre8:$wiremockVersion"
 }

server/notification/github/src/test/kotlin/projektor/notification/github/comment/GitHubCommentClientTest.kt

@@ -0,0 +1,120 @@
+package projektor.notification.github.comment
+
+import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo
+import com.github.tomakehurst.wiremock.junit5.WireMockTest
+import org.junit.jupiter.api.Test
+import projektor.notification.github.GitHubClientConfig
+import projektor.notification.github.GitHubWireMockStubber
+import projektor.notification.github.auth.MockJwtProvider
+import strikt.api.expectThat
+import strikt.assertions.*
+import kotlin.test.assertNotNull
+
+@WireMockTest
+class GitHubCommentClientTest {
+    private val jwtToken = "my-jwt"
+    private val jwtProvider = MockJwtProvider(jwtToken)
+
+    @Test
+    fun `should create comment on issue`(wmRuntimeInfo: WireMockRuntimeInfo) {
+        val gitHubWireMockStubber = GitHubWireMockStubber(wmRuntimeInfo.wireMock)
+
+        val gitHubApiUrl = "http://localhost:${wmRuntimeInfo.httpPort}/"
+        val clientConfig =
+            GitHubClientConfig(
+                gitHubApiUrl,
+            )
+        val gitHubCommentClient = GitHubCommentClient(clientConfig, jwtProvider)
+
+        val orgName = "my-org"
+        val repoName = "my-repo"
+        val issueId = 12
+
+        val commentText = "Here is my comment"
+
+        gitHubWireMockStubber.stubRepositoryRequests(orgName, repoName)
+
+        gitHubWireMockStubber.stubGetIssue(orgName, repoName, issueId)
+        gitHubWireMockStubber.stubAddComment(orgName, repoName, issueId)
+
+        val repository = gitHubCommentClient.getRepository(orgName, repoName)
+        assertNotNull(repository)
+        gitHubCommentClient.addComment(repository, issueId, commentText)
+
+        val addCommentRequestBodies = gitHubWireMockStubber.findAddCommentRequestBodies(orgName, repoName, issueId)
+        expectThat(addCommentRequestBodies).hasSize(1)
+
+        expectThat(addCommentRequestBodies[0]).contains(commentText)
+    }
+
+    @Test
+    fun `should return null when trying to get repository that does not have app enabled`(wmRuntimeInfo: WireMockRuntimeInfo) {
+        val gitHubWireMockStubber = GitHubWireMockStubber(wmRuntimeInfo.wireMock)
+
+        val gitHubApiUrl = "http://localhost:${wmRuntimeInfo.httpPort}/"
+        val clientConfig =
+            GitHubClientConfig(
+                gitHubApiUrl,
+            )
+        val gitHubCommentClient = GitHubCommentClient(clientConfig, jwtProvider)
+
+        val orgName = "my-org"
+        val repoName = "app-not-installed-repo"
+
+        gitHubWireMockStubber.stubApp()
+        gitHubWireMockStubber.stubGetRepoInstallationNotFound(orgName, repoName)
+
+        val repository = gitHubCommentClient.getRepository(orgName, repoName)
+        expectThat(repository).isNull()
+    }
+
+    @Test
+    fun `when open PR exists for branch should find the PR number`(wmRuntimeInfo: WireMockRuntimeInfo) {
+        val gitHubWireMockStubber = GitHubWireMockStubber(wmRuntimeInfo.wireMock)
+
+        val gitHubApiUrl = "http://localhost:${wmRuntimeInfo.httpPort}/"
+        val clientConfig =
+            GitHubClientConfig(
+                gitHubApiUrl,
+            )
+        val gitHubCommentClient = GitHubCommentClient(clientConfig, jwtProvider)
+
+        val orgName = "my-org"
+        val repoName = "my-repo"
+
+        gitHubWireMockStubber.stubRepositoryRequests(orgName, repoName)
+
+        gitHubWireMockStubber.stubListPullRequests(orgName, repoName, listOf("the-branch", "another-branch"))
+
+        val repository = gitHubCommentClient.getRepository(orgName, repoName)
+        assertNotNull(repository)
+
+        val pullRequestNumber = gitHubCommentClient.findOpenPullRequests(repository, "the-branch", null)
+        expectThat(pullRequestNumber).isNotNull().isEqualTo(1)
+    }
+
+    @Test
+    fun `when no open PR for branch should return null for PR number`(wmRuntimeInfo: WireMockRuntimeInfo) {
+        val gitHubWireMockStubber = GitHubWireMockStubber(wmRuntimeInfo.wireMock)
+
+        val gitHubApiUrl = "http://localhost:${wmRuntimeInfo.httpPort}/"
+        val clientConfig =
+            GitHubClientConfig(
+                gitHubApiUrl,
+            )
+        val gitHubCommentClient = GitHubCommentClient(clientConfig, jwtProvider)
+
+        val orgName = "my-org"
+        val repoName = "my-repo"
+
+        gitHubWireMockStubber.stubRepositoryRequests(orgName, repoName)
+
+        gitHubWireMockStubber.stubListPullRequests(orgName, repoName, listOf("the-branch", "another-branch"))
+
+        val repository = gitHubCommentClient.getRepository(orgName, repoName)
+        assertNotNull(repository)
+
+        val pullRequestNumber = gitHubCommentClient.findOpenPullRequests(repository, "some-branch", null)
+        expectThat(pullRequestNumber).isNull()
+    }
+}