toolkit.evaluator.33.1.0.source-code.DependencyRule.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evaluator Show documentation
Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.
There is a newer version: 40.0.1
/*
 * 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.evaluator

import org.ossreviewtoolkit.model.CuratedPackage
import org.ossreviewtoolkit.model.DependencyNode
import org.ossreviewtoolkit.model.Identifier
import org.ossreviewtoolkit.model.PackageLinkage
import org.ossreviewtoolkit.model.Project
import org.ossreviewtoolkit.model.licenses.ResolvedLicenseInfo
import org.ossreviewtoolkit.utils.common.enumSetOf

/**
 * A [Rule] to check a single [dependency][DependencyNode].
 */
class DependencyRule(
    ruleSet: RuleSet,
    name: String,
    pkg: CuratedPackage,
    resolvedLicenseInfo: ResolvedLicenseInfo,

    /**
     * The [dependency][DependencyNode] to check.
     */
    val dependency: DependencyNode,

    /**
     * The ancestors of the [dependency] in the dependency tree, sorted from farthest to closest: The first entry is the
     * direct dependency of a project, the last entry (at index `level - 1`) is a direct parent of this [dependency].
     * If the list is empty it means that this dependency is a direct dependency.
     */
    val ancestors: List,

    /**
     * The level of the [dependency] inside the dependency tree. Starts with 0 for a direct dependency of a project.
     */
    val level: Int,

    /**
     * The [name][scopeName] of the scope that contains the [dependency].
     */
    val scopeName: String,

    /**
     * The [Project] that contains the [dependency].
     */
    val project: Project
) : PackageRule(ruleSet, name, pkg, resolvedLicenseInfo) {
    override val description =
        "Evaluating rule '$name' for dependency '${dependency.id.toCoordinates()}' " +
            "(project=${project.id.toCoordinates()}, scope=$scopeName, level=$level)."

    override fun issueSource() =
        "$name - ${pkg.metadata.id.toCoordinates()} (dependency of ${project.id.toCoordinates()} in scope $scopeName)"

    /**
     * Return the direct dependencies of the [dependency].
     */
    fun directDependencies() = dependency.visitDependencies { it.toList() }

    /**
     * A [RuleMatcher] that checks if the level of the [dependency] inside the dependency tree equals [level], which
     * starts with 0 for a direct dependency.
     */
    fun isAtTreeLevel(level: Int) =
        object : RuleMatcher {
            override val description = "isAtTreeLevel($level)"

            override fun matches() = [email protected] == level
        }

    /**
     * A [RuleMatcher] that checks if the [identifier][Project.id] of the [project] belongs to one of the provided
     * [orgs][Identifier.isFromOrg].
     */
    fun isProjectFromOrg(vararg names: String) =
        object : RuleMatcher {
            override val description = "isProjectFromOrg(${names.joinToString()})"

            override fun matches() = project.id.isFromOrg(*names)
        }

    /**
     * A [RuleMatcher] that checks if the [dependency] is [statically linked][PackageLinkage].
     */
    fun isStaticallyLinked() =
        object : RuleMatcher {
            override val description = "isStaticallyLinked()"

            override fun matches() =
                dependency.linkage in enumSetOf(PackageLinkage.STATIC, PackageLinkage.PROJECT_STATIC)
        }
}