PluginConfig.kt

/*
 * Copyright (C) 2024 The ORT Project Copyright Holders <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>
 *
 * 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.plugins.api

import com.fasterxml.jackson.annotation.JsonIgnore

import org.ossreviewtoolkit.utils.common.Options

/** The configuration of a plugin, used as input for [PluginFactory.create]. */
data class PluginConfig(
    /** The configuration options of the plugin. */
    val options: Options = emptyMap(),

    /**
     * The configuration secrets of the plugin.
     *
     * This property is not serialized to ensure that secrets do not appear in serialized output.
     */
    @JsonIgnore
    val secrets: Options = emptyMap()
) {
    companion object {
        /** Constant for an empty [PluginConfig]. */
        val EMPTY = PluginConfig()
    }

    /** Return a string representation that does not contain the [secrets]. */
    override fun toString() = "${this::class.simpleName}(options=$options, secrets=[***])"
}

/** Returns this [PluginConfig] if it is not `null`, or the [empty][PluginConfig.EMPTY] [PluginConfig] otherwise. */
fun PluginConfig?.orEmpty() = this ?: PluginConfig.EMPTY