Update relocated Micronaut Security config yaml keys org.openrewrite.java.micronaut.UpdateSecurityYamlIfNeeded
This recipe will update relocated security config keys in Micronaut configuration yaml files.
Recipe source
GitHub , Issue Tracker , Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-micronaut
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-micronaut:2.3.1
in your build file or by running a shell command (in which case no build changes are needed):
Gradle Gradle init script Maven POM Maven Command Line Moderne CLI
Add the following to your build.gradle
file:
Copy plugins {
id( "org.openrewrite.rewrite" ) version( "6.12.0" )
}
rewrite {
activeRecipe( "org.openrewrite.java.micronaut.UpdateSecurityYamlIfNeeded" )
}
repositories {
mavenCentral()
}
dependencies {
rewrite( "org.openrewrite.recipe:rewrite-micronaut:2.3.1" )
}
Run gradle rewriteRun
to run the recipe.
Create a file named init.gradle
in the root of your project.
Copy initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath( "org.openrewrite:plugin:6.12.0" ) }
}
rootProject {
plugins . apply( org.openrewrite.gradle.RewritePlugin )
dependencies {
rewrite( "org.openrewrite.recipe:rewrite-micronaut:2.3.1" )
}
rewrite {
activeRecipe( "org.openrewrite.java.micronaut.UpdateSecurityYamlIfNeeded" )
}
afterEvaluate {
if (repositories . isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
Run gradle --init-script init.gradle rewriteRun
to run the recipe.
Add the following to your pom.xml
file:
Copy < project >
< build >
< plugins >
< plugin >
< groupId >org.openrewrite.maven</ groupId >
< artifactId >rewrite-maven-plugin</ artifactId >
< version >5.29.0</ version >
< configuration >
< activeRecipes >
< recipe >org.openrewrite.java.micronaut.UpdateSecurityYamlIfNeeded</ recipe >
</ activeRecipes >
</ configuration >
< dependencies >
< dependency >
< groupId >org.openrewrite.recipe</ groupId >
< artifactId >rewrite-micronaut</ artifactId >
< version >2.3.1</ version >
</ dependency >
</ dependencies >
</ plugin >
</ plugins >
</ build >
</ project >
Run mvn rewrite:run
to run the recipe.
Copy mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-micronaut:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.micronaut.UpdateSecurityYamlIfNeeded
You will need to have configured the Moderne CLI on your machine before you can run the following command.
Copy mod run . --recipe UpdateSecurityYamlIfNeeded
Definition
Recipe List Yaml Recipe List
Merge YAML snippet
key: $.micronaut.security.token
yaml: generator: access-token: expiration: cookie: enabled: cookie-max-age: cookie-path: cookie-domain: cookie-same-site: bearer: enabled:
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.generator.access-token.expiration
newKey: $.micronaut.security.token.generator.access-token.expiration
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.cookie.enabled
newKey: $.micronaut.security.token.cookie.enabled
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.cookie.cookie-max-age
newKey: $.micronaut.security.token.cookie.cookie-max-age
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.cookie.cookie-path
newKey: $.micronaut.security.token.cookie.cookie-path
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.cookie.cookie-domain
newKey: $.micronaut.security.token.cookie.cookie-domain
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.cookie.cookie-same-site
newKey: $.micronaut.security.token.cookie.cookie-same-site
Copy YAML value
oldKeyPath: $.micronaut.security.token.jwt.bearer.enabled
newKey: $.micronaut.security.token.bearer.enabled
Delete key
keyPath: $.micronaut.security.token.jwt.generator
Delete key
keyPath: $.micronaut.security.token.jwt.cookie
Delete key
keyPath: $.micronaut.security.token.jwt.bearer
Copy ---
type : specs.openrewrite.org/v1beta/recipe
name : org.openrewrite.java.micronaut.UpdateSecurityYamlIfNeeded
displayName : Update relocated Micronaut Security config yaml keys
description : This recipe will update relocated security config keys in Micronaut configuration yaml files.
recipeList :
- org.openrewrite.yaml.MergeYaml :
key : $.micronaut.security.token
yaml : generator :
access-token :
expiration :
cookie :
enabled :
cookie-max-age :
cookie-path :
cookie-domain :
cookie-same-site :
bearer :
enabled :
acceptTheirs : true
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.generator.access-token.expiration
newKey : $.micronaut.security.token.generator.access-token.expiration
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.cookie.enabled
newKey : $.micronaut.security.token.cookie.enabled
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.cookie.cookie-max-age
newKey : $.micronaut.security.token.cookie.cookie-max-age
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.cookie.cookie-path
newKey : $.micronaut.security.token.cookie.cookie-path
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.cookie.cookie-domain
newKey : $.micronaut.security.token.cookie.cookie-domain
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.cookie.cookie-same-site
newKey : $.micronaut.security.token.cookie.cookie-same-site
- org.openrewrite.yaml.CopyValue :
oldKeyPath : $.micronaut.security.token.jwt.bearer.enabled
newKey : $.micronaut.security.token.bearer.enabled
- org.openrewrite.yaml.DeleteKey :
keyPath : $.micronaut.security.token.jwt.generator
- org.openrewrite.yaml.DeleteKey :
keyPath : $.micronaut.security.token.jwt.cookie
- org.openrewrite.yaml.DeleteKey :
keyPath : $.micronaut.security.token.jwt.bearer
- org.openrewrite.yaml.cleanup.RemoveUnused
See how this recipe works across multiple open-source repositories
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Contributors
Jeremy Grelle , Knut Wannheden , Tim te Beek , Jonathan Schnéider