Ruby 用 Test Impact Analysis

Docs > Datadog の Test Optimization > Test Impact Analysis > Configure Test Impact Analysis > Ruby 用 Test Impact Analysis

互換性

Test Impact Analysis は、以下のバージョンとテストフレームワークでのみサポートされています。

datadog-ci >= 1.0
Ruby >= 2.7
- JRuby はサポートされていません。
rspec >= 3.0.0
minitest >= 5.0.0
cucumber >= 3.0.0

セットアップ

テスト最適化

Test Impact Analysis をセットアップする前に、先に Ruby 用 Test Optimization をセットアップしてください。Agent 経由でデータを送信している場合は、v6.40 以降または v7.40 以降を使用してください。

Activate Test Impact Analysis for the test service

You, or a user in your organization with the Intelligent Test Runner Activation (intelligent_test_runner_activation_write) permission, must activate Test Impact Analysis on the Test Service Settings page.

Test Impact Analysis enabled in test service settings in the CI section of Datadog.

Test Impact Analysis を有効にしてテストを実行する

セットアップが完了したら、通常どおりテストを実行してください。

特定のテストに対するスキップの無効化

Test Impact Analysis の動作を上書きし、特定のテストがスキップされないようにできます。これらのテストは unskippable テストと呼ばれます。

テストをスキップできないようにする理由は？

Test Impact Analysis はコードカバレッジデータを使用してテストをスキップすべきかどうかを判断します。場合によっては、このデータだけでは判断が不十分なことがあります。

例:

テキストファイルからデータを読み込むテスト
テスト対象のコード以外の API とやりとりするテスト (リモートの REST API など)
外部プロセスを実行するテスト
グローバルで共有される状態 (例: 別のテストやプロセスによって作成されるキャッシュ) に依存するテスト
フォークされたプロセスを使用するテスト (テストごとのコードカバレッジはメインプロセスのカバレッジのみを収集します)
capybara または selenium-webdriver を使用するインテグレーションテスト

テストを unskippable に指定すると、カバレッジデータに関係なく Test Impact Analysis によって常に実行されます。

unskippable テストの指定方法

特定のブロック内の RSpec テストがスキップされないようにするには、任意の describe、context、または it ブロックに、値 true を持つメタデータキー datadog_itr_unskippable を追加します。これにより、そのブロック内のすべてのテストが unskippable としてマークされます。

# ファイル全体を unskippable としてマークする
RSpec.describe MyClass, datadog_itr_unskippable: true do
  describe "#my_method" do
    context "when called without arguments" do
      it "works" do
      end
    end
  end
end

# 1 つのテストだけを unskippable としてマークする
RSpec.describe MyClass do
  describe "#my_method" do
    context "when called without arguments" do
      it "works", datadog_itr_unskippable: true do
      end
    end
  end
end

# 特定のブロックを unskippable としてマークする
RSpec.describe MyClass do
  describe "#my_method", datadog_itr_unskippable: true do
    context "when called without arguments" do
      it "works" do
      end
    end
  end
end

Cucumber でフィーチャファイル全体を unskippable にするには、タグ @datadog_itr_unskippable を使用します。これにより、そのフィーチャファイルに定義されているいずれのシナリオも Test Impact Analysis によってスキップされなくなります。

特定のシナリオだけを unskippable にしたい場合は、このタグを対象のシナリオに直接付与します。

@datadog_itr_unskippable
Feature: Unskippable feature
  Scenario: Say greetings
    When the greeter says greetings
    Then I should have heard "greetings"

Feature: An unskippable scenario

  @datadog_itr_unskippable
  Scenario: Unskippable scenario
    When the ITR wants to skip this scenario
    Then it will never be skipped

  Scenario: Skippable scenario
    When the ITR wants to skip this scenario
    Then it will be skipped

Minitest のサブクラス全体を unskippable にするには、datadog_itr_unskippable メソッドを使用します。サブクラス内の特定のテストだけを unskippable にしたい場合は、これらのテストメソッド名を datadog_itr_unskippable メソッド呼び出しの引数として指定します。

# クラス全体を unskippable としてマークする
class MyTest < Minitest::Test
  datadog_itr_unskippable

  def test_my_method
  end
end

# この例では test1 と test2 だけが unskippable
class MyTest < Minitest::Test
  datadog_itr_unskippable "test1", "test2"

  def test1
  end

  def test2
  end

  def test3
  end
end