PhpStorm 2021.3 Help

PHP规范

使用 PhpStorm,您可以通过使用PHPSpec工具集运行规范来练习行为驱动的开发。

在你开始前

确保在PHP 页面上的 PhpStorm中配置了 PHP 解释器,如配置本地 PHP 解释器配置远程 PHP 解释器中所述。

使用 Composer 安装 PHPSpec

在开始之前,请确保 Composer 已安装在您的计算机上并在当前项目中初始化,如Composer 依赖项管理器中所述。

  1. composer.json中,将phpspec/phpspec依赖记录添加到requireorrequire-dev部分。按Ctrl+Space以获得包名称和版本的代码完成。

  2. 执行以下操作之一:

    • 单击编辑器面板顶部的安装快捷方式链接。

    • 如果启用了未安装的 Composer 包检查,PhpStorm 将突出显示当前未安装的已声明依赖项。按Alt+Enter并选择是否要一次安装特定依赖项或所有依赖项。

从PHPSpec 官网了解更多关于 PHPSpec 安装的信息。

点击composer.json设置/首选项按钮编辑器gutter中包记录旁边的,跳转到对应的Settings/Preferences页面,手动配置PHPSpec

composer.json 中 phpspec 设置的装订线图标

将 PHPSpec 与 PhpStorm 项目集成

如果您使用本地 PHP 解释器,PhpStorm 会自动执行初始 Codeception 配置。对于远程 PHP 解释器,需要手动配置 Codeception。

自动配置 PHPSpec

  1. phpspec.ymlphpspec.yml.dist配置文件存放在项目根目录下。

  2. 使用 Composer 安装 PHPSpec

PhpStorm 将在Test Frameworks 页面PHPSpec运行/调试配置上创建本地框架配置。

手动配置 PHPSpec

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到PHP | 测试框架

    在打开的测试框架页面上,单击添加图标中央窗格并从列表中选择配置类型:

    ps_settings_php_test_frameworks.png
    • 在本地配置中,使用默认项目 PHP 解释器,请参阅默认项目 CLI 解释器了解详细信息。

    • 要将 PHPSpec 与远程 PHP 解释器一起使用,请在打开的对话框中选择一种配置:

      ps_settings_php_test_frameworks_phpspec_choose_php_interpreter.png
  2. PHPSpec 可执行文件的路径字段中,指定phpspec的位置。PHPSpec 不一定必须安装在当前项目根目录下。单击Path to PHPSpec directory 或 phar 文件字段重新加载按钮旁边的。PhpStorm 检测 PHPSpec 的版本并将其显示在字段下方。

    如果没有为本地解释器指定 PHPSpec 的路径,则PhpStorm 不提供对 PHPSpec 的完全支持,例如,它不显示代码完成建议并且不解析引用。

  3. Test Runner区域中,指定配置YML文件以用于启动和执行规范。

    默认情况下,PHPSpec在项目根文件夹中查找phpspec.ymlphpspec.yml.dist配置文件。您可以指定自定义配置文件。

    • 清除默认配置文件复选框以使 PHPSpec 使用项目根文件夹中的phpspec.ymlphpspec.yml.dist配置文件。如果没有找到这样的文件,则测试执行失败,因此显式指定配置文件可能更可靠。

    • 选中默认配置文件复选框以指定您自己的YML配置文件。该文件稍后将在所有 PHPSpec 运行/调试配置中用作默认文件。

      在该字段中,指定要使用的配置文件的位置。手动键入路径或单击浏览按钮并在打开的对话框中选择文件。

    在本地配置中,Prefix ('spec_prefix'):只读字段显示规范的命名空间前缀。PhpStorm从默认配置文件字段spec_prefix中指定的配置文件中检测。默认值为spec。有关详细信息,请参阅PHPSpec 配置:PSR-4PHPSpec 配置:规范和源位置

