refactor(swiftpm): Move the mapping to ORT's model into SwiftPM

Make `SwiftPmModel` dedicated to just the upstream swift models and it's parsing, by moving the mapping to ORT's model into `SwiftPM`. This simplifies refactoring and improves encapsulation as visibility can be reduced. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
oss-review-toolkit · Feb 2, 2024 · bcdac56 · bcdac56
1 parent ab1d875
commit bcdac56
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 78 deletions.
diff --git a/plugins/package-managers/swiftpm/src/main/kotlin/SwiftPm.kt b/plugins/package-managers/swiftpm/src/main/kotlin/SwiftPm.kt
@@ -24,25 +24,30 @@ import java.io.File
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
+import org.ossreviewtoolkit.downloader.VcsHost
 import org.ossreviewtoolkit.downloader.VersionControlSystem
 import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
+import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
+import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.model.orEmpty
 import org.ossreviewtoolkit.model.utils.DependencyGraphBuilder
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
+import org.ossreviewtoolkit.utils.common.toUri
+import org.ossreviewtoolkit.utils.ort.normalizeVcsUrl
 
 private const val PACKAGE_SWIFT_NAME = "Package.swift"
 private const val PACKAGE_RESOLVED_NAME = "Package.resolved"
 
 internal const val PROJECT_TYPE = "SwiftPM"
-internal const val PACKAGE_TYPE = "Swift"
+private const val PACKAGE_TYPE = "Swift"
 
 private const val DEPENDENCIES_SCOPE_NAME = "dependencies"
 
@@ -164,3 +169,72 @@ class SwiftPm(
         )
     }
 }
+
+internal val SwiftPackage.Dependency.id: Identifier
+    get() = Identifier(
+        type = PACKAGE_TYPE,
+        namespace = "",
+        name = getCanonicalName(repositoryUrl),
+        version = version
+    )
+
+internal fun SwiftPackage.Dependency.toPackage(): Package {
+    val vcsInfoFromUrl = VcsHost.parseUrl(repositoryUrl)
+    val vcsInfo = vcsInfoFromUrl.takeUnless { it.revision.isBlank() } ?: vcsInfoFromUrl.copy(revision = version)
+
+    return createPackage(id, vcsInfo)
+}
+
+private fun PinV2.toPackage(): Package {
+    val id = Identifier(
+        type = PACKAGE_TYPE,
+        namespace = "",
+        name = getCanonicalName(location),
+        version = state?.run {
+            when {
+                !version.isNullOrBlank() -> version
+                !revision.isNullOrBlank() -> "revision-$revision"
+                !branch.isNullOrBlank() -> "branch-$branch"
+                else -> ""
+            }
+        }.orEmpty()
+    )
+
+    val vcsInfoFromUrl = VcsHost.parseUrl(location)
+    val vcsInfo = if (vcsInfoFromUrl.revision.isBlank() && state != null) {
+        when {
+            !state.revision.isNullOrBlank() -> vcsInfoFromUrl.copy(revision = state.revision)
+            !state.version.isNullOrBlank() -> vcsInfoFromUrl.copy(revision = state.version)
+            else -> vcsInfoFromUrl
+        }
+    } else {
+        vcsInfoFromUrl
+    }
+
+    return createPackage(id, vcsInfo)
+}
+
+private fun createPackage(id: Identifier, vcsInfo: VcsInfo) =
+    Package(
+        vcs = vcsInfo,
+        description = "",
+        id = id,
+        binaryArtifact = RemoteArtifact.EMPTY,
+        sourceArtifact = RemoteArtifact.EMPTY,
+        declaredLicenses = emptySet(), // SPM files do not declare any licenses.
+        homepageUrl = ""
+    )
+
+/**
+ * Return the canonical name for a package based on the given [repositoryUrl].
+ * The algorithm assumes that the repository URL does not point to the local file
+ * system, as support for local dependencies is not implemented yet in ORT. Otherwise,
+ * the algorithm tries to effectively mimic the algorithm described in
+ * https://github.com/apple/swift-package-manager/blob/24bfdd180afdf78160e7a2f6f6deb2c8249d40d3/Sources/PackageModel/PackageIdentity.swift#L345-L415.
+ */
+internal fun getCanonicalName(repositoryUrl: String): String {
+    val normalizedUrl = normalizeVcsUrl(repositoryUrl)
+    return normalizedUrl.toUri {
+        it.host + it.path.removeSuffix(".git")
+    }.getOrDefault(normalizedUrl).lowercase()
+}
diff --git a/plugins/package-managers/swiftpm/src/main/kotlin/SwiftPmModel.kt b/plugins/package-managers/swiftpm/src/main/kotlin/SwiftPmModel.kt
@@ -29,14 +29,6 @@ import kotlinx.serialization.json.decodeFromJsonElement
 import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.json.jsonPrimitive
 
-import org.ossreviewtoolkit.downloader.VcsHost
-import org.ossreviewtoolkit.model.Identifier
-import org.ossreviewtoolkit.model.Package
-import org.ossreviewtoolkit.model.RemoteArtifact
-import org.ossreviewtoolkit.model.VcsInfo
-import org.ossreviewtoolkit.utils.common.toUri
-import org.ossreviewtoolkit.utils.ort.normalizeVcsUrl
-
 private val json = Json { ignoreUnknownKeys = true }
 
 /**
@@ -128,21 +120,6 @@ internal fun parseLockfile(packageResolvedFile: File): Result<Set<PinV2>> =
 
 internal fun parseSwiftPackage(string: String): SwiftPackage = json.decodeFromString<SwiftPackage>(string)
 
-internal val SwiftPackage.Dependency.id: Identifier
-    get() = Identifier(
-        type = PACKAGE_TYPE,
-        namespace = "",
-        name = getCanonicalName(repositoryUrl),
-        version = version
-    )
-
-internal fun SwiftPackage.Dependency.toPackage(): Package {
-    val vcsInfoFromUrl = VcsHost.parseUrl(repositoryUrl)
-    val vcsInfo = vcsInfoFromUrl.takeUnless { it.revision.isBlank() } ?: vcsInfoFromUrl.copy(revision = version)
-
-    return createPackage(id, vcsInfo)
-}
-
 private fun PinV1.toPinV2(projectDir: File): PinV2 =
     PinV2(
         identity = packageName,
@@ -156,57 +133,3 @@ private fun PinV1.toPinV2(projectDir: File): PinV2 =
             PinV2.Kind.REMOTE_SOURCE_CONTROL
         }
     )
-
-internal fun PinV2.toPackage(): Package {
-    val id = Identifier(
-        type = PACKAGE_TYPE,
-        namespace = "",
-        name = getCanonicalName(location),
-        version = state?.run {
-            when {
-                !version.isNullOrBlank() -> version
-                !revision.isNullOrBlank() -> "revision-$revision"
-                !branch.isNullOrBlank() -> "branch-$branch"
-                else -> ""
-            }
-        }.orEmpty()
-    )
-
-    val vcsInfoFromUrl = VcsHost.parseUrl(location)
-    val vcsInfo = if (vcsInfoFromUrl.revision.isBlank() && state != null) {
-        when {
-            !state.revision.isNullOrBlank() -> vcsInfoFromUrl.copy(revision = state.revision)
-            !state.version.isNullOrBlank() -> vcsInfoFromUrl.copy(revision = state.version)
-            else -> vcsInfoFromUrl
-        }
-    } else {
-        vcsInfoFromUrl
-    }
-
-    return createPackage(id, vcsInfo)
-}
-
-private fun createPackage(id: Identifier, vcsInfo: VcsInfo) =
-    Package(
-        vcs = vcsInfo,
-        description = "",
-        id = id,
-        binaryArtifact = RemoteArtifact.EMPTY,
-        sourceArtifact = RemoteArtifact.EMPTY,
-        declaredLicenses = emptySet(), // SPM files do not declare any licenses.
-        homepageUrl = ""
-    )
-
-/**
- * Return the canonical name for a package based on the given [repositoryUrl].
- * The algorithm assumes that the repository URL does not point to the local file
- * system, as support for local dependencies is not implemented yet in ORT. Otherwise,
- * the algorithm tries to effectively mimic the algorithm described in
- * https://github.com/apple/swift-package-manager/blob/24bfdd180afdf78160e7a2f6f6deb2c8249d40d3/Sources/PackageModel/PackageIdentity.swift#L345-L415.
- */
-internal fun getCanonicalName(repositoryUrl: String): String {
-    val normalizedUrl = normalizeVcsUrl(repositoryUrl)
-    return normalizedUrl.toUri {
-        it.host + it.path.removeSuffix(".git")
-    }.getOrDefault(normalizedUrl).lowercase()
-}