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 emuse/behat-html-formatter

使用 composer.json 安装

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

{
    "require": {
        "behat/behat": "3.*@stable",
        "emuse/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:
    ... # All your awesome suites come here

  formatters:
    html:
      output_path: %paths.base%/build/html/behat

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

配置

格式化器配置

• 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 将在每个执行后添加分隔换行符。

截图

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

当前仅支持 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 方法（其中生成截图）中获取当前场景。

问题提交

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

许可证和作者

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