CI/CD 구성 요소 예시

구성 요소 테스트

구성 요소의 기능에 따라 구성 요소 테스트가 저장소에 추가적인 파일을 요구할 수 있습니다. 예를 들어, 특정 프로그래밍 언어로 소프트웨어를 lint, 빌드 및 테스트하는 구성 요소의 경우, 실제 소스 코드 샘플이 필요합니다. 소스 코드 예제, 구성 파일 등을 동일한 저장소에 추가할 수 있습니다.

예를 들어, Code Quality CI/CD 구성 요소에는 테스트용 코드 샘플이 있습니다.

예시: Rust 언어 CI/CD 구성 요소 테스트

구성 요소의 기능에 따라 구성 요소 테스트가 저장소에 추가적인 파일을 요구할 수 있습니다.

다음은 Rust 프로그래밍 언어의 “hello world” 예제로, cargo 도구 체인을 사용하여 간단하게 작성된 예시입니다:

  1. CI/CD 구성 요소 루트 디렉토리로 이동합니다.

  2. cargo init 명령어를 사용하여 새로운 Rust 프로젝트를 초기화합니다. 

    cargo init

    해당 명령어는 src/main.rs를 포함한 모든 필요한 프로젝트 파일을 생성합니다. 이 단계는 cargo build로 Rust 소스 코드를 빌드하는 데 충분합니다. 

    tree
.
├── Cargo.toml
├── LICENSE.md
├── README.md
├── src
│   └── main.rs
└── templates
    └── build.yml

  3. 구성 요소에 Rust 소스 코드를 빌드하는 작업이 있는지 확인하세요. 예를 들어, templates/build.yml에서: 

    spec:
  inputs:
    stage:
      default: build
      description: '빌드 스테이지 정의'
    rust_version:
      default: latest
      description: 'Rust 버전 지정, https://hub.docker.com/_/rust/tags에서 값을 사용합니다. 기본값은 latest입니다.'
---

"build-$[[ inputs.rust_version ]]":
  stage: $[[ inputs.stage ]]
  image: rust:$[[ inputs.rust_version ]]
  script:
    - cargo build --verbose

    위 예시에서:

    • stage와 rust_version 입력은 기본 값에서 수정될 수 있습니다. CI/CD 작업은 build- 접두어로 시작하고 rust_version 입력을 기반으로 동적으로 이름이 생성됩니다. 명령어 cargo build --verbose는 Rust 소스 코드를 컴파일합니다.

  4. 프로젝트의 .gitlab-ci.yml 구성 파일에서 구성 요소의 build 템플릿을 테스트하세요: 

    include:
  # 현재 SHA에서 현재 프로젝트에 있는 구성 요소를 포함합니다
  - component: gitlab.com/$CI_PROJECT_PATH/build@$CI_COMMIT_SHA
    inputs:
      stage: build

stages: [build, test, release]

  5. 테스트 실행 및 추가 기능을 위해 Rust 코드에 추가적인 함수와 테스트를 추가하고, templates/test.yml에서 cargo test를 실행하는 작업을 추가하세요. 

    spec:
  inputs:
    stage:
      default: test
      description: '테스트 스테이지 정의'
    rust_version:
      default: latest
      description: 'Rust 버전 지정, https://hub.docker.com/_/rust/tags에서 값을 사용합니다. 기본값은 latest입니다.'
---

"test-$[[ inputs.rust_version ]]":
  stage: $[[ inputs.stage ]]
  image: rust:$[[ inputs.rust_version ]]
  script:
    - cargo test --verbose

  6. 파이프라인의 추가적인 작업을 테스트하기 위해 test 구성 요소 템플릿을 포함하세요: 

    include:
  # 현재 SHA에서 현재 프로젝트에 있는 구성 요소를 포함합니다
  - component: gitlab.com/$CI_PROJECT_PATH/build@$CI_COMMIT_SHA
    inputs:
      stage: build
  - component: gitlab.com/$CI_PROJECT_PATH/test@$CI_COMMIT_SHA
    inputs:
      stage: test

stages: [build, test, release]

CI/CD 구성 요소 이전 예시

이 섹션에서는 CI/CD 템플릿 및 파이프라인 구성을 재사용 가능한 CI/CD 구성 요소로 이전하는 실제 예시를 보여줍니다.

CI/CD 구성 요소 이전 예시: Go

소프트웨어 개발 라이프사이클을 위한 완전한 파이프라인은 여러 작업과 스테이지로 구성될 수 있습니다. 프로그래밍 언어에 대한 CI/CD 템플릿은 단일 템플릿 파일에서 여러 작업을 제공할 수 있습니다. 실습을 위해 다음의 Go CI/CD 템플릿을 이전해야 합니다. 

image: golang:latest

stages:
  - test
  - build
  - deploy

format:
  stage: test
  script:
    - go fmt $(go list ./... | grep -v /vendor/)
    - go vet $(go list ./... | grep -v /vendor/)
    - go test -race $(go list ./... | grep -v /vendor/)

compile:
  stage: build
  script:
    - mkdir -p mybinaries
    - go build -o mybinaries ./...
  artifacts:
    paths:
      - mybinaries

참고: 모든 작업을 이전하는 대신 하나의 작업부터 시작할 수도 있습니다. 아래의 지침을 따르고, 첫 번째 이터레이션에서 build CI/CD 작업만 이전하세요.

CI/CD 템플릿 이전은 다음 단계로 이뤄집니다:

  1. CI/CD 작업 및 종속성을 분석하고 이전 작업을 정의합니다:
    • image 구성은 전역이며, 작업 정의로 이동해야 합니다.
    • format 작업은 하나의 작업에서 여러 go 명령어를 실행합니다. go test 명령어는 파이프라인 효율성을 높이기 위해 별도의 작업으로 이동해야 합니다.
    • compile 작업은 go build를 실행하며 build로 이름이 바뀌어야 합니다.
  2. 더 나은 파이프라인 효율성을 위한 최적화 전략을 정의하세요.
    • stage 작업 속성은 다양한 CI/CD 파이프라인 컨슈머를 허용하기 위해 구성 가능해야 합니다.
    • image 키는 하드코딩된 이미지 태그 latest를 사용합니다. 더 유연하고 재사용 가능한 파이프라인을 위해 golang_version을 입력으로 추가하고 기본값을 latest로 설정하세요. 이 입력은 Docker Hub 이미지 태그 값과 일치해야 합니다.
    • compile 작업은 하드코딩된 대상 디렉토리인 mybinaries를 사용하여, 동적 입력과 기본 값을 mybinaries로 향상시킬 수 있습니다.

  3. 새로운 구성 요소에 대한 디렉토리 구조를 작성하고, 각 작업을 위한 새로운 템플릿을 기반으로 하세요.

    • 템플릿의 이름은 go 명령어를 따라야 하며, 예를 들어 format.yml, build.yml, test.yml이 될 수 있습니다.
    • 새 프로젝트를 생성하고, Git 저장소를 초기화하고 모든 변경 사항을 추가/커밋하고, 원격 원본을 설정하고 푸시하세요. CI/CD 구성 요소 프로젝트 경로를 수정하세요.
    • 최적의 실천 방법을 따르기 위해 다음과 같은 추가 파일을 생성하세요: README.md, LICENSE.md, .gitlab-ci.yml, .gitignore. 다음 쉘 명렁어는 Go 구성 요소 구조를 초기화합니다: 
    git init

mkdir templates
touch templates/{format,build,test}.yml

touch README.md LICENSE.md .gitlab-ci.yml .gitignore

git add -A
git commit -avm "Initial component structure"

git remote add origin https://gitlab.example.com/components/golang.git

git push
  4. 작업을 템플릿으로 정의하세요. build 작업부터 시작하세요.
    • spec 섹션에서 다음과 같은 입력을 정의하세요: stage, golang_version 및 binary_directory.
    • inputs.golang_version에 접근하여 동적 작업 이름 정의하세요.
    • inputs.golang_version에 접근하여 동적 Go 이미지 버전에 대한 유사한 패턴을 사용하세요.
    • inputs.stage 값을 stage에 할당하세요.
    • inputs.binary_directory에서 바이너리 디렉터리를 만들고 go build의 파라미터로 추가하세요.

    • inputs.binary_directory를 아티팩트 경로로 정의하세요. 

      spec:
  inputs:
    stage:
      default: 'build'
      description: '빌드 스테이지 정의'
    golang_version:
      default: 'latest'
      description: 'Go 이미지 버전 태그'
    binary_directory:
      default: 'mybinaries'
      description: '생성된 바이너리 아티팩트의 출력 디렉터리'
