基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

PHP中文网
發布: 2016-07-30 13:29:30
原創
3671 人瀏覽過

基於Jenkins 搭建持續整合環境 的基礎上,繼續介紹Jenkins結合php專案實現自動化測試和自動部署。廢話不再多說,直接上工作。

宅鳥所使用的server為Ubuntu

   要實現在jenkins中實現php的自動化測試,首先需要Jenkins伺服器上安裝php測試框架,php的測試框架很多,在這裡我們選擇PHPUnit Framework.

PHPUnit的安裝很簡單:

sudo apt-get install phpunit
登入後複製

如果出現如下錯誤:

PHP Warning: require_once(PHP/CodeCoverage/Filter.php): failed to open stream: No such file or directory 
in /usr/bin/phpunit on line 39
PHP Fatal error: require_once(): Failed opening required 'PHP/CodeCoverage/Filter.php' 
(include_path='.:/usr/share/php:/usr/share/pear') in /usr/bin/phpunit on line 39
登入後複製

可以透過下面方法安裝:

sudo pear channel-discover pear.phpunit.de
sudo pear channel-discover pear.symfony-project.com
sudo pear channel-discover components.ez.no
sudo pear channel-discover pear.symfony.com
sudo pear update-channels
sudo pear upgrade-all
sudo pear install pear.symfony.com/Yaml
sudo pear install --alldeps phpunit/PHPUnit
sudo pear install --force --alldeps phpunit/PHPUnit
登入後複製

安裝後執行phpunit --version 傳回版本資訊。表示安裝成功。

root@dop-kvm-2:# phpunit --version
PHPUnit 3.7.28 by Sebastian Bergmann.
登入後複製

下面我們開始給Jenkins一些插件:

Subversion/Git:用於集成項目版本控制軟體,根據需要選擇(在上篇博文已安裝使用)

Phing/Ant:使用Phing或Apache Ant 對PHP專案做自動化建置

CheckStyle:使用PHP CodeSniffer進行程式碼風格檢查的工具。用於檢查PHP程式碼是否有違反一組預先設定好的編碼標準的一個PEAR包,內建了ZEND,PEAR的編碼風格規則

Clover PHP:使用phpunit進行單元測試的工具,可以被xdebug擴充用來生成程式碼覆蓋率報告,並且可以與phing整合來自動測試,還可以和Selenium整合來完成大型自動化整合測試

DRY:使用PHPCPD(php copy paste detector)來發現專案中的重複程式碼

HTML Publisher:用來發布phpunit程式碼覆蓋率報告

JDepend:使用PHP Depend分析php中靜態程式碼,用來檢查專案中的程式碼規模和複雜度

Plot:使用phploc來統計php專案規模大小的工具,可以統計php的專案程式碼行數

PMD:使用phpmd(php mess dector),對基於pdepend的結果進行分析,一旦專案超過了pdepend中各具體指標的規定,將發出警告訊息.

Violations:按照程式碼缺陷嚴重性集中顯示pwd靜態程式碼分析的結果

xUnit:使用JUnit的格式來輸出phpunit的日誌檔案


注意這些插件是jenkins為php專案所提供的一些插件,但並不是必須的,所以宅

注意這些插件是jenkins為php專案所提供的一些插件,但並不是必須的,所以宅鳥只把最值得大家關注的怎麼自動化測試、打包和發布來講解大家。

先給出專案的目錄結構:

root@dop-kvm-2:/home/jenkins/api# tree
.
├── aa.php
├── build.xml
├── create.php
└── test
    ├── DemoTest.php
    └── FunctionTest.php
1 directory, 5 files
登入後複製

注意:

aa.php、create.php是專案的程式檔案

test目錄下的DemoTest.php和FunxtionTest.php是專案的測試檔案

test目錄下的DemoTest.php和FunxtionTest.php是專案的測試檔案

.xml是jenkins持續整合測試打包部署的呼叫檔案


先給專案所需的build.xml檔案:

