[swift] Swift Sourcery와 CI/CD 파이프라인의 통합

16 Nov 2023

swift

Swift Sourcery란?

Swift Sourcery는 Swift 코드 생성 도구로, 소스 코드를 분석하고 템플릿을 적용하여 중복되는 코드를 자동으로 생성할 수 있습니다. 이를 통해 개발자들은 불필요한 작업을 줄이고 코드를 더욱 효율적으로 작성할 수 있습니다.

CI/CD 파이프라인의 통합

CI/CD(Continuous Integration / Continuous Deployment) 파이프라인은 개발자들이 변화하는 소스 코드의 품질을 유지하고 애플리케이션을 지속적으로 배포하는 것을 도와줍니다. CI/CD 파이프라인에 Swift Sourcery를 통합하면, 코드 생성 과정을 자동화하여 업데이트된 코드를 빠르게 서비스에 반영할 수 있습니다.

CI/CD 파이프라인에 Swift Sourcery를 통합하는 방법은 다음과 같습니다.

코드 저장소에 CI/CD 설정 파일을 추가합니다. 대표적인 CI/CD 도구로는 Jenkins, Travis CI, CircleCI 등이 있습니다. 이 설정 파일에서는 CI/CD 파이프라인의 실행 과정과 조건을 정의합니다.
설정 파일 내에서 sourcery 명령어를 실행해 Sourcery를 호출합니다. 이때, --sources 옵션으로 소스 코드 경로를 지정하고, --templates 옵션으로 Sourcery 템플릿 폴더의 경로를 지정합니다.
Sourcery가 소스 코드와 템플릿을 분석하여 생성한 코드를 저장합니다.
CI/CD 파이프라인의 다음 단계에서는 생성된 코드를 컴파일하고, 유닛 테스트를 수행합니다.
유효성 검사를 통과한 코드는 배포 환경으로 이동하여 서비스에 적용됩니다.

실제 구현 예시

다음은 Jenkins를 사용하여 Swift Sourcery를 CI/CD 파이프라인에 통합하는 예시입니다.

stage('Sourcery') {
    steps {
        sh 'sourcery --sources Sources --templates SourceryTemplates --output GeneratedCode'
    }
}

stage('Build and Test') {
    steps {
        sh 'swift build'
        sh 'swift test'
    }
}

위의 코드에서 stage('Sourcery')는 Sourcery를 실행하여 코드를 생성하는 단계를 의미합니다. --sources 옵션으로 소스 코드의 경로를, --templates 옵션으로 템플릿 폴더의 경로를 지정합니다. 이후 stage('Build and Test')에서는 생성된 코드를 컴파일하고 유닛 테스트를 수행합니다.

목차

Swift Sourcery란?

CI/CD 파이프라인의 통합

실제 구현 예시

참고 자료