README

Behat 3 扩展，用于从测试结果生成 HTML 报告。此分支为每个步骤添加截图。

Twig 报告

Behat 2 报告

如何？

• 此工具可以轻松使用 composer 安装。
• 在 behat.yml 文件中定义格式化器
• 修改 behat.yml 文件中的设置

安装

先决条件

此扩展需要

• PHP 5.3.x 或更高版本
• Behat 3.x 或更高版本

通过 composer

使用 Composer 是保持套件更新的最简单方法

使用 composer 安装

$ composer require --dev dwt/behat-html-formatter

使用 composer.json 安装

将 BehatHtmlFormatterPlugin 添加到您的 composer.json 中的依赖项列表。

{
    "require": {
        "behat/behat": "3.*@stable",
        "dwt/behat-html-formatter": "0.1.*",
    },
    "minimum-stability": "dev",
    "config": {
        "bin-dir": "bin/"
    }
}

然后只需使用 composer 安装它

$ composer install --dev --prefer-dist

您可以在其 官方网页 上了解更多关于 Composer 的信息。

基本用法

通过在 behat.yml 中指定其类来激活扩展

# behat.yml
default:
  suites:
    default:
       contexts:
          - dwt\BehatHTMLFormatter\Context\ScreenshotContext:
               screenshotDir: build/html/behat/assets/screenshots
    ... # All your awesome suites come here
  formatters:
    html:
      output_path: %paths.base%/build/html/behat

  extensions:
    dwt\BehatHTMLFormatter\BehatHTMLFormatterExtension:
      name: html
      renderer: Twig,Behat2
      file_name: index
      print_args: true
      print_outp: true
      loop_break: true

命令行选项

将以下内容添加到您的 behat 命令中，以打印报告

behat --format html --out MYDIRECTORY

将格式设置为 html 将输出您下面配置的各种报告（Behat2、Twig、Minimal 等）

您还需要指定报告的输出目录为 MYDIRECTORY。

配置

格式化器配置

• output_path - Behat 将保存 HTML 报告的位置。使用 %paths.base% 构建完整路径。

扩展配置

• renderer - Behat 将使用的渲染引擎，因此 Behat 应输出的报告格式类型（允许多个报告格式，用逗号分隔）。允许的值有
• Behat2 - 用于生成类似于 Behat 2 生成的 HTML 报告。
• Twig - 基于Twig的新颖且更现代的格式。
• Minimal - 超级简约的 HTML 输出。
• file_name - （可选）Behat 将使用固定文件名，并在每次构建后覆盖相同文件。默认情况下，Behat 将使用随机名称创建新的 HTML 文件（例如 "renderer name"_"date hour"）。
• print_args - （可选）如果设置为 true，Behat 将将每个步骤的所有参数添加到报告中。（例如表格）
• print_outp - （可选）如果设置为 true，Behat 将将每个步骤的输出添加到报告中。（例如异常）
• loop_break - （可选）如果设置为 true，Behat 将在打印 Scenario Outlines 时在每个执行后添加分隔的换行符。

截图

存在将截图嵌入测试失败中的功能。

目前仅支持 png 图片格式。

为了嵌入截图，您需要使用您喜欢的 webdriver 捕获截图，并将其存储在以下文件路径格式中

results/html/assets/screenshots/{{feature_name}}/{{scenario_name}}.png

feature_name 和 scenario_name 变量需要是相关项目名称，且不含空格。

以下是一个 FeatureContext 方法的示例，它将在上述格式中生成图像文件

        /**
         * @BeforeScenario
         *
         * @param BeforeScenarioScope $scope
         *
         */
        public function setUpTestEnvironment($scope)
        {
            $this->currentScenario = $scope->getScenario();
        }

        /**
         * @AfterStep
         *
         * @param AfterStepScope $scope
         */
        public function afterStep($scope)
        {
            //if test has failed, and is not an api test, get screenshot
            if(!$scope->getTestResult()->isPassed())
            {
                //create filename string

               $featureFolder = preg_replace('/\W/', '', $scope->getFeature()->getTitle());
                  
                              $scenarioName = $this->currentScenario->getTitle();
                              $fileName = preg_replace('/\W/', '', $scenarioName) . '.png';

                //create screenshots directory if it doesn't exist
                if (!file_exists('results/html/assets/screenshots/' . $featureFolder)) {
                    mkdir('results/html/assets/screenshots/' . $featureFolder);
                }

                //take screenshot and save as the previously defined filename
                $this->driver->takeScreenshot('results/html/assets/screenshots/' . $featureFolder . '/' . $fileName);
                // For Selenium2 Driver you can use:
                // file_put_contents('results/html/assets/screenshots/' . $featureFolder . '/' . $fileName, $this->getSession()->getDriver()->getScreenshot());
            }
        }

请注意，currentScenario 变量需要位于类级别，并在 @BeforeScenario 方法中生成，因为 Behat 目前不支持在 @AfterStep 方法中获取当前 Scenario，而在该方法中生成截图

问题提交

当您需要额外的支持或发现某些奇怪的事情时，请随时创建一个新问题。

许可证和作者

作者： https://github.com/dutchiexl/BehatHtmlFormatterPlugin/contributors