<?xml version="1.0" encoding="UTF-8"?>
<project name="api" default="build">
        <target name="build" depends="make_runtime,phpcs-ci,phploc,pdepend,phpcb,phpunit,phpdox,phpcpd"/>
        <property name="version-m"  value="1.1" />
        <property name="version"    value="1.1.0" />
        <property name="stability"  value="stable" />
        <property name="releasenotes" value="" />
        <property name="tarfile"     value="${phing.project.name}.${buildnumber}.${buildid}.tar.gz" />
        <property name="pkgfile"     value="${phing.project.name}.${version}.tgz" />
        <property name="distfile"    value="dist/${tarfile}" />
        <property name="tests.dir" value="test" />
        <fileset id="api.tar.gz" dir=".">
            <include name="test/**"/>
            <include name="*.php"/>
            <include name="*.xml"/>
        </fileset>
        <target name="make_runtime">
                <mkdir dir="${project.basedir}/Runtime" />
                <mkdir dir="${project.basedir}/build/logs" />
                <mkdir dir="${project.basedir}/build/pdepend" />
                <mkdir dir="${project.basedir}/build/code-browser" />
        </target>
        <target name="phpcs" description="Find coding standard violations using PHP_CodeSniffer">
                <exec executable="phpcs">
                        <arg value="--standard=${project.basedir}/build/phpcs.xml" />
                        <arg value="--ignore=autoload.php" />
                        <arg path="${project.basedir}/" />
                </exec>
        </target>
        <target name="phpcs-ci" description="Find coding standard violations using PHP_CodeSniffer">
                <exec executable="phpcs" output="${project.basedir}/build/build.log">
                        <arg value="--report=checkstyle" />
                        <arg value="--report-file=${project.basedir}/build/logs/checkstyle.xml" />
                        <arg value="--standard=${project.basedir}/build/phpcs.xml" />
                        <arg value="--ignore=" />
                        <arg path="${project.basedir}/" />
                </exec>
        </target>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
        <target name="phploc" description="Measure project size using PHPLOC">
                <exec executable="phploc">
                        <arg value="--log-csv" />
                        <arg value="${project.basedir}/build/logs/phploc.csv"/>
                        <arg path="${project.basedir}/"/>
                </exec>
        </target>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
        <target name="pdepend" description="Calculate software metrics using PHP_Depend">
                <exec executable="pdepend">
                        <arg value="--jdepend-xml=${project.basedir}/build/logs/jdepend.xml"/>
                        <arg value="--jdepend-chart=${project.basedir}/build/pdepend/dependencies.svg"/>
                        <arg value="--overview-pyramid=${project.basedir}/build/pdepend/overview-pyramid.svg"/>
                        <arg path="${project.basedir}/"/>
                </exec>
        </target>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
        <target name="phpmd" description="Perform project mess detection using PHPMD">
                <exec executable="phpmd">
                        <arg path="${project.basedir}/"/>
                        <arg value="text"/>
                        <arg value="${project.basedir}/build/phpmd.xml"/>
                </exec>
        </target>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
        <target name="phpmd-ci" description="Perform project mess detection using PHPMD">
                <exec executable="phpmd">
                        <arg path="${project.basedir}/"/>
                        <arg value="xml"/>
                        <arg value="${project.basedir}/build/phpmd.xml"/>
                        <arg value="--reportfile"/>
                        <arg value="${project.basedir}/build/logs/pmd.xml"/>
                </exec>
        </target>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
        <target name="phpcpd" description="Find duplicate code using PHPCPD">
                <exec executable="phpcpd">
                        <arg value="--log-pmd"/>
                        <arg value="${project.basedir}/build/logs/pmd-cpd.xml"/>
                        <arg path="${project.basedir}/"/>
                </exec>
        </target>
        <target name="phpdox" description="Generate API documentation using phpDox">
                <exec executable="phpdox"/>
        </target>
        <target name="phpunit" description="Run unit tests with PHPUnit">
                <exec executable="phpunit" />
        </target>
        <target name="test" description="Run PHPUnit tests">
            <phpunit haltonerror="true" haltonfailure="true" printsummary="true">
            <batchtest>
            <fileset dir="${tests.dir}">
                <include name="**/*Test.php" />
            </fileset>
            </batchtest>
            </phpunit>
        </target>
        <target name="phpcb" description="Aggregate tool output with PHP_CodeBrowser">
                <exec executable="phpcb">
                        <arg value="--log"/>
                        <arg path="${project.basedir}/build/logs"/>
                        <arg value="--source"/>
                        <arg path="${project.basedir}/"/>
                        <arg value="--output"/>
                        <arg path="${project.basedir}/build/code-browser"/>
                </exec>
        </target>
        <target name="check" description="Check variables" >
            <fail unless="version" message="Version not defined!" />
            <fail unless="buildnumber" message="buildnumber not defined!" />
            <fail unless="buildid" message="buildid not defined!" />
            <delete dir="dist" failonerror="false" />
            <mkdir dir="dist" />
        </target>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
        <target name="tar" depends="check" description="Create tar file for release">
            <echo msg="Creating distribution tar for ${phing.project.name} ${version}"/>
            <delete file="${distfile}" failonerror="false"/>
            <tar destfile="${distfile}" compression="gzip">
                <fileset refid="api.tar.gz"/>
            </tar>
        </target>
</project>
登入後複製

閱讀build.xml後,大家可以了解一下內容:


閱讀build.xml後,大家可以了解一下內容: 、版本、打後的套件名稱:

