PHP自动化测试：Codeception快速入门

Codeception是PHP自动化测试的优选框架，它简化测试流程，集成单元、功能与验收测试，降低学习成本。相比PHPUnit，其统一API更易读写，支持自然语言描述，适合团队协作。安装使用Composer命令即可完成，初始化后生成配置文件codeception.yml并设置环境参数。编写测试分三类：1.单元测试基于PHPUnit，用generate:test unit创建，验证类方法；2.功能测试用Cest类和FunctionalTester模拟组件交互，如登录流程；3.验收测试通过AcceptanceTester模拟用户操作，检验整体行为。模块化设计提供REST、WebDriver等工具，增强测试能力。运行时加--coverage可生成代码覆盖率报告，支持CI持续集成工具自动执行测试与报告上传，提升项目质量与开发效率。

PHP自动化测试，用Codeception是个不错的选择，它上手快，集成了多种测试类型，能帮你快速搭建起测试体系。

Codeception入门

Codeception是一个PHP的完整堆栈测试框架。它允许你用统一的语法编写单元测试、集成测试和验收测试。它旨在简化测试过程，使开发者能够专注于编写高质量的代码，而不是花费大量时间配置和维护测试环境。

Codeception相比PHPUnit有什么优势？

PHPUnit是PHP测试界的标准，但Codeception更进一步，它整合了单元测试、功能测试和验收测试，用一套统一的API搞定所有。这意味着你不用在不同的测试框架之间切换，学习成本大大降低。而且，Codeception的测试用例更易读，更接近自然语言，这对于团队协作和代码维护非常有帮助。当然，PHPUnit在单元测试方面可能更精细，但如果你想快速构建一个全面的测试体系，Codeception绝对值得考虑。

如何安装和配置Codeception？

安装Codeception非常简单，推荐使用Composer：

composer require codeception/codeception --dev

安装完成后，你需要初始化Codeception环境：

./vendor/bin/codecept bootstrap

这会在你的项目根目录下创建tests目录，其中包含_bootstrap.php、_envs、_output等目录，以及codeception.yml配置文件。

接下来，你需要配置codeception.yml文件，指定测试环境、数据库连接等信息。例如：

namespace: App\Tests
actor: Tester
paths:
    tests: tests
    output: tests/_output
    data: tests/_data
    support: tests/_support
envs:
    dev:
        modules:
            config:
                Yii2:
                    configFile: 'config/test.php' # Yii2 specific
    prod:
        modules:
            config:
                Yii2:
                    configFile: 'config/prod.php' # Yii2 specific
extensions:
    enabled:
        - Codeception\Extension\RunFailed

这个配置文件定义了测试命名空间、测试路径、输出路径等。你还可以根据需要配置不同的测试环境，例如dev和prod。

如何编写第一个单元测试？

Codeception的单元测试基于PHPUnit，但提供了一些额外的特性。创建一个新的单元测试文件：

./vendor/bin/codecept generate:test unit User

这会在tests/unit目录下创建一个UserTest.php文件。打开这个文件，你会看到类似下面的代码：

setName('John Doe');
        $this->assertEquals('John Doe', $user->getName());
    }
}

这个例子测试了User类的setName和getName方法。_before和_after方法分别在每个测试用例执行前后执行。

运行测试：

./vendor/bin/codecept run unit

如何编写功能测试？

功能测试用于测试应用程序的不同组件之间的交互。创建一个新的功能测试文件：

./vendor/bin/codecept generate:test functional Login

这会在tests/functional目录下创建一个LoginTest.php文件。你需要配置functional.suite.yml文件，指定应用程序的入口文件和数据库连接等信息。

一个简单的功能测试例子：

amOnPage('/login');
    }

    public function testLoginWithValidCredentials(\App\Tests\FunctionalTester $I)
    {
        $I->fillField('username', 'admin');
        $I->fillField('password', 'password');
        $I->click('Login');
        $I->see('Welcome, admin!');
    }

    public function testLoginWithInvalidCredentials(\App\Tests\FunctionalTester $I)
    {
        $I->fillField('username', 'invalid');
        $I->fillField('password', 'invalid');
        $I->click('Login');
        $I->see('Invalid username or password.');
    }
}