为类生成 PHPSpec 测试

  1. 通过执行以下任一操作打开“创建新 PHP 测试”对话框:

    • 从主菜单中,选择文件 | 新的. 然后,选择 PHP 测试 | 上下文菜单中的PHPSpec Spec

    • Project工具窗口中,按Alt+Insert或右键单击要测试的 PHP 类并选择 New | PHP 测试 | PHPSpec 规范

    • 在要测试的 PHP 类的编辑器中,将插入符号放在类的定义处。然后,按并从弹出菜单中Alt+Enter选择创建新测试。这样,您可以为在单个 PHP 文件中的多个类中定义的 PHP 类生成测试。

      要为某个方法创建测试,请将插入符号放置在方法声明中。所选方法将在Create New PHP Test对话框的方法列表中自动选择。

  2. 创建新的PHP 测试对话框打开。

    创建新的 phpspec 测试对话框

    提供生成的测试的参数:

    • 测试文件模板,即 PhpStorm 生成测试类的模板。确保 在测试文件模板列表中选择了PHPSpec 。

    • 测试类的名称。PhpStorm 自动将生产类名称中的名称组合为 <production class>Spec.php

    • 测试类文件的文件夹,根据生产类的包含目录和命名空间、配置的测试源根目录及其psr-4 包前缀phpspec.yml配置文件src_path中指定的值 自动建议。请注意,要使自动文件夹建议正常工作,测试套件和生产类名称空间必须匹配。

      要指定不同的文件夹,请单击目录字段浏览按钮旁边的并选择相关文件夹。

    • 测试类所属的命名空间,根据生产类的包含目录和命名空间、配置的测试源根目录及其psr-4 包前缀phpspec.yml配置文件中指定的值 spec_prefix自动建议.namespace

    • 生成测试方法存根的生产类方法。选中所需的生产类方法旁边的复选框。要包括从父类继承的方法,请选中显示继承的方法复选框。

      PhpStorm 将自动将测试方法的名称组合为test<production method>. 您可以在文件和代码模板设置页面的代码选项卡上自定义用于生成测试方法存根的代码模板。

创建测试后,您可以通过选择Navigate |导航回生产类。转到测试主题。有关详细信息,请参阅在测试及其测试对象之间导航

运行和调试 PHPSpec 测试

有关编写PHPSpec 规范的信息,请参阅PHPSpec 文档。要运行或调试您的测试,请执行以下操作之一:

运行或调试 PHPSpec 测试

  • 在 Project 工具窗口中,选择要从中运行测试的文件或文件夹,然后从选择的上下文菜单中选择Run '<file or folder>'Debug '<file or folder>' :

    ps_test_frameworks_phpspec_launch_tests.png

    PhpStorm 生成默认运行配置并使用它启动运行/调试测试会话。

保存自动生成的默认配置

  • 测试会话结束后,从文件或文件夹的上下文菜单中选择保存 <default_test_configuration_name>

通过以前保存的运行/调试配置运行或调试测试

  • 从工具栏上的列表中选择所需的 PHPSpec 配置,然后单击运行按钮调试按钮

创建自定义运行/调试配置

  1. 在项目工具窗口中,选择要运行测试的文件或文件夹,然后从上下文菜单中选择创建运行配置。或者,选择运行 | 从主菜单编辑配置,然后单击并从列表中添加图标选择PHPSpec 。

  2. 在打开的PHPSpec对话框中,指定要运行的场景,选择要使用的PHP 解释器,并通过指定要传递给 PHP 可执行文件的选项和参数来自定义其行为。

监控测试结果

PhpStorm在Run 工具窗口的Test Runner 选项卡中显示测试执行结果。

ps_test_result_phpspec.png

该选项卡分为 2 个主要区域:

  • 左侧区域可让您深入了解所有单元测试以查看成功和失败的测试。您可以过滤测试、导出结果并使用上下文菜单命令运行特定测试或导航到源代码。

  • 右侧区域显示原始 PHPSpec 输出。

最后修改时间:2021 年 10 月 20 日