Merge pull request #226 from DataDog/anmarchenko/itr_fix_code_coverag…

…e_for_retries_and_telemetry

[SDTEST-740] Minor telemetry fixes

lib/datadog/ci/test.rb

@@ -70,6 +70,12 @@ def skipped_by_itr?
         get_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR) == "true"
       end
 
+      # Returns "true" if test span represents a retry.
+      # @return [Boolean] true if this test is a retry, false otherwise.
+      def is_retry?
+        get_tag(Ext::Test::TAG_IS_RETRY) == "true"
+      end
+
       # Marks this test as unskippable by the intelligent test runner.
       # This must be done before the test execution starts.
       #

lib/datadog/ci/test_optimisation/component.rb

@@ -99,6 +99,7 @@ def code_coverage?
 
         def start_coverage(test)
           return if !enabled? || !code_coverage?
+
           Telemetry.code_coverage_started(test)
           coverage_collector&.start
         end
@@ -109,13 +110,15 @@ def stop_coverage(test)
           Telemetry.code_coverage_finished(test)
 
           coverage = coverage_collector&.stop
+
+          # if test was skipped, we discard coverage data
+          return if test.skipped?
+
           if coverage.nil? || coverage.empty?
             Telemetry.code_coverage_is_empty
             return
           end
 
-          return if test.skipped?
-
           test_source_file = test.source_file
 
           # cucumber's gherkin files are not covered by the code coverage collector

sig/datadog/ci/test.rbs

@@ -11,6 +11,7 @@ module Datadog
       def itr_unskippable!: () -> void
       def source_file: () -> String?
       def parameters: () -> String?
+      def is_retry?: () -> bool
 
       private
 

spec/datadog/ci/test_optimisation/component_spec.rb

@@ -235,6 +235,21 @@
         expect(subject).to be_nil
         expect(writer).not_to have_received(:write)
       end
+
+      it_behaves_like "emits no metric", :inc, Datadog::CI::Ext::Telemetry::METRIC_CODE_COVERAGE_IS_EMPTY
+    end
+
+    context "when test is skipped and coverage is not collected" do
+      before do
+        test_span.skipped!
+      end
+
+      it "does not write coverage event" do
+        expect(subject).to be_nil
+        expect(writer).not_to have_received(:write)
+      end
+
+      it_behaves_like "emits no metric", :inc, Datadog::CI::Ext::Telemetry::METRIC_CODE_COVERAGE_IS_EMPTY
     end
 
     context "when coverage was not collected" do
@@ -333,6 +348,8 @@
         expect { subject }
           .not_to change { component.skipped_tests_count }
       end
+
+      it_behaves_like "emits no metric", :inc, Datadog::CI::Ext::Telemetry::METRIC_ITR_SKIPPED
     end
 
     context "test is skipped by ITR" do
@@ -363,6 +380,8 @@
         expect { subject }
           .not_to change { component.skipped_tests_count }
       end
+
+      it_behaves_like "emits no metric", :inc, Datadog::CI::Ext::Telemetry::METRIC_ITR_SKIPPED
     end
   end
 

spec/datadog/ci/test_spec.rb

@@ -322,4 +322,24 @@
       expect(ci_test.parameters).to eq(parameters)
     end
   end
+
+  describe "#is_retry?" do
+    subject(:is_retry) { ci_test.is_retry? }
+
+    context "when tag is set" do
+      before do
+        allow(tracer_span).to(
+          receive(:get_tag).with(Datadog::CI::Ext::Test::TAG_IS_RETRY).and_return("true")
+        )
+      end
+
+      it { is_expected.to be true }
+    end
+
+    context "when tag is not set" do
+      before { allow(tracer_span).to receive(:get_tag).with(Datadog::CI::Ext::Test::TAG_IS_RETRY).and_return(nil) }
+
+      it { is_expected.to be false }
+    end
+  end
 end

spec/support/contexts/telemetry_spy.rb

@@ -38,6 +38,15 @@ def telemetry_spy_value_suffix(value)
     end
   end
 
+  shared_examples_for "emits no metric" do |metric_type, metric_name|
+    it "emits no :#{metric_type} metric #{metric_name}" do
+      subject
+
+      metric = telemetry_metric(metric_type, metric_name)
+      expect(metric).to be_nil
+    end
+  end
+
   def telemetry_metric(type, name)
     @metrics[type].find { |m| m.name == name }
   end