Class: Datadog::CI::TestOptimisation::Component

Inherits:
Object
  • Object
show all
Includes:
Core::Utils::Forking
Defined in:
lib/datadog/ci/test_optimisation/component.rb

Overview

Intelligent test runner implementation Integrates with backend to provide test impact analysis data and skip tests that are not impacted by the changes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dd_env:, config_tags: {}, api: nil, coverage_writer: nil, enabled: false, bundle_location: nil, use_single_threaded_coverage: false, use_allocation_tracing: true) ⇒ Component

Returns a new instance of Component.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 31

def initialize(
  dd_env:,
  config_tags: {},
  api: nil,
  coverage_writer: nil,
  enabled: false,
  bundle_location: nil,
  use_single_threaded_coverage: false,
  use_allocation_tracing: true
)
  @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
  @use_single_threaded_coverage = use_single_threaded_coverage
  @use_allocation_tracing = use_allocation_tracing

  @test_skipping_enabled = false
  @code_coverage_enabled = false

  @coverage_writer = coverage_writer

  @correlation_id = nil
  @skippable_tests = Set.new

  @skipped_tests_count = 0
  @mutex = Mutex.new

  Datadog.logger.debug("TestOptimisation initialized with enabled: #{@enabled}")
end

Instance Attribute Details

#correlation_id ⇒ Object (readonly)

Returns the value of attribute correlation_id.



29
30
31
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 29

def correlation_id
  @correlation_id
end

#skippable_tests ⇒ Object (readonly)

Returns the value of attribute skippable_tests.



29
30
31
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 29

def skippable_tests
  @skippable_tests
end

#skipped_tests_count ⇒ Object (readonly)

Returns the value of attribute skipped_tests_count.



29
30
31
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 29

def skipped_tests_count
  @skipped_tests_count
end

Instance Method Details

#code_coverage? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 104

def code_coverage?
  @code_coverage_enabled
end

#configure(remote_configuration, test_session:, git_tree_upload_worker:) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 68

def configure(remote_configuration, test_session:, git_tree_upload_worker:)
  Datadog.logger.debug("Configuring TestOptimisation with remote configuration: #{remote_configuration}")

  @enabled = Utils::Parsing.convert_to_bool(
    remote_configuration.fetch(Ext::Transport::DD_API_SETTINGS_RESPONSE_ITR_ENABLED_KEY, false)
  )
  @test_skipping_enabled = @enabled && Utils::Parsing.convert_to_bool(
    remote_configuration.fetch(Ext::Transport::DD_API_SETTINGS_RESPONSE_TESTS_SKIPPING_KEY, false)
  )
  @code_coverage_enabled = @enabled && Utils::Parsing.convert_to_bool(
    remote_configuration.fetch(Ext::Transport::DD_API_SETTINGS_RESPONSE_CODE_COVERAGE_KEY, false)
  )

  test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_ENABLED, @test_skipping_enabled)
  # currently we set this tag when ITR requires collecting code coverage
  # this will change as soon as we implement total code coverage support in this library
  test_session.set_tag(Ext::Test::TAG_CODE_COVERAGE_ENABLED, @code_coverage_enabled)

  # we skip tests, not suites
  test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_TYPE, Ext::Test::ITR_TEST_SKIPPING_MODE)

  load_datadog_cov! if @code_coverage_enabled

  Datadog.logger.debug("Configured TestOptimisation with enabled: #{@enabled}, skipping_tests: #{@test_skipping_enabled}, code_coverage: #{@code_coverage_enabled}")

  fetch_skippable_tests(test_session: test_session, git_tree_upload_worker: git_tree_upload_worker)
end

#count_skipped_test(test) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 166

def count_skipped_test(test)
  return if !test.skipped? || !test.skipped_by_itr?

  if forked?
    Datadog.logger.warn { "Intelligent test runner is not supported for forking test runners yet" }
    return
  end

  @mutex.synchronize do
    Telemetry.itr_skipped

    @skipped_tests_count += 1
  end
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 96

def enabled?
  @enabled
end

#mark_if_skippable(test) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 148

def mark_if_skippable(test)
  return if !enabled? || !skipping_tests?

  skippable_test_id = Utils::TestRun.skippable_test_id(test.name, test.test_suite_name, test.parameters)
  if @skippable_tests.include?(skippable_test_id)
    if forked?
      Datadog.logger.warn { "Intelligent test runner is not supported for forking test runners yet" }
      return
    end

    test.set_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR, "true")

    Datadog.logger.debug { "Marked test as skippable: #{skippable_test_id}" }
  else
    Datadog.logger.debug { "Test is not skippable: #{skippable_test_id}" }
  end
end

#shutdown! ⇒ Object 



191
192
193
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 191

def shutdown!
  @coverage_writer&.stop
end

#skipping_tests? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 100

def skipping_tests?
  @test_skipping_enabled
end

#start_coverage(test) ⇒ Object 



108
109
110
111
112
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 108

def start_coverage(test)
  return if !enabled? || !code_coverage?
  Telemetry.code_coverage_started(test)
  coverage_collector&.start
end

#stop_coverage(test) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 114

def stop_coverage(test)
  return if !enabled? || !code_coverage?

  Telemetry.code_coverage_finished(test)

  coverage = coverage_collector&.stop
  if coverage.nil? || coverage.empty?
    Telemetry.code_coverage_is_empty
    return
  end

  return if test.skipped?

  test_source_file = test.source_file

  # cucumber's gherkin files are not covered by the code coverage collector
  ensure_test_source_covered(test_source_file, coverage) unless test_source_file.nil?

  Telemetry.code_coverage_files(coverage.size)

  event = Coverage::Event.new(
    test_id: test.id.to_s,
    test_suite_id: test.test_suite_id.to_s,
    test_session_id: test.test_session_id.to_s,
    coverage: coverage
  )

  Datadog.logger.debug { "Writing coverage event \n #{event.pretty_inspect}" }

  write(event)

  event
end

#write_test_session_tags(test_session) ⇒ Object 



181
182
183
184
185
186
187
188
189
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 181

def write_test_session_tags(test_session)
  return if !enabled?

  Datadog.logger.debug { "Finished optimised session with test skipping enabled: #{@test_skipping_enabled}" }
  Datadog.logger.debug { "#{@skipped_tests_count} tests were skipped" }

  test_session.set_tag(Ext::Test::TAG_ITR_TESTS_SKIPPED, @skipped_tests_count.positive?.to_s)
  test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_COUNT, @skipped_tests_count)
end