Class: Datadog::CI::CodeCoverage::Component

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/ci/code_coverage/component.rb

Overview

CodeCoverage component is responsible for uploading code coverage reports to Datadog's Code Coverage product.

Constant Summary collapse

COVERAGE_REPORT_TYPE = 
"coverage_report"
MAX_REPORT_FLAGS = 
32

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled:, transport:, flags:) ⇒ Component

Returns a new instance of Component.



25
26
27
28
29
 
# File 'lib/datadog/ci/code_coverage/component.rb', line 25

def initialize(enabled:, transport:, flags:)
  @enabled = enabled
  @transport = transport
  @flags = parse_flags(flags)
end

Instance Attribute Details

#enabled ⇒ Object (readonly)

Returns the value of attribute enabled.



17
18
19
 
# File 'lib/datadog/ci/code_coverage/component.rb', line 17

def enabled
  @enabled
end

Class Method Details

.build(enabled:, api:, discard_traces:, flags:) ⇒ Object 



19
20
21
22
23
 
# File 'lib/datadog/ci/code_coverage/component.rb', line 19

def self.build(enabled:, api:, discard_traces:, flags:)
  return NullComponent.new if api.nil? || discard_traces

  new(enabled: enabled, transport: Transport.new(api: api), flags: flags)
end

Instance Method Details

#configure(library_configuration) ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/datadog/ci/code_coverage/component.rb', line 31

def configure(library_configuration)
  @enabled &&= library_configuration.coverage_report_upload_enabled?

  Datadog.logger.debug do
    "[#{self.class.name}] Configured with enabled=#{@enabled}"
  end
end

#shutdown! ⇒ Object 



50
51
52
 
# File 'lib/datadog/ci/code_coverage/component.rb', line 50

def shutdown!
  # noop - transport is synchronous
end

#upload(serialized_report:, format:) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/datadog/ci/code_coverage/component.rb', line 39

def upload(serialized_report:, format:)
  return unless @enabled
  return if serialized_report.nil?

  Datadog.logger.debug { "[#{self.class.name}] Uploading coverage report..." }

  event = build_event(format)

  @transport.send_coverage_report(event: event, coverage_report: serialized_report)
end