toolkit.plugins.packagemanagers.bazel-package-manager.38.0.0.source-code.BazelModel.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2024 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.plugins.packagemanagers.bazel

import java.io.File

import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json

private val json = Json { ignoreUnknownKeys = true }

/**
 * The data model for MODULE.bazel.lock.
 */
@Serializable
internal data class Lockfile(
    // The flags containing the registry URLs (Bazel < 7.2.0).
    val flags: Flags? = null,

    // The registry URLs of the project's dependencies packages  (Bazel >= 7.2.0).
    val registryFileHashes: Map? = null
) {
    init {
        require((flags == null) xor (registryFileHashes == null)) {
            "A lockfile must either set the 'flags' or the 'registryFileHashes' property."
        }
    }

    @Serializable
    data class Flags(
        val cmdRegistries: List
    )

    /**
     * Return a list of URLs for the service registries defined for this project in case Bazel < 7.2.0 is used, or an
     * empty list otherwise.
     */
    fun registryUrls(): List = flags?.cmdRegistries.orEmpty()
}

internal fun parseLockfile(lockfile: File) = json.decodeFromString(lockfile.readText())

/**
 * The data model for the output of "bazel mod graph --output json".
 */
@Serializable
internal data class BazelModule(
    val key: String,
    val name: String? = null,
    val version: String? = null,
    val dependencies: List = emptyList()
)

internal fun String.parseBazelModule() = json.decodeFromString(this)