Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions model/src/commonMain/kotlin/ResolvablePluginConfig.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the commit message maybe also explain if the goal is to remove the non-ResolvableSecret PluginConfig going forward?

* Copyright (C) 2025 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/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.eclipse.apoapsis.ortserver.model

import kotlinx.serialization.Serializable

/** A [PluginConfig] with information about from which source the secret values must be resolved. */
@Serializable
data class ResolvablePluginConfig(
/**
* The configuration options of the plugin.
*/
val options: Options,

/**
* The resolvable configuration secrets of the plugin.
*/
val secrets: Map<String, ResolvableSecret>
)
99 changes: 99 additions & 0 deletions model/src/jvmTest/kotlin/ResolvablePluginConfigTest.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* Copyright (C) 2025 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/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.eclipse.apoapsis.ortserver.model

import io.kotest.core.spec.style.WordSpec
import io.kotest.matchers.shouldBe

import kotlinx.serialization.json.Json

class ResolvablePluginConfigTest : WordSpec({
"deserialization" should {
"work for up-to-date input" {
val input = """
{
"options": {
"key1": "value1",
"key2": "value2"
},
"secrets": {
"secret1": {
"name": "admin-secret",
"source": "ADMIN"
},
"secret2": {
"name": "user-secret",
"source": "USER"
}
}
}
""".trimIndent()

Json.decodeFromString<ResolvablePluginConfig>(input) shouldBe ResolvablePluginConfig(
options = mapOf(
"key1" to "value1",
"key2" to "value2"
),
secrets = mapOf(
"secret1" to ResolvableSecret(
name = "admin-secret",
source = SecretSource.ADMIN
),
"secret2" to ResolvableSecret(
name = "user-secret",
source = SecretSource.USER
)
)
)
}

"work for legacy input" {
val input = """
{
"options": {
"key1": "value1",
"key2": "value2"
},
"secrets": {
"secret1": "admin-secret",
"secret2": "user-secret"
}
}
""".trimIndent()

Json.decodeFromString<ResolvablePluginConfig>(input) shouldBe ResolvablePluginConfig(
options = mapOf(
"key1" to "value1",
"key2" to "value2"
),
secrets = mapOf(
"secret1" to ResolvableSecret(
name = "admin-secret",
source = SecretSource.ADMIN
),
"secret2" to ResolvableSecret(
name = "user-secret",
source = SecretSource.ADMIN
)
)
)
}
}
})