refactor(logaccess): Move LogLevel and LogSource to the model module

Make the enums accessible from other modules that don't depend on the `logaccess` module. Signed-off-by: Marcel Bochtler <[email protected]>
eclipse-apoapsis · Jan 17, 2025 · d8b13f0 · d8b13f0
1 parent 329e098
commit d8b13f0
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 12 deletions.
diff --git a/core/src/main/kotlin/api/RunsRoute.kt b/core/src/main/kotlin/api/RunsRoute.kt
@@ -64,9 +64,9 @@ import org.eclipse.apoapsis.ortserver.core.utils.requireIdParameter
 import org.eclipse.apoapsis.ortserver.core.utils.requireParameter
 import org.eclipse.apoapsis.ortserver.dao.QueryParametersException
 import org.eclipse.apoapsis.ortserver.logaccess.LogFileService
-import org.eclipse.apoapsis.ortserver.logaccess.LogLevel
-import org.eclipse.apoapsis.ortserver.logaccess.LogSource
 import org.eclipse.apoapsis.ortserver.model.JobStatus
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 import org.eclipse.apoapsis.ortserver.model.OrtRun
 import org.eclipse.apoapsis.ortserver.model.VulnerabilityWithIdentifier
 import org.eclipse.apoapsis.ortserver.model.authorization.RepositoryPermission

diff --git a/core/src/main/kotlin/apiDocs/RunsDocs.kt b/core/src/main/kotlin/apiDocs/RunsDocs.kt
@@ -54,8 +54,8 @@ import org.eclipse.apoapsis.ortserver.api.v1.model.Vulnerability
 import org.eclipse.apoapsis.ortserver.api.v1.model.VulnerabilityRating
 import org.eclipse.apoapsis.ortserver.api.v1.model.VulnerabilityReference
 import org.eclipse.apoapsis.ortserver.api.v1.model.VulnerabilityWithIdentifier
