toolkit.model.37.0.0.source-code.ResolvedConfiguration.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.
There is a newer version: 33.1.0
/*
 * Copyright (C) 2023 The ORT Project Authors (see )
 *
 * 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.ossreviewtoolkit.model

import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonInclude

import org.ossreviewtoolkit.model.config.PackageConfiguration
import org.ossreviewtoolkit.model.config.Resolutions
import org.ossreviewtoolkit.utils.common.getDuplicates

/**
 * The [ResolvedConfiguration] contains non-administrative configuration which was resolved by an ORT tool to be
 * available for subsequent tools. This is used to make the ORT result self-contained and consistent, so that it is not
 * required to rely on external configuration for further processing.
 * For example, [packageCurations] contains all package curations which apply to packages in this ORT result. This
 * ensures that any tool that uses this ORT result as input does not have to query the package curation providers again
 * and uses exactly the same set of package curations.
 *
 * TODO: Add further data.
 */
data class ResolvedConfiguration(
    /**
     * All [PackageConfiguration]s that correspond to the scan results in this [OrtResult].
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val packageConfigurations: List? = null,

    /**
     * The curations for all enabled providers ordered highest-priority-first. The list contains exactly one entry for
     * each enabled provider.
     */
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val packageCurations: List = emptyList(),

    /**
     * All resolutions that apply to this [OrtResult].
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val resolutions: Resolutions? = null
) {
    init {
        val duplicateProviderIds = packageCurations.getDuplicates().map { it.provider.id }
        require(duplicateProviderIds.isEmpty()) {
            "The list 'providers' contains the following duplicates, which is not allowed: " +
                "${duplicateProviderIds.joinToStringSingleQuoted()}."
        }
    }

    /**
     * Return all [PackageCuration]s contained in this [ResolvedConfiguration] in highest-priority-first order.
     */
    @JsonIgnore
    fun getAllPackageCurations(): List = packageCurations.flatMap { it.curations }
}

data class ResolvedPackageCurations(
    /**
     * The package curation provider.
     */
    val provider: Provider,

    /**
     * All package curations applicable to the packages contained in the enclosing [OrtResult] in the order as they
     * were provided by the package curation provider.
     */
    val curations: List = emptyList()
) {
    data class Provider(
        /**
         * The identifier of the provider.
         */
        val id: String

        // TODO: Add the attributes `type` and `config` from the provider configuration.
    ) companion object {
        /**
         * The provider ID to associate with package curations coming from the repository configuration.
         */
        const val REPOSITORY_CONFIGURATION_PROVIDER_ID = "RepositoryConfiguration"
    }
}

private fun Collection.joinToStringSingleQuoted() = joinToString(prefix = "'", separator = "','", postfix = "'")