Merge pull request #2800 from alphagov/PP-13647-update_aws_sdk_to_v2

SandorArpa · web-flow · commit 17303611dc6b · 2025-05-06T12:31:41.000+01:00
PP-13647 update AWS SDK to version 2
diff --git a/pom.xml b/pom.xml
@@ -37,9 +37,9 @@
                 <scope>import</scope>
             </dependency>
             <dependency>
-                <groupId>com.amazonaws</groupId>
-                <artifactId>aws-java-sdk-bom</artifactId>
-                <version>1.12.782</version>
+                <groupId>software.amazon.awssdk</groupId>
+                <artifactId>bom</artifactId>
+                <version>2.31.34</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
@@ -133,8 +133,8 @@
             <artifactId>commons-lang3</artifactId>
         </dependency>
         <dependency>
-            <groupId>com.amazonaws</groupId>
-            <artifactId>aws-java-sdk-sqs</artifactId>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>sqs</artifactId>
         </dependency>
         <dependency>
             <groupId>jakarta.xml.bind</groupId>
@@ -226,7 +226,7 @@
         </dependency>
         <dependency>
             <groupId>uk.gov.service.payments</groupId>
-            <artifactId>queue-dropwizard-4</artifactId>
+            <artifactId>queue-dropwizard-4-aws-sdk-v2</artifactId>
             <version>${pay-java-commons.version}</version>
         </dependency>
         <dependency>
diff --git a/src/main/java/uk/gov/pay/adminusers/app/config/AdminUsersModule.java b/src/main/java/uk/gov/pay/adminusers/app/config/AdminUsersModule.java
@@ -1,10 +1,5 @@
 package uk.gov.pay.adminusers.app.config;
 
-import com.amazonaws.auth.AWSStaticCredentialsProvider;
-import com.amazonaws.auth.BasicAWSCredentials;
-import com.amazonaws.client.builder.AwsClientBuilder;
-import com.amazonaws.services.sqs.AmazonSQS;
-import com.amazonaws.services.sqs.AmazonSQSClientBuilder;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provides;
@@ -15,6 +10,12 @@
 import com.warrenstrange.googleauth.GoogleAuthenticatorConfig;
 import io.dropwizard.core.setup.Environment;
 import io.dropwizard.db.DataSourceFactory;
+import jakarta.ws.rs.client.Client;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.sqs.SqsClient;
+import software.amazon.awssdk.services.sqs.SqsClientBuilder;
 import uk.gov.pay.adminusers.app.RestClientFactory;
 import uk.gov.pay.adminusers.resources.ResetPasswordValidator;
 import uk.gov.pay.adminusers.resources.UserRequestValidator;
@@ -34,7 +35,7 @@
 import uk.gov.pay.adminusers.validations.RequestValidations;
 import uk.gov.service.payments.commons.queue.sqs.SqsQueueService;
 
-import jakarta.ws.rs.client.Client;
+import java.net.URI;
 import java.time.InstantSource;
 import java.util.Properties;
 
@@ -122,33 +123,29 @@ public ObjectMapper provideObjectMapper() {
     }
 
     @Provides
