chore : s3 버킷 생성 및 이미지 업르도, 삭제 기능 테스트 (#6)

Author: seoyeonson

.gitignore

@@ -77,4 +77,92 @@ docker-compose.yaml
 db/
 
 ### secret 프로필
-application-secret.yml
+application-secret.yml
+
+### Terraform ###
+# Terraform 상태 파일
+*.tfstate
+*.tfstate.*
+
+# Terraform 변수 파일
+*.tfvars
+*.tfvars.json
+
+# 로컬 Terraform 디렉토리
+**/.terraform/*
+
+# 충돌 로그 파일
+crash.log
+crash.*.log
+
+# Terraform 재정의 파일
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Terraform CLI 설정 파일
+.terraformrc
+terraform.rc
+
+#
+.terraform.lock.hcl
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

build.gradle.kts

@@ -40,12 +40,12 @@ dependencies {
 	compileOnly("org.projectlombok:lombok")
 	annotationProcessor("org.projectlombok:lombok")
 
-	//DB
+	// DB
 	runtimeOnly("com.h2database:h2")
 	runtimeOnly("com.mysql:mysql-connector-j")
 	implementation("org.springframework.boot:spring-boot-starter-data-jpa")
 
-	//redis
+	// redis
 	implementation("org.springframework.boot:spring-boot-starter-data-redis")
 	implementation("org.springframework.session:spring-session-data-redis")
 
@@ -68,6 +68,10 @@ dependencies {
 
 	// WebClient
 	implementation ("org.springframework.boot:spring-boot-starter-webflux")
+
+	// aws
+	implementation(platform("software.amazon.awssdk:bom:2.24.0"))
+	implementation("software.amazon.awssdk:s3")
 }
 
 tasks.withType<Test> {

ec2/main.tf

@@ -0,0 +1,282 @@
+terraform {
+  // aws 라이브러리 불러옴
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 4.0"
+    }
+  }
+}
+
+# AWS 설정 시작
+provider "aws" {
+  region = var.region
+}
+# AWS 설정 끝
+
+# VPC 설정 시작
+resource "aws_vpc" "vpc_1" {
+  cidr_block = "10.0.0.0/16"
+
+  # 무조건 켜세요.
+  enable_dns_support = true
+  # 무조건 켜세요.
+  enable_dns_hostnames = true
+
+  tags = {
+    Name = "${var.prefix}-vpc-1"
+  }
+}
+
+resource "aws_subnet" "subnet_1" {
+  vpc_id                  = aws_vpc.vpc_1.id
+  cidr_block              = "10.0.1.0/24"
+  availability_zone       = "${var.region}a"
+  map_public_ip_on_launch = true
+
+  tags = {
+    Name = "${var.prefix}-subnet-1"
+  }
+}
+
+resource "aws_subnet" "subnet_2" {
+  vpc_id                  = aws_vpc.vpc_1.id
+  cidr_block              = "10.0.2.0/24"
+  availability_zone       = "${var.region}b"
+  map_public_ip_on_launch = true
+
+  tags = {
+    Name = "${var.prefix}-subnet-2"
+  }
+}
+
+resource "aws_subnet" "subnet_3" {
+  vpc_id                  = aws_vpc.vpc_1.id
+  cidr_block              = "10.0.3.0/24"
+  availability_zone       = "${var.region}c"
+  map_public_ip_on_launch = true
+
+  tags = {
+    Name = "${var.prefix}-subnet-3"
+  }
+}
+
+resource "aws_internet_gateway" "igw_1" {
+  vpc_id = aws_vpc.vpc_1.id
+
+  tags = {
+    Name = "${var.prefix}-igw-1"
+  }
+}
+
+resource "aws_route_table" "rt_1" {
+  vpc_id = aws_vpc.vpc_1.id
+
+  route {
+    cidr_block = "0.0.0.0/0"
+    gateway_id = aws_internet_gateway.igw_1.id
+  }
+
+  tags = {
+    Name = "${var.prefix}-rt-1"
+  }
+}
+
+resource "aws_route_table_association" "association_1" {
+  subnet_id      = aws_subnet.subnet_1.id
+  route_table_id = aws_route_table.rt_1.id
+}
+
+resource "aws_route_table_association" "association_2" {
+  subnet_id      = aws_subnet.subnet_2.id
+  route_table_id = aws_route_table.rt_1.id
+}
+
+resource "aws_route_table_association" "association_3" {
+  subnet_id      = aws_subnet.subnet_3.id
+  route_table_id = aws_route_table.rt_1.id
+}
+
+resource "aws_security_group" "sg_1" {
+  name = "${var.prefix}-sg-1"
+
+  ingress {
+    from_port   = 0
+    to_port     = 0
+    protocol    = "all"
+    cidr_blocks = ["0.0.0.0/0"]
+  }
+
+  egress {
+    from_port   = 0
+    to_port     = 0
+    protocol    = "all"
+    cidr_blocks = ["0.0.0.0/0"]
+  }
+
+  vpc_id = aws_vpc.vpc_1.id
+
+  tags = {
+    Name = "${var.prefix}-sg-1"
+  }
+}
+
+# EC2 설정 시작
+
+# EC2 역할 생성
+resource "aws_iam_role" "ec2_role_1" {
+  name = "${var.prefix}-ec2-role-1"
+
+  # 이 역할에 대한 신뢰 정책 설정. EC2 서비스가 이 역할을 가정할 수 있도록 설정
+  assume_role_policy = <<EOF
+  {
+    "Version": "2012-10-17",
+    "Statement": [
+      {
+        "Sid": "",
+        "Action": "sts:AssumeRole",
+        "Principal": {
+            "Service": "ec2.amazonaws.com"
+        },
+        "Effect": "Allow"
+      }
+    ]
+  }
+  EOF
+}
+
+# EC2 역할에 AmazonS3FullAccess 정책을 부착
+resource "aws_iam_role_policy_attachment" "s3_full_access" {
+  role       = aws_iam_role.ec2_role_1.name
+  policy_arn = "arn:aws:iam::aws:policy/AmazonS3FullAccess"
+}
+
+# EC2 역할에 AmazonEC2RoleforSSM 정책을 부착
+resource "aws_iam_role_policy_attachment" "ec2_ssm" {
+  role       = aws_iam_role.ec2_role_1.name
+  policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonEC2RoleforSSM"
+}
+
+# IAM 인스턴스 프로파일 생성
+resource "aws_iam_instance_profile" "instance_profile_1" {
+  name = "${var.prefix}-instance-profile-1"
+  role = aws_iam_role.ec2_role_1.name
+}
+
+locals {
+  ec2_user_data_base = <<-END_OF_FILE
+#!/bin/bash
+yum install socat -y
+yum install python -y
+
+yum install docker -y
+systemctl enable docker
+systemctl start docker
+
+curl -L https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose
+chmod +x /usr/local/bin/docker-compose
+
+exec 1> >(tee -a "/var/log/user-data.log") 2>&1
+
+
+# cmf 디렉터리 생성
+mkdir -p /dockerProjects/cmf
+cd /dockerProjects/cmf
+
+# docker-compose.yml 생성
+echo "[INFO] Creating docker-compose.yml..."
+cat << 'DOCKEREOF' > docker-compose.yml
+services:
+  mysql:
+    image: mysql:9.2.0
+    container_name: mysql-cmf
+    environment:
+      MYSQL_ROOT_PASSWORD: ${var.mysql_root_password}
+      MYSQL_DATABASE: ${var.mysql_database_name}
+    ports:
+      - "3306:3306"
+    volumes:
+      - ./db/:/var/lib/mysql
+
+  redis:
+    image: redis:latest
+    container_name: redis_1
+    restart: unless-stopped
+    ports:
+      - "6379:6379"
+    environment:
+      - TZ=Asia/Seoul
+    command: ["redis-server", "--requirepass", "${var.redis_password}"]  # 비밀번호 강제 설정
+
+  npm:
+    image: jc21/nginx-proxy-manager:latest
+    container_name: npm_1
+    restart: unless-stopped
+    ports:
+      - "80:80"
+      - "443:443"
+      - "81:81"
+    environment:
+      - TZ=Asia/Seoul
+    volumes:
+      - /dockerProjects/npm_1/volumes/data:/data
+      - /dockerProjects/npm_1/volumes/etc/letsencrypt:/etc/letsencrypt
+DOCKEREOF
+
+# 권한 설정 (소유권을 현재 사용자로 변경)
+chown -R $(whoami):$(whoami) /dockerProjects/cmf
+
+# docker-compose 실행
+echo "[INFO] Starting CMF stack..."
+docker-compose up -d
+
+# 컨테이너 상태 확인
+docker ps
+docker-compose logs
+
+echo "[INFO] Installation completed!"
+
+yum install git -y
+
+sudo dd if=/dev/zero of=/swapfile bs=128M count=32
+sudo chmod 600 /swapfile
+sudo mkswap /swapfile
+sudo swapon /swapfile
+sudo swapon -s
+sudo sh -c 'echo "/swapfile swap swap defaults 0 0" >> /etc/fstab'
+
+END_OF_FILE
+}
+
+# EC2 인스턴스 생성
+resource "aws_instance" "ec2_1" {
+  # 사용할 AMI ID
+  ami = "ami-04c596dcf23eb98d8"
+  # EC2 인스턴스 유형
+  instance_type = "t2.micro"
+  # 사용할 서브넷 ID
+  subnet_id = aws_subnet.subnet_1.id
+  # 적용할 보안 그룹 ID
+  vpc_security_group_ids = [aws_security_group.sg_1.id]
+  # 퍼블릭 IP 연결 설정
+  associate_public_ip_address = true
+
+  # 인스턴스에 IAM 역할 연결
+  iam_instance_profile = aws_iam_instance_profile.instance_profile_1.name
+
+  # 인스턴스에 태그 설정
+  tags = {
+    Name = "${var.prefix}-ec2-1"
+  }
+
+  # 루트 볼륨 설정
+  root_block_device {
+    volume_type = "gp3"
+    volume_size = 30  # 볼륨 크기를 30GB로 설정
+  }
+
+  # User data script for ec2_1
+  user_data = <<-EOF
+${local.ec2_user_data_base}
+EOF
+}

ec2/variables.tf

@@ -0,0 +1,31 @@
+variable "prefix" {
+  description = "Prefix for all resources"
+  default     = "cmf"
+}
+
+variable "region" {
+  description = "region"
+  default     = "ap-northeast-2"
+}
+
+variable "nickname" {
+  description = "nickname"
+  default     = "dev-seoyeon"
+}
+
+variable "mysql_root_password" {
+  description = "MySQL root password"
+  type        = string
+  sensitive   = true
+}
+
+variable "mysql_database_name" {
+  description = "MySQL database name"
+  type        = string
+}
+
+variable "redis_password" {
+  description = "Redis password"
+  type        = string
+  sensitive   = true
+}

src/main/java/cmf/commitField/domain/admin/controller/ApiV1PetImgController.java

@@ -0,0 +1,65 @@
+package cmf.commitField.domain.admin.controller;
+
+import cmf.commitField.global.aws.s3.S3Service;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.multipart.MultipartFile;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.Bucket;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.stream.Collectors;
+
+@RestController
+@RequestMapping("/api/v1/admin/pet")
+@RequiredArgsConstructor
+public class ApiV1PetImgController {
+    private final S3Client s3Client;
+    private final S3Service s3Service;
+
+    @GetMapping("/test")
+    public List<String> home() {
+        List<Bucket> bucketList = s3Client.listBuckets().buckets();
+        return bucketList.stream().map(Bucket::name).collect(Collectors.toList());
+    }
+
+    @GetMapping("/upload")
+    public String upload() {
+        return """
+                <form action="/api/v1/upload" method="post" enctype="multipart/form-data">
+                    <input type="file" name="file" accept="image/*">
+                    <input type="submit" value="Upload">
+                </form>
+                """;
+    }
+
+    @PostMapping("/upload")
+    @ResponseBody
+    public String handleFileUpload(@RequestParam("file") MultipartFile file) throws IOException {
+        String img = s3Service.uploadFile(file,"pet");
+
+        return """
+                <img src="%s">
+                <hr>
+                <div>업로드 완료</div>
+                """.formatted(img);
+    }
+
+    @GetMapping("/deleteFile")
+    public String showDeleteFile() {
+        return """
+                <form action="/api/v1/deleteFile" method="post">
+                    <input type="text" name="fileName">
+                    <input type="submit" value="delete">
+                </form>
+                """;
+    }
+
+    @PostMapping("/deleteFile")
+    @ResponseBody
+    public String deleteFile(String fileName) {
+        s3Service.deleteFile(fileName);
+        return "파일이 삭제되었습니다.";
+    }
+}

src/main/java/cmf/commitField/global/aws/s3/S3Cleaner.java

@@ -0,0 +1,37 @@
+package cmf.commitField.global.aws.s3;
+
+import jakarta.annotation.PreDestroy;
+import org.springframework.stereotype.Component;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
+import software.amazon.awssdk.services.s3.model.ListObjectsV2Response;
+import software.amazon.awssdk.services.s3.model.S3Object;
+
+@Component
+public class S3Cleaner {
+
+    private final S3Client s3Client;
+    private final String bucketName = "cmf-bucket-dev-seoyeon-1"; // S3 버킷 이름
+
+    public S3Cleaner(S3Client s3Client) {
+        this.s3Client = s3Client;
+    }
+
+    @PreDestroy
+    public void cleanup() {
+        // S3에서 테스트 파일 삭제
+        ListObjectsV2Request listObjects = ListObjectsV2Request.builder()
+                .bucket(bucketName)
+                .build();
+
+        // 파일 목록을 가져옵니다.
+        ListObjectsV2Response listObjectsResponse = s3Client.listObjectsV2(listObjects);
+
+        // 각 파일을 삭제합니다.
+        for (S3Object s3Object : listObjectsResponse.contents()) {
+            s3Client.deleteObject(builder -> builder.bucket(bucketName).key(s3Object.key()));
+        }
+
+        System.out.println("S3에 있는 테스트 파일들을 삭제했습니다.");
+    }
+}

src/main/java/cmf/commitField/global/aws/s3/S3Config.java

@@ -0,0 +1,16 @@
+package cmf.commitField.global.aws.s3;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.s3.S3Client;
+
+@Configuration
+public class S3Config {
+    @Bean
+    public S3Client s3Client() {
+        return S3Client.builder()
+                .region(Region.AP_NORTHEAST_2)
+                .build();
+    }
+}

src/main/java/cmf/commitField/global/aws/s3/S3Service.java

@@ -0,0 +1,45 @@
+package cmf.commitField.global.aws.s3;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+import software.amazon.awssdk.core.sync.RequestBody;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
+import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+
+import java.io.IOException;
+import java.util.UUID;
+
+@Service
+@RequiredArgsConstructor
+public class S3Service {
+    private final S3Client s3Client;
+    private static final String BUCKET_NAME = "cmf-bucket-dev-seoyeon-1";
+    private static final String REGION = "ap-northeast-2";
+
+    // 파일 업로드 기능
+    public String uploadFile(MultipartFile file, String dirName) throws IOException {
+        String fileName = dirName + "/" + UUID.randomUUID() + "_" + file.getOriginalFilename();
+        PutObjectRequest putObjectRequest = PutObjectRequest.builder()
+                .bucket(BUCKET_NAME)
+                .key(fileName)
+                .contentType(file.getContentType())
+                .build();
+
+        s3Client.putObject(putObjectRequest,
+                RequestBody.fromInputStream(file.getInputStream(), file.getSize()));
+
+        return "https://" + BUCKET_NAME + ".s3." + REGION + ".amazonaws.com/" + fileName;
+    }
+
+    // 파일 삭제 기능
+    public void deleteFile(String fileName) {
+        DeleteObjectRequest deleteObjectRequest = DeleteObjectRequest.builder()
+                .bucket(BUCKET_NAME)
+                .key(fileName)
+                .build();
+
+        s3Client.deleteObject(deleteObjectRequest);
+    }
+}