datadog-ci 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7641cbd9b01a787badb9bab7d3aa74933c99b750b46609c9a625ed3f7daaa11c
-  data.tar.gz: 5489c728c4b6c91ff68b515796533801b02dfb623f506da23849e60e343063a3
+  metadata.gz: 651794a9813c4b1b10909b0de41e4d25f90b95736815894f83356e03f9fa86d5
+  data.tar.gz: 1f8c32423bb4527c7faf6232acf842fcc6c3db404baf1e836e0d57bbd57a7d93
 SHA512:
-  metadata.gz: 3d2f41e5eb8f58c3eecb72200658add1799109c7778fad032c6d58ec2fd462a37df7e1a47edfb6cf7390e037c4e30ada85dc95c71983c30629de38b2bf62fd35
-  data.tar.gz: 408151cc04150bcc8ec2a0933c0f6d38cd1362b5842e8b145960ba276431681893988cfd0c49ce47f519ae9e7451549b45503a6ea79f123cfd4cc3750cb2a8ea
+  metadata.gz: 1c81e9f43de5457aa57aacfbacf2d432c47e0e8f9de68477d45ea9e20da3773687a0d85e79df51e73ce2c133c6e8432c9f8f9a83c35c65d0fe0f587e58968857
+  data.tar.gz: c37907789e0c3f0bbd9cc283d245f8be60d90c0c888bd707db7119b0e36375d3ae10227a7d08d43d448d2af6d42e339ffd4bdfce479028aef1e3b3de1549870b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.10.0] - 2024-12-05
+
+### Added
+
+* Skip before(:all) context hooks when all examples are skipped ([#262][])
+
 ## [1.9.0] - 2024-11-26
 
 ### Added
@@ -362,7 +368,8 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 
 - Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.9.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.10.0...main
+[1.10.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.9.0...v1.10.0
 [1.9.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.8.1...v1.9.0
 [1.8.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.8.0...v1.8.1
 [1.8.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.7.0...v1.8.0
@@ -521,4 +528,5 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#244]: https://github.com/DataDog/datadog-ci-rb/issues/244
 [#248]: https://github.com/DataDog/datadog-ci-rb/issues/248
 [#250]: https://github.com/DataDog/datadog-ci-rb/issues/250
-[#259]: https://github.com/DataDog/datadog-ci-rb/issues/259
+[#259]: https://github.com/DataDog/datadog-ci-rb/issues/259
+[#262]: https://github.com/DataDog/datadog-ci-rb/issues/262

data/lib/datadog/ci/contrib/rspec/example.rb

@@ -21,42 +21,25 @@ module Datadog
               return super if ::RSpec.configuration.dry_run? && !datadog_configuration[:dry_run_enabled]
               return super unless datadog_configuration[:enabled]
 
-              test_name = full_description.strip
-              if metadata[:description].empty?
-                # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
-                test_name << " #{description}"
-              end
-
-              test_suite_description = fetch_top_level_example_group[:description]
-              suite_name = "#{test_suite_description} at #{metadata[:example_group][:rerun_file_path]}"
-
-              # remove example group description from test name to avoid duplication
-              test_name = test_name.sub(test_suite_description, "").strip
-
-              if ci_queue?
-                suite_name = "#{suite_name} (ci-queue running example [#{test_name}])"
-                ci_queue_test_span = test_visibility_component.start_test_suite(suite_name)
-              end
+              test_suite_span = test_visibility_component.start_test_suite(datadog_test_suite_name) if ci_queue?
 
               # don't report test to RSpec::Core::Reporter until retries are done
               @skip_reporting = true
 
               test_retries_component.with_retries do
                 test_visibility_component.trace_test(
-                  test_name,
-                  suite_name,
+                  datadog_test_name,
+                  datadog_test_suite_name,
                   tags: {
                     CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                     CI::Ext::Test::TAG_FRAMEWORK_VERSION => datadog_integration.version.to_s,
                     CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(metadata[:file_path]),
                     CI::Ext::Test::TAG_SOURCE_START => metadata[:line_number].to_s,
-                    CI::Ext::Test::TAG_PARAMETERS => Utils::TestRun.test_parameters(
-                      metadata: {"scoped_id" => metadata[:scoped_id]}
-                    )
+                    CI::Ext::Test::TAG_PARAMETERS => datadog_test_parameters
                   },
                   service: datadog_configuration[:service_name]
                 ) do |test_span|
-                  test_span&.itr_unskippable! if metadata[CI::Ext::Test::ITR_UNSKIPPABLE_OPTION]
+                  test_span&.itr_unskippable! if datadog_unskippable?
 
                   metadata[:skip] = CI::Ext::Test::ITR_TEST_SKIP_REASON if test_span&.skipped_by_itr?
 
@@ -87,8 +70,8 @@ module Datadog
                 end
               end
 
-              # this is a special case for ci-queue, we need to finish the test suite span
-              ci_queue_test_span&.finish
+              # this is a special case for ci-queue, we need to finish the test suite span created for a single test
+              test_suite_span&.finish
 
               # after retries are done, we can finally report the test to RSpec
               @skip_reporting = false
@@ -106,6 +89,18 @@ module Datadog
               super(::RSpec::Core::NullReporter)
             end
 
+            def datadog_test_id
+              @datadog_test_id ||= Utils::TestRun.datadog_test_id(
+                datadog_test_name,
+                datadog_test_suite_name,
+                datadog_test_parameters
+              )
+            end
+
+            def datadog_unskippable?
+              !!metadata[CI::Ext::Test::ITR_UNSKIPPABLE_OPTION]
+            end
+
             private
 
             def fetch_top_level_example_group
@@ -129,6 +124,45 @@ module Datadog
               Datadog.configuration.ci[:rspec]
             end
 
+            def datadog_test_suite_description
+              @datadog_test_suite_description ||= fetch_top_level_example_group[:description]
+            end
+
+            def datadog_test_name
+              return @datadog_test_name if defined?(@datadog_test_name)
+
+              test_name = full_description.strip
+              if metadata[:description].empty?
+                # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
+                test_name << " #{description}"
+              end
+
+              # remove example group description from test name to avoid duplication
+              test_name = test_name.sub(datadog_test_suite_description, "").strip
+
+              @datadog_test_name = test_name
+            end
+
+            def datadog_test_suite_name
+              return @datadog_test_suite_name if defined?(@datadog_test_suite_name)
+
+              suite_name = "#{datadog_test_suite_description} at #{metadata[:example_group][:rerun_file_path]}"
+
+              if ci_queue?
+                suite_name = "#{suite_name} (ci-queue running example [#{datadog_test_name}])"
+              end
+
+              @datadog_test_suite_name = suite_name
+            end
+
+            def datadog_test_parameters
+              return @datadog_test_parameters if defined?(@datadog_test_parameters)
+
+              @datadog_test_parameters = Utils::TestRun.test_parameters(
+                metadata: {"scoped_id" => metadata[:scoped_id]}
+              )
+            end
+
             def test_visibility_component
               Datadog.send(:components).test_visibility
             end

data/lib/datadog/ci/contrib/rspec/example_group.rb

@@ -18,10 +18,17 @@ module Datadog
             def run(reporter = ::RSpec::Core::NullReporter)
               return super if ::RSpec.configuration.dry_run? && !datadog_configuration[:dry_run_enabled]
               return super unless datadog_configuration[:enabled]
+
+              # skip the context hooks if all descendant example are going to be skipped
+              # IMPORTANT: must happen before top_level? check because skipping hooks must happen
+              # even if it is a nested context
+              metadata[:skip] = true if all_examples_skipped_by_datadog?
+
+              # return early because we create Datadog::CI::TestSuite only for top-level example groups
               return super unless top_level?
 
               suite_name = "#{description} at #{file_path}"
-              test_suite = test_visibility_component.start_test_suite(
+              test_suite = test_visibility_component&.start_test_suite(
                 suite_name,
                 tags: {
                   CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(metadata[:file_path]),
@@ -47,6 +54,12 @@ module Datadog
 
             private
 
+            def all_examples_skipped_by_datadog?
+              descendant_filtered_examples.all? do |example|
+                !example.datadog_unskippable? && test_optimisation_component&.skippable?(example)
+              end
+            end
+
             def datadog_configuration
               Datadog.configuration.ci[:rspec]
             end
@@ -54,6 +67,10 @@ module Datadog
             def test_visibility_component
               Datadog.send(:components).test_visibility
             end
+
+            def test_optimisation_component
+              Datadog.send(:components).test_optimisation
+            end
           end
         end
       end

data/lib/datadog/ci/test.rb

@@ -17,6 +17,11 @@ module Datadog
         get_tag(Ext::Test::TAG_NAME)
       end
 
+      # @return [String] the test id according to Datadog's test impact analysis.
+      def datadog_test_id
+        @datadog_test_id ||= Utils::TestRun.datadog_test_id(name, test_suite_name, parameters)
+      end
+
       # Finishes the current test.
       # @return [void]
       def finish
@@ -140,22 +145,18 @@ module Datadog
 
       # @internal
       def any_retry_passed?
-        !!test_suite&.any_test_retry_passed?(test_id)
+        !!test_suite&.any_test_retry_passed?(datadog_test_id)
       end
 
       private
 
-      def test_id
-        @test_id ||= Utils::TestRun.datadog_test_id(name, test_suite_name, parameters)
-      end
-
       def record_test_result(datadog_status)
         # if this test was already executed in this test suite, mark it as retried
-        if test_suite&.test_executed?(test_id)
+        if test_suite&.test_executed?(datadog_test_id)
           set_tag(Ext::Test::TAG_IS_RETRY, "true")
         end
 
-        test_suite&.record_test_result(test_id, datadog_status)
+        test_suite&.record_test_result(datadog_test_id, datadog_status)
       end
     end
   end

data/lib/datadog/ci/test_optimisation/component.rb

@@ -144,11 +144,16 @@ module Datadog
           event
         end
 
+        def skippable?(test)
+          return false if !enabled? || !skipping_tests?
+
+          @skippable_tests.include?(test.datadog_test_id)
+        end
+
         def mark_if_skippable(test)
           return if !enabled? || !skipping_tests?
 
-          datadog_test_id = Utils::TestRun.datadog_test_id(test.name, test.test_suite_name, test.parameters)
-          if @skippable_tests.include?(datadog_test_id)
+          if skippable?(test)
             if forked?
               Datadog.logger.warn { "Intelligent test runner is not supported for forking test runners yet" }
               return
@@ -156,9 +161,9 @@ module Datadog
 
             test.set_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR, "true")
 
-            Datadog.logger.debug { "Marked test as skippable: #{datadog_test_id}" }
+            Datadog.logger.debug { "Marked test as skippable: #{test.datadog_test_id}" }
           else
-            Datadog.logger.debug { "Test is not skippable: #{datadog_test_id}" }
+            Datadog.logger.debug { "Test is not skippable: #{test.datadog_test_id}" }
           end
         end
 

data/lib/datadog/ci/version.rb

@@ -4,7 +4,7 @@ module Datadog
   module CI
     module VERSION
       MAJOR = 1
-      MINOR = 9
+      MINOR = 10
       PATCH = 0
       PRE = nil
       BUILD = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog