PyCharm 2025.3 Help

Cucumber.js

Cucumber.js 是针对行为驱动的 JavaScript 开发的测试框架。 Cucumber.js 测试使用可读性强的 Gherkin 语言编写,并存储在具有 功能 扩展名的 feature 文件中。 PyCharm 与 Cucumber.js 集成,并能识别用 Gherkin 编写的功能,因此您可以直接在 IDE 中运行 Cucumber.js 测试。

开始之前

  1. 要使用 Cucumber.js 6.0.0+,请确保您使用 PyCharm 2020.3.1 或更高版本。

  2. 请确保您的计算机上已安装 Node.js

  3. 请确保已在 设置 | 插件 页面、 已安装 选项卡中启用了必需插件 JavaScript and TypeScriptGherkin。 有关详细信息,请参阅 管理插件

  4. 请在 设置 | 插件 页面、 Marketplace 选项卡中安装并启用 Cucumber.js 插件,具体请参阅 从 JetBrains Marketplace 安装插件

安装 Cucumber.js

  • 在嵌入式 终端Alt+F12 )中,输入以下命令之一:

    • npm install cucumber :在您的项目中进行本地安装。

    • npm install -g cucumber :进行全局安装。

    • npm install --save-dev cucumber :将 Cucumber.js 作为 开发依赖项 进行安装。

    另请参阅 Cucumber.js 官方网站上的 Cucumber.js 演示

创建测试定义

借助 PyCharm,您可以使用 JavaScript 或 TypeScript 编写步骤定义。 PyCharm 会检测并突出显示缺少定义的步骤,并建议使用快速修复生成它们。

  1. 将插入符号置于没有定义的步骤上,按下 Alt+Enter ,然后选择 创建步骤定义创建所有步骤定义

    创建 Cucumber.js 步骤定义:快速修复

    或者,将鼠标悬停在该步骤上,并使用弹出窗口中的链接。

    创建 Cucumber.js 步骤定义:从弹出窗口调用操作
  2. 在打开的对话框中,指定新文件的名称以及用于编写定义的语言。

    创建 Cucumber.js 步骤定义:选择语言版本

    如果已存在此类文件,PyCharm 会显示一个弹出窗口,您需要在其中选择要将定义添加到的文件,或选择创建新文件。

运行测试

Cucumber.js 测试只能通过运行/调试配置启动。

创建 Cucumber.js 运行配置

  1. 打开 运行/调试配置 对话框(主菜单中的 运行 | 编辑配置 ),在左侧窗格中点击 添加按钮 ,然后在列表中选择 Cucumber.js。 将打开 运行/调试配置: Cucumber.js 对话框。

  2. 功能文件或目录 字段中,指定要运行的测试。 输入特定 .feature 文件的路径,或者如果您希望运行多个 feature,请输入文件夹路径。

  3. 指定要使用的 Node.js 运行时。

    如果您选择 项目 别名,PyCharm 将自动使用 JavaScript 运行时 页面上 Node 运行时 字段中的项目默认解释器。 在大多数情况下,PyCharm 会检测到项目默认运行时,并自动填充该字段。

    您还可以选择其他已配置的本地或远程解释器,或者点击 浏览按钮 并配置一个新的解释器。

  4. Cucumber 包 字段中,指定 cucumber 包所在文件夹的路径。

  5. 指定应用程序的工作目录。 默认情况下, 工作目录 字段显示项目根文件夹。 要更改此预定义设置,请指定目标文件夹的路径。

  6. 可选:

    • 名称筛选器 字段中,输入要运行的特定场景名称,而不是 feature 文件或目录中的所有场景。

    • 指定要传递给可执行文件的命令行参数,例如 -r--require LIBRARY|DIR-t--tags TAG_EXPRESSION ,或 --coffee。 有关详细信息,请参阅通过 cucumber-js --help 命令提供的内置帮助。

    • 环境变量 字段中,指定应用程序的环境变量。

通过运行配置运行测试

  1. 选择 Cucumber.js 运行/调试配置,然后在列表或工具栏中点击 运行图标  。

  2. 运行 工具窗口的 测试运行器 选项卡中,监控测试执行并分析测试结果。 有关详细信息,请参阅 Explore test results

从测试文件运行测试

  • 要运行单个测试,请在编辑器中打开测试文件,将插入符号置于要运行的场景处,然后从上下文菜单中选择 运行场景:<scenario name>

  • 要运行单个测试文件中的所有测试,请在编辑器中打开该测试文件,或在 项目 工具窗口中选中它,然后从上下文菜单中选择 运行 <test filename>

在任一情况下,PyCharm 会创建一个运行/调试配置,您可以保存并在以后使用。

调试测试

通过运行配置调试测试

  1. 选择 Cucumber.js 运行/调试配置,然后在列表或工具栏中点击 调试图标 &#xa0;。

  2. 运行 工具窗口的 测试运行器 选项卡中,监控测试执行并分析测试结果。 有关详细信息,请参阅 Explore test results

从测试文件调试测试

  • 要调试单个测试, 设置断点 (如有必要),将插入符号置于要调试的场景处,然后从上下文菜单中选择 调试场景:<scenario name>

  • 要调试单个测试文件中的所有测试,请在编辑器中打开该测试文件,或在 项目 工具窗口中选中它,然后从上下文菜单中选择 调试 <test filename>

在任一情况下,PyCharm 会创建一个运行/调试配置,您可以保存并在以后使用。

运行并调试用 TypeScript 编写的测试

  1. 创建 Cucumber.js 运行/调试配置 如上所述

  2. 启动前 区域,点击 添加按钮 ,从列表中选择 编译 TypeScript ,然后指定要使用的 tsconfig.json 文件。 PyCharm 将在运行 Cucumber.js 之前,使用此 tsconfig.json 运行 TypeScript 编译器。

    Cucumber.js 运行配置:添加 编译 TypeScript 启动前任务
  3. 要调试用 TypeScript 编写的测试,请打开您的 tsconfig.json ,并将 "sourceMap": true 设置为启用源映射。

借助 PyCharm,您可以在文件与相关测试文件之间跳转,或从 测试运行器选项卡 中的测试结果跳转到测试。

  • 要在测试与其被测代码之间或反向跳转,请在编辑器中打开该文件,并从上下文菜单中选择 转到 | 测试(S)转到 | 被测对象 ,或直接按 Ctrl+Shift+T

  • 要从 .feature 文件中的步骤跳转到步骤定义,请按住 Ctrl ,将鼠标悬停在该步骤上,并在其变成链接时点击该步骤。

  • 要从测试结果跳转到测试定义,请在 测试运行器 选项卡中双击测试名称,或从上下文菜单中选择 跳转到源 ,或直接按 F4。 测试文件会在编辑器中打开,并将插入符号置于测试定义处。

配置语法高亮

您可以根据您的偏好和习惯配置 Cucumber.js 感知的语法高亮。

  1. 设置 对话框(Ctrl+Alt+S )中,转到 编辑器 | 配色方案 | Cucumber

  2. 选择配色方案,接受从默认设置继承的高亮设置,或按照 颜色与字体 中所述进行自定义。

最后修改日期: 2025年 12月 2日