🔀 :: [#734] - 애플리케ㅣ션 배포시 초기화 스크립트 적용

[dolong2]

개요

• 애플리케이션 배포시에 초기화 스크립트를 수행하는 로직을 추가합니다.

작업내용

• 초기화 스크립트 도커파일 내용을 생성하는 메서드 추가
• 도커파일 생성을 하나의 메서드에서 처리하도록 수정
• 도커파일 생성 서비스에서 when 분기대신 getApplicationDockerFileContent 메서드를 사용하도록 수정
• 도커파일 생성 서비스에 초기화 스크립트 관련 테스트 케이스 추가

체크리스트

탬플릿외에 필요한 항목이 있으면 추가해주세요.

• 로컬에서 빌드가 성공하나요?
• 추가(수정)한 코드가 정상적으로 동작하나요?
• pr 타켓 브랜치가 맞게 설정되어 있나요?
• pr에서 작업할 내용만 작업됐나요?
• 기존 API와 호환되지 않는 사항이 있나요?

Summary by CodeRabbit

릴리스 노트

• 새로운 기능

  • Docker 파일 생성 시 여러 초기 스크립트(RUN 명령) 추가 실행 지원

• 리팩토링

  • 애플리케이션 유형별 Dockerfile 생성 로직을 통합해 호출 방식 단순화

• 테스트

  • 초기 스크립트 흐름을 반영하도록 단위 테스트 및 목 설정 업데이트

[coderabbitai]

Walkthrough

애플리케이션 타입별 Dockerfile 생성 로직을 통합 API로 리팩토링하고, 초기 스크립트(initialScripts)를 조회·삽입하도록 서비스와 테스트를 변경함.

Changes

코호트 / 파일(s)	변경 요약
FileContent 리팩토링 src/main/kotlin/com/dcd/server/core/common/file/FileContent.kt	getApplicationDockerFileContent(applicationType, version, port, env, initialScripts) 공용 API 추가. 기존 타입별 퍼블릭 빌더들을 private으로 전환하고 initialScripts 매개변수 추가. 초기 스크립트 RUN 행 생성을 위한 getInitialScriptsString 헬퍼 추가 및 env 통합 유지.
서비스 레이어 업데이트 src/main/kotlin/com/dcd/server/core/domain/application/service/impl/CreateDockerFileServiceImpl.kt	QueryApplicationInitialScriptPort 의존성 추가 및 생성자 인자에 주입. findAllByApplication으로 초기 스크립트를 조회하여 FileContent.getApplicationDockerFileContent(..., initialScripts) 호출로 Dockerfile 생성 흐름 통합.
테스트 업데이트 src/test/kotlin/com/dcd/server/core/domain/application/service/CreateDockerFileServiceImplTest.kt	QueryApplicationInitialScriptPort 목 추가 및 주입. 모든 시나리오에서 findAllByApplication(application)을 빈 리스트로 모킹. 기대값 검증을 통합 API(getApplicationDockerFileContent) 호출로 변경.

Sequence Diagram(s)

sequenceDiagram
    participant Client as 요청자
    participant Service as CreateDockerFileServiceImpl
    participant QueryInit as QueryApplicationInitialScriptPort
    participant FileContent as FileContent
    participant FS as 파일시스템

    Client->>Service: Dockerfile 생성 요청 (application)
    Service->>QueryInit: findAllByApplication(application)
    QueryInit-->>Service: initialScripts : List<String>
    Service->>FileContent: getApplicationDockerFileContent(type, version, port, env, initialScripts)
    FileContent-->>Service: Dockerfile 내용 (String)
    Service->>FS: Dockerfile 쓰기
    FS-->>Service: 완료 응답

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• 추가로 주의할 파일/영역:
  • FileContent.kt의 초기 스크립트 RUN 라인 생성 및 env 병합 로직
  • CreateDockerFileServiceImpl의 생성자 서명 변경과 의존성 주입 위치
  • 테스트에서 모킹된 초기 스크립트가 실제 생성 결과에 반영되는지 검증

Possibly related issues

• 애플리케이션 배포시 초기화 스크립트 적용 #734 — 초기 스크립트 기반 Dockerfile 변경을 도입하는 이슈와 기능 목적이 일치함 (초기 스크립트 조회·삽입).

Possibly related PRs

• 🔀 :: [#731] - 초기화 스크립트 엔티티 추가 #733 — 초기 스크립트 도메인/포트/지속성 추가 PR과 기능 연계성이 높음.
• 🔀 :: [#498] - Spring 애플리케이션 배포 방식 수정 #499 — FileContent와 CreateDockerFileServiceImpl 관련 빌더/호출 방식 변경을 이미 다루며 연관성이 큼.
• 🔀 :: [#732] - 애플리케이션 생성및 수정시 초기화 스크립트 스펙 추가 #735 — 초기 스크립트 기능을 서비스 흐름에 통합한 다른 PR과 코드 수준 목적이 유사함.

Suggested labels

:\u2692: Refactor

시

🐰 새벽 토끼가 말하네,
Dockerfile에 스크립트 한 줌 넣고,
타입 가리지 않고 통합했네,
깔끔히 쌓인 RUN 줄들에,
빌드 준비 끝! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	제목이 PR의 주요 변경사항(초기화 스크립트 적용)을 명확하게 설명하고 있으며, 이슈 번호도 포함되어 있습니다.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/apply-initial-script-to-deploy

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e2680d and 29bd8e2.

📒 Files selected for processing (1)

• src/main/kotlin/com/dcd/server/core/common/file/FileContent.kt (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: dolong2
Repo: dolong2/dcd PR: 703
File: src/main/kotlin/com/dcd/server/core/domain/volume/model/Volume.kt:1-12
Timestamp: 2025-09-01T14:52:42.625Z
Learning: dolong2 prefers to implement validation logic (such as path validation for Volume.physicalPath) in the business logic layer rather than in domain model init blocks, keeping domain models as simple data containers.

Learnt from: dolong2
Repo: dolong2/dcd PR: 703
File: src/test/resources/data.sql:28-30
Timestamp: 2025-09-01T14:57:07.656Z
Learning: dolong2 prefers to implement deletion validation in business logic rather than using database CASCADE constraints. For volume deletion, they want to validate if any mounts exist before allowing deletion, preventing accidental data loss while maintaining explicit control over the deletion process.

Learnt from: dolong2
Repo: dolong2/dcd PR: 655
File: src/main/kotlin/com/dcd/server/persistence/workspace/entity/WorkspaceJpaEntity.kt:12-14
Timestamp: 2025-07-12T14:05:23.333Z
Learning: dolong2는 JPA의 GeneratedValue(strategy = GenerationType.UUID) 대신 생성자에서 UUID.randomUUID()로 직접 초기화하는 방식을 선호한다. 더 간단하고 예측 가능한 동작을 위해서다.

Learnt from: dolong2
Repo: dolong2/dcd PR: 659
File: src/main/kotlin/com/dcd/server/core/domain/domain/usecase/ConnectDomainUseCase.kt:40-41
Timestamp: 2025-07-14T15:01:47.531Z
Learning: dolong2는 기능적으로 문제가 없는 코드 개선사항의 경우, 실제로 필요할 때까지 수정을 미루는 실용적인 접근법을 선호한다. 예를 들어 의미론적 정확성을 위한 변경은 해당 기능이 실제로 필요할 때 수정하는 방식을 택한다.

📚 Learning: 2025-02-15T10:33:37.315Z

Learnt from: dolong2
Repo: dolong2/dcd PR: 517
File: src/main/kotlin/com/dcd/server/presentation/domain/application/data/exetension/ApplicationRequestDataExtension.kt:13-13
Timestamp: 2025-02-15T10:33:37.315Z
Learning: In the DCD project, while spaces are allowed in application names (UI/display), they must be replaced with appropriate characters in specific technical contexts:
1. With underscores for Docker container names (in Application.kt)
2. With hyphens for HTTP configuration files (in GenerateHttpConfigServiceImpl.kt)

Applied to files:

• src/main/kotlin/com/dcd/server/core/common/file/FileContent.kt

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Test

🔇 Additional comments (1)

src/main/kotlin/com/dcd/server/core/common/file/FileContent.kt (1)

167-173: 치명적 이슈가 수정되었습니다 ✓

이전 리뷰에서 지적된 줄바꿈 문자 누락 문제가 Line 170에서 올바르게 수정되었습니다. 이제 각 RUN 명령어 뒤에 \n이 포함되어 Dockerfile 구문 오류가 발생하지 않습니다.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

src/test/kotlin/com/dcd/server/core/domain/application/service/CreateDockerFileServiceImplTest.kt (1)

36-36: 초기화 스크립트가 있는 경우의 테스트 케이스 추가를 고려하세요

현재 모든 테스트는 빈 초기화 스크립트 리스트만 사용합니다. 실제 초기화 스크립트가 있을 때 Dockerfile에 올바르게 포함되는지 검증하는 테스트 케이스를 추가하면 더 완전한 테스트 커버리지를 확보할 수 있습니다.

예시:

given("초기화 스크립트가 있는 애플리케이션이 주어지고") {
    val application = ApplicationGenerator.generateApplication(applicationType = ApplicationType.SPRING_BOOT)
    val initialScripts = listOf(
        ApplicationInitialScript(/* ... */, script = "apt-get update"),
        ApplicationInitialScript(/* ... */, script = "apt-get install -y curl")
    )
    every { queryApplicationEnvPort.findByApplication(application) } returns emptyList()
    every { queryApplicationInitialScriptPort.findAllByApplication(application) } returns initialScripts
    
    `when`("서비스를 실행할때") {
        createDockerFileService.createFileToApplication(application, application.version)
        
        then("생성된 DockerFile에 초기화 스크립트가 포함되어야함") {
            val actualFileContent = File("./${application.name}/Dockerfile").readText()
            actualFileContent shouldContain "RUN apt-get update"
            actualFileContent shouldContain "RUN apt-get install -y curl"
        }
    }
}

Also applies to: 65-65, 93-93, 121-121

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7adc1b9 and 4e2680d.

📒 Files selected for processing (3)

• src/main/kotlin/com/dcd/server/core/common/file/FileContent.kt (2 hunks)
• src/main/kotlin/com/dcd/server/core/domain/application/service/impl/CreateDockerFileServiceImpl.kt (4 hunks)
• src/test/kotlin/com/dcd/server/core/domain/application/service/CreateDockerFileServiceImplTest.kt (9 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: dolong2
Repo: dolong2/dcd PR: 703
File: src/main/kotlin/com/dcd/server/core/domain/volume/model/Volume.kt:1-12
Timestamp: 2025-09-01T14:52:42.625Z
Learning: dolong2 prefers to implement validation logic (such as path validation for Volume.physicalPath) in the business logic layer rather than in domain model init blocks, keeping domain models as simple data containers.

Learnt from: dolong2
Repo: dolong2/dcd PR: 703
File: src/test/resources/data.sql:28-30
Timestamp: 2025-09-01T14:57:07.656Z
Learning: dolong2 prefers to implement deletion validation in business logic rather than using database CASCADE constraints. For volume deletion, they want to validate if any mounts exist before allowing deletion, preventing accidental data loss while maintaining explicit control over the deletion process.

Learnt from: dolong2
Repo: dolong2/dcd PR: 655
File: src/main/kotlin/com/dcd/server/persistence/workspace/entity/WorkspaceJpaEntity.kt:12-14
Timestamp: 2025-07-12T14:05:23.333Z
Learning: dolong2는 JPA의 GeneratedValue(strategy = GenerationType.UUID) 대신 생성자에서 UUID.randomUUID()로 직접 초기화하는 방식을 선호한다. 더 간단하고 예측 가능한 동작을 위해서다.

Learnt from: dolong2
Repo: dolong2/dcd PR: 659
File: src/main/kotlin/com/dcd/server/core/domain/domain/usecase/ConnectDomainUseCase.kt:40-41
Timestamp: 2025-07-14T15:01:47.531Z
Learning: dolong2는 기능적으로 문제가 없는 코드 개선사항의 경우, 실제로 필요할 때까지 수정을 미루는 실용적인 접근법을 선호한다. 예를 들어 의미론적 정확성을 위한 변경은 해당 기능이 실제로 필요할 때 수정하는 방식을 택한다.

📚 Learning: 2025-08-12T14:59:22.963Z

Learnt from: dolong2
Repo: dolong2/dcd PR: 692
File: src/main/kotlin/com/dcd/server/core/domain/env/spi/QueryApplicationEnvPort.kt:0-0
Timestamp: 2025-08-12T14:59:22.963Z
Learning: In the dcd codebase, when updating port interface method signatures to include workspace parameters for tenant isolation, all layers must be updated together: the port interface, service interface, service implementation, persistence adapter, repository layer, and use case callers. The user dolong2 demonstrated proper multi-layer refactoring by updating QueryApplicationEnvPort.findAllByLabelsIn to include workspace parameter and systematically updating all dependent code in a single commit, including updating repository method name to findAllByWorkspaceAndLabelsIn.

Applied to files:

• src/test/kotlin/com/dcd/server/core/domain/application/service/CreateDockerFileServiceImplTest.kt
• src/main/kotlin/com/dcd/server/core/domain/application/service/impl/CreateDockerFileServiceImpl.kt

📚 Learning: 2025-08-12T14:59:22.963Z

Learnt from: dolong2
Repo: dolong2/dcd PR: 692
File: src/main/kotlin/com/dcd/server/core/domain/env/spi/QueryApplicationEnvPort.kt:0-0
Timestamp: 2025-08-12T14:59:22.963Z
Learning: In the dcd codebase, when updating port interface method signatures to include workspace parameters, all layers must be updated together: the port interface, persistence adapter implementation, repository layer, service callers, and tests. The user dolong2 demonstrated proper multi-layer refactoring by updating QueryApplicationEnvPort.findAllByLabelsIn to include workspace parameter and updating all dependent code in a single commit.

Applied to files:

• src/test/kotlin/com/dcd/server/core/domain/application/service/CreateDockerFileServiceImplTest.kt

📚 Learning: 2025-02-15T10:33:37.315Z

Learnt from: dolong2
Repo: dolong2/dcd PR: 517
File: src/main/kotlin/com/dcd/server/presentation/domain/application/data/exetension/ApplicationRequestDataExtension.kt:13-13
Timestamp: 2025-02-15T10:33:37.315Z
Learning: In the DCD project, while spaces are allowed in application names (UI/display), they must be replaced with appropriate characters in specific technical contexts:
1. With underscores for Docker container names (in Application.kt)
2. With hyphens for HTTP configuration files (in GenerateHttpConfigServiceImpl.kt)

Applied to files:

• src/main/kotlin/com/dcd/server/core/common/file/FileContent.kt

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Test

🔇 Additional comments (2)

src/main/kotlin/com/dcd/server/core/domain/application/service/impl/CreateDockerFileServiceImpl.kt (1)

61-64: 초기화 스크립트 조회 로직 확인 완료

초기화 스크립트를 조회하여 스크립트 문자열 리스트로 변환하는 로직이 명확합니다. 다른 포트 호출과 일관된 패턴을 유지하고 있습니다.

src/test/kotlin/com/dcd/server/core/domain/application/service/CreateDockerFileServiceImplTest.kt (1)

25-30: 테스트 설정이 올바르게 업데이트되었습니다

새로운 QueryApplicationInitialScriptPort 의존성이 추가되고 서비스 생성자에 올바르게 전달되었습니다.