Merge pull request #211 from DataDog/anmarchenko/cucumber_better_test…

…_skipping

[SDTEST-481] Skip Before/After hooks in cucumber when scenario is skipped by intelligent test runner

lib/datadog/ci/contrib/cucumber/instrumentation.rb

@@ -21,6 +21,14 @@ def formatters
               @datadog_formatter ||= CI::Contrib::Cucumber::Formatter.new(@configuration)
               [@datadog_formatter] + existing_formatters
             end
+
+            def begin_scenario(test_case)
+              if Datadog::CI.active_test&.skipped_by_itr?
+                raise ::Cucumber::Core::Test::Result::Skipped, CI::Ext::Test::ITR_TEST_SKIP_REASON
+              end
+
+              super
+            end
           end
         end
       end

lib/datadog/ci/contrib/cucumber/patcher.rb

@@ -3,13 +3,12 @@
 require "datadog/tracing/contrib/patcher"
 
 require_relative "instrumentation"
-require_relative "step"
 
 module Datadog
   module CI
     module Contrib
       module Cucumber
-        # Patcher enables patching of 'cucumber' module.
+        # Patches 'cucumber' gem.
         module Patcher
           include Datadog::Tracing::Contrib::Patcher
 
@@ -21,7 +20,6 @@ def target_version
 
           def patch
             ::Cucumber::Runtime.include(Instrumentation)
-            ::Cucumber::Core::Test::Step.include(Datadog::CI::Contrib::Cucumber::Step)
           end
         end
       end

spec/datadog/ci/contrib/cucumber/features/step_definitions/steps.rb

@@ -1,5 +1,17 @@
 require_relative "helpers/helper"
 
+Before do
+  Datadog::CI.active_test.set_tag("cucumber_before_hook_executed", "true")
+end
+
+After do
+  Datadog::CI.active_test.set_tag("cucumber_after_hook_executed", "true")
+end
+
+AfterStep do
+  Datadog::CI.active_test.set_tag("cucumber_after_step_hook_executed", "true")
+end
+
 Then "datadog" do
   Helper.help?
 end

spec/datadog/ci/contrib/cucumber/instrumentation_spec.rb

@@ -236,6 +236,11 @@
 
         itr_skipped_test = test_spans.find { |span| span.name == "cucumber scenario" }
         expect(itr_skipped_test).to have_test_tag(:itr_skipped_by_itr, "true")
+
+        # check that hooks are not executed for skipped tests
+        expect(itr_skipped_test.get_tag("cucumber_before_hook_executed")).to be_nil
+        expect(itr_skipped_test.get_tag("cucumber_after_hook_executed")).to be_nil
+        expect(itr_skipped_test.get_tag("cucumber_after_step_hook_executed")).to be_nil
       end
 
       it "sets session level tags" do

vendor/rbs/cucumber/0/cucumber.rbs

@@ -9,6 +9,7 @@ end
 
 class Cucumber::Runtime
   def formatters: () -> untyped
+  def begin_scenario: (untyped test_case) -> void
 end
 
 module Cucumber::Formatter
@@ -23,6 +24,9 @@ class Cucumber::Core::Test::Result
   def undefined?: () -> bool
   def message: () -> String
   def exception: () -> untyped
+
+  class Skipped < StandardError
+  end
 end
 
 module Cucumber::Core::Test::Step