Resolvable secrets #3831
+646
−146
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /* | ||
|
Contributor
There was a problem hiding this comment. Can the commit message maybe also explain if the goal is to remove the non- |
||
| * 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> | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
|
Contributor
There was a problem hiding this comment. Commit message:
will be taken |
||
| * 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.KSerializer | ||
| import kotlinx.serialization.KeepGeneratedSerializer | ||
| import kotlinx.serialization.Serializable | ||
| import kotlinx.serialization.SerializationException | ||
| import kotlinx.serialization.descriptors.SerialDescriptor | ||
| import kotlinx.serialization.encoding.Decoder | ||
| import kotlinx.serialization.encoding.Encoder | ||
| import kotlinx.serialization.json.JsonDecoder | ||
| import kotlinx.serialization.json.JsonPrimitive | ||
|
|
||
| @KeepGeneratedSerializer | ||
| @Serializable(with = ResolvableSecretSerializer::class) | ||
| data class ResolvableSecret( | ||
| /** The name of the secret. */ | ||
| val name: String, | ||
|
|
||
| /** The source of the secret. */ | ||
| val source: SecretSource | ||
| ) | ||
|
|
||
| /** | ||
| * A custom deserializer for backward compatibility that allows deserializing a [ResolvableSecret] from either a string | ||
| * or an object. If the value is deserialized from a string, the source is set to [SecretSource.ADMIN] because that was | ||
| * the only available source before the introduction of [ResolvableSecret]. | ||
| */ | ||
| object ResolvableSecretSerializer : KSerializer<ResolvableSecret> { | ||
| private val delegate = ResolvableSecret.generatedSerializer() | ||
|
|
||
| override val descriptor = SerialDescriptor( | ||
| serialName = "org.eclipse.apoapsis.ortserver.model.ResolvableSecret.Custom", | ||
| original = delegate.descriptor | ||
| ) | ||
|
Comment on lines
+50
to
+53
Contributor
There was a problem hiding this comment. Shouldn't the descriptor say it's a contextual serializer, similar to here? In general, you might be able to simplify code by doing like in that other class and using the generated serializer as a delegate. |
||
|
|
||
| override fun serialize(encoder: Encoder, value: ResolvableSecret) { | ||
| encoder.encodeSerializableValue(delegate, value) | ||
| } | ||
|
|
||
| override fun deserialize(decoder: Decoder): ResolvableSecret { | ||
| val jsonDecoder = decoder as? JsonDecoder | ||
| ?: throw SerializationException("ResolvableSecret can only be deserialized from JSON.") | ||
|
|
||
| return when (val element = jsonDecoder.decodeJsonElement()) { | ||
| is JsonPrimitive -> { | ||
| if (!element.isString) { | ||
| throw SerializationException("Expected string or object for ResolvableSecret.") | ||
| } | ||
| ResolvableSecret( | ||
| name = element.content, | ||
| source = SecretSource.ADMIN | ||
| ) | ||
| } | ||
|
|
||
| else -> { | ||
| jsonDecoder.json.decodeFromJsonElement(delegate, element) | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * 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 | ||
|
|
||
| /** An enum class to describe the different sources for secrets. */ | ||
| enum class SecretSource { | ||
| /** The secret is resolved from the admin secrets. */ | ||
| ADMIN, | ||
|
|
||
| /** The secret is resolved from the user secrets configured in the hierarchy. */ | ||
| USER | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this say "from admin secrets"?