scanner: presigned URL 1st implementation, doesn't work yet

Signed-off-by: Etsija <[email protected]>

Author: Etsija

clients/dos/build.gradle.kts

@@ -29,11 +29,10 @@ plugins {
 
 dependencies {
     api(libs.retrofit)
+    api(libs.log4jApiKotlin)
 
     implementation(libs.bundles.kotlinxSerialization)
     implementation(libs.retrofitConverterKotlinxSerialization)
-
-    testImplementation(libs.wiremock)
 }
 
 tasks.withType<KotlinCompile>().configureEach {

clients/dos/src/main/kotlin/DOSService.kt

@@ -18,7 +18,60 @@
  */
 
 package org.ossreviewtoolkit.clients.dos
+import com.jakewharton.retrofit2.converter.kotlinx.serialization.asConverterFactory
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonNamingStrategy
+import okhttp3.MediaType.Companion.toMediaType
+import okhttp3.OkHttpClient
+import org.apache.logging.log4j.kotlin.Logging
+import retrofit2.Retrofit
+import retrofit2.http.Body
+import retrofit2.http.POST
 
 interface DOSService {
 
+    companion object: Logging {
+        /**
+         * The default API URL.
+         */
+        const val DEFAULT_API_URL = "https://double-open-server.herokuapp.com/api/"
+
+        /**
+         * The JSON (de-)serialization object used by this service.
+         */
+        val JSON = Json {
+            ignoreUnknownKeys = true
+            namingStrategy = JsonNamingStrategy.SnakeCase
+        }
+
+        /**
+         * Create a new service instance that connects to the [url] specified and uses the optionally provided [client].
+         */
+        fun create(url: String? = null, client: OkHttpClient? = null): DOSService {
+            val contentType = "application/json; charset=utf-8".toMediaType()
+            val retrofit = Retrofit.Builder()
+                .apply { if (client != null) client(client) }
+                .baseUrl(url ?: DEFAULT_API_URL)
+                .addConverterFactory(JSON.asConverterFactory(contentType))
+                .build()
+
+            return retrofit.create(DOSService::class.java)
+        }
+    }
+    @Serializable
+    data class PresignedUrlRequestBody(
+        val key: String? = null
+    )
+    @Serializable
+    data class PresignedUrlResponseBody(
+        val success: Boolean,
+        val presignedUrl: String? = null
+    )
+
+    val json: Json.Default
+
+    @POST("upload-url")
+    suspend fun getPresignedUrl(@Body body: PresignedUrlRequestBody): PresignedUrlResponseBody
+
 }

plugins/scanners/dos/build.gradle.kts

@@ -20,9 +20,14 @@
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
+    alias(libs.plugins.kotlinSerialization)
 }
 
 dependencies {
     api(project(":model"))
     api(project(":scanner"))
+
+    implementation(libs.bundles.kotlinxSerialization)
+    implementation(libs.kotlinxCoroutines)
+    implementation(project(":clients:dos-client"))
 }

plugins/scanners/dos/src/main/kotlin/DOS.kt

@@ -19,16 +19,12 @@
 
 package org.ossreviewtoolkit.plugins.scanners.dos
 
-import java.io.File
-import java.time.Instant
-
-import okhttp3.MediaType.Companion.toMediaType
-import okhttp3.OkHttpClient
-import okhttp3.Request
-import okhttp3.RequestBody.Companion.toRequestBody
-
+import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
 import org.apache.logging.log4j.kotlin.Logging
-
+import org.ossreviewtoolkit.clients.dos.DOSService
+import org.ossreviewtoolkit.clients.dos.DOSService.PresignedUrlRequestBody
 import org.ossreviewtoolkit.model.ScanSummary
 import org.ossreviewtoolkit.model.ScannerDetails
 import org.ossreviewtoolkit.model.config.DownloaderConfiguration
@@ -37,6 +33,8 @@ import org.ossreviewtoolkit.scanner.AbstractScannerWrapperFactory
 import org.ossreviewtoolkit.scanner.PathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScannerCriteria
+import java.io.File
+import java.time.Instant
 
 class DOS internal constructor(
     private val name: String,
@@ -53,15 +51,26 @@ class DOS internal constructor(
         get() = ScannerDetails(name, "1.0", "")
 
     override val criteria: ScannerCriteria? = null
+
+    private val service = DOSService.create()
     override fun scanPath(path: File, context: ScanContext): ScanSummary {
 
         val startTime = Instant.now()
 
         logger.info { "DOS / path to scan: $path" }
-        val dosUrl = System.getenv("DOS_URL")
         val spacesKey = System.getenv("SPACES_KEY")
 
+        runBlocking {
+            val requestBody = PresignedUrlRequestBody(spacesKey)
+            val requestBodyJson = Json.encodeToString(requestBody)
+            logger.info { "DOS / presigned URL request body: $requestBodyJson" }
+            val response = service.getPresignedUrl(requestBody)
+            val responseJson = Json.encodeToString(response)
+            logger.info { "DOS / presigned URL call results: $responseJson" }
+        }
+
         // Request presigned URL from DOS API
+        /*
         val client = OkHttpClient()
         val endPoint = "upload-url"
         val jsonMediaType = "application/json; charset=utf-8".toMediaType()
@@ -81,6 +90,7 @@ class DOS internal constructor(
             val presignedUrlKey = response.body?.string()
             logger.info { "DOS / presigned URL: $presignedUrlKey" }
         }
+        */
 
         val endTime = Instant.now()