Typed Config for GOP #241
Merged
Typed Config for GOP #241
Conversation
This file contains 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 allows for adding internal properties (can't be set by user via config), preparing for Schema to become the typed configuration object. Reuse @JsonPropertyDescription that already was on almost all properties. A more explicit and more common alternative would have been to use @JsonProperty, but this would basically mean to duplicate all @JsonPropertyDescription annotations adding more than 100 LOC of bloat.
For future usage as config singleton used by all classes.
* More compact output than JSON, * more reuse, * Less complex code, all Config conversions (fromMap, toMap, toYaml) in one place * Get rid of complicated ConfigToConfigFileConverterTest
Allows for a smooth transition from injecting Map via Configuration to injecting Config object directly.
Config and CLI options in one place promise easier maintenance. Not directly related minor refactorings: * Schema now knows the possible values for VaultMode. * Allow for setting config file and map at the same time * this also makes precedence of config options more explicit in code * On top of that, also prepares for adding more config options like secrets or multiple maps or secrets * Hides stack traces when not debug or trace. * Some more classes that are only needed during initialization were converted to static, which make GitopsPlaygroundCliMainScripted a bit simpler. Downsides: Drop params --petclinic-base-domain --nginx-base-domain Because they will soon be refactored anyway and would require separate classes. @immutable needed to be removed, because Picocli can't handle Strings. All options like @immutable or using lombok seem impossible or come with huge downsides themselves. So it would be pragmatic to accept a mutable config :/
nihussmann
commented
Nov 12, 2024
nihussmann
force-pushed
the
feature/typed-config
branch
2 times, most recently
from
46195af to
a90b27b
Compare
nihussmann
commented
Nov 12, 2024
src/main/groovy/com/cloudogu/gitops/cli/GitopsPlaygroundCliMainScripted.groovy
Show resolved
Hide resolved
| @@ -161,6 +162,6 @@ class ScmmRepoTest { | |||
| } | |||
|
|
|||
| private ScmmRepo createRepo(String repoTarget = "dont-care-repo-target") { | |||
| return new TestScmmRepoProvider(new Configuration(config), new FileSystemUtils()).getRepo(repoTarget) | |||
| return new TestScmmRepoProvider(Config.fromMap(config), new FileSystemUtils()).getRepo(repoTarget) | |||
There was a problem hiding this comment.
change map to Config in tests?
| @@ -13,7 +14,7 @@ class NetworkingUtilsTest { | |||
| ] | |||
| ] | |||
|
|
|||
| K8sClientForTest k8sClient = new K8sClientForTest(config) | |||
| K8sClientForTest k8sClient = new K8sClientForTest(Config.fromMap( config)) | |||
| @@ -47,6 +48,6 @@ class DeployerTest { | |||
| ] | |||
| ] | |||
|
|
|||
| return new Deployer(new Configuration(config), argoCdStrat, helmStrat) | |||
| return new Deployer(Config.fromMap(config), argoCdStrat, helmStrat) | |||
| @@ -85,7 +86,7 @@ spec: | |||
| ] | |||
|
|
|||
|
|
|||
| def repoProvider = new TestScmmRepoProvider(new Configuration(config), new FileSystemUtils()) { | |||
| def repoProvider = new TestScmmRepoProvider(Config.fromMap(config), new FileSystemUtils()) { | |||
| @@ -13,7 +14,7 @@ class FeatureTest { | |||
| namePrefix: "foo-" | |||
| ] | |||
| ] | |||
| K8sClientForTest k8sClient = new K8sClientForTest(config) | |||
| K8sClientForTest k8sClient = new K8sClientForTest(Config.fromMap( config)) | |||
There was a problem hiding this comment.
use Config instead Map ?
| config.application['mirrorRepos'] = true | ||
| when(airGappedUtils.mirrorHelmRepoToGit(any(Map))).thenReturn('a/b') | ||
| config.application.mirrorRepos = true | ||
| when(airGappedUtils.mirrorHelmRepoToGit(any())).thenReturn('a/b') |
src/test/groovy/com/cloudogu/gitops/destroy/ScmmDestructionHandlerTest.groovy
Show resolved
Hide resolved
ThomasMichael1811
force-pushed
the
feature/typed-config
branch
from
5d87273 to
b38f42d
Compare
schnatterer
added a commit
that referenced
this pull request
Dec 19, 2024
After they moved there from ApplicationConfigurator in #241
schnatterer
added a commit
that referenced
this pull request
Dec 19, 2024
After they moved there from ApplicationConfigurator in #241
schnatterer
added a commit
that referenced
this pull request
Dec 19, 2024
After they moved there from ApplicationConfigurator in #241
schnatterer
added a commit
that referenced
this pull request
Dec 19, 2024
After they moved there from ApplicationConfigurator in #241
schnatterer
added a commit
that referenced
this pull request
Dec 19, 2024
After they moved there from ApplicationConfigurator in #241
nihussmann
pushed a commit
that referenced
this pull request
Jan 2, 2025
After they moved there from ApplicationConfigurator in #241
schnatterer
added a commit
that referenced
this pull request
Jan 7, 2025
After they moved there from ApplicationConfigurator in #241
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.