PHP 프로젝트 테스트

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

이 안내서는 PHP 프로젝트를 위한 기본 빌드 지침을 다룹니다.

두 가지 테스트 시나리오를 다루고 있습니다: 도커 executor를 사용한 테스트와 셸 executor를 사용한 테스트.

도커 executor를 사용하여 PHP 프로젝트 테스트

PHP 앱을 어떤 시스템에서든 테스트하는 것은 가능하지만, 개발자의 매뉴얼 구성을 필요로 합니다. 이를 극복하기 위해 Docker Hub에서 찾을 수 있는 공식 PHP Docker 이미지를 사용합니다.

이를 통해 PHP 프로젝트를 다른 PHP 버전에 대해 테스트할 수 있습니다. 그러나 모든 것이 플러그 앤 플레이는 아니며, 여전히 일부 구성이 필요합니다.

모든 작업과 마찬가지로 빌드 환경을 설명하는 유효한 .gitlab-ci.yml을 생성해야 합니다.

먼저 작업 프로세스에 사용되는 PHP 이미지를 지정해야 합니다. (이미지가 러너용 용어에 대한 자세한 내용은 도커 이미지 사용를 참조하세요.)

.gitlab-ci.yml에 이미지를 추가하여 시작하세요: 

image: php:5.6

공식 이미지는 훌륭하지만, 테스트를 위한 몇 가지 유용한 도구가 부족합니다. 먼저 빌드 환경을 준비해야 합니다. 이를 극복하는 한 가지 방법은 실제 테스트가 이루어지기 전에 모든 필수 작업을 설치하는 스크립트를 만드는 것입니다.

우리의 리포지터리 루트 디렉터리에 다음 내용을 포함하는 ci/docker_install.sh 파일을 만들어 보겠습니다: 

#!/bin/bash

# 도커에 대해서만 의존성을 설치해야 함
[[ ! -e /.dockerenv ]] && exit 0

set -xe

# composer에서 필요로 하는 git을 설치해야 함
apt-get update -yqq
apt-get install git -yqq

# 테스트에 사용할 도구인 phpunit을 설치
curl --location --output /usr/local/bin/phpunit "https://phar.phpunit.de/phpunit.phar"
chmod +x /usr/local/bin/phpunit

# mysql 드라이버 설치
# 여기에서 필요한 다른 확장 기능을 설치할 수 있음
docker-php-ext-install pdo_mysql

docker-php-ext-install이 무엇인지 궁금할 것입니다. 간단히 말해서, 공식 PHP Docker 이미지에서 제공하는 스크립트로 확장 기능을 쉽게 설치할 수 있습니다. 자세한 내용은 문서를 참조하세요.

이제 빌드 환경에 필요한 모든 사전 작업을 포함하는 스크립트를 만들었으니, .gitlab-ci.yml에 추가해보겠습니다: 

before_script:
  - bash ci/docker_install.sh > /dev/null

마지막 단계는 phpunit을 사용하여 실제 테스트를 실행하는 것입니다: 

test:app:
  script:
    - phpunit --configuration phpunit_myapp.xml

마지막으로 파일을 커밋하고 GitLab에 푸시하여 빌드가 성공하는지(또는 실패하는지) 확인하세요.

최종 .gitlab-ci.yml은 다음과 유사해야 합니다: 

default:
  # https://hub.docker.com/_/php에서 이미지 선택
  image: php:5.6
  before_script:
    # 의존성 설치
    - bash ci/docker_install.sh > /dev/null

test:app:
  script:
    - phpunit --configuration phpunit_myapp.xml

도커 빌드에서 다른 PHP 버전에 대해 테스트

다중 PHP 버전에 대해 테스트하는 것은 매우 쉽습니다. 다른 Docker 이미지 버전을 사용하여 다른 작업을 추가하면 러너가 나머지를 처리합니다: 

default:
  before_script:
    # 의존성 설치
    - bash ci/docker_install.sh > /dev/null

# 우리는 PHP5.6에 대해 테스트합니다
test:5.6:
  image: php:5.6
  script:
    - phpunit --configuration phpunit_myapp.xml

# PHP7.0에 대해 테스트합니다 (운이 좋기를 바랍니다)
test:7.0:
  image: php:7.0
  script:
    - phpunit --configuration phpunit_myapp.xml

도커 빌드에서 사용자 지정 PHP 구성

당신이 PHP 환경을 사용자 정의해야 하는 경우가 있습니다. 이를 위해 .ini 파일을 /usr/local/etc/php/conf.d/에 넣어야 합니다. 이를 위해 before_script 액션을 추가하십시오: 

before_script:
  - cp my_php.ini /usr/local/etc/php/conf.d/test.ini

물론, my_php.ini는 리포지터리의 루트 디렉터리에 있어야 합니다.

셸 executor를 사용하여 PHP 프로젝트 테스트

