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

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

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이 사전 설치되어 있어야 합니다. 이 실행 방법은 shell executor를 사용하는 GitLab Runner와 유사합니다.

셸 실행을 사용한 Freestyle

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

freestyle shell

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

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

freestyle plugin

이 플러그인은 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 파이프라인 구성 또는 Git 리포지토리에 Jenkinsfile로 직접 저장됩니다.

Jenkins 구성을 GitLab CI/CD로 변환

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

전제 조건:

  • Shell executor를 가진 GitLab Runner
  • Shell runner에 설치된 Maven 3.6.3 및 Java 11 JDK

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

GitLab CI/CD 파이프라인에서는 명령이 “jobs”에서 실행되며, 이는 단계로 그룹화됩니다.
.gitlab-ci.yml 구성 파일의 마이그레이션된 구성은 두 개의 전역 키워드(stagesvariables)로 시작하여 3개의 jobs로 구성됩니다:

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 리포지토리의 위치를 runner의 GitLab 프로젝트 디렉토리로 설정하여, 작업이 리포지토리에 접근하고 수정할 수 있도록 합니다.
    • MAVEN_CLI_OPTSmvn 명령에 추가될 특정 인수입니다:
      • -DskipTests는 Maven 빌드 생명 주기에서 test 단계를 건너뜁니다.
  • test-code, build-JAR, 및 install-JAR는 파이프라인에서 실행할 작업의 사용자 정의 이름입니다:
    • stage는 작업이 실행되는 단계를 정의합니다. 파이프라인은 하나 이상의 단계로 구성되며, 각 단계는 하나 이상의 작업을 포함합니다. 이 예제에는 각각 단일 작업이 있는 세 단계가 있습니다.
    • script는 해당 작업에서 실행할 명령을 정의하며, 이는 Jenkinsfilesteps와 유사합니다.
      작업은 이미지 컨테이너 내에서 순차적으로 여러 명령을 실행할 수 있지만, 이 예제에서는 각 작업이 하나의 명령만 실행합니다.

Docker 컨테이너에서 작업 실행

Jenkins 샘플처럼 이 빌드 프로세스를 처리하기 위해 지속적인 머신을 사용하는 대신, 이 예제는 실행을 처리하기 위해 임시 Docker 컨테이너를 사용합니다.

컨테이너를 사용하면 가상 머신과 그 안에 설치된 Maven 버전을 유지 관리할 필요가 없으므로 유연성이 높아지고 파이프라인의 기능을 확장하고 연장할 수 있습니다.

전제 조건:

  • 프로젝트에서 사용할 수 있는 Docker 실행기가 있는 GitLab Runner. GitLab.com을 사용하는 경우, 공용 인스턴스 러너를 사용할 수 있습니다.

이 마이그레이션된 파이프라인 구성은 세 개의 글로벌 키워드(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 예와 마찬가지로 테스트 작업이 먼저 실행된 후, 빌드 작업이 이어지고 마지막으로 설치 작업이 실행됩니다.

  • default는 모든 작업에서 기본적으로 재사용할 표준 구성을 정의합니다:
    • image는 사용할 Docker 이미지 컨테이너를 정의하고, 그 안에서 명령을 실행합니다. 이 예제에서는 필요한 모든 것이 이미 설치된 공식 Maven Docker 이미지입니다.
    • cache는 종속성을 캐시하고 재사용하는 데 사용됩니다:
      • key는 특정 캐시 아카이브의 고유 식별자입니다. 이 예제에서는 Git 커밋 레프의 축약 버전으로, 미리 정의된 CI/CD 변수로 자동 생성됩니다. 동일한 커밋 레프에 대해 실행되는 모든 작업은 동일한 캐시를 재사용합니다.
      • paths는 캐시에 포함할 디렉토리나 파일입니다. 이 예제에서는 .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_OPTSmvn 명령에 추가할 특정 인수입니다:
      • -DskipTests는 Maven 빌드 수명 주기에서 test 단계를 건너뜁니다.
  • test-code, build-JAR, install-JAR는 파이프라인에서 실행할 작업에 대한 사용자 정의 이름입니다:
    • stage는 작업이 실행될 단계를 정의합니다. 파이프라인은 하나 이상의 단계와 단계 내에 하나 이상의 작업을 포함합니다. 이 예제는 각각 단일 작업이 있는 세 개의 단계를 포함합니다.
    • script는 해당 작업에서 실행할 명령을 정의하며, 이는 Jenkinsfilesteps와 유사합니다. 작업은 순차적으로 여러 명령을 실행할 수 있으며, 이 예제에서는 각 작업이 하나의 명령만 실행합니다.