Gitlab Pipeline으로 Android CI/CD 맛보기(feat. Windows, Docker)

안드로이드 외부 환경과 연동하는 프로젝트를 진행하고있다. 안드로이드와 연계된 부분을 테스트를 하려면 매번 새로 빌드 받아 테스트 모바일 기기에 설치해야 하는데 매번 설치를 요청하는 것도, 매번 연결해서 설치하는 것도 상당히 비효율적이라는 생각이 들었다. Github Actions로 build하여 artifacts로 뽑아본 경험이 있었기에, gitlab의 비슷한 기능인 gitlab pipeline을 사용하면 되지않을까? 라는 생각으로 이번에 도전해봤다.

 

이번에 해볼 것은 gitlab-pipeline으로  안드로이드 프로젝트를 build 해서, artifacts로 debug apk를 추출하는 것이다.

Windows에서 로컬 환경 Gitlab-Runner 초기 세팅하기

사용하기 쉬운 환경을 위해서 Docker와 Docker-Compose를 사용해 gitlab-runner를 설치할 것이다. docker-desktop을 먼저 설치하면 된다.

 

docker에 있는 terminal을 사용할 건데, 리눅스 명령어가 동작하는 mingw64를 쓰거나, wsl2 환경에서 진행하면 된다.

# 로컬 환경에 디렉토리 만들기

먼저 C드라이브나, 접근하기 쉬운 위치에 gitlab runner 디렉토리를 만들어준다.

mkdir gitlab-runner
cd gitlab-runner

이제 여기가 gitlab-runner 서비스가 위치할 곳이다.

vscode나 다른 에디터로 해당 디렉토리에서 docker-compose.yml을 만들어준다. 내용은 아래와 같이 하면 된다.

version: "3"

services:
  gitlab-runner:
    container_name: gitlab-runner
    image: 'gitlab/gitlab-runner:latest'
    restart: always
    volumes:
    - './config:/etc/gitlab-runner'
    - '/var/run/docker.sock:/var/run/docker.sock'

최신버전의 gitlab-runner가 설치되는 compose 파일을 만든다. 위에서 부터 쭉 보자.

Docker Compose 버전을 3으로 지정하고, gitlab-runner라는 이름의 컨테이너를 만들어서 서비스로 등록한다. 컨테이너에 사용될 이미지는 gitlab-runner 최신버전이고, 컨테이너가 중지될때(PC 종료와 같은 경우) 재시작 옵션을 걸고 컨테이너의 볼륨마운트 까지 정의해줬다. 볼륨마운트 의미는 아래와 같다.
`./config:/etc/gitlab-runner`: 현재 디렉토리의 config 폴더를 컨테이너의 /etc/gitlab-runner에 마운트한다.
`/var/run/docker.sock:/var/run/docker.sock`: 호스트의 Docker 소켓을 컨테이너 내부로 마운트한다. 이러면 gitlab runnner가 호스트 docker-daemon을 써서 docker in docker 환경이 구성되는데, 이러면 컨테이너 내부에서 호스트의 도커 엔진을 사용할 수 있고 호스트의 이미지 캐시를 사용하게 되므로 좀 더 효율적인 구성이 가능해진다.

 

컴포즈 파일을 실행시켜서 컨테이너를 만들면 된다.

docker compose up -d

Gitlab-Runner 등록하기

gitlab 프로젝트로 가서, runner를 만들어줘야한다.

CI/CD세팅으로 가서 runner를 만들어준다.

tag를 지정해주고, unstaged jobs도 체크해서 태그가 지정안된 ci 작업도 돌아가게 만들었다.

그러면 gitlab-runner 등록 코드가 나오는데, 이걸 도커로 만든 컨테이너에 지정해줄 것이다.

docker-compose exec gitlab-runner bash

docker-compose exec는 이미 실행 중인 gitlab-runnner 컨테이너 내부에서 새 명령을 실행하라는 의미이다. bash 셸을 열겠다는 의미로 여기서 저 gitlab-runner register를 등록해야 도커에 올라간 컨테이너가 깃랩 컨테이너의 역할을 수행할 수 있게된다.

