datadog-ci 1.0.0.beta3 → 1.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 335897204d48926d8c0e3ab1ef8e7c6247a88b12627e27e021614f1b368ab788
-  data.tar.gz: db5b4ac716d7e0f28712cb7fef86c1f438f2a8b5fa28af0bb67ef91d3758d1c0
+  metadata.gz: 035d75d50e0e09c7895bc0e434c5ac1e0655618763ac724a94989833e0c07d61
+  data.tar.gz: bfbd5d6ff101ef51e59d3546d110f906f178c23602241f85b3a8b413524a9900
 SHA512:
-  metadata.gz: c2ebd289964298131bed28406316a48992aaec8e54a6fb21f58ffb6c3d2c523f49fbc5aedf83c9f72a5b8ba45c54cce6df46b8d83eae6ce42804a8901954b61c
-  data.tar.gz: dd1fcd1c56179c0ab933d166801f69cb843efe67449ad69e7491ee674ff3325fcb9b1adb814881a80137d24de6fa264103ad02d71b73c814acf84a56b706a707
+  metadata.gz: c1b6463b913cbff1e20a2c3f4fcaa6c47814ba693eee5682fa41c3baa74f9e92414b4e554ec8407807d6eeb1744f0c76d87bb0889bd0e639c6ebdc3de1dcd180
+  data.tar.gz: dca4568f30dbaef22e8fac94389e682beb21ba6f92f0578553ff01d2ad289f38d33f899c79bef604f3f83906d6c31b9e64a9495cc3dc986fb321bd810430780d

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [1.0.0.beta4] - 2024-05-14
+
+### Added
+
+* Knapsack Pro 7/RSpec 3 support ([#172][])
+* add settings option to ignore code coverage for bundled gems location ([#174][])
+* log an error message if tracing is disabled but test visibility is enabled ([#175][])
+
+### Removed
+
+* remove deprecated use alias ([#173][])
+
 ## [1.0.0.beta3] - 2024-04-30
 
 ### Added
@@ -226,7 +238,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/v0.8.3...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta4...main
+[1.0.0.beta4]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta3...v1.0.0.beta4
 [1.0.0.beta3]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta2...v1.0.0.beta3
 [1.0.0.beta2]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta1...v1.0.0.beta2
 [1.0.0.beta1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.3...v1.0.0.beta1
@@ -321,3 +334,7 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#166]: https://github.com/DataDog/datadog-ci-rb/issues/166
 [#167]: https://github.com/DataDog/datadog-ci-rb/issues/167
 [#168]: https://github.com/DataDog/datadog-ci-rb/issues/168
+[#172]: https://github.com/DataDog/datadog-ci-rb/issues/172
+[#173]: https://github.com/DataDog/datadog-ci-rb/issues/173
+[#174]: https://github.com/DataDog/datadog-ci-rb/issues/174
+[#175]: https://github.com/DataDog/datadog-ci-rb/issues/175

data/ext/datadog_cov/datadog_cov.c

@@ -5,10 +5,35 @@
 #define DD_COV_TARGET_FILES 1
 #define DD_COV_TARGET_LINES 2
 
+static int is_prefix(VALUE prefix, const char *str)
+{
+  if (prefix == Qnil)
+  {
+    return 0;
+  }
+
+  const char *c_prefix = RSTRING_PTR(prefix);
+  if (c_prefix == NULL)
+  {
+    return 0;
+  }
+
+  long prefix_len = RSTRING_LEN(prefix);
+  if (strncmp(c_prefix, str, prefix_len) == 0)
+  {
+    return 1;
+  }
+  else
+  {
+    return 0;
+  }
+}
+
 // Data structure
 struct dd_cov_data
 {
   VALUE root;
+  VALUE ignored_path;
   int mode;
   VALUE coverage;
 };
@@ -18,6 +43,7 @@ static void dd_cov_mark(void *ptr)
   struct dd_cov_data *dd_cov_data = ptr;
   rb_gc_mark_movable(dd_cov_data->coverage);
   rb_gc_mark_movable(dd_cov_data->root);
+  rb_gc_mark_movable(dd_cov_data->ignored_path);
 }
 
 static void dd_cov_free(void *ptr)
@@ -32,6 +58,7 @@ static void dd_cov_compact(void *ptr)
   struct dd_cov_data *dd_cov_data = ptr;
   dd_cov_data->coverage = rb_gc_location(dd_cov_data->coverage);
   dd_cov_data->root = rb_gc_location(dd_cov_data->root);
+  dd_cov_data->ignored_path = rb_gc_location(dd_cov_data->ignored_path);
 }
 
 const rb_data_type_t dd_cov_data_type = {
@@ -49,6 +76,7 @@ static VALUE dd_cov_allocate(VALUE klass)
   VALUE obj = TypedData_Make_Struct(klass, struct dd_cov_data, &dd_cov_data_type, dd_cov_data);
   dd_cov_data->coverage = rb_hash_new();
   dd_cov_data->root = Qnil;
+  dd_cov_data->ignored_path = Qnil;
   dd_cov_data->mode = DD_COV_TARGET_FILES;
   return obj;
 }
@@ -66,6 +94,8 @@ static VALUE dd_cov_initialize(int argc, VALUE *argv, VALUE self)
     rb_raise(rb_eArgError, "root is required");
   }
 
+  VALUE rb_ignored_path = rb_hash_lookup(opt, ID2SYM(rb_intern("ignored_path")));
+
   VALUE rb_mode = rb_hash_lookup(opt, ID2SYM(rb_intern("mode")));
   if (!RTEST(rb_mode) || rb_mode == ID2SYM(rb_intern("files")))
   {
@@ -84,6 +114,7 @@ static VALUE dd_cov_initialize(int argc, VALUE *argv, VALUE self)
   TypedData_Get_Struct(self, struct dd_cov_data, &dd_cov_data_type, dd_cov_data);
 
   dd_cov_data->root = rb_root;
+  dd_cov_data->ignored_path = rb_ignored_path;
   dd_cov_data->mode = mode;
 
   return Qnil;
@@ -100,20 +131,15 @@ static void dd_cov_update_line_coverage(rb_event_flag_t event, VALUE data, VALUE
     return;
   }
 
-  if (dd_cov_data->root == Qnil)
+  // if given filename is not located under the root, we skip it
+  if (is_prefix(dd_cov_data->root, filename) == 0)
   {
     return;
   }
 
-  char *c_root = RSTRING_PTR(dd_cov_data->root);
-  if (c_root == NULL)
-  {
-    return;
-  }
-  long root_len = RSTRING_LEN(dd_cov_data->root);
-  // check that root is a prefix of the filename
-  // so this file is located under the given root
-  if (strncmp(c_root, filename, root_len) != 0)
+  // if ignored_path is provided and given filename is located under the ignored_path, we skip it too
+  // this is useful for ignoring bundled gems location
+  if (RTEST(dd_cov_data->ignored_path) && is_prefix(dd_cov_data->ignored_path, filename) == 1)
   {
     return;
   }

data/lib/datadog/ci/configuration/components.rb

@@ -43,6 +43,16 @@ module Datadog
         end
 
         def activate_ci!(settings)
+          unless settings.tracing.enabled
+            Datadog.logger.error(
+              "CI visibility requires tracing to be enabled. Disabling CI visibility. " \
+              "NOTE: if you didn't disable tracing intentionally, add `c.tracing.enabled = true` to " \
+              "your Datadog.configure block."
+            )
+            settings.ci.enabled = false
+            return
+          end
+
           # Configure ddtrace library for CI visibility mode
           # Deactivate telemetry
           settings.telemetry.enabled = false
@@ -107,7 +117,8 @@ module Datadog
             dd_env: settings.env,
             config_tags: custom_configuration_tags,
             coverage_writer: coverage_writer,
-            enabled: settings.ci.enabled && settings.ci.itr_enabled
+            enabled: settings.ci.enabled && settings.ci.itr_enabled,
+            bundle_location: settings.ci.itr_code_coverage_excluded_bundle_path
           )
 
           git_tree_uploader = Git::TreeUploader.new(api: test_visibility_api)

data/lib/datadog/ci/configuration/settings.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../ext/settings"
+require_relative "../utils/bundle"
 
 module Datadog
   module CI
@@ -67,6 +68,14 @@ module Datadog
                 o.default true
               end
 
+              option :itr_code_coverage_excluded_bundle_path do |o|
+                o.type :string, nilable: true
+                o.env CI::Ext::Settings::ENV_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH
+                o.default do
+                  Datadog::CI::Utils::Bundle.location
+                end
+              end
+
               define_method(:instrument) do |integration_name, options = {}, &block|
                 return unless enabled
 
@@ -89,9 +98,6 @@ module Datadog
                 fetch_integration(integration_name).configuration
               end
 
-              # @deprecated Will be removed on datadog-ci-rb 1.0.
-              alias_method :use, :instrument
-
               option :trace_flush
 
               option :writer_options do |o|

data/lib/datadog/ci/contrib/rspec/knapsack_pro/extension.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "knapsack_pro/extensions/rspec_extension"
+
+require_relative "runner"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Instrument RSpec::Core::Example
+        module KnapsackPro
+          module Extension
+            def self.included(base)
+              base.singleton_class.prepend(ClassMethods)
+            end
+
+            module ClassMethods
+              def setup!
+                super
+
+                ::RSpec::Core::Runner.include(Datadog::CI::Contrib::RSpec::KnapsackPro::Runner)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../../ext/test"
+require_relative "../ext"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        module KnapsackPro
+          module Runner
+            def self.included(base)
+              base.prepend(InstanceMethods)
+            end
+
+            module InstanceMethods
+              def knapsack__run_specs(*)
+                return super unless datadog_configuration[:enabled]
+
+                test_session = CI.start_test_session(
+                  tags: {
+                    CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
+                    CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s
+                  },
+                  service: datadog_configuration[:service_name]
+                )
+
+                test_module = CI.start_test_module(Ext::FRAMEWORK)
+
+                result = super
+                return result unless test_module && test_session
+
+                if result != 0
+                  test_module.failed!
+                  test_session.failed!
+                else
+                  test_module.passed!
+                  test_session.passed!
+                end
+                test_module.finish
+                test_session.finish
+
+                result
+              end
+
+              private
+
+              def datadog_configuration
+                Datadog.configuration.ci[:rspec]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,19 +21,35 @@ module Datadog
           end
 
           def patch
+            # ci-queue test runner instrumentation
+            # https://github.com/Shopify/ci-queue
             if ci_queue?
               ::RSpec::Queue::Runner.include(Runner)
             end
 
+            # Knapsack Pro test runner instrumentation
+            # https://github.com/KnapsackPro/knapsack_pro-ruby
+            if knapsack_pro?
+              require_relative "knapsack_pro/extension"
+              ::KnapsackPro::Extensions::RSpecExtension.include(KnapsackPro::Extension)
+            end
+
             ::RSpec::Core::Runner.include(Runner)
             ::RSpec::Core::Example.include(Example)
             ::RSpec::Core::ExampleGroup.include(ExampleGroup)
           end
 
           def ci_queue?
-            # ::RSpec::Queue::Runner is a ci-queue runner
             defined?(::RSpec::Queue::Runner)
           end
+
+          def knapsack_pro?
+            knapsack_version = Gem.loaded_specs["knapsack_pro"]&.version
+
+            # additional instrumentation is needed for KnapsackPro version 7 and later
+            defined?(::KnapsackPro) &&
+              knapsack_version && knapsack_version >= Gem::Version.new("7")
+          end
         end
       end
     end

data/lib/datadog/ci/ext/environment.rb

@@ -23,6 +23,11 @@ module Datadog
         TAG_NODE_NAME = "ci.node.name"
         TAG_CI_ENV_VARS = "_dd.ci.env_vars"
 
+        POSSIBLE_BUNDLE_LOCATIONS = [
+          "vendor/bundle",
+          ".bundle"
+        ].freeze
+
         module_function
 
         def tags(env)

data/lib/datadog/ci/ext/settings.rb

@@ -12,6 +12,7 @@ module Datadog
         ENV_FORCE_TEST_LEVEL_VISIBILITY = "DD_CIVISIBILITY_FORCE_TEST_LEVEL_VISIBILITY"
         ENV_ITR_ENABLED = "DD_CIVISIBILITY_ITR_ENABLED"
         ENV_GIT_METADATA_UPLOAD_ENABLED = "DD_CIVISIBILITY_GIT_METADATA_UPLOAD_ENABLED"
+        ENV_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH = "DD_CIVISIBILITY_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH"
 
         # Source: https://docs.datadoghq.com/getting_started/site/
         DD_SITE_ALLOWLIST = [

data/lib/datadog/ci/itr/runner.rb

@@ -30,20 +30,27 @@ module Datadog
           config_tags: {},
           api: nil,
           coverage_writer: nil,
-          enabled: false
+          enabled: false,
+          bundle_location: nil
         )
           @enabled = enabled
           @api = api
           @dd_env = dd_env
           @config_tags = config_tags || {}
 
+          @bundle_location = if bundle_location && !File.absolute_path?(bundle_location)
+            File.join(Git::LocalRepository.root, bundle_location)
+          else
+            bundle_location
+          end
+
           @test_skipping_enabled = false
           @code_coverage_enabled = false
 
           @coverage_writer = coverage_writer
 
           @correlation_id = nil
-          @skippable_tests = []
+          @skippable_tests = Set.new
 
           @skipped_tests_count = 0
           @mutex = Mutex.new
@@ -177,7 +184,10 @@ module Datadog
         end
 
         def coverage_collector
-          Thread.current[:dd_coverage_collector] ||= Coverage::DDCov.new(root: Git::LocalRepository.root)
+          Thread.current[:dd_coverage_collector] ||= Coverage::DDCov.new(
+            root: Git::LocalRepository.root,
+            ignored_path: @bundle_location
+          )
         end
 
         def load_datadog_cov!

data/lib/datadog/ci/utils/bundle.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../ext/environment"
+require_relative "../git/local_repository"
+
+module Datadog
+  module CI
+    module Utils
+      module Bundle
+        def self.location
+          require "bundler"
+          bundle_path = Bundler.bundle_path.to_s
+          bundle_path if bundle_path&.start_with?(Datadog::CI::Git::LocalRepository.root)
+        rescue => e
+          Datadog.logger.warn("Failed to find bundled gems location: #{e}")
+
+          Ext::Environment::POSSIBLE_BUNDLE_LOCATIONS.each do |location|
+            path = File.join(Datadog::CI::Git::LocalRepository.root, location)
+            return path if File.directory?(path)
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/version.rb

@@ -6,7 +6,7 @@ module Datadog
       MAJOR = "1"
       MINOR = "0"
       PATCH = "0"
-      PRE = "beta3"
+      PRE = "beta4"
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta4
 platform: ruby
 authors:
 - Datadog, Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -88,6 +88,8 @@ files:
 - lib/datadog/ci/contrib/rspec/example_group.rb
 - lib/datadog/ci/contrib/rspec/ext.rb
 - lib/datadog/ci/contrib/rspec/integration.rb
+- lib/datadog/ci/contrib/rspec/knapsack_pro/extension.rb
+- lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb
 - lib/datadog/ci/contrib/rspec/patcher.rb
 - lib/datadog/ci/contrib/rspec/runner.rb
 - lib/datadog/ci/contrib/settings.rb
@@ -156,6 +158,7 @@ files:
 - lib/datadog/ci/transport/gzip.rb
 - lib/datadog/ci/transport/http.rb
 - lib/datadog/ci/transport/remote_settings_api.rb
+- lib/datadog/ci/utils/bundle.rb
 - lib/datadog/ci/utils/configuration.rb
 - lib/datadog/ci/utils/git.rb
 - lib/datadog/ci/utils/parsing.rb
@@ -170,7 +173,7 @@ metadata:
   changelog_uri: https://github.com/DataDog/datadog-ci-rb/blob/main/CHANGELOG.md
   homepage_uri: https://github.com/DataDog/datadog-ci-rb
   source_code_uri: https://github.com/DataDog/datadog-ci-rb
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Datadog CI visibility for your ruby application
 test_files: []