From d42b518a2792252353e96a2139a9bdbf5d6d5ada Mon Sep 17 00:00:00 2001 From: anuram Date: Fri, 24 Jan 2025 14:28:43 -0500 Subject: [PATCH 1/6] first commit --- .../java/migrate/ChangeDefaultKeyStore.java | 57 ++++++++++++++ .../migrate/ChangeDefaultKeyStoreTest.java | 77 +++++++++++++++++++ 2 files changed, 134 insertions(+) create mode 100644 src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java create mode 100644 src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java diff --git a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java new file mode 100644 index 000000000..fa4def987 --- /dev/null +++ b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java @@ -0,0 +1,57 @@ +/* + * Copyright 2025 the original author or authors. + *

+ * Licensed under the Moderne Source Available License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://docs.moderne.io/licensing/moderne-source-available-license + *

+ * 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. + */ +package org.openrewrite.java.migrate; + + +import org.openrewrite.ExecutionContext; +import org.openrewrite.Recipe; +import org.openrewrite.TreeVisitor; +import org.openrewrite.java.JavaVisitor; +import org.openrewrite.java.MethodMatcher; +import org.openrewrite.java.tree.J; +import org.openrewrite.java.tree.JavaType; +import org.openrewrite.java.tree.Space; +import org.openrewrite.marker.Markers; + +import static org.openrewrite.Tree.randomId; + + +public class ChangeDefaultKeyStore extends Recipe { + private static final MethodMatcher KEYSTORE_METHOD_REF = new MethodMatcher("java.security.KeyStore getDefaultType()", true); + + @Override + public String getDisplayName() { + return "Replace `java.lang.ref.Reference.clone()` with constructor call"; + } + + @Override + public String getDescription() { + return "This recipe returns default keystore value of jks when getDefaultKeyStore is called."; + } + + @Override + public TreeVisitor getVisitor() { + return new JavaVisitor() { + @Override + public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { + if (KEYSTORE_METHOD_REF.matches(method)) { + return new J.Literal(randomId(), Space.EMPTY, Markers.EMPTY, "\"JKS\"", "\"JKS\"", null, JavaType.Primitive.String); + } + return super.visitMethodInvocation(method, ctx); + } + }; + } +} diff --git a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java new file mode 100644 index 000000000..c8115fae2 --- /dev/null +++ b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java @@ -0,0 +1,77 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Moderne Source Available License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://docs.moderne.io/licensing/moderne-source-available-license + *

