Skip to content

Extend packages with curations info #2483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions api/v1/mapping/src/commonMain/kotlin/Mappings.kt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import org.eclipse.apoapsis.ortserver.api.v1.model.AnalyzerJob as ApiAnalyzerJob
import org.eclipse.apoapsis.ortserver.api.v1.model.AnalyzerJobConfiguration as ApiAnalyzerJobConfiguration
import org.eclipse.apoapsis.ortserver.api.v1.model.ComparisonOperator as ApiComparisonOperator
import org.eclipse.apoapsis.ortserver.api.v1.model.CredentialsType as ApiCredentialsType
import org.eclipse.apoapsis.ortserver.api.v1.model.Curation as ApiCuration
import org.eclipse.apoapsis.ortserver.api.v1.model.EcosystemStats as ApiEcosystemStats
import org.eclipse.apoapsis.ortserver.api.v1.model.EnvironmentConfig as ApiEnvironmentConfig
import org.eclipse.apoapsis.ortserver.api.v1.model.EnvironmentVariableDeclaration as ApiEnvironmentVariableDeclaration
Expand Down Expand Up @@ -145,14 +146,15 @@ import org.eclipse.apoapsis.ortserver.model.runs.Issue
import org.eclipse.apoapsis.ortserver.model.runs.OrtRuleViolation
import org.eclipse.apoapsis.ortserver.model.runs.PackageFilters
import org.eclipse.apoapsis.ortserver.model.runs.PackageManagerConfiguration
import org.eclipse.apoapsis.ortserver.model.runs.PackageWithShortestDependencyPaths
import org.eclipse.apoapsis.ortserver.model.runs.PackageRunData
import org.eclipse.apoapsis.ortserver.model.runs.ProcessedDeclaredLicense
import org.eclipse.apoapsis.ortserver.model.runs.Project
import org.eclipse.apoapsis.ortserver.model.runs.RemoteArtifact
import org.eclipse.apoapsis.ortserver.model.runs.ShortestDependencyPath
import org.eclipse.apoapsis.ortserver.model.runs.VcsInfo
import org.eclipse.apoapsis.ortserver.model.runs.advisor.Vulnerability
import org.eclipse.apoapsis.ortserver.model.runs.advisor.VulnerabilityReference
import org.eclipse.apoapsis.ortserver.model.runs.repository.PackageCurationData
import org.eclipse.apoapsis.ortserver.model.util.ComparisonOperator
import org.eclipse.apoapsis.ortserver.model.util.FilterOperatorAndValue
import org.eclipse.apoapsis.ortserver.model.util.ListQueryParameters
Expand Down Expand Up @@ -857,7 +859,7 @@ fun ShortestDependencyPath.mapToApi() = ApiShortestDependencyPath(
path = path.map { it.mapToApi() }
)

fun PackageWithShortestDependencyPaths.mapToApi() = ApiPackage(
fun PackageRunData.mapToApi() = ApiPackage(
pkg.identifier.mapToApi(),
pkg.purl,
pkg.cpe,
Expand All @@ -872,7 +874,17 @@ fun PackageWithShortestDependencyPaths.mapToApi() = ApiPackage(
pkg.vcsProcessed.mapToApi(),
pkg.isMetadataOnly,
pkg.isModified,
shortestDependencyPaths.map { it.mapToApi() }
shortestDependencyPaths.map { it.mapToApi() },
curations.map { it.mapToApi() }
)

fun PackageCurationData.mapToApi(): ApiCuration = ApiCuration(
concludedLicense ?: "",
comment ?: "",
description ?: "",
homepageUrl ?: "",
authors?.toList() ?: emptyList(),
declaredLicenseMapping
)

fun ApiPackageFilters.mapToModel(): PackageFilters =
Expand Down
32 changes: 32 additions & 0 deletions api/v1/model/src/commonMain/kotlin/Curation.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
* Copyright (C) 2025 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/blob/main/NOTICE>)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/

package org.eclipse.apoapsis.ortserver.api.v1.model

import kotlinx.serialization.Serializable

@Serializable
data class Curation(
val concludedLicense: String,
val comment: String,
val description: String,
val homepageUrl: String,
val authors: List<String>,
val declaredLicenseMapping: Map<String, String>
)
3 changes: 2 additions & 1 deletion api/v1/model/src/commonMain/kotlin/Package.kt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ data class Package(
val vcsProcessed: VcsInfo,
val isMetadataOnly: Boolean = false,
val isModified: Boolean = false,
val shortestDependencyPaths: List<ShortestDependencyPath>
val shortestDependencyPaths: List<ShortestDependencyPath>,
val curations: List<Curation>
)

/**
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/kotlin/api/RunsRoute.kt
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ import org.eclipse.apoapsis.ortserver.model.authorization.RepositoryPermission
import org.eclipse.apoapsis.ortserver.model.repositories.OrtRunRepository
import org.eclipse.apoapsis.ortserver.model.runs.Issue
import org.eclipse.apoapsis.ortserver.model.runs.OrtRuleViolation
import org.eclipse.apoapsis.ortserver.model.runs.PackageWithShortestDependencyPaths
import org.eclipse.apoapsis.ortserver.model.runs.PackageRunData
import org.eclipse.apoapsis.ortserver.model.runs.Project
import org.eclipse.apoapsis.ortserver.services.IssueService
import org.eclipse.apoapsis.ortserver.services.OrtRunService
Expand Down Expand Up @@ -245,7 +245,7 @@ fun Route.runs() = route("runs") {
.listForOrtRunId(ortRun.id, pagingOptions.mapToModel(), filters.mapToModel())

val pagedResponse = packagesForOrtRun
.mapToApi(PackageWithShortestDependencyPaths::mapToApi)
.mapToApi(PackageRunData::mapToApi)
.toSearchResponse(filters)

call.respond(HttpStatusCode.OK, pagedResponse)
Expand Down
11 changes: 11 additions & 0 deletions core/src/main/kotlin/apiDocs/RunsDocs.kt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import kotlin.time.Duration.Companion.minutes
import kotlinx.datetime.Clock

import org.eclipse.apoapsis.ortserver.api.v1.model.ComparisonOperator
import org.eclipse.apoapsis.ortserver.api.v1.model.Curation
import org.eclipse.apoapsis.ortserver.api.v1.model.EcosystemStats
import org.eclipse.apoapsis.ortserver.api.v1.model.FilterOperatorAndValue
import org.eclipse.apoapsis.ortserver.api.v1.model.Identifier
Expand Down Expand Up @@ -428,6 +429,16 @@ val getPackagesByRunId: RouteConfig.() -> Unit = {
Identifier("Maven", "org.example", "other", "1.0")
)
)
),
curations = listOf(
Curation(
concludedLicense = "MIT",
comment = "A comment",
description = "",
homepageUrl = "https://example.com/namespace/name",
authors = listOf("John Doe <[email protected]>"),
declaredLicenseMapping = emptyMap()
)
)
)
),
Expand Down
Loading
Loading