使用 PHPUnit 进行测试


适用于 PHP 的 NetBeans IDE 支持 PHPUnit 自动测试。通过 PHPUnit,NetBeans IDE 可为 PHP 提供代码覆盖率,这与 IDE 为 Python 提供的代码覆盖率类似。测试输出将显示在功能丰富的输出窗口中,该窗口与 IDE 的 JUnit 和Python 测试运行器所使用的输出窗口相同。

NetBeans IDE 还支持将 Selenium 可移植测试框架与 PHPUnit 结合使用。Selenium 插件可以从更新中心获取。安装此插件会将 Selenium 服务器添加到 IDE 的已注册服务器中,并将 Selenium 测试选项添加到 PHP 菜单。

目录

要学习本教程,您需要具备以下软件和资源。

软件或资源

要求的版本

NetBeans IDE

PHP 下载包

PHP 引擎,包括 PEAR

版本 5。

Web 服务器

推荐使用 Apache HTTP Server 2.2。

PHPUnit

版本 3.4.0 或更高版本。

PHPUnit 的框架生成器

作为 PHPUnit 的版本。

安装 PHPUnit

使用 PEAR 安装 PHPUnit(如 PHPUnit 文档中所述)和 PHPUnit 的框架生成器(如框架生成器文档中所述)。应安装 PHPUnit 版本 3.4.0 或更高版本。无需任何特殊设置。安装 PHPUnit 之后,NetBeans 便可识别它。请注意,您需要将 PEAR 随 PHP 引擎一起安装。另请注意,PHPUnit 文档中指出 PHPUnit 通常会安装到本地 PEAR 目录。该文档还给出了具体的路径:/usr/lib/php/PHPUnit;但在适用于 Windows 的 XAMPP 上,此路径为 XAMPP_HOME\php\PEAR\PHPUnit。

要检查 NetBeans IDE 是否可以识别您的 PHPUnit 安装,请打开 "Tools"(工具)>"Options"(选项)(在 Mac 上,请打开 "NetBeans Preferences"(NetBeans 首选项))并查看 "PHP" 窗口。打开 "UnitTesting"(单元测试)标签。此时应显示您的 PHPUnit 和框架生成器脚本的路径。如果没有显示脚本,请单击空字段旁边的 "Search"(搜索)。IDE 将在您的本地系统中搜索该脚本。或者,单击 "Browse"(浏览)浏览查找脚本。

创建并运行 PHPUnit 测试

NetBeans IDE 可以对某个文件中的所有 PHP 类创建并运行 PHPUnit 测试。为确保测试生成器可以正常运行,请为 PHP 文件指定与该文件中的第一类相同的名称。

为某个类创建并运行 PHPUnit 测试:

  1. 创建一个名为 Calculator 的 PHP 项目。在此项目中,创建一个名为 Calculator.php 的文件。在此文件中,键入或粘贴 PHPUnit 文档的 "Skeleton Generator"(框架生成器)一章中所提供的 Calculator 类。

2. <?php

3. class Calculator

4. {

5.     public function add($a, $b)

6.     {

7.         return $a + $b;

8.     }

9. }

?>

  1. 添加一个包含 @assert 标注以及一些样例输入和输出的注释块。请注意,本示例中包括一个错误的断言。

11.<?php

12.class Calculator

13.{

14.    /**

15.     * @assert (0,0) == 0

16.     * @assert (0,1) == 1

17.     * @assert (1,0) == 1

18.     * @assert (1,1) == 2

19.     * @assert (1,2) == 4

20.     */

21.    public functionadd($a, $b)

22.    {

23.        return $a +$b;

24.    }

25.}

?>

注:您可以使用标注代码完成来添加 @assert 标注。使用 Tab 键在参数之间导航,或者在填写参数值后单击Enter。

  1. 在 "Projects"(项目)窗口中,右键单击 "Calculator.php" 节点,然后选择 "Tools"(工具)> "Create PHPUnit Tests"(创建 PHPUnit 测试)。请注意,您可以在 "Source Files"(源文件)节点的上下文菜单中为项目中的所有文件创建测试。
  2. 第一次创建测试时,将会打开一个对话框,询问您要存储测试文件的目录。在本示例中,使用“浏览”功能创建了 tests 目录。

注:您可以手动为一个项目编写多个测试。如果编写多个测试,可以将它们分类到测试文件目录的子文件夹中,例如 "important" 或 "quick"。然后,可以通过右键单击某个子文件夹并选择 "Run Tests"(运行测试),来运行该文件夹中的测试。

  1. IDE 在一个名为 CalculatorTest.php 的文件中生成框架测试类,在 "Projects"(项目)窗口中会显示该文件,并在编辑器中将其打开。