---

"build-$[[ inputs.golang_version ]]":
  image: golang:$[[ inputs.golang_version ]]
  stage: $[[ inputs.stage ]]
  script:
    - mkdir -p $[[ inputs.binary_directory ]]
    - go build -o $[[ inputs.binary_directory ]] ./...
  artifacts:
    paths:
      - $[[ inputs.binary_directory ]]

    • format 작업 템플릿은 동일한 패턴을 따르지만, stage 및 golang_version 입력만 필요합니다. 

      spec:
  inputs:
    stage:
      default: 'format'
      description: '포맷 스테이지 정의'
    golang_version:
      default: 'latest'
      description: 'Go 이미지 버전 태그'
---

"format-$[[ inputs.golang_version ]]":
  image: golang:$[[ inputs.golang_version ]]
  stage: $[[ inputs.stage ]]
  script:
    - go fmt $(go list ./... | grep -v /vendor/)
    - go vet $(go list ./... | grep -v /vendor/)

    • test 작업 템플릿은 동일한 패턴을 따르지만, stage와 golang_version 입력만 필요합니다. 

      spec:
  inputs:
    stage:
      default: 'test'
      description: '포맷 스테이지 정의'
    golang_version:
      default: 'latest'
      description: 'Go 이미지 버전 태그'
---

"test-$[[ inputs.golang_version ]]":
  image: golang:$[[ inputs.golang_version ]]
  stage: $[[ inputs.stage ]]
  script:
    - go test -race $(go list ./... | grep -v /vendor/)

  5. 구성 요소를 테스트하기 위해 .gitlab-ci.yml 구성 파일을 수정하고 테스트를 추가하세요.

    • golang_version에 대해 build 작업에 대한 입력으로 다른 값으로 지정하세요.

    • 프로젝트 경로를 수정하세요. 

      stages: [format, build, test]

include:
  - component: example.gitlab.com/$CI_PROJECT_PATH/format@$CI_COMMIT_SHA
  - component: example.gitlab.com/$CI_PROJECT_PATH/build@$CI_COMMIT_SHA
  - component: example.gitlab.com/$CI_PROJECT_PATH/build@$CI_COMMIT_SHA
    inputs:
      golang_version: "1.21"
  - component: example.gitlab.com/$CI_PROJECT_PATH/test@$CI_COMMIT_SHA
    inputs:
      golang_version: latest

  6. Go 소스 코드를 추가하여 CI/CD 구성 요소를 테스트하세요. go 명령어들은 루트 디렉토리에 go.mod와 main.go가 있는 Go 프로젝트를 기대합니다.

    • Go 모듈을 초기화하세요. 프로젝트 경로를 수정하세요. 

      go mod init example.gitlab.com/components/golang

    • main.go 파일을 만들고, 예를 들어 Hello, CI/CD component를 출력하는 메인 함수를 생성하세요. 팁: GitLab Duo Code Suggestions를 사용하여 Go 코드를 생성하기 위해 코드 주석을 사용하세요. 

      // 패키지 지정, 필요한 패키지 가져오기
// 메인 함수 생성
// 메인 함수 내에서 "Hello, CI/CD Component"를 출력

package main

import "fmt"

func main() {
  fmt.Println("Hello, CI/CD Component")
}

    • 디렉토리 트리는 다음과 같아야 합니다: 

      tree
.
├── LICENSE.md
├── README.md
├── go.mod
├── main.go
└── templates
    ├── build.yml
    ├── format.yml
    └── test.yml

나머지 단계는 CI/CD 템플릿을 구성 요소로 변환하는 섹션의 지침을 따르세요:

  1. 변경 사항을 커밋하고 푸시하고 CI/CD 파이프라인 결과를 확인하세요.
  2. 문서 최상의 실천 방법을 따라 README.md 및 LICENSE.md 파일을 업데이트하세요.
  3. 구성 요소를 릴리스하고 CI/CD 카탈로그에서 확인하세요.
  4. CI/CD 구성 요소를 스테이징/프로덕션 환경에 추가하세요.

GitLab 유지 관리 Go 구성 요소는 Go CI/CD 템플릿에서 성공적으로 구성 요소로의 이전 예시를 제공하며, 입력 및 구성 요소 최상의 실천 방법이 적용되어 있습니다. 자세한 내용은 Git 히스토리를 확인할 수 있습니다.