-    public AmazonSQS sqsClient(AdminUsersConfig adminUsersConfig) {
-        AmazonSQSClientBuilder clientBuilder = AmazonSQSClientBuilder
-                .standard();
+    public SqsClient sqsClient(AdminUsersConfig adminUsersConfig) {
+        SqsClientBuilder clientBuilder = SqsClient.builder();
 
         if (adminUsersConfig.getSqsConfig().isNonStandardServiceEndpoint()) {
 
-            BasicAWSCredentials basicAWSCredentials = new BasicAWSCredentials(
-                    adminUsersConfig.getSqsConfig().getAccessKey(),
-                    adminUsersConfig.getSqsConfig().getSecretKey());
+            AwsBasicCredentials basicAWSCredentials = AwsBasicCredentials
+                    .create(adminUsersConfig.getSqsConfig().getAccessKey(),
+                            adminUsersConfig.getSqsConfig().getSecretKey());
 
             clientBuilder
-                    .withCredentials(new AWSStaticCredentialsProvider(basicAWSCredentials))
-                    .withEndpointConfiguration(
-                            new AwsClientBuilder.EndpointConfiguration(
-                                    adminUsersConfig.getSqsConfig().getEndpoint(),
-                                    adminUsersConfig.getSqsConfig().getRegion())
-                    );
+                    .credentialsProvider(StaticCredentialsProvider.create(basicAWSCredentials))
+                    .endpointOverride(URI.create(adminUsersConfig.getSqsConfig().getEndpoint()))
+                    .region(Region.of(adminUsersConfig.getSqsConfig().getRegion()));
         } else {
             // uses AWS SDK's DefaultAWSCredentialsProviderChain to obtain credentials
-            clientBuilder.withRegion(adminUsersConfig.getSqsConfig().getRegion());
+            clientBuilder.region(Region.of(adminUsersConfig.getSqsConfig().getRegion()));
         }
 
         return clientBuilder.build();
     }
 
     @Provides
-    public SqsQueueService provideSqsQueueService(AmazonSQS amazonSQS, AdminUsersConfig adminUsersConfig) {
+    public SqsQueueService provideSqsQueueService(SqsClient amazonSQS, AdminUsersConfig adminUsersConfig) {
         return new SqsQueueService(
                 amazonSQS,
                 adminUsersConfig.getSqsConfig().getMessageMaximumWaitTimeInSeconds(),
@@ -160,5 +157,4 @@ public SqsQueueService provideSqsQueueService(AmazonSQS amazonSQS, AdminUsersCon
     public Client provideClient() {
         return RestClientFactory.buildClient(configuration.getRestClientConfig());
     }
-
 }
diff --git a/src/test/java/uk/gov/pay/adminusers/fixtures/EventFixtureUtil.java b/src/test/java/uk/gov/pay/adminusers/fixtures/EventFixtureUtil.java
@@ -1,18 +1,20 @@
 package uk.gov.pay.adminusers.fixtures;
 
 import au.com.dius.pact.consumer.dsl.PactDslJsonBody;
-import com.amazonaws.services.sqs.AmazonSQS;
-import com.amazonaws.services.sqs.model.SendMessageResult;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import org.apache.commons.lang3.NotImplementedException;
+import software.amazon.awssdk.services.sqs.SqsClient;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
+import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
 import uk.gov.pay.adminusers.infra.SqsTestDocker;
+import uk.gov.service.payments.commons.queue.model.QueueMessage;
 
 import static org.apache.commons.lang3.StringUtils.isBlank;
 
 public class EventFixtureUtil {
 
-    public static String insert(AmazonSQS sqsClient, String eventType, String serviceId, Boolean live, String resourceExternalId,
+    public static String insert(SqsClient sqsClient, String eventType, String serviceId, Boolean live, String resourceExternalId,
                                 String parentResourceExternalId, String eventData) {
         String messageBody = String.format("{" +
                         "\"resource_external_id\": \"%s\"," +
@@ -30,8 +32,13 @@ public static String insert(AmazonSQS sqsClient, String eventType, String servic
                 eventData
         );
 
-        SendMessageResult result = sqsClient.sendMessage(SqsTestDocker.getQueueUrl("event-queue"), messageBody);
-        return result.getMessageId();
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(messageBody)
+                .build();
+        SendMessageResponse result = sqsClient.sendMessage(messageRequest);
+        
+        return QueueMessage.of(result, messageRequest.messageBody()).getMessageId();
     }
 
     public static PactDslJsonBody getAsPact(String serviceId, Boolean live, String eventType, String resourceExternalId,
diff --git a/src/test/java/uk/gov/pay/adminusers/infra/AppWithPostgresAndSqsRule.java b/src/test/java/uk/gov/pay/adminusers/infra/AppWithPostgresAndSqsRule.java
@@ -1,6 +1,5 @@
 package uk.gov.pay.adminusers.infra;
 
-import com.amazonaws.services.sqs.AmazonSQS;
 import com.google.inject.Guice;
 import com.google.inject.Injector;
 import com.google.inject.persist.PersistService;
@@ -20,6 +19,7 @@
 import org.junit.runners.model.Statement;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import software.amazon.awssdk.services.sqs.SqsClient;
 import uk.gov.pay.adminusers.app.AdminUsersApp;
 import uk.gov.pay.adminusers.app.config.AdminUsersConfig;
 import uk.gov.pay.adminusers.app.config.AdminUsersModule;
@@ -45,7 +45,7 @@ public class AppWithPostgresAndSqsRule implements TestRule {
 
     private final String configFilePath;
     private final PostgresDockerRule postgres;
-    private final AmazonSQS sqsClient;
+    private final SqsClient sqsClient;
     private final DropwizardAppRule<AdminUsersConfig> app;
     private final RuleChain rules;
     private final int wireMockPort = PortFactory.findFreePort();
@@ -115,7 +115,7 @@ public DatabaseTestHelper getDatabaseTestHelper() {
         return databaseTestHelper;
     }
 
-    public AmazonSQS getSqsClient() {
+    public SqsClient getSqsClient() {
         return sqsClient;
     }
 
diff --git a/src/test/java/uk/gov/pay/adminusers/infra/AppWithPostgresExtension.java b/src/test/java/uk/gov/pay/adminusers/infra/AppWithPostgresExtension.java
@@ -61,6 +61,7 @@ public AppWithPostgresExtension(String configPath, ConfigOverride... configOverr
                         config("database.user", postgres.getUsername()),
                         config("database.password", postgres.getPassword()),
                         config("sqs.connectorTasksQueueUrl", SqsTestDocker.getQueueUrl("event-queue")),
+                        config("sqs.endpoint", SqsTestDocker.getEndpoint()),
                         config("ledgerBaseURL", "http://localhost:" + wireMockPort))
                 .toArray(new ConfigOverride[0]);
 
diff --git a/src/test/java/uk/gov/pay/adminusers/infra/SqsTestDocker.java b/src/test/java/uk/gov/pay/adminusers/infra/SqsTestDocker.java
@@ -1,23 +1,24 @@
 package uk.gov.pay.adminusers.infra;
 
-import com.amazonaws.auth.AWSStaticCredentialsProvider;
-import com.amazonaws.auth.BasicAWSCredentials;
-import com.amazonaws.client.builder.AwsClientBuilder;
-import com.amazonaws.services.sqs.AmazonSQS;
-import com.amazonaws.services.sqs.AmazonSQSClientBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.wait.strategy.Wait;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.sqs.SqsClient;
+import software.amazon.awssdk.services.sqs.model.CreateQueueRequest;
 
+import java.net.URI;
 import java.util.List;
 
 public class SqsTestDocker {
     private static final Logger logger = LoggerFactory.getLogger(SqsTestDocker.class);
 
     private static GenericContainer sqsContainer;
 
-    public static AmazonSQS initialise(List<String> queueNames) {
+    public static SqsClient initialise(List<String> queueNames) {
         try {
             createContainer();
             return createQueues(queueNames);
@@ -38,9 +39,15 @@ private static void createContainer() {
         }
     }
 
-    private static AmazonSQS createQueues(List<String> queueNames) {
-        AmazonSQS amazonSQS = getSqsClient();
-        queueNames.forEach(amazonSQS::createQueue);
+    private static SqsClient createQueues(List<String> queueNames) {
+        SqsClient amazonSQS = getSqsClient();
+        queueNames.forEach(queueName -> {
+            CreateQueueRequest createQueueRequest = CreateQueueRequest.builder()
+                    .queueName(queueName)
+                    .build();
+
+            amazonSQS.createQueue(createQueueRequest);
+        });
 
         return amazonSQS;
     }
@@ -53,18 +60,13 @@ public static String getEndpoint() {
         return "http://localhost:" + sqsContainer.getMappedPort(9324);
     }
 
-    private static AmazonSQS getSqsClient() {
+    private static SqsClient getSqsClient() {
         // random credentials required by AWS SDK to build SQS client
-        BasicAWSCredentials awsCreds = new BasicAWSCredentials("x", "x");
-
-        return AmazonSQSClientBuilder.standard()
-                .withCredentials(new AWSStaticCredentialsProvider(awsCreds))
-                .withEndpointConfiguration(
-                        new AwsClientBuilder.EndpointConfiguration(
-                                getEndpoint(),
-                                "region-1"
-                        ))
-                .withRequestHandlers()
+        AwsBasicCredentials awsCreds = AwsBasicCredentials.create("x", "x");
+        return SqsClient.builder()
+                .credentialsProvider(StaticCredentialsProvider.create(awsCreds))
+                .endpointOverride(URI.create(getEndpoint()))
+                .region(Region.of("region-1"))
                 .build();
     }
 }
diff --git a/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeCreatedEventQueueConsumerIT.java b/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeCreatedEventQueueConsumerIT.java
@@ -13,6 +13,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.adminusers.client.ledger.model.LedgerTransaction;
 import uk.gov.pay.adminusers.fixtures.EventFixture;
 import uk.gov.pay.adminusers.fixtures.ServiceDbFixture;
@@ -137,7 +138,11 @@ public void setUp() throws Exception {
     public void test() throws Exception {
         String messageContents = new String(currentMessage);
         String snsMessage = new GsonBuilder().create().toJson(Map.of("Message", messageContents));
-        adminusersApp.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), snsMessage);
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(snsMessage)
+                .build();
+        adminusersApp.getSqsClient().sendMessage(messageRequest);
         await().atMost(2, TimeUnit.SECONDS).until(
                 () -> !wireMockRule.findAll(RequestPatternBuilder.newRequestPattern().withUrl("/v2/notifications/email")).isEmpty());
         
diff --git a/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeEvidenceSubmittedEventQueueConsumerIT.java b/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeEvidenceSubmittedEventQueueConsumerIT.java
@@ -13,6 +13,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.adminusers.client.ledger.model.LedgerTransaction;
 import uk.gov.pay.adminusers.fixtures.EventFixture;
 import uk.gov.pay.adminusers.fixtures.ServiceDbFixture;
@@ -132,7 +133,11 @@ public void setUp() throws Exception {
     public void test() throws Exception {
         String messageContents = new String(currentMessage);
         String snsMessage = new GsonBuilder().create().toJson(Map.of("Message", messageContents));
-        adminusersApp.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), snsMessage);
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(snsMessage)
+                .build();
+        adminusersApp.getSqsClient().sendMessage(messageRequest);
         await().atMost(2, TimeUnit.SECONDS).until(
                 () -> !wireMockRule.findAll(RequestPatternBuilder.newRequestPattern().withUrl("/v2/notifications/email")).isEmpty());
         
diff --git a/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeLostEventQueueConsumerIT.java b/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeLostEventQueueConsumerIT.java
@@ -13,6 +13,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.adminusers.client.ledger.model.LedgerTransaction;
 import uk.gov.pay.adminusers.fixtures.EventFixture;
 import uk.gov.pay.adminusers.fixtures.ServiceDbFixture;
@@ -132,7 +133,11 @@ public void setUp() throws Exception {
     public void test() throws Exception {
         String messageContents = new String(currentMessage);
         String snsMessage = new GsonBuilder().create().toJson(Map.of("Message", messageContents));
-        adminusersApp.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), snsMessage);
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(snsMessage)
+                .build();
+        adminusersApp.getSqsClient().sendMessage(messageRequest);
         await().atMost(2, TimeUnit.SECONDS).until(
                 () -> !wireMockRule.findAll(RequestPatternBuilder.newRequestPattern().withUrl("/v2/notifications/email")).isEmpty());
 
diff --git a/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeWonEventQueueConsumerIT.java b/src/test/java/uk/gov/pay/adminusers/pact/queuemessage/DisputeWonEventQueueConsumerIT.java
@@ -13,6 +13,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.adminusers.client.ledger.model.LedgerTransaction;
 import uk.gov.pay.adminusers.fixtures.EventFixture;
 import uk.gov.pay.adminusers.fixtures.ServiceDbFixture;
@@ -132,7 +133,11 @@ public void setUp() throws Exception {
     public void test() throws Exception {
         String messageContents = new String(currentMessage);
         String snsMessage = new GsonBuilder().create().toJson(Map.of("Message", messageContents));
-        adminusersApp.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), snsMessage);
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(snsMessage)
+                .build();
+        adminusersApp.getSqsClient().sendMessage(messageRequest);
         await().atMost(2, TimeUnit.SECONDS).until(
                 () -> !wireMockRule.findAll(RequestPatternBuilder.newRequestPattern().withUrl("/v2/notifications/email")).isEmpty());
         
diff --git a/src/test/java/uk/gov/pay/adminusers/queue/event/EventSubscriberQueueTest.java b/src/test/java/uk/gov/pay/adminusers/queue/event/EventSubscriberQueueTest.java
@@ -1,12 +1,12 @@
 package uk.gov.pay.adminusers.queue.event;
 
-import com.amazonaws.services.sqs.model.SendMessageResult;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
 import uk.gov.pay.adminusers.app.config.AdminUsersConfig;
 import uk.gov.pay.adminusers.app.config.EventSubscriberQueueConfig;
 import uk.gov.pay.adminusers.app.config.SqsConfig;
@@ -59,7 +59,7 @@ void setUp() {
     void shouldRetrieveEventsForCorrectlyFormattedJSON() throws Exception {
         String message = load(DISPUTE_CREATED_SNS_MESSAGE);
 
-        var sendMessageResult = mock(SendMessageResult.class);
+        var sendMessageResult = mock(SendMessageResponse.class);
         List<QueueMessage> messages = List.of(
                 QueueMessage.of(sendMessageResult, message)
         );
diff --git a/src/test/resources/config/test-it-config.yaml b/src/test/resources/config/test-it-config.yaml
@@ -111,7 +111,7 @@ secondFactorAuthentication:
 
 sqs:
   nonStandardServiceEndpoint: ${AWS_SQS_NON_STANDARD_SERVICE_ENDPOINT:-true}
-  endpoint: ${AWS_SQS_ENDPOINT:-localhost}
+  endpoint: ${AWS_SQS_ENDPOINT:-http://localhost}
   region: ${AWS_SQS_REGION:-region-1}
   secretKey: ${AWS_SECRET_KEY:-x}
   accessKey: ${AWS_ACCESS_KEY:-x}
