toolkit.scanner.44.0.0.source-code.CommandLinePathScannerWrapper.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scanner 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.scanner

import java.io.File
import java.time.Instant

import org.ossreviewtoolkit.model.ScanSummary
import org.ossreviewtoolkit.model.ScannerDetails
import org.ossreviewtoolkit.utils.common.CommandLineTool

/**
 * A [PathScannerWrapper] that is executed as a [CommandLineTool] on the local machine.
 */
abstract class CommandLinePathScannerWrapper(override val name: String) : PathScannerWrapper, CommandLineTool {
    override val version by lazy { getVersion() }

    final override fun scanPath(path: File, context: ScanContext): ScanSummary {
        val startTime = Instant.now()
        val result = runScanner(path, context)
        val endTime = Instant.now()
        return createSummary(result, startTime, endTime)
    }

    /**
     * Run the scanner on the given [path] with the given [context].
     */
    abstract fun runScanner(path: File, context: ScanContext): String

    /**
     * Create [ScannerDetails] from parsing [result] in a scanner-specific way. This function can be used if a scan
     * storage provider returns raw scan results in the native format of the scanner.
     */
    open fun parseDetails(result: String): ScannerDetails = throw NotImplementedError()

    /**
     * Create a [ScanSummary] from the scan [result] in a scanner-native format. If the [result] itself does not contain
     * time information, [startTime] and [endTime] may be used instead.
     */
    abstract fun createSummary(result: String, startTime: Instant, endTime: Instant): ScanSummary
}