toolkit.model.37.0.0.source-code.ProvenanceResolutionResult.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) 2017 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.JsonInclude

/**
 * This class holds the results of the provenance resolution for the package denoted by [id]. The provenance
 * resolution consists of root provenance resolution and nested provenance resolution - that is, determining the
 * sub-repositories of the root provenance. The information tells what has been scanned, or in case of an issues, what
 * problems happened during provenance resolution.
 */
data class ProvenanceResolutionResult(
    /**
     * The identifier of package.
     */
    val id: Identifier,

    /**
     * The resolved provenance of the package. Can only be null if a [packageProvenanceResolutionIssue] occurred.
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val packageProvenance: KnownProvenance? = null,

    /**
     * The (recursive) sub-repositories of [packageProvenance]. The map can only be empty if a
     * [packageProvenanceResolutionIssue] or a [nestedProvenanceResolutionIssue] occurred.
     */
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    val subRepositories: Map = emptyMap(),

    /**
     * The issue which happened during package provenance resolution, if any.
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val packageProvenanceResolutionIssue: Issue? = null,

    /**
     * The issue which happened during nested provenance resolution, if any.
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    val nestedProvenanceResolutionIssue: Issue? = null
) {
    init {
        require((packageProvenance != null).xor(packageProvenanceResolutionIssue != null)) {
            "Either the package provenance must be known, or a resolution issue must have occurred."
        }

        subRepositories.forEach { (path, vcsInfo) ->
            // TODO: Check if Git-Repo allows to include sub directories of repositories.
            require(vcsInfo.path.isEmpty()) {
                "The resolved sub-repository for package '${id.toCoordinates()}' at '$path' has a non-empty VCS path " +
                    "which is not allowed."
            }
        }

        if (packageProvenanceResolutionIssue != null) {
            require(nestedProvenanceResolutionIssue == null) {
                "Nested provenance resolution was not executed as already the (root) provenance resolution had an " +
                    "issue, but still the nested provenance resolution also has an issue."
            }
        }
    }
}