improvements + docker compose file

Author: AncaGhenade

.pre-commit-config.yaml

@@ -0,0 +1,4 @@
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+    - id: detect-aws-credentials

docker-compose.yml

@@ -0,0 +1,19 @@
+version: "3.9"
+
+services:
+  localstack:
+    image: localstack/localstack
+    container_name: localstack
+    ports:
+      - "4566:4566" # port of to where localstack can be addressed to
+      - "9000:9000"
+    environment:
+      - SERVICES=s3,dynamodb # a list of desired services you want to use.
+      - DEFAULT_REGION=eu-central-1 # where the localstack mocks to be running
+      - AWS_ACCESS_KEY_ID=test_access_key
+      - AWS_SECRET_ACCESS_KEY=test_secret_access_key
+      - DATA_DIR=/tmp/localstack/data
+      - PORT_WEB_UI=9000
+      - LAMBDA_EXECUTOR=local
+      - DOCKER_HOST=unix:///var/run/docker.sock
+      - START_WEB=1

scripts/new-bucket-local.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# Set the name of the S3 bucket
+bucket_name="shipment-list-demo-bucket"
+aws_region="eu-central-1"
+
+# Create the S3 bucket
+awslocal s3api create-bucket --bucket $bucket_name

new-bucket.sh renamed to scripts/new-bucket.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 
 # For demo purpose only;
-# Access key and secret key are set and using `aws configure` to manage the aws cli on your local machine
+# Access key and secret key are set and using `aws configure`
+# to manage the aws cli on your local machine
 
 # Set the name of the S3 bucket
 bucket_name="shipment-list-demo-bucket"
@@ -14,4 +15,4 @@ aws s3 mb s3://$bucket_name
 aws s3api create-bucket --bucket $bucket_name --region $aws_region
 
 # Set the bucket policy
-aws s3api put-bucket-acl --bucket $bucket_name --acl private
+aws s3api put-bucket-acl --bucket $bucket_name --acl private

src/main/java/dev/ancaghenade/shipmentlistdemo/config/AmazonS3Config.java

@@ -3,6 +3,7 @@
 import com.amazonaws.auth.AWSCredentials;
 import com.amazonaws.auth.AWSStaticCredentialsProvider;
 import com.amazonaws.auth.BasicAWSCredentials;
+import com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration;
 import com.amazonaws.services.s3.AmazonS3;
 import com.amazonaws.services.s3.AmazonS3ClientBuilder;
 import org.springframework.beans.factory.annotation.Value;
@@ -12,25 +13,30 @@
 @Configuration
 public class AmazonS3Config {
 
-  @Value("${aws.access.key}")
+  @Value("${aws.credentials.access-key}")
   private String awsAccessKey;
 
-  @Value("${aws.access.secret-key}")
+  @Value("${aws.credentials.secret-key}")
   private String awsSecretKey;
 
   @Value("${aws.region}")
   private String awsRegion;
 
+  @Value("${aws.s3.endpoint}")
+  private String awsS3EndPoint;
+
   @Bean
   public AmazonS3 s3() {
     AWSCredentials awsCredentials = new BasicAWSCredentials(
         awsAccessKey,
         awsSecretKey
     );
-    return AmazonS3ClientBuilder
+    AmazonS3ClientBuilder amazonS3ClientBuilder = AmazonS3ClientBuilder
         .standard()
-        .withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
-        .withRegion(awsRegion)
+        .withEndpointConfiguration(new EndpointConfiguration(awsS3EndPoint,
+            awsRegion));
+
+    return amazonS3ClientBuilder.withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
         .build();
   }
 

src/main/java/dev/ancaghenade/shipmentlistdemo/config/DynamoDBConfiguration.java

@@ -16,10 +16,10 @@
 @Configuration
 public class DynamoDBConfiguration {
 
-  @Value("${aws.access.key}")
+  @Value("${aws.credentials.access-key}")
   private String awsAccessKey;
 
-  @Value("${aws.access.secret-key}")
+  @Value("${aws.credentials.secret-key}")
   private String awsSecretKey;
 
   @Value("${aws.dynamodb.endpoint}")
@@ -48,8 +48,7 @@ AmazonDynamoDB buildAmazonDynamoDB() {
                 awsRegion
             )
         )
-        .withCredentials(
-            (awsAccessKey == null && awsSecretKey == null) ? null : amazonAWSCredentialsProvider())
+        .withCredentials(amazonAWSCredentialsProvider())
         .build();
   }
 

src/main/java/dev/ancaghenade/shipmentlistdemo/controller/ShipmentController.java

@@ -41,7 +41,7 @@ public void uploadShipmentImage(@PathVariable("shipmentId") String shipmentId,
 
 
   @GetMapping(
-      path = "{shipmentId}/image/download")
+      path = "{shipmentId}/image/download", produces = MediaType.IMAGE_JPEG_VALUE)
   public byte[] downloadShipmentImage(@PathVariable("shipmentId") String shipmentId) {
    return shipmentService.downloadShipmentImage(shipmentId);
   }

src/main/java/dev/ancaghenade/shipmentlistdemo/repository/S3StorageService.java

@@ -43,7 +43,7 @@ public byte[] download(String path, String key) {
     } catch (AmazonServiceException e) {
       throw new IllegalStateException("Failed to download file.", e);
     } catch (IOException e) {
-      throw new RuntimeException(e);
+      return new byte[0];
     }
   }
 }

src/main/java/dev/ancaghenade/shipmentlistdemo/service/ShipmentService.java

@@ -13,7 +13,6 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.UUID;
-import org.apache.http.entity.ContentType;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 import org.springframework.web.multipart.MultipartFile;
@@ -44,8 +43,6 @@ public void uploadShipmentImage(String shipmentId, MultipartFile file) {
 
     checkIfFileIsEmpty(file);
 
-    checkIfFileIsImage(file);
-
     Shipment shipment = getShipment(shipmentId);
 
     Map<String, String> metadata = getMetadata(file);
@@ -92,17 +89,6 @@ private Shipment getShipment(String shipmentId) {
             () -> new IllegalStateException(format("Shipment %s was not found.", shipmentId)));
   }
 
-  private void checkIfFileIsImage(MultipartFile file) {
-    if (!List.of(ContentType.IMAGE_JPEG.getMimeType(),
-            ContentType.IMAGE_PNG.getMimeType(),
-            ContentType.IMAGE_BMP.getMimeType(),
-            ContentType.IMAGE_GIF.getMimeType())
-        .contains(file.getContentType())) {
-      throw new IllegalStateException(
-          "File format not accepted.");
-    }
-  }
-
   private void checkIfFileIsEmpty(MultipartFile file) {
     if (file.isEmpty()) {
       throw new IllegalStateException(

src/main/resources/application-dev.yml

@@ -1,4 +1,12 @@
 server:
   port: 8081
 
-//  Localstack TODO + add Lambda
+aws:
+  credentials:
+    access-key: test_access_key
+    secret-key: test_secret_access_key
+  s3:
+    endpoint: https://s3.localhost.localstack.cloud:4566/
+  dynamodb:
+    endpoint: https://dynamodb.localhost.localstack.cloud:4566/
+  region: eu-central-1