欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  php教程

PHP开源项目使用Travis CI进行持续集成

程序员文章站 2022-05-02 09:15:19
...

一个项目如何保证代码质量是开发中非常重要的环节,对于开源项目来说更是如此,因为开源项目要面对的是来自不同水平开发者提交的代码。所以围绕开源做持续集成(Continuous Integration)变得越来越重要,而目前使用最广泛的免费CI工具当数Travis CI,以我的

一个项目如何保证代码质量是开发中非常重要的环节,对于开源项目来说更是如此,因为开源项目要面对的是来自不同水平开发者提交的代码。所以围绕开源做持续集成(Continuous Integration)变得越来越重要,而目前使用最广泛的免费CI工具当数Travis CI,以我的项目EvaThumber为例,来介绍一下如何在PHP开源项目中配合Travis CI进行持续集成

Travis CI能做的最主要工作是自动运行项目的单元测试并生成报告。例如进入EvaThumber的Travis CI页面,可以看到最新版本的测试情况,默认设置下,每次对项目进行Push时,都会触发Travis CI运行一次测试,测试环境包括PHP5.3与PHP5.4两个主流版本。Travis CI同时提供了一个项目状态图标,可以放置在项目主页告知用户当前的测试情况:

EvaThumber Master分支: PHP开源项目使用Travis CI进行持续集成

PHP项目的目录结构

如何开始一个PHP项目的持续集成,首先从项目的目录结构说起。目前的PHP项目一般都会遵守PHP-FIG制订的PSR规范,可以根据实际项目与团队的情况选择规范的严格程度,如果是新项目建议尽可能选择PSR-2或以上级别。

遵守规范的意义在于你的项目可以非常容易的集成到其他项目中,同时因为有了相同的代码书写约定,别人也更加容易阅读你的代码。所以越是优秀的PHP项目,越能严格的遵守规范,这会让整个PHP社区进入一个良性循环。

那么一个遵循PSR-2规范的PHP项目进行CI,推荐目录结构以及必须的文件如下:

src/
    EvaThumber/
        Thumber.php
tests/
    EvaThumberTest/
        ThumberTest.php
    Bootstrap.php
    phpunit.xml.dist
vendor/
.travis.yml
composer.json
LICENSE
  • src目录用于存放项目源代码,文件夹命名必须与命名空间一致,以便可以进行类的自动载入
  • tests 目录放置单元测试代码,推荐与src目录保持一样的结构,在文件夹与文件名后缀Test以避免重名。
  • tests/Bootstrap.php 不是必须的,但一般都会存在,主要用于初始化类的自动载入功能
  • tests/phpunit.xml.dist 是PHPUnit的配置文件,一般来说可以简单配置一下要测试的目录以及Bootstrap.php的位置,详细的可配置项参考官网说明
  • vendor 目录用于放置项目依赖的第三方类库。
  • .travis.yml 是Travis CI的配置文件,在这个文件中可以设置项目语言,测试环境等。可以参考Travis CI详细设置
  • composer.json 是Composer管理第三方类库依赖关系的配置文件,参考Composer详细文档
  • LICENSE 内文是当前项目使用的许可证

依赖管理并加入启动文件

EvaThumber依赖一些第三方项目,所以最终composer.json的内容如下:

{
    "name": "AlloVince/EvaThumber",
    "description": "EvaThumber",
    "license": "BSD-3-Clause",
    "homepage": "http://avnpc.com/",
    "require": {
        "php": ">=5.3.3",
        "imagine/Imagine": "dev-master"
    },
    "require-dev": {
        "rmccue/Requests": "dev-master@dev",
        "aferrandini/phpqrcode": "dev-master@dev",
        "symfony/process": "dev-master@dev"
    },
    "autoload": {
        "psr-0": {
            "Requests": "library/",
            "PHPQRCode": "lib/"
        }
    }
}

这个配置文件中首先定义了EvaThumber自己的名称,然后规定php运行环境必须大于等于5.3.3,并且列出了所有依赖项目的名称,autoload栏目则对PSR-0的项目的自动加载单独进行了处理。最终当EvaThumber项目被使用时,只需要在项目目录下运行

composer install

即可安装依赖。安装完毕后会生成vendor/autoload.php文件,由于单元测试也需要自动加载的支持,我们编写tests/Bootstrap.php为:

$loader = include __DIR__ . '/../vendor/autoload.php';
$loader->add('EvaThumber', __DIR__ . '/../src');

配置单元测试

有了单元测试的启动文件,为了在每次运行测试时加载,需要编写tests/phpunit.xml.dist为:

phpunit bootstrap="./Bootstrap.php" colors="true">