-
Notifications
You must be signed in to change notification settings - Fork 17
Resolvable secrets #3831
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Resolvable secrets #3831
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
a33f595
feat(model): Add a `ResolvableSecret` class
mnonnenmacher 3c5636e
feat(model): Add a `ResolvablePluginConfig`
mnonnenmacher 614cb02
feat: Use `ResolvablePluginConfig` in job configurations
mnonnenmacher 2206a68
refactor(workers): Add `SecretService` to `WorkerContextImpl`
mnonnenmacher 785b16c
test(workers): Rename a test class
mnonnenmacher 2ad15eb
refactor(workers): Turn a function into an expression function
mnonnenmacher ba9f380
feat(secret-service): Add a function to get the value of a secret
mnonnenmacher 9d786f1
test(workers): Create a helper object centrally
mnonnenmacher f07129b
test(workers): Remove unused constructor arguments
mnonnenmacher 882dc99
refactor(workers): Use the `SecretService` for resolving secret values
mnonnenmacher 1fd24d8
test(workers): Remove redundant qualifiers
mnonnenmacher 16d9f9f
feat(workers): Support user secrets in plugin configs
mnonnenmacher File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ | ||
| /* | ||
sschuberth marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * 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,66 @@ | ||
| /* | ||
mnonnenmacher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * 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.encoding.Decoder | ||
| 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> by ResolvableSecret.generatedSerializer() { | ||
| 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(ResolvableSecret.generatedSerializer(), 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.
Uh oh!
There was an error while loading. Please reload this page.