Jenkins에서 GitLab CI/CD로 Maven 빌드 마이그레이션하기

Jenkins에서 Maven 빌드를 사용 중이라면 Java Spring 프로젝트 템플릿을 사용하여 GitLab으로 마이그레이션할 수 있습니다. 해당 템플릿은 Maven을 기본 종속성 관리 도구로 사용합니다.

샘플 Jenkins 구성

다음 세 가지 Jenkins 예제는 각각 다른 방법으로 Maven 프로젝트를 테스트하고 빌드하고 설치하는 메서드를 사용합니다:

셸 에이전트에 대한 쉘 실행을 사용한 Freestyle
Maven 작업 플러그인을 사용한 Freestyle
Jenkinsfile을 사용한 선언적 파이프라인

세 가지 예제는 각각 세 가지 다른 스테이지에서 동일한 세 가지 명령을 실행합니다:

mvn test: 코드베이스에서 발견된 테스트를 실행합니다.
mvn package -DskipTests: 코드를 POM에서 정의된 실행 가능한 유형으로 컴파일하고 첫 번째 스테이지에서 테스트를 이미 실행했기 때문에 테스트를 건너뜁니다.
mvn install -DskipTests: 컴파일된 실행 가능한 파일을 에이전트의 로컬 Maven .m2 리포지토리에 설치하고 테스트를 다시 건너뜁니다.

이러한 예제들은 단일하고 지속적인 Jenkins 에이전트를 사용하며 에이전트에 Maven이 사전 설치되어 있어야 합니다. 이 실행 방법은 GitLab 러너가 셸 실행자를 사용하는 것과 유사합니다.

셸 실행을 사용한 Freestyle

에이전트에서 쉘 실행 옵션을 사용하여 직접 mvn 명령을 호출하는 Jenkins의 내장 셸 실행 옵션을 사용하면 구성이 다음과 같을 수 있습니다:

Maven 작업 플러그인을 사용한 Freestyle

Jenkins에서 Maven 플러그인을 사용하여 Maven 빌드 라이프사이클에서 특정 목표를 선언하고 실행하는 경우 구성은 다음과 같을 수 있습니다:

이 플러그인은 Jenkins 에이전트에 Maven이 설치되어 있어야 하며 Maven 명령을 호출하기 위한 스크립트 래퍼를 사용합니다.

선언적 파이프라인 사용

선언적 파이프라인을 사용하는 경우 구성은 다음과 같을 수 있습니다:

pipeline {
    agent any
    tools {
        maven 'maven-3.6.3'
        jdk 'jdk11'
    }
    stages {
        stage('Build') {
            steps {
                sh "mvn package -DskipTests"
            }
        }
        stage('Test') {
            steps {
                sh "mvn test"
            }
        }
        stage('Install') {
            steps {
                sh "mvn install -DskipTests"
            }
        }
    }
}

이 예제는 플러그인 대신 셸 실행 명령을 사용합니다.

기본적으로 선언적 파이프라인 구성은 Jenkins 파이프라인 구성 또는 Jenksinfile 내에 직접 저장됩니다.

Jenkins 구성을 GitLab CI/CD로 변환

위의 예제는 모두 약간 다르지만 모두 동일한 파이프라인 구성으로 GitLab CI/CD로 마이그레이션할 수 있습니다.

전제 조건:

셸 실행자가 있는 GitLab 러너
셸 실행자에 설치된 Maven 3.6.3 및 Java 11 JDK

이 예제는 빌드, 테스트 및 Jenkins에서의 설치와 구문을 모방합니다.

GitLab CI/CD 파이프라인에서 명령은 “작업”에서 실행되며, 이는 스테이지로 그룹화됩니다. .gitlab-ci.yml 구성 파일의 마이그레이션된 구성은 stages 및 variables 두 개의 전역 키워드로 시작하고 다음과 같이 3개의 작업으로 이루어집니다:

stages:
  - build
  - test
  - install

variables:
  MAVEN_OPTS: >-
    -Dhttps.protocols=TLSv1.2
    -Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository
  MAVEN_CLI_OPTS: >-
    -DskipTests

build-JAR:
  stage: build
  script:
    - mvn $MAVEN_CLI_OPTS package

test-code:
  stage: test
  script:
    - mvn test

install-JAR:
  stage: install
  script:
    - mvn $MAVEN_CLI_OPTS install

이 예제에서:

stages는 순서대로 실행되는 세 가지 스테이지를 정의합니다. 위의 Jenkins 예제와 마찬가지로, 테스트 작업이 먼저 실행되고 빌드 작업이 실행되며 마지막으로 설치 작업이 실행됩니다.
variables은 모든 작업에서 사용할 수 있는 CI/CD 변수를 정의합니다:
- MAVEN_OPTS: Maven이 실행될 때 필요한 Maven 환경 변수를 정의합니다:
  - -Dhttps.protocols=TLSv1.2: 파이프라인에서 HTTP 요청에 대한 TLS 프로토콜을 1.2 버전으로 설정합니다.
  - -Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository: 로컬 Maven 리포지토리의 위치를 러너의 GitLab 프로젝트 디렉토리로 설정하여 작업이 리포지토리에 액세스하고 수정할 수 있도록 합니다.
