main.Extensions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of analyzer Show documentation

Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.

There is a newer version: 44.0.0

/*
 * 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.analyzer

import org.apache.logging.log4j.kotlin.logger

import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
import org.ossreviewtoolkit.utils.common.alsoIfNull

/**
 * Return the list of enabled [PackageManager]s based on the [AnalyzerConfiguration.enabledPackageManagers] and
 * [AnalyzerConfiguration.disabledPackageManagers] configuration properties and the
 * [default][PackageManagerFactory.isEnabledByDefault] of the [PackageManager]s.
 */
fun AnalyzerConfiguration.determineEnabledPackageManagers(): Set {
    val enabled = enabledPackageManagers?.mapNotNull { name ->
        PackageManagerFactory.ALL[name].alsoIfNull {
            logger.error {
                "Package manager '$name' is configured to be enabled but is not available in the classpath. It must " +
                    "be one of: ${PackageManagerFactory.ALL.keys.joinToString()}."
            }
        }
    } ?: PackageManagerFactory.ENABLED_BY_DEFAULT

    val disabled = disabledPackageManagers?.mapNotNull { name ->
        PackageManagerFactory.ALL[name].alsoIfNull {
            logger.warn {
                "Package manager '$name' is configured to be disabled but is not available in the classpath."
            }
        }
    }.orEmpty()

    return enabled.toSet() - disabled.toSet()
}