-
Notifications
You must be signed in to change notification settings - Fork 915
Add recipe to change SDK generated types. #5053
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
474 changes: 474 additions & 0 deletions
474
migration-tool/src/main/java/software/amazon/awssdk/migration/recipe/ChangeSdkType.java
Large diffs are not rendered by default.
Oops, something went wrong.
66 changes: 66 additions & 0 deletions
66
...ol/src/main/java/software/amazon/awssdk/migration/recipe/utils/NamingConversionUtils.java
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 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.migration.recipe.utils; | ||
|
|
||
| import java.util.stream.Stream; | ||
| import software.amazon.awssdk.annotations.SdkInternalApi; | ||
| import software.amazon.awssdk.utils.internal.CodegenNamingUtils; | ||
|
|
||
| @SdkInternalApi | ||
| public final class NamingConversionUtils { | ||
|
|
||
| private static final String V1_PACKAGE_PREFIX = "com.amazonaws.services"; | ||
| private static final String V2_PACKAGE_PREFIX = "software.amazon.awssdk.services"; | ||
|
|
||
| private NamingConversionUtils() { | ||
| } | ||
|
|
||
| public static String getV2Equivalent(String currentFqcn) { | ||
| int lastIndexOfDot = currentFqcn.lastIndexOf("."); | ||
| String v1ClassName = currentFqcn.substring(lastIndexOfDot + 1, currentFqcn.length()); | ||
| String packagePrefix = currentFqcn.substring(0, lastIndexOfDot); | ||
|
|
||
| String v2ClassName; | ||
| String v2PackagePrefix = packagePrefix.replace(V1_PACKAGE_PREFIX, V2_PACKAGE_PREFIX); | ||
|
|
||
| if (Stream.of("Abstract", "Amazon", "AWS").anyMatch(v1ClassName::startsWith)) { | ||
| v2ClassName = getV2ClientEquivalent(v1ClassName); | ||
| } else { | ||
| v2ClassName = v1ClassName.replace("Result", "Response"); | ||
| } | ||
|
|
||
| return v2PackagePrefix + "." + v2ClassName; | ||
| } | ||
|
|
||
| private static String getV2ClientEquivalent(String className) { | ||
| if (className.startsWith("Abstract") ) { | ||
| className = className.substring(8); | ||
| } | ||
| if (className.startsWith("Amazon") ) { | ||
| className = className.substring(6); | ||
| } else if (className.startsWith("AWS")) { | ||
| className = className.substring(3); | ||
| } | ||
|
|
||
| String v2Style = CodegenNamingUtils.pascalCase(className); | ||
|
|
||
| if (!className.endsWith("Client") && !className.endsWith("Builder")) { | ||
| v2Style = v2Style + "Client"; | ||
| } | ||
|
|
||
| return v2Style; | ||
| } | ||
| } |
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
26 changes: 0 additions & 26 deletions
26
migration-tool/src/main/resources/META-INF/rewrite/update-sdk-type.yml
This file was deleted.
Oops, something went wrong.
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
182 changes: 182 additions & 0 deletions
182
migration-tool/src/test/java/software/amazon/awssdk/migration/recipe/ChangeSdkTypeTest.java
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,182 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.migration.recipe; | ||
|
|
||
| import static org.openrewrite.java.Assertions.java; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.condition.EnabledOnJre; | ||
| import org.junit.jupiter.api.condition.JRE; | ||
| import org.openrewrite.java.Java8Parser; | ||
| import org.openrewrite.test.RecipeSpec; | ||
| import org.openrewrite.test.RewriteTest; | ||
|
|
||
| public class ChangeSdkTypeTest implements RewriteTest { | ||
|
|
||
| @Override | ||
| public void defaults(RecipeSpec spec) { | ||
| spec.recipe(new ChangeSdkType()); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledOnJre({JRE.JAVA_8}) | ||
| void shouldChangeVariables() { | ||
| rewriteRun( | ||
| spec -> spec.parser(Java8Parser.builder().classpath("aws-java-sdk-sqs")), | ||
| java( | ||
| "import com.amazonaws.services.sqs.AmazonSQS;\n" + | ||
| "import com.amazonaws.services.sqs.AmazonSQSClient;\n" + | ||
| "import com.amazonaws.services.sqs.model.ListQueuesResult;\n" + | ||
| "import com.amazonaws.services.sqs.model.ListQueuesRequest;\n" + | ||
| "class Test {\n" + | ||
| " static void method() {\n" + | ||
| " AmazonSQS sqs = null;\n" + | ||
| " ListQueuesRequest request = null;\n" + | ||
| " ListQueuesResult result = null;\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "import software.amazon.awssdk.services.sqs.SqsClient;\n" + | ||
| "import software.amazon.awssdk.services.sqs.model.ListQueuesRequest;\n" + | ||
| // TODO: duplicate import for some reason, fix this | ||
| "import software.amazon.awssdk.services.sqs.SqsClient;\n" + | ||
| "import software.amazon.awssdk.services.sqs.model.ListQueuesResponse;\n" + | ||
| "\n" + | ||
| "class Test {\n" + | ||
| " static void method() {\n" + | ||
| " SqsClient sqs = null;\n" + | ||
| " ListQueuesRequest request = null;\n" + | ||
| " ListQueuesResponse result = null;\n" + | ||
| " }\n" + | ||
| "}\n" | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledOnJre({JRE.JAVA_8}) | ||
| void shouldChangeFields() { | ||
| rewriteRun( | ||
| spec -> spec.parser(Java8Parser.builder().classpath("aws-java-sdk-sqs")), | ||
| java( | ||
| "import com.amazonaws.services.sqs.model.DeleteQueueRequest;\n" + | ||
| "import com.amazonaws.services.sqs.model.DeleteQueueResult;\n" + | ||
| "class Test {\n" + | ||
| " private DeleteQueueRequest deleteQueueRequest;\n" + | ||
| " private static DeleteQueueResult resultField;\n" + | ||
| "}\n", | ||
| "import software.amazon.awssdk.services.sqs.model.DeleteQueueRequest;\n" + | ||
| "import software.amazon.awssdk.services.sqs.model.DeleteQueueResponse;\n" + | ||
| "\n" + | ||
| "class Test {\n" + | ||
| " private DeleteQueueRequest deleteQueueRequest;\n" + | ||
| " private static DeleteQueueResponse resultField;\n" + | ||
| "}\n" | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledOnJre({JRE.JAVA_8}) | ||
| void shouldChangeFieldsInAList() { | ||
| rewriteRun( | ||
| spec -> spec.parser(Java8Parser.builder().classpath("aws-java-sdk-sqs")), | ||
| java( | ||
| "import com.amazonaws.services.sqs.model.DeleteQueueResult;\n" + | ||
| "import java.util.List;\n" + | ||
| "class Test {\n" + | ||
| " private List<DeleteQueueResult> results;\n" + | ||
| "}\n", | ||
| "import software.amazon.awssdk.services.sqs.model.DeleteQueueResponse;\n\n" + | ||
| "import java.util.List;\n" + | ||
| "\n" + | ||
| "class Test {\n" + | ||
| " private List<DeleteQueueResponse> results;\n" + | ||
| "}\n" | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledOnJre({JRE.JAVA_8}) | ||
| void shouldChangeMethodParameters() { | ||
| rewriteRun( | ||
| spec -> spec.parser(Java8Parser.builder().classpath("aws-java-sdk-sqs")), | ||
| java( | ||
| "import com.amazonaws.services.sqs.model.CreateQueueRequest;\n" + | ||
| "class Test {\n" + | ||
| " static void method(CreateQueueRequest request) {\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "import software.amazon.awssdk.services.sqs.model.CreateQueueRequest;\n" + | ||
| "\n" + | ||
| "class Test {\n" + | ||
| " static void method(CreateQueueRequest request) {\n" + | ||
| " }\n" + | ||
| "}\n" | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledOnJre({JRE.JAVA_8}) | ||
| void shouldNotChangeExistingV2Types() { | ||
| rewriteRun( | ||
| spec -> spec.parser(Java8Parser.builder().classpath("aws-java-sdk-sqs", "sqs")), | ||
| java( | ||
| "import com.amazonaws.services.sqs.model.CreateQueueRequest;\n" + | ||
| "import software.amazon.awssdk.services.sqs.model.DeleteQueueRequest;\n" + | ||
| "class Test {\n" + | ||
| " private CreateQueueRequest createQueue;\n" + | ||
| " private DeleteQueueRequest deleteQueue;\n" + | ||
| " static void method() {\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "import software.amazon.awssdk.services.sqs.model.CreateQueueRequest;\n" + | ||
| "import software.amazon.awssdk.services.sqs.model.DeleteQueueRequest;\n" + | ||
| "\n" + | ||
| "class Test {\n" + | ||
| " private CreateQueueRequest createQueue;\n" + | ||
| " private DeleteQueueRequest deleteQueue;\n" + | ||
| " static void method() {\n" + | ||
| " }\n" + | ||
| "}\n" | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| @EnabledOnJre({JRE.JAVA_8}) | ||
| void shouldChangeFieldsInInnerClass() { | ||
| rewriteRun( | ||
| spec -> spec.parser(Java8Parser.builder().classpath("aws-java-sdk-sqs")), | ||
| java( | ||
| "import com.amazonaws.services.sqs.model.CreateQueueResult;\n" + | ||
| "class Test {\n" + | ||
| " public class Inner{\n" + | ||
| " private CreateQueueResult createQueue;\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "import software.amazon.awssdk.services.sqs.model.CreateQueueResponse;\n" + | ||
| "\n" + | ||
| "class Test {\n" + | ||
| " public class Inner{\n" + | ||
| " private CreateQueueResponse createQueue;\n" + | ||
| " }\n" + | ||
| "}\n" | ||
| ) | ||
| ); | ||
| } | ||
| } |
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
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.