- MAVEN_CLI_OPTS: mvn 명령에 추가해야 하는 특정 인수를 정의합니다:
  - -DskipTests: Maven 빌드 라이프사이클의 test 스테이지를 건너뜁니다.
test-code, build-JAR, install-JAR은 파이프라인에서 실행될 사용자 정의 작업의 이름입니다:
- stage는 작업이 실행되는 스테이지를 정의합니다. 파이프라인에는 하나 이상의 스테이지가 포함되며 각 스테이지에는 하나 이상의 작업이 포함됩니다. 이 예제에는 각각 하나의 작업을 포함하는 세 개의 스테이지가 있습니다.
- script는 해당 작업에서 실행할 명령을 정의합니다. 이는 Jenkinsfile의 steps와 유사합니다. 작업은 이미지 컨테이너에서 여러 명령을 실행할 수 있지만, 이 예제에서는 각 작업이 각각 하나의 명령을 실행합니다.

도커 컨테이너에서 작업 실행

Jenkins 샘플과 같이 빌드 프로세스를 처리하기 위해 지속적인 머신 대신 본 예시는 순간적인 도커 컨테이너를 사용하여 실행합니다. 컨테이너를 사용함으로써 가상 머신을 유지하는 필요가 없어지며, 설치된 Maven 버전을 유지할 필요도 없어집니다. 또한 이는 파이프라인의 확장과 기능을 확장하는 유연성을 증가시킵니다.

사전 준비사항:

프로젝트에서 사용할 수 있는 Docker executor를 갖춘 GitLab Runner. GitLab.com을 사용 중이라면 public 인스턴스 러너를 사용할 수 있습니다.

이 이주된 파이프라인 구성은 세 개의 전역 키워드(stages, default, variables) 뒤에 이어서 3개의 작업으로 이루어져 있습니다. 이 구성은 위의 예시에 비해 개선된 파이프라인을 위해 추가적인 GitLab CI/CD 기능을 활용합니다:

stages:
  - build
  - test
  - install

default:
  image: maven:3.6.3-openjdk-11
  cache:
    key: $CI_COMMIT_REF_SLUG
    paths:
      - .m2/

variables:
  MAVEN_OPTS: >-
    -Dhttps.protocols=TLSv1.2
    -Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository
  MAVEN_CLI_OPTS: >-
    -DskipTests

build-JAR:
  stage: build
  script:
    - mvn $MAVEN_CLI_OPTS package

test-code:
  stage: test
  script:
    - mvn test

install-JAR:
  stage: install
  script:
    - mvn $MAVEN_CLI_OPTS install

이 예시에서:

stages는 순서대로 실행되는 세 개의 단계를 정의합니다. Jenkins 예시와 마찬가지로, test 작업이 먼저 실행되고, build 작업이 그 뒤를 이어서 실행되며, 마지막으로 install 작업이 실행됩니다.
default는 모든 작업에서 재사용하는 표준 구성을 정의합니다:
- image는 사용할 도커 이미지 컨테이너를 정의하고 해당 이미지에서 명령을 실행합니다. 이 예시에서는 필요한 모든 것이 이미 설치된 공식 Maven 도커 이미지를 사용합니다.
- cache는 종속성을 캐시하고 재사용하는 데 사용됩니다:
  - key는 특정 캐시 아카이브의 고유 식별자를 정의합니다. 이 예시에서는 Git 커밋 ref의 약식 버전으로 자동 생성되는 미리 정의된 CI/CD 변수입니다. 동일한 커밋 ref를 가진 모든 작업은 동일한 캐시를 재사용합니다.
  - paths는 캐시에 포함할 디렉토리 또는 파일을 정의합니다. 이 예시에서는 job 실행 간에 종속성을 다시 설치하는 것을 피하기 위해 .m2/ 디렉터리를 캐시합니다.
variables는 모든 작업에서 사용할 수 있는 CI/CD 변수를 정의합니다:
- MAVEN_OPTS는 Maven을 실행할 때 필요한 Maven 환경 변수를 정의합니다:
  - -Dhttps.protocols=TLSv1.2는 파이프라인에서 HTTP 요청에 대한 TLS 프로토콜을 버전 1.2로 설정합니다.
  - -Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository는 로컬 Maven 저장소의 위치를 러너의 GitLab 프로젝트 디렉토리로 설정하여 작업이 저장소에 액세스하고 수정할 수 있도록합니다.
- MAVEN_CLI_OPTS는 mvn 명령에 추가할 특정 인수를 정의합니다:
  - -DskipTests는 Maven 빌드 라이프사이클의 test 단계를 건너뛰도록 합니다.
test-code, build-JAR, install-JAR는 파이프라인에서 실행할 사용자 정의 작업의 이름입니다:
- stage는 작업이 실행되는 단계를 정의합니다. 파이프라인에는 하나 이상의 단계가 포함되며, 단계에는 하나 이상의 작업이 포함됩니다. 이 예시에서는 각각의 작업이 있는 세 개의 단계가 있습니다.
- script는 해당 작업에서 실행할 명령을 정의합니다. Jenkinsfile의 steps와 유사하게 작업은 이미지 컨테이너에서 순서대로 여러 명령을 실행할 수 있지만, 이 예시에서는 각 작업이 하나의 명령만 실행합니다.