+ * 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. + */ +package org.openrewrite.java.migrate; + +import org.junit.jupiter.api.Test; +import org.openrewrite.test.RecipeSpec; +import org.openrewrite.test.RewriteTest; + +import static org.openrewrite.java.Assertions.java; + +public class ChangeDefaultKeyStoreTest implements RewriteTest { + @Override + public void defaults(RecipeSpec spec) { + spec.recipe(new ChangeDefaultKeyStore()); + } + @Test + void testKeyStore() { + rewriteRun( + //language=java + java( + """ + import java.io.FileInputStream; + import java.io.IOException; + import java.security.Key; + import java.security.KeyStore; + + class Foo { + void bar() { + try{ + KeyStore keystore = KeyStore.getInstance(KeyStore.getDefaultType()); + char[] password = "your_keystore_password".toCharArray(); + FileInputStream keystoreFile = new FileInputStream("path_to_your_keystore_file.jks"); + keystore.load(keystoreFile, password); + } + catch (Exception e) { + e.printStackTrace(); + } + } + } + """, + """ + import java.io.FileInputStream; + import java.io.IOException; + import java.security.Key; + import java.security.KeyStore; + + class Foo { + void bar() { + try{ + KeyStore keystore = KeyStore.getInstance("JKS"); + char[] password = "your_keystore_password".toCharArray(); + FileInputStream keystoreFile = new FileInputStream("path_to_your_keystore_file.jks"); + keystore.load(keystoreFile, password); + } + catch (Exception e) { + e.printStackTrace(); + } + } + } + """ + ) + ); + } +} From ebfc4007af68b481440fa180674a64c7a97c1797 Mon Sep 17 00:00:00 2001 From: anuram Date: Mon, 27 Jan 2025 14:36:37 -0500 Subject: [PATCH 2/6] add .yml and updated description --- .../org/openrewrite/java/migrate/ChangeDefaultKeyStore.java | 6 ++++-- src/main/resources/META-INF/rewrite/java-version-11.yml | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java index fa4def987..26634fd4d 100644 --- a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java +++ b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java @@ -34,12 +34,14 @@ public class ChangeDefaultKeyStore extends Recipe { @Override public String getDisplayName() { - return "Replace `java.lang.ref.Reference.clone()` with constructor call"; + return "Return String `JKS` when `KeyStore.getDefaultType()` is called"; } @Override public String getDescription() { - return "This recipe returns default keystore value of jks when getDefaultKeyStore is called."; + return "In Java 11 the default keystore was updated from JKS to PKCS12." + + "As a result, applications relying on KeyStore.getDefaultType() may encounter issues after migrating, unless their JKS keystore has been converted to PKCS12." + + "This recipe returns default key store of `JKS` when `KeyStore.getDefaultType()` method is called to use the pre Java 11 default keystore."; } @Override diff --git a/src/main/resources/META-INF/rewrite/java-version-11.yml b/src/main/resources/META-INF/rewrite/java-version-11.yml index 5ad5aa265..319af5f17 100644 --- a/src/main/resources/META-INF/rewrite/java-version-11.yml +++ b/src/main/resources/META-INF/rewrite/java-version-11.yml @@ -76,7 +76,7 @@ recipeList: - org.openrewrite.java.migrate.ReplaceLocalizedStreamMethods - org.openrewrite.java.migrate.ArrayStoreExceptionToTypeNotPresentException - org.openrewrite.java.migrate.IllegalArgumentExceptionToAlreadyConnectedException - + - org.openrewrite.java.migrate.ChangeDefaultKeyStore --- type: specs.openrewrite.org/v1beta/recipe name: org.openrewrite.java.migrate.UpgradeBuildToJava11 @@ -292,3 +292,4 @@ recipeList: - org.openrewrite.java.ChangeMethodName: methodPattern: java.nio.file.Path get(..) newMethodName: of + From 6bb756857fad8434816209388fe2bad1aede98d0 Mon Sep 17 00:00:00 2001 From: anuram Date: Mon, 27 Jan 2025 14:45:46 -0500 Subject: [PATCH 3/6] small update --- .../org/openrewrite/java/migrate/ChangeDefaultKeyStore.java | 6 +++--- .../openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java index 26634fd4d..fee63adce 100644 --- a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java +++ b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java @@ -34,14 +34,14 @@ public class ChangeDefaultKeyStore extends Recipe { @Override public String getDisplayName() { - return "Return String `JKS` when `KeyStore.getDefaultType()` is called"; + return "Return String `jks` when `KeyStore.getDefaultType()` is called"; } @Override public String getDescription() { return "In Java 11 the default keystore was updated from JKS to PKCS12." + "As a result, applications relying on KeyStore.getDefaultType() may encounter issues after migrating, unless their JKS keystore has been converted to PKCS12." + - "This recipe returns default key store of `JKS` when `KeyStore.getDefaultType()` method is called to use the pre Java 11 default keystore."; + "This recipe returns default key store of `jks` when `KeyStore.getDefaultType()` method is called to use the pre Java 11 default keystore."; } @Override @@ -50,7 +50,7 @@ public TreeVisitor getVisitor() { @Override public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { if (KEYSTORE_METHOD_REF.matches(method)) { - return new J.Literal(randomId(), Space.EMPTY, Markers.EMPTY, "\"JKS\"", "\"JKS\"", null, JavaType.Primitive.String); + return new J.Literal(randomId(), Space.EMPTY, Markers.EMPTY, "\"jks\"", "\"jks\"", null, JavaType.Primitive.String); } return super.visitMethodInvocation(method, ctx); } diff --git a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java index c8115fae2..f418f29da 100644 --- a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java +++ b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java @@ -60,7 +60,7 @@ void bar() { class Foo { void bar() { try{ - KeyStore keystore = KeyStore.getInstance("JKS"); + KeyStore keystore = KeyStore.getInstance("jks"); char[] password = "your_keystore_password".toCharArray(); FileInputStream keystoreFile = new FileInputStream("path_to_your_keystore_file.jks"); keystore.load(keystoreFile, password); From 609e3c5ca0295d4454f40cfd3d9e30c34d27c25a Mon Sep 17 00:00:00 2001 From: anuram Date: Mon, 27 Jan 2025 15:26:42 -0500 Subject: [PATCH 4/6] post review comments --- .../java/migrate/ChangeDefaultKeyStore.java | 20 ++++++++++--------- .../migrate/ChangeDefaultKeyStoreTest.java | 9 +++++++-- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java index fee63adce..028cd33c7 100644 --- a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java +++ b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java @@ -17,10 +17,12 @@ import org.openrewrite.ExecutionContext; +import org.openrewrite.Preconditions; import org.openrewrite.Recipe; import org.openrewrite.TreeVisitor; import org.openrewrite.java.JavaVisitor; import org.openrewrite.java.MethodMatcher; +import org.openrewrite.java.search.UsesJavaVersion; import org.openrewrite.java.tree.J; import org.openrewrite.java.tree.JavaType; import org.openrewrite.java.tree.Space; @@ -46,14 +48,14 @@ public String getDescription() { @Override public TreeVisitor getVisitor() { - return new JavaVisitor() { - @Override - public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { - if (KEYSTORE_METHOD_REF.matches(method)) { - return new J.Literal(randomId(), Space.EMPTY, Markers.EMPTY, "\"jks\"", "\"jks\"", null, JavaType.Primitive.String); - } - return super.visitMethodInvocation(method, ctx); - } - }; + return Preconditions.check(new UsesJavaVersion<>(11), + new JavaVisitor() { + public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { + if (KEYSTORE_METHOD_REF.matches(method)) { + return new J.Literal(randomId(), Space.EMPTY, Markers.EMPTY, "\"jks\"", "\"jks\"", null, JavaType.Primitive.String); + } + return super.visitMethodInvocation(method, ctx); + } + }); } } diff --git a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java index f418f29da..a95029b46 100644 --- a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java +++ b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java @@ -16,18 +16,23 @@ package org.openrewrite.java.migrate; import org.junit.jupiter.api.Test; +import org.openrewrite.DocumentExample; import org.openrewrite.test.RecipeSpec; import org.openrewrite.test.RewriteTest; import static org.openrewrite.java.Assertions.java; +import static org.openrewrite.java.Assertions.javaVersion; public class ChangeDefaultKeyStoreTest implements RewriteTest { @Override public void defaults(RecipeSpec spec) { - spec.recipe(new ChangeDefaultKeyStore()); + spec.recipe(new ChangeDefaultKeyStore()) + .allSources(src -> src.markers(javaVersion(11))); } + + @DocumentExample @Test - void testKeyStore() { + void keyStore() { rewriteRun( //language=java java( From 91889d34e1dd172abc6feefbd478d7e6c93b18be Mon Sep 17 00:00:00 2001 From: anuram Date: Mon, 27 Jan 2025 15:32:47 -0500 Subject: [PATCH 5/6] small updates --- .../org/openrewrite/java/migrate/ChangeDefaultKeyStore.java | 1 + .../org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java index 028cd33c7..3b1f742c8 100644 --- a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java +++ b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java @@ -50,6 +50,7 @@ public String getDescription() { public TreeVisitor getVisitor() { return Preconditions.check(new UsesJavaVersion<>(11), new JavaVisitor() { + @Override public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { if (KEYSTORE_METHOD_REF.matches(method)) { return new J.Literal(randomId(), Space.EMPTY, Markers.EMPTY, "\"jks\"", "\"jks\"", null, JavaType.Primitive.String); diff --git a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java index a95029b46..4731c86b2 100644 --- a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java +++ b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java @@ -23,7 +23,7 @@ import static org.openrewrite.java.Assertions.java; import static org.openrewrite.java.Assertions.javaVersion; -public class ChangeDefaultKeyStoreTest implements RewriteTest { +class ChangeDefaultKeyStoreTest implements RewriteTest { @Override public void defaults(RecipeSpec spec) { spec.recipe(new ChangeDefaultKeyStore()) From ec5bffb9be77ee13984b4ee51fce094943edbda8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Merlin=20B=C3=B6gershausen?= Date: Tue, 4 Feb 2025 16:42:14 +0100 Subject: [PATCH 6/6] add no change tests and additional precondition for `java.security.KeyStore#getDefaultType()` --- .../java/migrate/ChangeDefaultKeyStore.java | 10 ++-- .../migrate/ChangeDefaultKeyStoreTest.java | 57 +++++++++++++++++++ 2 files changed, 63 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java index 3b1f742c8..561a37cbb 100644 --- a/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java +++ b/src/main/java/org/openrewrite/java/migrate/ChangeDefaultKeyStore.java @@ -23,6 +23,7 @@ import org.openrewrite.java.JavaVisitor; import org.openrewrite.java.MethodMatcher; import org.openrewrite.java.search.UsesJavaVersion; +import org.openrewrite.java.search.UsesMethod; import org.openrewrite.java.tree.J; import org.openrewrite.java.tree.JavaType; import org.openrewrite.java.tree.Space; @@ -41,14 +42,15 @@ public String getDisplayName() { @Override public String getDescription() { - return "In Java 11 the default keystore was updated from JKS to PKCS12." + - "As a result, applications relying on KeyStore.getDefaultType() may encounter issues after migrating, unless their JKS keystore has been converted to PKCS12." + - "This recipe returns default key store of `jks` when `KeyStore.getDefaultType()` method is called to use the pre Java 11 default keystore."; + return "In Java 11 the default keystore was updated from JKS to PKCS12." + "As a result, applications relying on KeyStore.getDefaultType() may encounter issues after migrating, unless their JKS keystore has been converted to PKCS12." + "This recipe returns default key store of `jks` when `KeyStore.getDefaultType()` method is called to use the pre Java 11 default keystore."; } @Override public TreeVisitor getVisitor() { - return Preconditions.check(new UsesJavaVersion<>(11), + return Preconditions.check( + Preconditions.and( + new UsesJavaVersion<>(11), + new UsesMethod<>("java.security.KeyStore getDefaultType()")), new JavaVisitor() { @Override public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { diff --git a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java index 4731c86b2..02f23514c 100644 --- a/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java +++ b/src/test/java/org/openrewrite/java/migrate/ChangeDefaultKeyStoreTest.java @@ -79,4 +79,61 @@ void bar() { ) ); } + + @Test + void keepString() { + rewriteRun( + //language=java + java( + """ + import java.io.FileInputStream; + import java.io.IOException; + import java.security.Key; + import java.security.KeyStore; + + class Foo { + void bar() { + try{ + KeyStore keystore = KeyStore.getInstance("jks"); + char[] password = "your_keystore_password".toCharArray(); + FileInputStream keystoreFile = new FileInputStream("path_to_your_keystore_file.jks"); + keystore.load(keystoreFile, password); + } + catch (Exception e) { + e.printStackTrace(); + } + } + } + """) + ); + } + + @Test + void keepStringForJava8() { + rewriteRun( + //language=java + java( + """ + import java.io.FileInputStream; + import java.io.IOException; + import java.security.Key; + import java.security.KeyStore; + + class Foo { + void bar() { + try{ + KeyStore keystore = KeyStore.getInstance(KeyStore.getDefaultType()); + char[] password = "your_keystore_password".toCharArray(); + FileInputStream keystoreFile = new FileInputStream("path_to_your_keystore_file.jks"); + keystore.load(keystoreFile, password); + } + catch (Exception e) { + e.printStackTrace(); + } + } + } + """, + spec -> spec.markers(javaVersion(8))) + ); + } }