这个例子测试了登录功能。$I是FunctionalTester类的实例，它提供了一系列方法来模拟用户操作，例如amOnPage、fillField、click、see等。

运行测试：

./vendor/bin/codecept run functional

如何编写验收测试？

验收测试用于测试整个应用程序的行为，模拟真实用户的操作。创建一个新的验收测试文件：

./vendor/bin/codecept generate:test acceptance Home

这会在tests/acceptance目录下创建一个HomeTest.php文件。你需要配置acceptance.suite.yml文件，指定浏览器、URL等信息。

一个简单的验收测试例子：

amOnPage('/');
    }

    public function testHomePageWorks(\App\Tests\AcceptanceTester $I)
    {
        $I->see('Welcome to my website!');
        $I->seeLink('About', '/about');
        $I->click('About');
        $I->see('About me');
    }
}

这个例子测试了首页的功能。$I是AcceptanceTester类的实例，它提供了一系列方法来模拟用户操作，例如amOnPage、see、seeLink、click等。

运行测试：

./vendor/bin/codecept run acceptance

如何使用Codeception的模块？

Codeception的模块提供了一系列预定义的动作和断言，可以简化测试用例的编写。常用的模块包括：

• Asserts: 提供标准的PHPUnit断言。
• Filesystem: 提供文件系统操作的API。
• PhpBrowser: 提供模拟HTTP请求的API。
• WebDriver: 提供通过Selenium WebDriver控制浏览器的API。
• Doctrine2: 提供与Doctrine ORM交互的API。
• REST: 提供与REST API交互的API。

你可以在codeception.yml文件中配置要使用的模块。例如：

modules:
    enabled:
        - Asserts
        - PhpBrowser:
            url: http://localhost
        - REST:
            url: http://api.localhost

然后，你就可以在测试用例中使用这些模块提供的API。例如：

haveHttpHeader('Content-Type', 'application/json');
        $I->sendGET('/users');
        $I->seeResponseCodeIsSuccessful();
        $I->seeResponseIsJson();
        $I->seeResponseContainsJson([
            'id' => 1,
            'name' => 'John Doe',
        ]);
    }
}

这个例子使用REST模块测试了一个REST API。$I->haveHttpHeader设置了HTTP头，$I->sendGET发送了一个GET请求，$I->seeResponseCodeIsSuccessful断言响应码是成功的，$I->seeResponseIsJson断言响应是JSON格式的，$I->seeResponseContainsJson断言响应包含指定的JSON数据。

如何生成代码覆盖率报告？

Codeception可以生成代码覆盖率报告，帮助你了解测试的覆盖程度。首先，你需要安装php-code-coverage和xdebug扩展。然后，在运行测试时加上--coverage选项：

./vendor/bin/codecept run unit --coverage

这会在tests/_output目录下生成coverage.xml和coverage.html文件，分别包含XML格式和HTML格式的代码覆盖率报告。你可以使用phpcov工具将XML格式的报告转换为其他格式，例如：

./vendor/bin/phpcov merge tests/_output/coverage.xml coverage
./vendor/bin/phpcov html coverage coverage-html

这会将XML格式的报告合并到coverage目录，并生成HTML格式的报告到coverage-html目录。

如何与持续集成工具集成？

Codeception可以很容易地与持续集成工具集成，例如Jenkins、Travis CI、GitLab CI等。你需要在CI配置文件中添加运行测试的命令：

script:
  - composer install
  - ./vendor/bin/codecept run acceptance

这会在每次代码提交时自动运行验收测试。你还可以配置CI工具生成代码覆盖率报告，并将其上传到代码覆盖率服务，例如Codecov或Coveralls。

Codeception是一个强大的PHP自动化测试框架，它可以帮助你快速构建一个全面的测试体系，提高代码质量，减少bug。通过学习和实践，你一定能掌握Codeception，并将其应用到你的项目中。