refactor(ort-project-file): Use Identifier as the type for id

Signed-off-by: Frank Viernau <frank.viernau@gmail.com>

Author: fviernau

plugins/package-managers/ort-project-file/src/funTest/kotlin/OrtProjectFileFunTest.kt

@@ -192,7 +192,7 @@ class OrtProjectFileFunTest : WordSpec({
             val project = OrtProjectFileFactory.create().resolveSingleProject(definitionFile)
             project.packages should beEmptyCollection()
             project.issues.shouldBeSingleton {
-                it.message shouldContain "The id 'Maven:0.1.0' is not a valid Identifier."
+                it.message shouldContain "The id 'Maven:0.1.0::' is not a valid Identifier."
                 it.source shouldBe "ORT Project File"
             }
         }

plugins/package-managers/ort-project-file/src/main/kotlin/OrtProject.kt

@@ -24,10 +24,18 @@ import com.charleskorn.kaml.Yaml
 import java.io.File
 import java.io.IOException
 
+import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.decodeFromString
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.json.Json
 
+import org.ossreviewtoolkit.model.Identifier
+
 @Serializable
 internal data class OrtProject(
     val projectName: String? = null,
@@ -39,7 +47,8 @@ internal data class OrtProject(
 ) {
     @Serializable
     data class Dependency(
-        val id: String? = null,
+        @Serializable(with = IdentifierSerializer::class)
+        val id: Identifier? = null,
         val purl: String? = null,
         val description: String? = null,
         val vcs: Vcs? = null,
@@ -84,3 +93,16 @@ internal fun File.parseOrtProject(): OrtProject =
     }.getOrElse { cause ->
         throw IOException("Could not parse ORT project file at '$absolutePath'.", cause)
     }
+
+private object IdentifierSerializer : KSerializer<Identifier> {
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor(
+        serialName = checkNotNull(Identifier::class.qualifiedName),
+        kind = PrimitiveKind.STRING
+    )
+
+    override fun serialize(encoder: Encoder, value: Identifier) {
+        encoder.encodeString(value.toCoordinates())
+    }
+
+    override fun deserialize(decoder: Decoder) = Identifier(decoder.decodeString())
+}

plugins/package-managers/ort-project-file/src/main/kotlin/OrtProjectMapper.kt

@@ -99,16 +99,14 @@ private fun Dependency.getIdentifiers(): Pair<Identifier, String> {
     val packageUrl = purl.toPackageUrl()
 
     when {
-        id.isNullOrBlank() && packageUrl == null ->
+        id == null && packageUrl == null ->
             throw IllegalArgumentException("There is no id or purl defined for the package.")
 
-        !id.isNullOrBlank() && packageUrl != null ->
-            return Pair(Identifier(id), packageUrl.toString())
+        id != null && packageUrl != null ->
+            return Pair(id, packageUrl.toString())
 
-        !id.isNullOrBlank() -> {
-            val identifier = Identifier(id)
-            return Pair(identifier, identifier.toPurl())
-        }
+        id != null ->
+            return Pair(id, id.toPurl())
 
         packageUrl != null ->
             return Pair(packageUrl.toIdentifier(), packageUrl.toString())
@@ -121,10 +119,9 @@ private fun Dependency.getIdentifiers(): Pair<Identifier, String> {
 }
 
 private fun Dependency.validateIdentifiers() {
-    if (!id.isNullOrBlank()) {
-        val identifier = Identifier(id)
-        require(!identifier.type.isBlank() && !identifier.name.isBlank() && !identifier.version.isBlank()) {
-            "The id '$id' is not a valid Identifier."
+    if (id != null) {
+        require(!id.type.isBlank() && !id.name.isBlank() && !id.version.isBlank()) {
+            "The id '${id.toCoordinates()}' is not a valid Identifier."
         }
     }