[CIVIS-2892] datadog_cov native extension for per test code coverage

.gitignore

@@ -15,3 +15,11 @@ Gemfile-*.lock
 .ruby-version
 .DS_Store
 /test.rb
+
+# Native extension binaries
+lib/**/*.bundle
+lib/**/*.so
+lib/**/*.o
+lib/**/*.dylib
+lib/**/*.dll
+

CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.8.3] - 2024-03-20
+
+### Fixed
+
+* fix: cucumber-ruby 9.2 includes breaking change for Cucumber::Core::Test::Result ([#145][])
+
+### Changed
+
+* remove temporary hack and use Core::Remote::Negotiation's new constructor param ([#142][])
+* use filter_basic_auth method from Datadog::Core ([#141][])
+
 ## [0.8.2] - 2024-03-19
 
 ### Fixed
@@ -176,7 +187,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.2...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.3...main
+[0.8.3]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.2...v0.8.3
 [0.8.2]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.1...v0.8.2
 [0.8.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.0...v0.8.1
 [0.8.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.7.0...v0.8.0
@@ -247,3 +259,6 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#131]: https://github.com/DataDog/datadog-ci-rb/issues/131
 [#134]: https://github.com/DataDog/datadog-ci-rb/issues/134
 [#139]: https://github.com/DataDog/datadog-ci-rb/issues/139
+[#141]: https://github.com/DataDog/datadog-ci-rb/issues/141
+[#142]: https://github.com/DataDog/datadog-ci-rb/issues/142
+[#145]: https://github.com/DataDog/datadog-ci-rb/issues/145

Gemfile

@@ -12,6 +12,9 @@ gem "pry"
 gem "rake"
 gem "os"
 
+# To compile native extensions
+gem "rake-compiler"
+
 gem "climate_control"
 
 gem "rspec"

Rakefile

@@ -5,6 +5,7 @@ require_relative "lib/datadog/ci/version"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "yard"
+require "rake/extensiontask"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -107,8 +108,12 @@ end
 namespace :spec do
   desc "" # "Explicitly hiding from `rake -T`"
   RSpec::Core::RakeTask.new(:main) do |t, args|
-    t.pattern = "spec/**/*_spec.rb"
-    t.exclude_pattern = "spec/**/{contrib}/**/*_spec.rb,"
+    t.pattern = if RUBY_ENGINE == "jruby"
+      "spec/datadog/**/*_spec.rb"
+    else
+      "spec/datadog/**/*_spec.rb,spec/ddcov/**/*_spec.rb"
+    end
+    t.exclude_pattern = "spec/datadog/**/{contrib}/**/*_spec.rb,"
     t.rspec_opts = args.to_a.join(" ")
   end
 
@@ -132,3 +137,18 @@ end
 
 desc "CI task; it runs all tests for current version of Ruby"
 task ci: "test:all"
+
+# native extensions
+Rake::ExtensionTask.new("datadog_cov.#{RUBY_VERSION}_#{RUBY_PLATFORM}") do |ext|
+  ext.ext_dir = "ext/datadog_cov"
+end
+
+task :compile_ext do
+  if RUBY_ENGINE == "ruby"
+    Rake::Task[:clean].invoke
+    Rake::Task[:compile].invoke
+  end
+end
+
+# run compile before any tests are run
+Rake::Task["test:all"].prerequisite_tasks.each { |t| t.enhance([:compile_ext]) }

datadog-ci.gemspec

@@ -34,10 +34,14 @@ Gem::Specification.new do |spec|
       LICENSE*
       NOTICE
       README.md
+      ext/**/*
       lib/**/*
     ]].select { |fn| File.file?(fn) } # We don't want directories, only files
+      .reject { |fn| fn.end_with?(".so", ".bundle") } # Exclude local native binary artifacts
 
   spec.require_paths = ["lib"]
 
   spec.add_dependency "msgpack"
+
+  spec.extensions = ["ext/datadog_cov/extconf.rb"]
 end

ext/datadog_cov/datadog_cov.c

@@ -0,0 +1,192 @@
+#include <ruby.h>
+#include <ruby/debug.h>
+
+// constants
+#define DD_COV_TARGET_FILES 1
+#define DD_COV_TARGET_LINES 2
+
+// Data structure
+struct dd_cov_data
+{
+  VALUE root;
+  int mode;
+  VALUE coverage;
+};
+
+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);
+}
+
+static void dd_cov_free(void *ptr)
+{
+  struct dd_cov_data *dd_cov_data = ptr;
+
+  xfree(dd_cov_data);
+}
+
+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);
+}
+
+const rb_data_type_t dd_cov_data_type = {
+    .wrap_struct_name = "dd_cov",
+    .function = {
+        .dmark = dd_cov_mark,
+        .dfree = dd_cov_free,
+        .dsize = NULL,
+        .dcompact = dd_cov_compact},
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY};
+
+static VALUE dd_cov_allocate(VALUE klass)
+{
+  struct dd_cov_data *dd_cov_data;
+  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->mode = DD_COV_TARGET_FILES;
+  return obj;
+}
+
+// DDCov methods
+static VALUE dd_cov_initialize(int argc, VALUE *argv, VALUE self)
+{
+  VALUE opt;
+  int mode;
+
+  rb_scan_args(argc, argv, "10", &opt);
+  VALUE rb_root = rb_hash_lookup(opt, ID2SYM(rb_intern("root")));
+  if (!RTEST(rb_root))
+  {
+    rb_raise(rb_eArgError, "root is required");
+  }
+
+  VALUE rb_mode = rb_hash_lookup(opt, ID2SYM(rb_intern("mode")));
+  if (!RTEST(rb_mode) || rb_mode == ID2SYM(rb_intern("files")))
+  {
+    mode = DD_COV_TARGET_FILES;
+  }
+  else if (rb_mode == ID2SYM(rb_intern("lines")))
+  {
+    mode = DD_COV_TARGET_LINES;
+  }
+  else
+  {
+    rb_raise(rb_eArgError, "mode is invalid");
+  }
+
+  struct dd_cov_data *dd_cov_data;
+  TypedData_Get_Struct(self, struct dd_cov_data, &dd_cov_data_type, dd_cov_data);
+
+  dd_cov_data->root = rb_root;
+  dd_cov_data->mode = mode;
+
+  return Qnil;
+}
+
+static void dd_cov_update_line_coverage(rb_event_flag_t event, VALUE data, VALUE self, ID id, VALUE klass)
+{
+  struct dd_cov_data *dd_cov_data;
+  TypedData_Get_Struct(data, struct dd_cov_data, &dd_cov_data_type, dd_cov_data);
+
+  const char *filename = rb_sourcefile();
+  if (filename == NULL)
+  {
+    return;
+  }
+
+  if (dd_cov_data->root == Qnil)
+  {
+    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)
+  {
+    return;
+  }
+
+  VALUE rb_str_source_file = rb_str_new2(filename);
+
+  if (dd_cov_data->mode == DD_COV_TARGET_FILES)
+  {
+    rb_hash_aset(dd_cov_data->coverage, rb_str_source_file, Qtrue);
+    return;
+  }
+
+  // this isn't optimized yet, this is a POC to show that lines coverage is possible
+  // ITR beta is going to use files coverage, we'll get back to this part when
+  // we need to implement lines coverage
+  if (dd_cov_data->mode == DD_COV_TARGET_LINES)
+  {
+    int line_number = rb_sourceline();
+    if (line_number <= 0)
+    {
+      return;
+    }
+
+    VALUE rb_lines = rb_hash_aref(dd_cov_data->coverage, rb_str_source_file);
+    if (rb_lines == Qnil)
+    {
+      rb_lines = rb_hash_new();
+      rb_hash_aset(dd_cov_data->coverage, rb_str_source_file, rb_lines);
+    }
+
+    rb_hash_aset(rb_lines, INT2FIX(line_number), Qtrue);
+  }
+}
+
+static VALUE dd_cov_start(VALUE self)
+{
+  // get current thread
+  VALUE thval = rb_thread_current();
+
+  // add event hook
+  rb_thread_add_event_hook(thval, dd_cov_update_line_coverage, RUBY_EVENT_LINE, self);
+
+  return self;
+}
+
+static VALUE dd_cov_stop(VALUE self)
+{
+  // get current thread
+  VALUE thval = rb_thread_current();
+  // remove event hook for the current thread
+  rb_thread_remove_event_hook(thval, dd_cov_update_line_coverage);
+
+  struct dd_cov_data *dd_cov_data;
+  TypedData_Get_Struct(self, struct dd_cov_data, &dd_cov_data_type, dd_cov_data);
+
+  VALUE cov = dd_cov_data->coverage;
+
+  dd_cov_data->coverage = rb_hash_new();
+
+  return cov;
+}
+
+void Init_datadog_cov(void)
+{
+  VALUE mDatadog = rb_define_module("Datadog");
+  VALUE mCI = rb_define_module_under(mDatadog, "CI");
+  VALUE mITR = rb_define_module_under(mCI, "ITR");
+  VALUE mCoverage = rb_define_module_under(mITR, "Coverage");
+  VALUE cDatadogCov = rb_define_class_under(mCoverage, "DDCov", rb_cObject);
+
+  rb_define_alloc_func(cDatadogCov, dd_cov_allocate);
+
+  rb_define_method(cDatadogCov, "initialize", dd_cov_initialize, -1);
+  rb_define_method(cDatadogCov, "start", dd_cov_start, 0);
+  rb_define_method(cDatadogCov, "stop", dd_cov_stop, 0);
+}

ext/datadog_cov/extconf.rb

@@ -0,0 +1,18 @@
+if RUBY_ENGINE != "ruby" || Gem.win_platform?
+  warn(
+    "WARN: Skipping build of code coverage native extension because of unsupported platform."
+  )
+
+  File.write("Makefile", "all install clean: # dummy makefile that does nothing")
+  exit
+end
+
+require "mkmf"
+
+# Tag the native extension library with the Ruby version and Ruby platform.
+# This makes it easier for development (avoids "oops I forgot to rebuild when I switched my Ruby") and ensures that
+# the wrong library is never loaded.
+# When requiring, we need to use the exact same string, including the version and the platform.
+EXTENSION_NAME = "datadog_cov.#{RUBY_VERSION}_#{RUBY_PLATFORM}".freeze
+
+create_makefile(EXTENSION_NAME)

gemfiles/jruby_9.4_activesupport_4.gemfile

@@ -6,6 +6,7 @@ gem "datadog", github: "DataDog/dd-trace-rb", branch: "2.0"
 gem "pry"
 gem "rake"
 gem "os"
+gem "rake-compiler"
 gem "climate_control"
 gem "rspec"
 gem "rspec-collection_matchers"

gemfiles/jruby_9.4_activesupport_4.gemfile.lock

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: ..
   specs:
-    datadog-ci (0.8.2)
+    datadog-ci (0.8.3)
       msgpack
 
 GEM
@@ -61,6 +61,8 @@ GEM
     racc (1.7.3-java)
     rainbow (3.1.1)
     rake (13.1.0)
+    rake-compiler (1.2.7)
+      rake
     regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -142,6 +144,7 @@ DEPENDENCIES
   pimpmychangelog (>= 0.1.2)
   pry
   rake
+  rake-compiler
   rspec
   rspec-collection_matchers
   rspec_junit_formatter

gemfiles/jruby_9.4_activesupport_5.gemfile

@@ -6,6 +6,7 @@ gem "datadog", github: "DataDog/dd-trace-rb", branch: "2.0"
 gem "pry"
 gem "rake"
 gem "os"
+gem "rake-compiler"
 gem "climate_control"
 gem "rspec"
 gem "rspec-collection_matchers"

gemfiles/jruby_9.4_activesupport_5.gemfile.lock

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: ..
   specs:
-    datadog-ci (0.8.2)
+    datadog-ci (0.8.3)
       msgpack
 
 GEM
@@ -61,6 +61,8 @@ GEM
     racc (1.7.3-java)
     rainbow (3.1.1)
     rake (13.1.0)
+    rake-compiler (1.2.7)
+      rake
     regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -142,6 +144,7 @@ DEPENDENCIES
   pimpmychangelog (>= 0.1.2)
   pry
   rake
+  rake-compiler
   rspec
   rspec-collection_matchers
   rspec_junit_formatter