-import org.eclipse.apoapsis.ortserver.logaccess.LogLevel
-import org.eclipse.apoapsis.ortserver.logaccess.LogSource
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 
 val getOrtRunById: OpenApiRoute.() -> Unit = {
     operationId = "getOrtRunById"

diff --git a/core/src/test/kotlin/api/RunsRouteIntegrationTest.kt b/core/src/test/kotlin/api/RunsRouteIntegrationTest.kt
@@ -89,13 +89,13 @@ import org.eclipse.apoapsis.ortserver.core.shouldHaveBody
 import org.eclipse.apoapsis.ortserver.dao.utils.toDatabasePrecision
 import org.eclipse.apoapsis.ortserver.logaccess.LogFileCriteria
 import org.eclipse.apoapsis.ortserver.logaccess.LogFileProviderFactoryForTesting
-import org.eclipse.apoapsis.ortserver.logaccess.LogLevel
-import org.eclipse.apoapsis.ortserver.logaccess.LogSource
 import org.eclipse.apoapsis.ortserver.model.AdvisorJobConfiguration
 import org.eclipse.apoapsis.ortserver.model.AnalyzerJobConfiguration
 import org.eclipse.apoapsis.ortserver.model.EvaluatorJobConfiguration
 import org.eclipse.apoapsis.ortserver.model.JobConfigurations
 import org.eclipse.apoapsis.ortserver.model.JobStatus
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 import org.eclipse.apoapsis.ortserver.model.OrtRun
 import org.eclipse.apoapsis.ortserver.model.OrtRunStatus
 import org.eclipse.apoapsis.ortserver.model.PluginConfiguration

diff --git a/logaccess/loki/build.gradle.kts b/logaccess/loki/build.gradle.kts
@@ -32,6 +32,7 @@ dependencies {
     api(libs.typesafeConfig)
 
     implementation(projects.logaccess.logaccessSpi)
+    implementation(projects.model)
     implementation(projects.utils.config)
 
     implementation(libs.ktorClientAuth)

diff --git a/logaccess/loki/src/main/kotlin/LokiLogFileProvider.kt b/logaccess/loki/src/main/kotlin/LokiLogFileProvider.kt
@@ -40,8 +40,8 @@ import kotlinx.datetime.Instant
 import kotlinx.serialization.json.Json
 
 import org.eclipse.apoapsis.ortserver.logaccess.LogFileProvider
-import org.eclipse.apoapsis.ortserver.logaccess.LogLevel
-import org.eclipse.apoapsis.ortserver.logaccess.LogSource
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 
 import org.slf4j.LoggerFactory
 

diff --git a/logaccess/loki/src/test/kotlin/LokiLogFileProviderTest.kt b/logaccess/loki/src/test/kotlin/LokiLogFileProviderTest.kt
@@ -58,8 +58,8 @@ import kotlinx.datetime.Instant
 
 import org.eclipse.apoapsis.ortserver.config.ConfigManager
 import org.eclipse.apoapsis.ortserver.logaccess.LogFileService
-import org.eclipse.apoapsis.ortserver.logaccess.LogLevel
-import org.eclipse.apoapsis.ortserver.logaccess.LogSource
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 
 class LokiLogFileProviderTest : StringSpec() {
     private val server = WireMockServer(WireMockConfiguration.options().dynamicPort())

diff --git a/logaccess/spi/build.gradle.kts b/logaccess/spi/build.gradle.kts
@@ -30,9 +30,11 @@ group = "org.eclipse.apoapsis.ortserver.logaccess"
 
 dependencies {
     api(projects.config.configSpi)
+    api(projects.model)
 
     api(libs.kotlinxDatetime)
 
+    implementation(projects.model)
     implementation(projects.utils.config)
 
     implementation(libs.kotlinxCoroutines)
@@ -46,5 +48,6 @@ dependencies {
     testImplementation(libs.kotestRunnerJunit5)
     testImplementation(libs.mockk)
 
+    testFixturesImplementation(projects.model)
     testFixturesImplementation(projects.utils.config)
 }
diff --git a/logaccess/spi/src/main/kotlin/LogFileProvider.kt b/logaccess/spi/src/main/kotlin/LogFileProvider.kt
@@ -23,6 +23,9 @@ import java.io.File
 
 import kotlinx.datetime.Instant
 
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
+
 /**
  * The Service Provider Interface for the log file provider abstraction.
  *

diff --git a/logaccess/spi/src/main/kotlin/LogFileService.kt b/logaccess/spi/src/main/kotlin/LogFileService.kt
@@ -32,6 +32,8 @@ import kotlinx.datetime.Instant
 
 import org.eclipse.apoapsis.ortserver.config.ConfigManager
 import org.eclipse.apoapsis.ortserver.config.Path as ConfigPath
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 import org.eclipse.apoapsis.ortserver.utils.config.getStringOrNull
 
 import org.ossreviewtoolkit.utils.common.packZip

diff --git a/logaccess/spi/src/test/kotlin/LogFileServiceTest.kt b/logaccess/spi/src/test/kotlin/LogFileServiceTest.kt
@@ -39,6 +39,8 @@ import java.util.EnumSet
 import kotlinx.datetime.Instant
 
 import org.eclipse.apoapsis.ortserver.config.ConfigManager
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 
 import org.ossreviewtoolkit.utils.common.unpack
 

diff --git a/logaccess/spi/src/test/kotlin/LogLevelTest.kt b/logaccess/spi/src/test/kotlin/LogLevelTest.kt
@@ -22,6 +22,8 @@ package org.eclipse.apoapsis.ortserver.logaccess
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder
 
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+
 class LogLevelTest : WordSpec({
     "levelOrHigher" should {
         "return a correct set for the ERROR level" {

diff --git a/logaccess/spi/src/testFixtures/kotlin/LogFileProviderFactoryForTesting.kt b/logaccess/spi/src/testFixtures/kotlin/LogFileProviderFactoryForTesting.kt
@@ -26,6 +26,8 @@ import java.util.EnumSet
 import kotlinx.datetime.Instant
 
 import org.eclipse.apoapsis.ortserver.config.ConfigManager
+import org.eclipse.apoapsis.ortserver.model.LogLevel
+import org.eclipse.apoapsis.ortserver.model.LogSource
 
 /**
  * An implementation of [LogFileProviderFactory] that can be used to test interactions with log file providers.

diff --git a/logaccess/spi/src/main/kotlin/LogLevel.kt → model/src/commonMain/kotlin/LogLevel.kt b/logaccess/spi/src/main/kotlin/LogLevel.kt → model/src/commonMain/kotlin/LogLevel.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.eclipse.apoapsis.ortserver.logaccess
+package org.eclipse.apoapsis.ortserver.model
 
 import java.util.EnumSet
 

diff --git a/logaccess/spi/src/main/kotlin/LogSource.kt → model/src/commonMain/kotlin/LogSource.kt b/logaccess/spi/src/main/kotlin/LogSource.kt → model/src/commonMain/kotlin/LogSource.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.eclipse.apoapsis.ortserver.logaccess
+package org.eclipse.apoapsis.ortserver.model
 
 /**
  * An enumeration class that defines the different sources for which log files can be downloaded. The sources