请注意,将为每个 @assert 标注创建一个测试。

    /**

     * Generatedfrom @assert (1, 1) == 2.

     */

    public functiontestAdd4()

    {

       $this->assertEquals(

          2,

         $this->object->add(1, 1)

        );

    }

  1. 您既可以测试单个文件,也可以测试整个项目。要测试项目,请右键单击项目的父节点,然后选择 "Test"(测试)或按 Alt-F6 组合键。要测试 Calculator.php 文件,请右键单击该文件的节点,然后选择 "Test"(测试),或者按 Ctrl-F6/⌘-F6 组合键。本示例只有一个文件,且该文件中只有一个类,因此两种测试结果相同。IDE 会运行测试并在 "Test Results"(测试结果)窗口中显示结果。

测试结果的更详细文本版本会显示在 "Output"(输出)窗口中。

使用测试组

您可以选择要在测试套件运行期间执行的测试组。例如,可能有一些测试您希望只在生产环境中运行,而另一些测试在生产和开发环境中同时运行。您可以将前一种测试放在production 组中,而将后一种测试同时放在 production 和 development 组中。在开发环境中运行测试套件时,可以选择只执行 development 测试组。

必须首先对 PHP 项目启用测试组,然后才能对该项目中的所有文件使用测试组。

要将测试标记为测试组的一部分,请使用@group [groupname] 来标注测试方法。

创建和运行测试组:

  1. 在 "Projects"(项目)窗口中,右键单击 "Calculator" 节点,然后选择 "Properties"(属性)。"Project Properties"(项目属性)打开。
  2. 在 "Project Properties"(项目属性)中,选择 "PhpUnit" 类别。选择 "Ask for Test Groups Before Running Tests"(在运行测试之前询问测试组)。单击 "OK"(确定)。
  3. 在编辑器中打开 CalculatorTest.php。
  4. 为 testAdd、testAdd3 和 testAdd5 方法添加标注 @group production。
  5. 对于方法 testAdd2 和 testAdd4,添加标注 @group production 和 @group development。
  6. 右键单击 Calculator.php 节点,然后选择 "Test"(测试)。此时将会打开一个对话框,询问您要运行哪些测试组。选择 "development",然后单击 "OK"(确定)。IDE 只运行使用 @group development 标注的测试。

有关 NetBeans IDE 中 PhpUnit 测试组的详细信息,请参见 "NetBeans IDE for PHP" 博客帖子:Using PHP Unit Test Groups(使用 PHP 单元测试组)。

测试结果和 IDE 输出

PHPUnit 测试的结果会显示在 IDE 的 "Test Results"(测试结果)和"Output"(输出)两个窗口中。"Test Results"(测试结果)窗口包含一个图形窗格和一个简短文本窗格。“"Output"(输出)窗口提供了输出的更详细文本版本。在此部分,您将详细 了解 "Test Results"(测试结果)窗口和"Output"(输出)窗口。

在"Test Results"(测试结果)窗口中,您可以从下列位置获取有关失败的测试的信息:

  • UI 窗格中失败测试的树条目所附带的消息
  • 右侧窗格中的文本,其中包括指向失败的测试代码行的链接
  • 将光标悬停在 UI 窗格中失败的测试上时显示的工具提示文本

"Test Results"(测试结果)窗口在左侧包括以下按钮:

  • 重新运行测试按钮
  • 显示失败的测试
  • 显示通过的测试
  • 显示通过但出错的测试
  • 导航至下一个测试结果的按钮 ,以及导航至上一个测试结果的按钮

"Output"(输出)窗口显示 PHPUnit脚本的完整输出。当您无法通过 "Test Results"(测试结果)窗口中的信息找出错误原因时,该窗口会非常有用。与 "Test Results"(测试结果)窗口类似,"Output"(输出)窗口包括指向失败的测试类行的链接。它还在左侧包括用于重新运行测试和用于打开 "PHP Options"(PHP 选项)窗口的按钮。

代码覆盖率

适用于 PHP 的 NetBeans IDE 提供了代码覆盖率以及 PHPUnit 支持。(IDE 也为Python 提供了代码覆盖率)。代码覆盖率检查 PHPUnit 测试是否覆盖了所有方法。在此部分,您将了解如何通过现有 Calculator 类来使用代码覆盖率。

