终端执行在 .feature 场景步骤之前显示 .rb 步骤

Question

问题描述

我在使用 Ruby 创建 Cucumber 自动化时遇到了“问题”。我的终端在 .feature 场景步骤之前显示 .rb 步骤，这对于可读性来说真的很烦人。

Information
Ruby: 3.0.3p157
Terminal: Git 2.34.1
Cucumber: 7.1.0

我的功能文件包含：

@home_screen
Feature: Tests for home screen functionality

  @default
  Scenario: Default values on home screen is Foot and Centimeter
    Given I land on the home screen
    Then left unit picker value should be 'Foot'
    And right unit picker value should be 'Centimeter'

  Scenario: Show All button should be enabled at launch
    Given I land on home screen
    Then the Show All button is enabled
    When I press on Clear button
    Then the Show All button is disabled

  @conversions
  Scenario Outline: Verify default conversions
    Given I land on home screen
    When I type <target> to target field
    Then I should should see <result> as the result

      Examples:
      | target | result |
      | 1      | 12     |
      | 2      | 24     |
      | 3      | 36     |
      | 9      | 106    |

我的步骤定义包含：

Given('I land on home screen') do
  puts 'I am at the home screen'
end

Then('left unit picker value should be {string}') do |string|
  puts "left unit picker value is #{string}"
end

And('right unit picker value should be {string}') do |string|
  puts "right unit picker value is #{string}"
end

When('I press on Clear button') do
  puts 'Clear button is pressed'
end

When('I type {int} to target field') do |target|
  puts "Target is: #{target}."
end

Then(/the Show All button is (enabled|disabled)/) do |state|
  state == 'enabled' ? puts('Button is enabled') : puts('Button is disabled')
end

Then('I should should see {int} as the result') do |result|
  puts "Result is: #{result}."
end

一个场景的终端执行

预期输出

感谢您的宝贵时间！

Answer 1

将步骤视为断言，而不是消息生成器

在 Cucumber 中，步骤的主体在确定它执行的 Gherkin 语句是否成功之前执行。您遇到的问题是您将该步骤视为直接报告的结果，而不是作为使 Gherkin 语句通过或失败的测试断言。由于您的示例中每个步骤的主体都通过Kernel#puts 创建到 STDOUT 的输出，因此在知道相关 Gherkin 语句的状态之前，该步骤的输出可能会打印到屏幕上。在任何情况下，它都会将步骤中的消息打印到标准输出，因为步骤定义明确告诉它这样做。

与其直接从您的步骤打印结果，不如将步骤视为返回布尔值的断言。 cucumber-ruby documentation 提供了一些有用的例子。如果您认为 Gherkin 语句更像是 RSpec 描述，而 Cucumber 步骤更像是 RSpec 期望而不是状态消息，那么您将在标准输出上获得更合理的结果。

一些一般 BDD 建议

Cucumber 步骤实际上不应该首先将输出直接发送到 STDOUT，因为它会造成混乱（正如您所发现的那样）。而是：

• 如果您想记录某些内容，请使用Logger module。
• 如果您想打印步骤中的错误或其他信息，请使用 $stderr.puts 并通过 shell 重定向或 Ruby 文件句柄将其定向到终端以外的其他位置。
• 如果您使用 Cucumber 进行低级测试，请考虑将这些测试（尤其是任何嘈杂的测试）转移到 RSpec 或 MiniTest 单元测试，以免污染您的 Cucumber 测试或输出。

Cucumber 可以通过各种方式被滥用，但它不能替代单元测试或功能测试。与单元测试相比，它确实最适合集成测试和域级可执行文档，但您的应用范围可能会有所不同。