Codeception 技术文档

1. 安装指南

1.1 使用 Composer 安装

Codeception 可以通过 Composer 进行安装。首先，确保你已经安装了 Composer，然后在项目目录下运行以下命令：

php composer.phar require "codeception/codeception"

如果你需要安装特定的模块，例如 phpbrowser 模块，可以运行：

php composer.phar require "codeception/module-phpbrowser"

1.2 使用 Phar 安装

你也可以通过下载 codecept.phar 文件来安装 Codeception。首先，下载文件：

wget https://codeception.com/codecept.phar

然后，将文件设置为可执行文件，并将其移动到系统的 $PATH 中：

chmod +x codecept.phar
sudo mv codecept.phar /usr/local/bin/codecept

安装完成后，你可以通过命令行运行 Codeception，例如：

codecept bootstrap
codecept run

2. 项目的使用说明

2.1 初始化项目

安装完成后，你可以通过以下命令初始化 Codeception 项目：

codecept bootstrap

该命令会创建一个默认的目录结构和测试套件。

2.2 编写测试

Codeception 支持多种测试类型，包括接受测试、功能测试和单元测试。以下是一个简单的接受测试示例：

$I->amOnPage('/');
$I->click('Pages');
$I->click('New');
$I->see('New Page');
$I->submitForm('form#new_page', ['title' => 'Movie Review']);
$I->see('page created'); // 提示信息
$I->see('Movie Review','h1'); // 页面标题
$I->seeInCurrentUrl('pages/movie-review'); // URL 包含 slug
$I->seeInDatabase('pages', ['title' => 'Movie Review']); // 数据库中存在数据

对于单元测试，你可以继续使用经典的 PHPUnit 测试，Codeception 也可以运行这些测试。

2.3 运行测试

你可以通过以下命令运行测试：

codecept run

该命令会运行所有测试套件中的测试。

3. 项目 API 使用文档

Codeception 提供了丰富的 API 来帮助你编写测试。以下是一些常用的 API 示例：

3.1 页面操作

• amOnPage('/')：导航到指定页面。
• click('Link Text')：点击页面上的链接。
• see('Text')：检查页面是否包含指定文本。

3.2 表单操作

• submitForm('form#id', ['field' => 'value'])：提交表单。
• fillField('field', 'value')：填充表单字段。

3.3 数据库操作

• seeInDatabase('table', ['field' => 'value'])：检查数据库中是否存在指定记录。
• dontSeeInDatabase('table', ['field' => 'value'])：检查数据库中是否不存在指定记录。

4. 项目安装方式

Codeception 提供了两种主要的安装方式：

4.1 使用 Composer 安装

通过 Composer 安装是最常见的方式，适用于大多数 PHP 项目。安装命令如下：

php composer.phar require "codeception/codeception"

4.2 使用 Phar 安装

如果你不想使用 Composer，可以通过下载 codecept.phar 文件来安装 Codeception。安装步骤如下：

1. 下载 codecept.phar 文件。
2. 将文件设置为可执行文件，并将其移动到系统的 $PATH 中。
3. 通过命令行运行 Codeception。

这两种安装方式都可以让你快速开始使用 Codeception 进行测试。