Transforming S3 PUT override

migration-tool/src/main/java/software/amazon/awssdk/migration/internal/recipe/S3StreamingRequestToV2.java

@@ -0,0 +1,173 @@
+/*
+ * 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.internal.recipe;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+import org.openrewrite.ExecutionContext;
+import org.openrewrite.Recipe;
+import org.openrewrite.Tree;
+import org.openrewrite.TreeVisitor;
+import org.openrewrite.java.JavaIsoVisitor;
+import org.openrewrite.java.MethodMatcher;
+import org.openrewrite.java.tree.Expression;
+import org.openrewrite.java.tree.J;
+import org.openrewrite.java.tree.JContainer;
+import org.openrewrite.java.tree.JRightPadded;
+import org.openrewrite.java.tree.JavaType;
+import org.openrewrite.java.tree.Space;
+import org.openrewrite.java.tree.TypeUtils;
+import org.openrewrite.marker.Markers;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.migration.internal.utils.IdentifierUtils;
+
+@SdkInternalApi
+public class S3StreamingRequestToV2 extends Recipe {
+    private static final MethodMatcher PUT_OBJECT =
+        new MethodMatcher("com.amazonaws.services.s3.AmazonS3 "
+                          + "putObject(java.lang.String, java.lang.String, java.io.File)",
+                          true);
+    private static final JavaType.FullyQualified V1_PUT_OBJECT_REQUEST =
+        TypeUtils.asFullyQualified(JavaType.buildType("com.amazonaws.services.s3.model.PutObjectRequest"));
+    private static final JavaType.FullyQualified REQUEST_BODY =
+        TypeUtils.asFullyQualified(JavaType.buildType("software.amazon.awssdk.core.sync.RequestBody"));
+
+    @Override
+    public String getDisplayName() {
+        return "S3StreamingRequestToV2";
+    }
+
+    @Override
+    public String getDescription() {
+        return "S3StreamingRequestToV2.";
+    }
+
+    @Override
+    public TreeVisitor<?, ExecutionContext> getVisitor() {
+        return new Visitor();
+    }
+
+    private static final class Visitor extends JavaIsoVisitor<ExecutionContext> {
+        @Override
+        public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext executionContext) {
+            if (PUT_OBJECT.matches(method, false)) {
+                method = transformPutFileOverload(method);
+            }
+            return super.visitMethodInvocation(method, executionContext);
+        }
+
+        private J.MethodInvocation transformPutFileOverload(J.MethodInvocation method) {
+            JavaType.Method methodType = method.getMethodType();
+            if (methodType == null) {
+                return method;
+            }
+
+            List<Expression> originalArgs = method.getArguments();
+
+            Expression bucketExpr = originalArgs.get(0);
+            Expression keyExpr = originalArgs.get(1);
+            Expression fileExpr = originalArgs.get(2);
+
+            List<Expression> newArgs = new ArrayList<>();
+            Expression getObjectExpr = bucketAndKeyToPutObject(bucketExpr, keyExpr);
+            newArgs.add(getObjectExpr);
+
+            Space fileArgPrefix = fileExpr.getPrefix();
+            fileExpr = fileToRequestBody(fileExpr.withPrefix(Space.EMPTY)).withPrefix(fileArgPrefix);
+            newArgs.add(fileExpr);
+
+            List<String> paramNames = Arrays.asList("request", "file");
+            List<JavaType> paramTypes = newArgs.stream()
+                                               .map(Expression::getType)
+                                               .collect(Collectors.toList());
+
+
+            methodType = methodType.withParameterTypes(paramTypes)
+                                   .withParameterNames(paramNames);
+
+            return method.withMethodType(methodType).withArguments(newArgs);
+        }
+
+        private J.MethodInvocation fileToRequestBody(Expression fileExpr) {
+            maybeAddImport(REQUEST_BODY);
+
+            J.Identifier requestBodyId = IdentifierUtils.makeId(REQUEST_BODY.getClassName(), REQUEST_BODY);
+
+            JavaType.Method fromFileType = new JavaType.Method(
+                null,
+                0L,
+                REQUEST_BODY,
+                "fromFile",
+                REQUEST_BODY,
+                Collections.singletonList("file"),
+                Collections.singletonList(JavaType.buildType("java.io.File")),
+                null,
+                null
+            );
+
+            J.Identifier fromFileId = IdentifierUtils.makeId("fromFile", fromFileType);
+
+            return new J.MethodInvocation(
+                Tree.randomId(),
+                Space.EMPTY,
+                Markers.EMPTY,
+                JRightPadded.build(requestBodyId),
+                null,
+                fromFileId,
+                JContainer.build(Collections.singletonList(JRightPadded.build(fileExpr))),
+                fromFileType
+            );
+        }
+
+        private Expression bucketAndKeyToPutObject(Expression bucketExpr, Expression keyExpr) {
+            maybeAddImport(V1_PUT_OBJECT_REQUEST);
+
+            J.Identifier putObjRequestId = IdentifierUtils.makeId(V1_PUT_OBJECT_REQUEST.getClassName(), V1_PUT_OBJECT_REQUEST);
+
+            JavaType.Method ctorType = new JavaType.Method(
+                null,
+                0L,
+                V1_PUT_OBJECT_REQUEST,
+                "<init>",
+                V1_PUT_OBJECT_REQUEST,
+                Arrays.asList("bucket", "key"),
+                Arrays.asList(bucketExpr.getType(), keyExpr.getType()),
+                null,
+                null
+            );
+
+            return new J.NewClass(
+                Tree.randomId(),
+                Space.EMPTY,
+                Markers.EMPTY,
+                null,
+                Space.EMPTY,
+                putObjRequestId.withPrefix(Space.SINGLE_SPACE),
+                JContainer.build(
+                    Arrays.asList(
+                        JRightPadded.build(bucketExpr),
+                        JRightPadded.build(keyExpr)
+                    )
+                ),
+                null,
+                ctorType
+            );
+        }
+    }
+}

migration-tool/src/main/resources/META-INF/rewrite/java-sdk-v1-to-v2.yml

@@ -23,8 +23,10 @@ tags:
 recipeList:
   # TODO: update recipe naming to be consistent
   - software.amazon.awssdk.UpgradeSdkDependencies
-  - software.amazon.awssdk.S3GetObjectConstructorToFluent
   - software.amazon.awssdk.migration.internal.recipe.S3StreamingResponseToV2
+  - software.amazon.awssdk.migration.internal.recipe.S3StreamingRequestToV2
+  - software.amazon.awssdk.S3GetObjectConstructorToFluent
+  - software.amazon.awssdk.S3PutObjectConstructorToFluent
   - software.amazon.awssdk.migration.recipe.ChangeSdkType
   - software.amazon.awssdk.ChangeSdkCoreTypes
   # At this point, all classes should be changed to v2 equivalents

migration-tool/src/main/resources/META-INF/rewrite/s3-putbject-constructor-to-fluent.yml

@@ -0,0 +1,27 @@
+#
+# 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.
+#
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: software.amazon.awssdk.S3PutObjectConstructorToFluent
+displayName: Change PutObject constructors to fluent builder calls
+recipeList:
+  - software.amazon.awssdk.migration.internal.recipe.ConstructorToFluent:
+      clzzFqcn: com.amazonaws.services.s3.model.PutObjectRequest
+      parameterTypes:
+        - java.lang.String
+        - java.lang.String
+      fluentNames:
+        - withBucket
+        - withKey

migration-tool/src/test/java/software/amazon/awssdk/migration/internal/recipe/S3StreamingRequestToV2Test.java

@@ -0,0 +1,81 @@
+/*
+ * 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.internal.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 S3StreamingRequestToV2Test implements RewriteTest {
+    @Override
+    public void defaults(RecipeSpec spec) {
+        spec.recipe(new S3StreamingRequestToV2());
+        spec.parser(Java8Parser.builder().classpath(
+            "aws-java-sdk-s3",
+            "aws-java-sdk-core",
+            "s3",
+            "sdk-core",
+            "aws-core"));
+    }
+
+    @Test
+    @EnabledOnJre({JRE.JAVA_8})
+    public void testS3PutObjectOverrideRewrite() {
+        rewriteRun(
+            java(
+                "import com.amazonaws.services.s3.AmazonS3Client;\n"
+                + "\n"
+                + "import java.io.File;\n"
+                + "\n"
+                + "public class S3PutObjectExample {\n"
+                + "    private static final String BUCKET = \"my-bucket\";\n"
+                + "    private static final String KEY = \"key\";\n"
+                + "\n"
+                + "    public static void main(String[] args) {\n"
+                + "        AmazonS3Client s3 = null;\n"
+                + "\n"
+                + "        File myFile = new File(\"test.txt\");\n"
+                + "\n"
+                + "        s3.putObject(BUCKET, KEY, myFile);\n"
+                + "    }\n"
+                + "}\n",
+                "import com.amazonaws.services.s3.AmazonS3Client;\n"
+                + "import com.amazonaws.services.s3.model.PutObjectRequest;\n"
+                + "import software.amazon.awssdk.core.sync.RequestBody;\n"
+                + "\n"
+                + "import java.io.File;\n"
+                + "\n"
+                + "public class S3PutObjectExample {\n"
+                + "    private static final String BUCKET = \"my-bucket\";\n"
+                + "    private static final String KEY = \"key\";\n"
+                + "\n"
+                + "    public static void main(String[] args) {\n"
+                + "        AmazonS3Client s3 = null;\n"
+                + "\n"
+                + "        File myFile = new File(\"test.txt\");\n"
+                + "\n"
+                + "        s3.putObject(new PutObjectRequest(BUCKET, KEY), RequestBody.fromFile(myFile));\n"
+                + "    }\n"
+                + "}"
+            )
+        );
+    }
+}