셸 executor는 서버의 터미널 세션에서 작업을 실행합니다. 프로젝트를 테스트하려면 먼저 모든 의존성이 설치되었는지 확인해야 합니다.

예를 들어 Debian 8을 실행하는 VM에서, 먼저 캐시를 업데이트한 후 phpunit과 php5-mysql을 설치하세요: 

sudo apt-get update -y
sudo apt-get install -y phpunit php5-mysql

다음, .gitlab-ci.yml에 다음 스니펫을 추가하세요: 

test:app:
  script:
    - phpunit --configuration phpunit_myapp.xml

마지막으로 GitLab에 푸시하여 테스트를 시작해보세요!

셸 빌드에서 다른 PHP 버전에 대해 테스트

phpenv 프로젝트를 사용하면 각각의 구성과 함께 다른 PHP 버전을 쉽게 관리할 수 있습니다. 특히 셸 executor로 PHP 프로젝트를 테스트할 때 매우 유용합니다.

이를 위해 빌드 머신의 gitlab-runner 사용자 계정 아래 상위 스트림 설치 가이드를 따라 설치해야 합니다.

phpenv를 사용하면 다음과 같이 PHP 환경을 쉽게 구성할 수 있습니다: 

phpenv confi-add my_config.ini

중요 노트: phpenv/phpenv가 폐기된 것으로 보입니다. madumlao/phpenv에서 프로젝트를 되살리려고 노력 중인 포크가 있습니다. 또한 CHH/phpenv도 좋은 대안으로 보입니다. 언급된 도구 중 하나를 선택하는 것은 이 튜토리얼의 범위를 벗어납니다.*

사용자 지정 확장 기능 설치

이것은 상당히 맨 평판된 PHP 환경 설치인 만큼, 빌드 머신에 현재 없는 일부 확장 기능이 필요할 수 있습니다.

추가 확장 기능을 설치하려면 다음을 실행하세요: 

pecl install <extension>

이것을 .gitlab-ci.yml에 추가하는 것은 권장하지 않습니다. 빌드 환경을 설정하기 위해 이 명령을 한 번만 실행해야 합니다.

테스트 확장

atoum 사용

PHPUnit 대신에 다른 도구를 사용하여 유닛 테스트를 실행할 수 있습니다. 예를 들어 atoum을 사용할 수 있습니다: 

test:atoum:
  before_script:
    - wget http://downloads.atoum.org/nightly/mageekguy.atoum.phar
  script:
    - php mageekguy.atoum.phar

Composer 사용

대부분의 PHP 프로젝트는 PHP 패키지를 관리하기 위해 Composer를 사용합니다. 테스트를 실행하기 전에 Composer를 실행하려면 다음을 .gitlab-ci.yml에 추가하세요: 

# Composer는 모든 다운로드된 패키지를 vendor/ 디렉터리에 저장합니다.
# vendor/ 디렉터리가 리포지터리에 커밋되어 있다면 다음을 사용하지 마십시오.
default:
  cache:
    paths:
      - vendor/
  before_script:
    # Composer 의존성 설치
    - wget https://composer.github.io/installer.sig -O - -q | tr -d '\n' > installer.sig
    - php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
    - php -r "if (hash_file('SHA384', 'composer-setup.php') === file_get_contents('installer.sig')) { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
    - php composer-setup.php
    - php -r "unlink('composer-setup.php'); unlink('installer.sig');"
    - php composer.phar install

개인 패키지 또는 의존성에 액세스

귀하의 테스트 수트가 비공개 리포지터리에 액세스해야 할 경우, 복제할 수 있도록 SSH 키를 구성해야 합니다.

데이터베이스 또는 다른 서비스 사용

대부분의 경우, 테스트를 실행하는 데 실행 중인 데이터베이스가 필요합니다. Docker 실행자를 사용하는 경우, Docker를 활용하여 다른 컨테이너에 연결할 수 있습니다. GitLab Runner를 사용하면 service를 정의하여 이를 달성할 수 있습니다.

이 기능은 CI 서비스 문서에서 다루고 있습니다.

로컬에서 것들을 테스트

GitLab Runner 1.0을 사용하면 변경 사항을 로컬에서도 테스트할 수 있습니다. 터미널에서 다음을 실행하세요: 

# 도커 실행자를 사용하여 확인
gitlab-runner exec docker test:app

# 쉘 실행자를 사용하여 확인
gitlab-runner exec shell test:app

예제 프로젝트

Example PHP Project를 설정하였으며, 공개적으로 사용 가능한 인스턴스 실행자를 활용하여 GitLab.com에서 실행되는 편리한 예제입니다.

해acking 뭔가 해보고 싶으신가요? 포크하여 커밋하고 변경 사항을 푸시하세요. 곧바로 공개 실행자가 변경 사항을 수용하고 작업이 시작됩니다.