<project name="api" default="build">
        <target name="build" depends="make_runtime,phpcs-ci,phploc,pdepend,phpcb,phpunit,phpdox,phpcpd"/>
        <property name="version-m"  value="1.1" />
        <property name="version"    value="1.1.0" />
        <property name="stability"  value="stable" />
        <property name="releasenotes" value="" />
        <property name="tarfile"     value="${phing.project.name}.${buildnumber}.${buildid}.tar.gz" />
        <property name="pkgfile"     value="${phing.project.name}.${version}.tgz" />
        <property name="distfile"    value="dist/${tarfile}" />
        <property name="tests.dir" value="test" />
登入後複製

打包時包含的檔案和資料夾:這裡還可以使用exclude排除檔案和資料夾:

<fileset id="api.tar.gz" dir=".">
           <include name="test/**"/>
           <include name="*.php"/>
           <include name="*.xml"/>
       </fileset>
登入後複製

測試檔案所在位址:

<target name="phpunit" description="Run unit tests with PHPUnit">
                <exec executable="phpunit" />
        </target>
        <target name="test" description="Run PHPUnit tests">
            <phpunit haltonerror="true" haltonfailure="true" printsummary="true">
            <batchtest>
            <fileset dir="${tests.dir}">
                <include name="**/*Test.php" />
            </fileset>
            </batchtest>
            </phpunit>
        </target>
登入後複製

了解這些後,我們開始在了解這些後,我們開始在了解這些後,我們開始在了解這些後,我們開始在了解這些後,我們開始在了解這些後,我們開始在理解jenkins中新建autoTestTarAndPublish項目,選擇:建立一個自由風格的軟體專案:

並且指定好程式碼庫:如圖所示

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署然後再增加建置步驟->Invoke Phing targets:

然後再增加建置步驟->Invoke Phing targets:

然後再增加建置步驟: test,tar 分別與build.xml中的test,tar名稱相對應

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

給tar加上參數:

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

然後在左邊主選單: 系統管理->系統設定-Publish.下新增主機:(這裡宅鳥設定使用ssh免密碼登陸)需要設定成從jenkins到要發佈的web伺服器的無密碼登陸

如圖設定:

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署


這裡新增設定的主機名是:134


接下來我們就可以設定部署工作了:

在新增建置步驟下來表中選擇:Send files or execute commands over SSh,如果該選項未出現需要在插件管理中安裝插件:Publish Over SSH 然後重啟jenkins即可.

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

然後在出現的SSH Publishers中選擇要發布的主機:

並填寫打包文件地址,發佈到遠程打包文件地址信息,並在Execserver command文本框中填入解壓縮等shell腳本:

詳情請見圖:

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

此項設定完畢後,就可以發布php專案到134伺服器上了:


最後檔案發布包的存檔工作:發佈包的存檔工作:發佈包

增加建置後操作步驟:

填写dist/*.tar.gz

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

至此配置完毕后,点击 保存 按钮.我们就可以发布程序到指定服务器134上了.


来看一下发布结果:

回到项目左侧点击:立即构建:可以看到构建进度条,结束后可以在控制台看到输出结果:

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

我们来到134上看:

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

至此发布完毕.


此时我们查看一下test/DemoTest.php文件内容:

<?php
class DemoTest extends PHPUnit_Framework_TestCase {
  public function testPass() {
      $this->assertTrue(true);
    }
  public function testFail() {
      $this->assertFalse(false);
    }
}
?>
登入後複製
登入後複製

我们把 testFail()改成下面:

<?php
class DemoTest extends PHPUnit_Framework_TestCase {
  public function testPass() {
      $this->assertTrue(true);
    }
  public function testFail() {
     $this->assertTrue(false);
    }
}
?>
登入後複製

$this->assertTrue(false);

这个是错误的断定:

提交文件后再次构建:

我们可以看到本次构建失败,查看输出结果如下:

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

当把测试用例修改回正确后,执行构建,发布正确。

<?php
class DemoTest extends PHPUnit_Framework_TestCase {
  public function testPass() {
      $this->assertTrue(true);
    }
  public function testFail() {
      $this->assertFalse(false);
    }
}
?>
登入後複製
登入後複製

基於Jenkins 實現php專案的自動化測試、自動打包和自動部署

ok,到此介绍结束.

总结一下:

jenkins根据项目根目录下的build.xml文件,并根据jenkins中targets的配置,首先自动执行test,当测试通过后,开始执行tar,打包完成后,开始链接远程webserver把程序包上传到远程webserver指定目录下,然后再根据jenkins下的command 执行解压操作,然后就可以根据自己的业务通过shell脚本进行自动处理自动发布的各项操作.


如果在执行test过程中,出现发现测试用例不通过,则就发出错误报告,终止本次构建。


以上就是基于Jenkins 实现php项目的自动化测试、自动打包和自动部署的内容,更多相关内容请关注PHP中文网(www.php.cn)!


來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板