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

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

Overview

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

Constant Summary collapse

FILE_STORAGE_KEY = 
"test_optimisation_component_state"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Stateful

#load_component_state, #load_json, #store_component_state

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, static_dependencies_tracking_enabled: false) ⇒ Component

Returns a new instance of Component.



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
67
68
69
70
71
72
73
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 37

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,
  static_dependencies_tracking_enabled: false
)
  @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
  @static_dependencies_tracking_enabled = static_dependencies_tracking_enabled

  @test_skipping_enabled = false
  @code_coverage_enabled = false

  @coverage_writer = coverage_writer

  @correlation_id = nil
  @skippable_tests = Set.new

  @mutex = Mutex.new

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

Instance Attribute Details

#code_coverage_enabled ⇒ Object (readonly)

Returns the value of attribute code_coverage_enabled.



34
35
36
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 34

def code_coverage_enabled
  @code_coverage_enabled
end

#correlation_id ⇒ Object (readonly)

Returns the value of attribute correlation_id.



34
35
36
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 34

def correlation_id
  @correlation_id
end

#enabled ⇒ Object (readonly)

Returns the value of attribute enabled.



34
35
36
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 34

def enabled
  @enabled
end

#skippable_tests ⇒ Object (readonly)

Returns the value of attribute skippable_tests.



34
35
36
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 34

def skippable_tests
  @skippable_tests
end

#skippable_tests_fetch_error ⇒ Object (readonly)

Returns the value of attribute skippable_tests_fetch_error.



34
35
36
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 34

def skippable_tests_fetch_error
  @skippable_tests_fetch_error
end

#test_skipping_enabled ⇒ Object (readonly)

Returns the value of attribute test_skipping_enabled.



34
35
36
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 34

def test_skipping_enabled
  @test_skipping_enabled
end

Instance Method Details

#code_coverage? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 116

def code_coverage?
  @code_coverage_enabled
end

#configure(remote_configuration, test_session) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 75

def configure(remote_configuration, test_session)
  return unless enabled?

  Datadog.logger.debug("Configuring TestOptimisation with remote configuration: #{remote_configuration}")

  @enabled = remote_configuration.itr_enabled?
  @test_skipping_enabled = @enabled && remote_configuration.tests_skipping_enabled?
  @code_coverage_enabled = @enabled && remote_configuration.code_coverage_enabled?

  test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_ENABLED, @test_skipping_enabled)
  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)

  if @code_coverage_enabled
    load_datadog_cov!

    populate_static_dependencies_map!
  end

  # Load component state first, and if successful, skip fetching skippable tests
  # Also try to restore from DDTest cache if available
  if skipping_tests?
    return if load_component_state
    return if restore_state_from_datadog_test_runner

    fetch_skippable_tests(test_session)
    store_component_state if test_session.distributed
  end

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

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


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

def enabled?
  @enabled
end

#mark_if_skippable(test) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 172

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

  if skippable?(test.datadog_test_id) && !test.attempt_to_fix?
    test.set_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR, "true")

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

#on_test_finished(test, context) ⇒ Object 



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

def on_test_finished(test, context)
  return if !test.skipped? || !test.skipped_by_test_impact_analysis?

  Telemetry.itr_skipped

  context.incr_tests_skipped_by_tia_count
end

#restore_state(state) ⇒ Object 



218
219
220
221
222
223
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 218

def restore_state(state)
  @mutex.synchronize do
    @correlation_id = state[:correlation_id]
    @skippable_tests = state[:skippable_tests]
  end
end

#restore_state_from_datadog_test_runner ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 229

def restore_state_from_datadog_test_runner
  Datadog.logger.debug { "Restoring skippable tests from DDTest cache" }

  skippable_tests_data = load_json(Ext::DDTest::SKIPPABLE_TESTS_FILE_NAME)
  if skippable_tests_data.nil?
    Datadog.logger.debug { "Restoring skippable tests failed, will request again" }
    return false
  end

  Datadog.logger.debug { "Restored skippable tests from DDTest: #{skippable_tests_data}" }

  transformed_data = transform_test_runner_data(skippable_tests_data)

  Datadog.logger.debug { "Skippable tests after transformation: #{transformed_data}" }

  # Use the Skippable::Response class to parse the transformed data
  skippable_response = Skippable::Response.from_json(transformed_data)

  @mutex.synchronize do
    @correlation_id = skippable_response.correlation_id
    @skippable_tests = skippable_response.tests
  end

  Datadog.logger.debug { "Found [#{@skippable_tests.size}] skippable tests from context" }
  Datadog.logger.debug { "ITR correlation ID from context: #{@correlation_id}" }

  true
end

#serialize_state ⇒ Object

Implementation of Stateful interface



211
212
213
214
215
216
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 211

def serialize_state
  {
    correlation_id: @correlation_id,
    skippable_tests: @skippable_tests
  }
end

#shutdown! ⇒ Object 



206
207
208
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 206

def shutdown!
  @coverage_writer&.stop
end

#skippable?(datadog_test_id) ⇒ Boolean

Returns:

  • (Boolean) 


166
167
168
169
170
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 166

def skippable?(datadog_test_id)
  return false if !enabled? || !skipping_tests?

  @mutex.synchronize { @skippable_tests.include?(datadog_test_id) }
end

#skippable_tests_count ⇒ Object 



202
203
204
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 202

def skippable_tests_count
  skippable_tests.count
end

#skipping_tests? ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 112

def skipping_tests?
  @test_skipping_enabled
end

#start_coverage(test) ⇒ Object 



120
121
122
123
124
125
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 120

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

  Telemetry.code_coverage_started(test)
  coverage_collector&.start
end

#stop_coverage(test) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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 127

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

  Telemetry.code_coverage_finished(test)

  coverage = coverage_collector&.stop

  # if test was skipped, we discard coverage data
  return if test.skipped?

  if coverage.nil? || coverage.empty?
    Telemetry.code_coverage_is_empty
    return
  end

  # cucumber's gherkin files are not covered by the code coverage collector - we add them here explicitly
  test_source_file = test.source_file
  ensure_test_source_covered(test_source_file, coverage) unless test_source_file.nil?

  # if we have static dependencies tracking enabled then we can make the coverage
  # more precise by fetching which files we depend on based on constants usage
  enrich_coverage_with_static_dependencies(coverage)

  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

#storage_key ⇒ Object 



225
226
227
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 225

def storage_key
  FILE_STORAGE_KEY
end

#write_test_session_tags(test_session, skipped_tests_count) ⇒ Object 



192
193
194
195
196
197
198
199
200
 
# File 'lib/datadog/ci/test_optimisation/component.rb', line 192

def write_test_session_tags(test_session, skipped_tests_count)
  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