toolkit.evaluator.44.0.0.source-code.RulesScriptTemplate.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.

The newest version!

/*
 * Copyright (C) 2022 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 java.time.Instant

import kotlin.script.experimental.annotations.KotlinScript
import kotlin.script.experimental.api.ScriptCompilationConfiguration
import kotlin.script.experimental.api.defaultImports

import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.RuleViolation
import org.ossreviewtoolkit.model.licenses.LicenseClassifications
import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
import org.ossreviewtoolkit.model.utils.ResolutionProvider
import org.ossreviewtoolkit.utils.scripting.OrtScriptCompilationConfiguration

@KotlinScript(
    displayName = "ORT Evaluator Rules Script",
    fileExtension = "rules.kts",
    compilationConfiguration = RulesScriptCompilationConfiguration::class
)
open class RulesScriptTemplate(
    val ortResult: OrtResult,
    val licenseInfoResolver: LicenseInfoResolver,
    val resolutionProvider: ResolutionProvider,
    val licenseClassifications: LicenseClassifications,
    val time: Instant
) {
    val ruleViolations = mutableListOf()
}

class RulesScriptCompilationConfiguration : ScriptCompilationConfiguration(
    OrtScriptCompilationConfiguration(),
    body = {
        defaultImports(
            "org.ossreviewtoolkit.evaluator.*",
            "org.ossreviewtoolkit.model.*",
            "org.ossreviewtoolkit.model.config.*",
            "org.ossreviewtoolkit.model.licenses.*",
            "org.ossreviewtoolkit.model.utils.*",
            "org.ossreviewtoolkit.utils.spdx.*"
        )
    }
)