Подготовка и сборка проекта PHP в Дженкинс

В предыдущей статье мы рассмотрели установку Jenkins и подготовили все, чтобы начать работу. Мы продолжим в этой статье, фактически подготовив наш проект. Если у вас уже есть готовая установка Jenkins, вам не нужно проходить предыдущую часть — вы можете очень хорошо выполнить ее.

Подготовить композитора

Мы собираемся подготовить наш проект в первую очередь. Мы могли бы использовать проект, предоставленный Себастьяном Бергманном, но это скорее базовый проект, и он без проблем будет работать в Дженкинсе. В этой статье мы будем использовать другой репозиторий, в котором нам придется преодолеть некоторые препятствия. Мы будем использовать форк Jumph в качестве основы.

Прежде всего, мы должны убедиться, что у нас есть такие инструменты, как PHPUnit и PHP-CodeSniffer. Мы можем сделать это двумя разными способами. Либо мы устанавливаем пакеты на наш сервер Jenkins через Pear или Composer глобально, либо определяем зависимости в нашем файле composer.json Я решил использовать последний метод, чтобы мы могли легко контролировать версию этих инструментов как на нашей локальной машине, так и на Jenkins. Поэтому мы начнем с добавления следующих строк в файл composer.jsoncomposer update

 "require-dev": {
    "squizlabs/php_codesniffer": "~1.5.*",
    "phpmd/phpmd": "~2.1.*",
    "sebastian/phpcpd": "~2.0.*",
    "pdepend/pdepend": "~2.0.*",
    "phploc/phploc": "~2.0.*",
    "phpunit/phpunit": "~4.3.*",
    "theseer/phpdox": "~0.7.*",
},

Если вы хотите узнать больше о том, что делает каждый пакет, посмотрите статью Бруно об инструментах PHP QA .

Подготовить муравей

На нашем сервере Jenkins мы будем использовать Ant . Так что, если Ant еще не установлен на вашем сервере, убедитесь, что это, выполнив следующую команду.

 sudo apt-get install ant

Ant помогает автоматизировать процесс сборки программного обеспечения. Вы определяете задачи, называемые целями, в файле конфигурации. Ant прочитает этот файл и выполнит соответствующее действие. Вы можете определить зависимости, чтобы указать, в каком порядке Ant должен выполнять эти задачи. Файл конфигурации — это так называемый файл build.xml Мы собираемся добавить это в наш проект, чтобы Ant мог выполнять эти задачи на нашем сервере Jenkins. Мы собираемся использовать шаблон, предоставленный Себастьяном Бергманном, который можно найти здесь . Мы добавляем это в корень нашего проекта.

Чтобы запустить Ant, вы можете запустить ant build Это означает, что Ant запустит цель build Если параметр не указан, Ant запустит цель, как указано в конфигурации по умолчанию, которая в этом случае также является build

Давайте внимательнее посмотрим на цель build

 <target name="build" depends="prepare,lint,phploc-ci,pdepend,phpmd-ci,phpcs-ci,phpcpd-ci,phpunit,phpdox" description=""/>

Цель пуста, однако это зависит от множества других целей. Сначала он запустит цель preparelint Давайте посмотрим на цель phploc-ci, например.

 <target name="phploc-ci" depends="prepare" description="Measure project size using PHPLOC and log result in CSV and XML format. Intended for usage within a continuous integration environment.">
    <exec executable="${toolsdir}phploc">
        <arg value="--count-tests"/>
        <arg value="--log-csv"/>
        <arg path="${basedir}/build/logs/phploc.csv"/>
        <arg value="--log-xml"/>
        <arg path="${basedir}/build/logs/phploc.xml"/>
        <arg path="${basedir}/src"/>
        <arg path="${basedir}/tests"/>
    </exec>
</target>

Эту цель довольно легко понять. Вы заметите, что это зависит от цели prepare Так как он уже был запущен целью build Затем мы получаем исполняемый файл phploc Вы установили это ранее с помощью Composer. Наконец, мы увидим конкретные аргументы PHPLOC. Ant запустит следующий ввод командной строки на основе этой целевой конфигурации.

 phploc --count-tests --log-csv /build/logs/phploc.csv --log-xml /build/logs/phploc.xml /src /tests

${toolsdir}${basedir} В зависимости от того, как они настроены, они могут влиять на общий вывод командной строки

Как указано выше, если вы хотите запустить только эту цель, вы должны запустить ant phploc-ci

Обратите внимание, что эта команда phploc.csvphploc.xmlbuild.xml Плагины, установленные в Jenkins ранее, будут, например, читать эти файлы и конвертировать их в графики. В следующей статье мы углубимся в эту тему.

Если вы посмотрите весь файл phpunit.xml build / phpmd.xml , build / phpdox.xml и build / phpunit.xml . Эти файлы конфигурации запрашиваются фактическими инструментами. Чтобы узнать больше, посмотрите их соответствующие документы.

 build.xml

 build.xml

 parameters.yml

 <target name="copy-parameters" description="Copy parameters.yml file">
  <exec executable="cp" failonerror="true">
   <arg path="app/config/parameters.yml.dist" />
   <arg path="app/config/parameters.yml" />
  </exec>
 </target>

 curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/bin/composer

sudo apt-get install nodejs
sudo apt-get install npm
sudo npm install -g bower
sudo ln -s /usr/bin/nodejs /usr/bin/node #This is needed on certain linux distro's.

 <target name="composer" description="Installing composer dependencies">
 <exec executable="composer" failonerror="true">
  <arg value="install" />
  <arg value="--dev" />
  <arg value="--prefer-dist" />
  <arg value="--no-progress" />

  <env key="SYMFONY_ENV" value="test"/>
 </exec>
</target>

 <target name="bower" description="Installing bower dependencies">
 <exec executable="bower" failonerror="true">
  <arg value="install" />
 </exec>
</target>

 <target name="build" depends="prepare,copy-parameters,bower,composer,lint,phploc-ci,pdepend,phpmd-ci,phpcs-ci,phpcpd-ci,phpunit,phpdox" description=""/>

 # build
!build/phpmd.xml
!build/phpunit.xml
!build/phpdox.xml
build/*