# gitlab-runner 컨테이너 안의 shell이다.
gitlab-runner register  --url gitlab 서버 주소  --token 아까 있던 토큰 값

아까 명령어를 복사해서 그대로 붙여 실행하면 된다. 그러면 뭐라뭐라 나오는데, executer 를 `docker`, docker image를 `alpine:latest` 로 설정하는 이외에는 다 enter  쳐서 기본값으로 넣어도 된다.

Android CI 파일 작성하기

처음에는 구독중인 클로드를 사용했는데, 영 동문서답만 나와서 그냥 gitlab 공식 예제를 사용했다.

https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Android.latest.gitlab-ci.yml

lib/gitlab/ci/templates/Android.latest.gitlab-ci.yml · master · GitLab.org / GitLab · GitLab

이거 기반으로 작성했고, 최신 sdk인 34에 맞췄다.

 

먼저 프로젝트에 등록된 `local.properties`값들을 Gitlab에도 세팅해줘야한다.

CI/CD 탭의 Variables에서 작성하면된다. 다만 나의 경우처럼 Mask를 활성화 할 경우, value에 큰 따옴표를 넣을 수 없기 때문에 이따가 yml파일 작성할 때 이스케이프 처리를 해줘야한다.

파이프라인 설정은 각자 목적에 맞게 해주면 된다. 나는 그냥 root 디렉토리에 위치시켰다.

이제 `.gitlab-ci.yml` 파일을 작성하자. 파이프라인 에디터에서 바로 해도 되고, 로컬PC에서 작성해서 올려도 된다.

image: eclipse-temurin:17-jdk-jammy

variables:
  ANDROID_COMPILE_SDK: "34"
  ANDROID_BUILD_TOOLS: "34.0.0"
  ANDROID_SDK_TOOLS: "9477386"

SDK34를 사용하고, gradle 버전이 8.7이라서 jdk버전도 11이 아닌 17로 올려서 사용한다.

script를 작성하기 전에 프로젝트 repository를 보면, Android 폴더가 따로 존재한다. 즉 build를 저 폴더로 들어가서 진행해야한다는 의미가 된다. 그래서 before_script에 `cd Drtaa-Android`가 존재한다.

before_script:
  - cd Drtaa-Android
  - apt-get --quiet update --yes
  - apt-get --quiet install --yes wget unzip
  - export ANDROID_HOME="${PWD}/android-sdk-root"
  - install -d $ANDROID_HOME
  - wget --no-verbose --output-document=$ANDROID_HOME/cmdline-tools.zip https://dl.google.com/android/repository/commandlinetools-linux-${ANDROID_SDK_TOOLS}_latest.zip
  - unzip -q -d "$ANDROID_HOME/cmdline-tools" "$ANDROID_HOME/cmdline-tools.zip"
  - mv -T "$ANDROID_HOME/cmdline-tools/cmdline-tools" "$ANDROID_HOME/cmdline-tools/tools"
  - export PATH=$PATH:$ANDROID_HOME/cmdline-tools/latest/bin:$ANDROID_HOME/cmdline-tools/tools/bin
  - sdkmanager --version
  - yes | sdkmanager --licenses > /dev/null || true
  - sdkmanager "platforms;android-${ANDROID_COMPILE_SDK}"
  - sdkmanager "platform-tools"
  - sdkmanager "build-tools;${ANDROID_BUILD_TOOLS}"
  - chmod +x ./gradlew

나머지는 예시에 적힌 내용과 동일하다. 이제 문제는 variable에 적어둔 변수들을 가져와서 넣어줘야 한다는 점이다. 안그러면 BuildConfig로 설정해둔 값이 다 오류난다.