使用代码覆盖率:

  1. 打开 Calculator.php,然后添加内容与 add 函数相同的 add2 函数。现在,Calculator 类将如下所示:

2. <?php

3. class Calculator {

4.     /**

5.      * @assert (0, 0) == 0

6.      * @assert (0, 1) == 1

7.      * @assert (1, 0) == 1

8.      * @assert (1, 1) == 2

9.      * @assert (1, 2) == 4

10.     */

11.    public functionadd($a, $b) {

12.        return $a +$b;

13.    }

14. 

15.    public functionadd2($a, $b) {

16.        return $a +$b;

17.    }

18. 

19.}   

20.?>

  1. 右键单击项目节点。从上下文菜单中,选择 "Code Coverage"(代码覆盖率)> "Collect and Display Code Coverage"(收集并显示代码覆盖率)。默认情况下,"Show Editor Bar"(显示编辑器栏)也会处于选定状态。
  2. 现在,编辑器会在底部显示代码覆盖率编辑器栏。由于尚未测试代码覆盖率,因此编辑器栏报告覆盖率为 0%。(在单击 "Clear"(清除)以清除测试结果后,编辑器栏也会显示覆盖率为 0%。)
  3. 单击 "Test"(测试)以测试打开的文件,或单击 "All Tests"(所有测试)以运行项目的所有测试。此时显示 "Test Results"(测试结果)。此外,"Code Coverage"(代码覆盖率)栏会告知您测试所覆盖的可执行代码语句百分比。在编辑器窗口中,覆盖的代码将以绿色突出显示,未覆盖的代码将以红色突出 显示。

警告:如果在添加 add2 函数之后重新生成测试文件,则不会运行 PHPUnit 测试。这是因为 PHPUnit 创建了两个冲突的 testAdd2 函数。如果您计划对多个此类函数使用 PHPUnit,则不要通过在末尾附加数字的方式来区分函数。请参见PHPUnit 文档

  1. 在编辑器栏中,单击 "Report..."(报告...)。代码覆盖率报告打开,其中显示了对项目运行的所有测试的结果。使用报告中的按钮,您可以清除结果,再次运行所有测试或取消激活代码覆盖率(单击 "Done"(完成))。
  2. 您可以在项目中添加其他类;删除测试文件,然后重新创建测试文件;接下来,再次查看代码覆盖率报告。此时将会列出新类。在下面的报告中,Calculator 类又有一个函数未包括在测试中。

使用项目特定的配置

在IDE 中,可以为项目选择以下定制配置:

  • 引导文件
  • XML 配置文件
  • 测试套件
  • 定制 PHPUnit 脚本

要设置项目特定的配置,请执行以下操作:

  1. 右键单击项目节点或项目的 "Test Files"(测试文件)节点,然后选择 "Properties"(属性)。这会打开 "Properties"(属性)对话框。
  2. 选择 PHPUnit 类别。此时将打开一个对话框,可以在其中选择定制引导、XML 配置、PHPUnit 脚本或测试套件文件。
  3. 如果您不熟悉引导或 XML 配置文件的结构,可以使用 NetBeans IDE 生成框架。您还可以通过单击 "Help"(帮助)查找有关使用该对话框的说明。

使用定制类加载器的项目需要引导选项,例如,通过实现 Magic 函数 __autoload()。如果需要预先包含一个文件(如定义项目中的多个类所使用的全局常量的文件),则也需要使用引导选项。

可通过 XML 配置文件定义命令行调用中使用的选项。PHPUnit 手册中进行了完整介绍。还可以使用 XML 配置文件为测试用例定义 php.ini 设置和全局变量。也可以在 XML 配置文件中设置引导选项。

如果设置定制测试套件,每次选择 "Run"(运行)> "TestProject"(测试项目)时,都会运行该套件。如果要仅运行一部分测试,或者要使用最近添加(必须手动添加)的 PHPUnit 功能(如数据提供器),该功能特别有用。请注意,您可以根据需要定义多个测试套件,并通过在项目资源管理器中右键单击文件并选择 "run"(运行)来分别运行这些套件。为防止造成混乱,NetBeans会通知您是否使用定制测试套件。可以在 "Test Results"(测试结果)和 "Output"(输出)窗口中找到通知。

可以将定制 PHPUnit 脚本(而非 "Tools"(工具)> "Options"(选项)中所选的默认脚本)用于项目。定制PHPUnit 脚本可以包含 PHPUnit手册中描述的任何命令行开关。

 

没有更多推荐了,返回首页