Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[POC] per test code coverage using built-in Coverage.resume/suspend #124

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions lib/datadog/ci/itr/coverage/collector.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# frozen_string_literal: true

require "coverage"

require_relative "filter"

module Datadog
module CI
module Itr
module Coverage
class Collector
def initialize(enabled: true)
# Do not run code coverage if someone else is already running it.
# It means that user is running the test with coverage and ITR would mess it up.
@enabled = enabled
@coverage_supported = !::Coverage.running?
# @coverage_supported = false
end

def setup
if @coverage_supported && @enabled
p "RUNNING WITH CODE COVERAGE ENABLED!"
::Coverage.setup(lines: true)
else
p "RUNNING WITH CODE COVERAGE DISABLED!"
end
end

def start
return if !@coverage_supported || !@enabled

# if execution is threaded then coverage might already be running
::Coverage.resume unless ::Coverage.running?
end

def stop
return if !@coverage_supported || !@enabled

result = ::Coverage.result(stop: false, clear: true)
::Coverage.suspend if ::Coverage.running?

Filter.call(result)
end
end
end
end
end
end
30 changes: 30 additions & 0 deletions lib/datadog/ci/itr/coverage/filter.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# frozen_string_literal: true

require_relative "../../utils/git"

module Datadog
module CI
module Itr
module Coverage
# not filter, but rather filter and transformer
class Filter
def self.call(raw_result)
new.call(raw_result)
end

def initialize(root: Utils::Git.root)
@regex = /\A#{Regexp.escape(root + File::SEPARATOR)}/i.freeze
end

def call(raw_result)
return nil if raw_result.nil?

raw_result.select do |path, coverage|
path =~ @regex && coverage[:lines].any? { |line| !line.nil? && line > 0 }
end
end
end
end
end
end
end
43 changes: 43 additions & 0 deletions lib/datadog/ci/test_visibility/recorder.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
require_relative "../test_module"
require_relative "../test_suite"

require_relative "../itr/coverage/collector"

module Datadog
module CI
module TestVisibility
Expand All @@ -38,6 +40,13 @@ def initialize(
@local_context = Context::Local.new
@global_context = Context::Global.new
@codeowners = codeowners

@coverage_collector = Itr::Coverage::Collector.new
begin
@coverage_collector.setup
rescue => e
Datadog.logger.debug("Coverage collector setup failed: #{e.message}")
end
end

def start_test_session(service: nil, tags: {})
Expand Down Expand Up @@ -103,12 +112,15 @@ def trace_test(test_name, test_suite_name, service: nil, tags: {}, &block)
{resource: test_name, continue_from: Datadog::Tracing::TraceDigest.new}
)

@coverage_collector.start
if block
start_datadog_tracer_span(test_name, span_options) do |tracer_span|
test = build_test(tracer_span, tags)

@local_context.activate_test(test) do
block.call(test)

on_test_end(test)
end
end
else
Expand Down Expand Up @@ -160,6 +172,8 @@ def active_test_suite(test_suite_name)
end

def deactivate_test
on_test_end(active_test) if active_test

@local_context.deactivate_test
end

Expand Down Expand Up @@ -314,6 +328,35 @@ def validate_test_suite_level_visibility_correctness(test)
end
end
end

# event system?
def on_test_end(test)
coverage = @coverage_collector.stop
if coverage
if ENV["DD_COV_REPORT"]
# append to report.log file
File.open("report.log", "a") do |f|
f.write("#{test.name}\n")
f.write("---------------------------------------------------\n")

coverage.each do |filename, cov|
f.write("#{filename}\n")
sorted_lines = []

cov[:lines].each_with_index do |count, line_number|
next if count.nil? || count.zero?

sorted_lines << line_number + 1
end
f.write("#{sorted_lines.sort}\n")
end
f.write("---------------------------------------------------\n")
end
end

test.set_tag("_test.coverage", coverage)
end
end
end
end
end
Expand Down
Loading