toolkit.evaluator.36.0.0.source-code.Evaluator.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 java.time.Instant

import kotlin.script.experimental.api.KotlinType
import kotlin.script.experimental.api.ScriptEvaluationConfiguration
import kotlin.script.experimental.api.providedProperties
import kotlin.script.experimental.api.scriptsInstancesSharing
import kotlin.script.experimental.jvmhost.createJvmCompilationConfigurationFromTemplate

import org.ossreviewtoolkit.model.EvaluatorRun
import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.licenses.LicenseClassifications
import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
import org.ossreviewtoolkit.model.utils.ResolutionProvider
import org.ossreviewtoolkit.model.utils.createLicenseInfoResolver
import org.ossreviewtoolkit.utils.scripting.ScriptRunner

class Evaluator(
    ortResult: OrtResult = OrtResult.EMPTY,
    licenseInfoResolver: LicenseInfoResolver = ortResult.createLicenseInfoResolver(),
    resolutionProvider: ResolutionProvider = DefaultResolutionProvider.create(),
    licenseClassifications: LicenseClassifications = LicenseClassifications(),
    time: Instant = Instant.now()
) : ScriptRunner() {
    private val customProperties = mapOf(
        "ortResult" to ortResult,
        "licenseInfoResolver" to licenseInfoResolver,
        "resolutionProvider" to resolutionProvider,
        "licenseClassifications" to licenseClassifications,
        "time" to time
    )

    override val compConfig = createJvmCompilationConfigurationFromTemplate {
        providedProperties(customProperties.mapValues { (_, v) -> KotlinType(v::class) })
    }

    override val evalConfig = ScriptEvaluationConfiguration {
        providedProperties(customProperties)
        scriptsInstancesSharing(true)
    }

    fun run(vararg scripts: String): EvaluatorRun {
        val startTime = Instant.now()

        val violations = scripts.flatMapTo(mutableListOf()) {
            val scriptInstance = runScript(it).scriptInstance as RulesScriptTemplate
            scriptInstance.ruleViolations
        }

        val endTime = Instant.now()

        return EvaluatorRun(startTime, endTime, violations)
    }
}