Client 모듈 구현

.github/workflows/backend-cd-dev.yml

@@ -0,0 +1,59 @@
+name: backend CD dev
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Repository checkout
+        uses: actions/checkout@v4
+
+      - name: Setup java 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Cache gradle
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Grant permission to gradlew
+        run: chmod +x gradlew
+
+      - name: Build and test with gradle
+        run: ./gradlew clean build
+
+      - name: Sign in Dockerhub
+        uses: docker/login-action@v1
+        with:
+          username: ${{secrets.DOCKER_USERNAME}}
+          password: ${{secrets.DOCKER_PASSWORD}}
+
+      - name: Build the Docker image
+        run: docker build -f ./Dockerfile --platform linux/arm64 --no-cache -t ossori/ossori:dev .
+
+      - name: Push the Docker Image to Dockerhub
+        run: docker push ossori/ossori:dev
+
+  deploy:
+    needs: build
+    runs-on: [ self-hosted ]
+
+    steps:
+      - name: Pull docker image
+        run: sudo docker pull ossori/ossori:dev
+
+      - name: Docker compose up
+        run: sudo docker compose -f ~/docker/ossori-dev-compose.yml up -d

.github/workflows/backend-ci.yml

@@ -0,0 +1,55 @@
+name: backend CI
+
+on:
+  pull_request:
+    branches:
+      - 'develop'
+      - 'main'
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+permissions: write-all
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Repository checkout
+        uses: actions/checkout@v4
+
+      - name: Setup java 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Cache gradle
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Grant permission to gradlew
+        run: chmod +x gradlew
+
+      - name: Build and test with gradle
+        run: ./gradlew build --info
+
+      - name: Publish test results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: ${{ github.workspace }}/build/test-results/test/TEST-*.xml
+
+      - name: Publish test report
+        uses: mikepenz/action-junit-report@v4
+        if: always()
+        with:
+          report_paths: ${{ github.workspace }}/build/test-results/test/TEST-*.xml

Dockerfile