이번 프로젝트에서는 keystore를 사용하지않고 local.properties에서 키들을 관리하고 있기 때문에 local.properties 파일을 만들어서 거기에 값을 써주는 방식을 채택했다.

  - echo "sdk.dir=$ANDROID_SDK_ROOT" > local.properties
  - echo "NAVER_MAP_CLIENT_ID=\"$NAVER_MAP_CLIENT_ID\"" >> local.properties
  - echo "NAVER_MAP_CLIENT_ID_MANIFEST=$NAVER_MAP_CLIENT_ID_MANIFEST" >> local.properties
  - echo "NAVER_MAP_CLIENT_SECRET=\"$NAVER_MAP_CLIENT_SECRET\"" >> local.properties
  - echo "NAVER_CLIENT_ID=\"$NAVER_CLIENT_ID\"" >> local.properties
  - echo "NAVER_CLIENT_SECRET=\"$NAVER_CLIENT_SECRET\"" >> local.properties
  - echo "GOOGLE_LOGIN_CLIENT_ID=\"$GOOGLE_LOGIN_CLIENT_ID\"" >> local.properties
  - echo "TOUR_API_KEY=\"$TOUR_API_KEY\"" >> local.properties
  - echo "BASE_URL=\"$BASE_URL\"" >> local.properties
  - echo "MQTT_URL=\"$MQTT_URL\"" >> local.properties
  - echo "BOOTPAY_APP_ID=\"$BOOTPAY_APP_ID\"" >> local.properties

이스케이프 처리해둔 값들은 kotlin 코드에서 사용되는 값들이다. 내 코드의 경우 buildConfig에 사용되는 값들이 `" " `로 감싸져있지않으면 gradle에서 읽어올 때 에러가 난다. 아까 variable을 넣어줄때 mask를 활성화 해둬서 큰 따옴표를 못쓰기 때문이 이렇게 처리해줬다.

이 과정을 거치면 build할 때도 `local.properties`를 생성한 효과가 나타난다.

 

이제 job을 설정하면 된다. 내가 할 작업이 assembleDebug라서, 이름도 똑같이 넣어줬다.

assembleDebug:
  interruptible: true
  stage: build
  script:
    - ./gradlew assembleDebug
  artifacts:
    paths:
      - Drtaa-Android/app/build/outputs/apk/debug/app-debug.apk
      - Drtaa-Android/app/build/outputs/logs/
    expire_in: 1 week

interruptible를 true로 켜서 새로운 커밋이 들어오면 현재 실행 중인 job을 중단하고 새 job을 시작하도록한다. 
stage: build: 이 job이 'build' 단계에서 실행됨을 나타냅니다. CI/CD 파이프라인의 여러 단계 중 하나입니다.
script에는 before_script를 기반으로 실행될 명령어를 정의하는 곳이다. 지금은 assembleDebug만 있지만, detekt같은 걸 시도할 수도 있다.

artifacts에는 이 job이 완료된 후 보존할 파일들을 정의해주는데, 저 paths 에 적힌 경로에 들어가서 파일을 긁어온다. 나는 안드로이드 프로젝트 안에 들어가야 되므로 `Drtaa-Android/`를 넣어서 경로를 확실하게 지정해야한다. 프로젝트 전체 artifacts 용량이 1GB라서 보존기간을 일주일로 명시해뒀다.

 

이렇게 하면 기존 목적이었던 아티팩트를 뽑는 과정이 완성된다. 문제는 다른 폴더에서 작업하여 develop이 업데이트 될 때도 이 pipeline이 돌아간다는 점이다. github actions에서는 workflow를 설정해서 이걸 막을 수 있었는데, 여기서는 only 옵션으로 돌릴 수 있다. gitlab에도 workflow가 있어서 stage별 제어조건을 걸 수 있는데 이건 나중에 확인하자.

https://docs.gitlab.com/ee/ci/yaml/#workflow

CI/CD YAML syntax reference | GitLab

 

.android_changes: &android_changes
  only:
    changes:
      - Drtaa-Android/**/*

assembleDebug:
  <<: *android_changes
  interruptible: true
  stage: build
  script:
    - ./gradlew assembleDebug
  artifacts:
    paths:
      - Drtaa-Android/app/build/outputs/apk/debug/app-debug.apk
      - Drtaa-Android/app/build/outputs/logs/
    expire_in: 1 week

앵커를 작성해주고, 안드로이드 폴더에서 변화가 있을 때만 assembleDebug Job을 돌아가게 했다. 이러면 다른 폴더에서 작업한 건 assembleDebug Job을 실행시키지않는다!

 

도움이 됐다면 댓글이나 공감 버튼 한 번씩 누르고 가주세요!