@@ -0,0 +1,4 @@
+FROM eclipse-temurin:21-jdk
+ARG JAR_FILE=build/libs/*.jar
+COPY ${JAR_FILE} app.jar
+ENTRYPOINT ["java", "-jar", "-Duser.timezone=Asia/Seoul", "-Dfile.encoding=UTF-8", "/app.jar"]

module-core/module-client/build.gradle.kts

@@ -15,6 +15,8 @@ repositories {
 dependencies {
     implementation(project(":module-core:module-domain"))
 
+    implementation("org.springframework.boot:spring-boot-starter-web")
+
     testImplementation(kotlin("test"))
 }
 

module-core/module-client/src/main/kotlin/client/github/GithubClient.kt

@@ -0,0 +1,45 @@
+package client.github
+
+import dto.response.GithubRepositoriesResponse
+import dto.response.GithubRepositoryResponse
+import org.springframework.boot.context.properties.EnableConfigurationProperties
+import org.springframework.http.MediaType.APPLICATION_JSON
+import org.springframework.stereotype.Component
+import org.springframework.web.client.RestClient
+
+@EnableConfigurationProperties(GithubClientProperties::class)
+@Component
+class GithubClient(
+    private val githubRestClient: RestClient,
+    private val githubClientProperties: GithubClientProperties
+) {
+
+    companion object {
+        private const val AUTHORIZATION_HEADER = "Authorization"
+        private const val AUTHORIZATION_METHOD = "Bearer"
+    }
+
+    fun getOpenSourceRepository(filterQuery: String): GithubRepositoriesResponse {
+        val uri = "${githubClientProperties.searchRepositoryBaseUrl}$filterQuery"
+        return defaultGithubGetClient(uri)//?q=good-first-issues:>1+help-wanted-issues:>1
+    }
+
+    fun getRepositoryInfo(repositoryOwner: String, repositoryName: String): GithubRepositoryResponse {
+        val uri = "${githubClientProperties.repositoryBaseUrl}/$repositoryOwner/$repositoryName"
+        return defaultGithubGetClient(uri)
+    }
+
+    private fun getGithubToken(): String {
+        return "$AUTHORIZATION_METHOD ${githubClientProperties.token}"
+    }
+
+    private inline fun <reified T> defaultGithubGetClient(uri: String): T {
+        val response = githubRestClient.get()
+            .uri(uri)
+            .accept(APPLICATION_JSON)
+            //.header(AUTHORIZATION_HEADER, getGithubToken())
+            .retrieve()
+            .body(T::class.java)
+        return response ?: throw RuntimeException("Response body is null")
+    }
+}

module-core/module-client/src/main/kotlin/client/github/GithubClientProperties.kt

@@ -0,0 +1,14 @@
+package client.github
+
+import org.springframework.boot.context.properties.ConfigurationProperties
+
+@ConfigurationProperties(prefix = "security.github")
+data class GithubClientProperties(
+
+    val repositoryBaseUrl: String,
+
+    val searchRepositoryBaseUrl: String,
+
+    val token: String
+) {
+}

module-core/module-client/src/main/kotlin/client/github/GithubResponseErrorHandler.kt

@@ -0,0 +1,23 @@
+package client.github
+
+import global.exception.GithubResponseException
+import org.springframework.http.HttpMethod
+import org.springframework.http.client.ClientHttpResponse
+import org.springframework.web.client.ResponseErrorHandler
+import java.net.URI
+
+class GithubResponseErrorHandler : ResponseErrorHandler {
+    override fun hasError(response: ClientHttpResponse): Boolean {
+        return response.statusCode.is4xxClientError || response.statusCode.is5xxServerError
+    }
+
+    override fun handleError(url: URI, method: HttpMethod, response: ClientHttpResponse) {
+        if (response.statusCode.is4xxClientError) {
+            throw GithubResponseException("Status code: ${response.statusCode}, Description: ${response.body}")
+        }
+        if (response.statusCode.is5xxServerError) {
+            throw GithubResponseException("Github Server Unavailable")
+        }
+        throw GithubResponseException(response.body.toString())
+    }
+}

module-core/module-client/src/main/kotlin/config/RestClientConfig.kt

@@ -0,0 +1,30 @@
+package config
+
+import client.github.GithubResponseErrorHandler
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.http.client.ClientHttpRequestFactory
+import org.springframework.http.client.SimpleClientHttpRequestFactory
+import org.springframework.web.client.RestClient
+import java.time.Duration
+
+@Configuration
+class RestClientConfig {
+
+    @Bean
+    fun githubRestClient(): RestClient {
+        val requestFactory = simpleRequestFactory()
+        return RestClient.builder()
+            .requestFactory(requestFactory)
+            .defaultStatusHandler(GithubResponseErrorHandler())
+            .build()
+    }
+
+    private fun simpleRequestFactory(): ClientHttpRequestFactory {
+        val requestFactory = SimpleClientHttpRequestFactory()
+        requestFactory.setConnectTimeout(Duration.ofSeconds(2))
+        requestFactory.setReadTimeout(Duration.ofSeconds(10))
+
+        return requestFactory
+    }
+}

module-core/module-client/src/main/kotlin/dto/response/GithubRepositoriesResponse.kt

@@ -0,0 +1,13 @@
+package dto.response
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class GithubRepositoriesResponse(
+
+    @JsonProperty("total_count")
+    val totalCount: Long,
+
+    val items: List<GithubRepositoryResponse>
+
+) {
+}

module-core/module-client/src/main/kotlin/dto/response/GithubRepositoryResponse.kt

@@ -0,0 +1,23 @@
+package dto.response
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class GithubRepositoryResponse(
+
+    val id: Long,
+
+    val name: String,
+
+    val description: String?,
+
+    @JsonProperty("html_url")
+    val githubLink: String,
+
+    @JsonProperty("stargazers_count")
+    val countingStar: Long,
+
+    @JsonProperty("open_issues_count")
+    val issueCount: Long,
+
+) {
+}

module-core/module-client/src/main/kotlin/global/exception/GithubResponseException.kt

@@ -0,0 +1,5 @@
+package global.exception
+
+class GithubResponseException(message: String) : RuntimeException(message) {
+
+}

module-core/module-client/src/main/resources/application.yml

@@ -0,0 +1,9 @@
+security:
+  github:
+    repository_base_url: https://api.github.com/repos
+    search_repository_base_url: https://api.github.com/search/repositories
+    token: test_pat
+
+spring:
+  jpa:
+    defer-datasource-initialization: true

module-core/module-client/src/test/kotlin/client/github/GithubClientTest.kt

@@ -0,0 +1,49 @@
+package client.github
+
+import org.junit.jupiter.api.Assertions.assertNotNull
+import org.junit.jupiter.api.Disabled
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.TestConfiguration
+import org.springframework.context.annotation.ComponentScan
+import org.springframework.test.context.ContextConfiguration
+import org.springframework.test.context.TestPropertySource
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import kotlin.test.Test
+
+@TestConfiguration
+@ComponentScan(basePackages = ["client", "config"])
+class TestConfig() {
+}
+
+@TestPropertySource(
+    properties = [
+        "security.github.repository_base_url=https://api.github.com/repos/",
+        "security.github.search_repository_base_url=https://api.github.com/search/repositories",
+        "security.github.token=dummy-token"
+    ]
+)
+@ExtendWith(SpringExtension::class)
+@ContextConfiguration(classes = [TestConfig::class])
+class GithubClientTest(
+
+    @Autowired
+    val githubClient: GithubClient
+) {
+
+    @Disabled
+    @Test
+    fun repositoryTest() {
+        val repositoryInfo = githubClient.getRepositoryInfo("Almumol", "OSSori")
+        assertNotNull(repositoryInfo)
+    }
+
+    @Disabled
+    @Test
+    fun searchRepositoryTest() {
+        var openSourceRepository = githubClient.getOpenSourceRepository("?q=good-first-issues:>0")
+        assertNotNull(openSourceRepository)
+        openSourceRepository = githubClient.getOpenSourceRepository("?q=help-wanted-issues:>0")
+        assertNotNull(openSourceRepository)
+    }
+}