Module: Datadog::CI::Configuration::Components

Defined in:
lib/datadog/ci/configuration/components.rb

Overview

Adds CI behavior to Datadog trace components

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#ci_remote ⇒ Object (readonly)

Returns the value of attribute ci_remote.



33
34
35
 
# File 'lib/datadog/ci/configuration/components.rb', line 33

def ci_remote
  @ci_remote
end

#git_tree_upload_worker ⇒ Object (readonly)

Returns the value of attribute git_tree_upload_worker.



33
34
35
 
# File 'lib/datadog/ci/configuration/components.rb', line 33

def git_tree_upload_worker
  @git_tree_upload_worker
end

#test_optimisation ⇒ Object (readonly)

Returns the value of attribute test_optimisation.



33
34
35
 
# File 'lib/datadog/ci/configuration/components.rb', line 33

def test_optimisation
  @test_optimisation
end

#test_retries ⇒ Object (readonly)

Returns the value of attribute test_retries.



33
34
35
 
# File 'lib/datadog/ci/configuration/components.rb', line 33

def test_retries
  @test_retries
end

#test_visibility ⇒ Object (readonly)

Returns the value of attribute test_visibility.



33
34
35
 
# File 'lib/datadog/ci/configuration/components.rb', line 33

def test_visibility
  @test_visibility
end

Instance Method Details

#activate_ci!(settings) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/datadog/ci/configuration/components.rb', line 58

def activate_ci!(settings)
  unless settings.tracing.enabled
    Datadog.logger.error(
      "CI visibility requires tracing to be enabled. Disabling CI visibility. " \
      "NOTE: if you didn't disable tracing intentionally, add `c.tracing.enabled = true` to " \
      "your Datadog.configure block."
    )
    settings.ci.enabled = false
    return
  end

  # Builds test visibility API layer in agentless or EvP proxy mode
  test_visibility_api = build_test_visibility_api(settings)
  # bail out early if api is misconfigured
  return unless settings.ci.enabled

  # Configure datadog gem for test visibility mode
  configure_telemetry(settings)

  # Test visibility uses its own remote settings
  settings.remote.enabled = false

  # startup logs are useless for test visibility and create noise
  settings.diagnostics.startup_logs.enabled = false

  # timecop configuration
  configure_time_providers(settings)

  # Configure Datadog::Tracing module

  # No need not use 128-bit trace ids for test visibility,
  # they are used for OTEL compatibility in Datadog tracer
  settings.tracing.trace_id_128_bit_generation_enabled = false

  # Activate underlying tracing test mode with async worker
  settings.tracing.test_mode.enabled = true
  settings.tracing.test_mode.async = true
  settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Partial.new

  trace_writer_options = settings.ci.writer_options
  trace_writer_options[:shutdown_timeout] = 60
  trace_writer_options[:buffer_size] = 10_000
  tracing_transport = build_tracing_transport(settings, test_visibility_api)
  trace_writer_options[:transport] = tracing_transport if tracing_transport

  settings.tracing.test_mode.writer_options = trace_writer_options

  @git_tree_upload_worker = build_git_upload_worker(settings, test_visibility_api)
  @ci_remote = Remote::Component.new(
    library_settings_client: build_library_settings_client(settings, test_visibility_api)
  )
  @test_retries = TestRetries::Component.new(
    retry_failed_tests_enabled: settings.ci.retry_failed_tests_enabled,
    retry_failed_tests_max_attempts: settings.ci.retry_failed_tests_max_attempts,
    retry_failed_tests_total_limit: settings.ci.retry_failed_tests_total_limit,
    retry_new_tests_enabled: settings.ci.retry_new_tests_enabled,
    unique_tests_client: build_unique_tests_client(settings, test_visibility_api)
  )
  # @type ivar @test_optimisation: Datadog::CI::TestOptimisation::Component
  @test_optimisation = build_test_optimisation(settings, test_visibility_api)
  @test_visibility = TestVisibility::Component.new(
    test_suite_level_visibility_enabled: !settings.ci.force_test_level_visibility,
    logical_test_session_name: settings.ci.test_session_name
  )
end

#build_coverage_writer(settings, api) ⇒ Object 



210
211
212
213
214
215
216
217
 
# File 'lib/datadog/ci/configuration/components.rb', line 210

def build_coverage_writer(settings, api)
  # nil means that coverage event will be ignored
  return nil if api.nil? || settings.ci.discard_traces

  TestOptimisation::Coverage::Writer.new(
    transport: TestOptimisation::Coverage::Transport.new(api: api)
  )
end

#build_git_upload_worker(settings, api) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/datadog/ci/configuration/components.rb', line 219

def build_git_upload_worker(settings, api)
  if settings.ci.git_metadata_upload_enabled
    git_tree_uploader = Git::TreeUploader.new(api: api)
    Worker.new do |repository_url|
      git_tree_uploader.call(repository_url)
    end
  else
    DummyWorker.new
  end
end

#build_library_settings_client(settings, api) ⇒ Object 



230
231
232
233
234
235
236
 
# File 'lib/datadog/ci/configuration/components.rb', line 230

def build_library_settings_client(settings, api)
  Remote::LibrarySettingsClient.new(
    api: api,
    dd_env: settings.env,
    config_tags: custom_configuration(settings)
  )
end

#build_test_optimisation(settings, test_visibility_api) ⇒ Object 



124
125
126
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
 
# File 'lib/datadog/ci/configuration/components.rb', line 124

def build_test_optimisation(settings, test_visibility_api)
  if settings.ci.itr_code_coverage_use_single_threaded_mode &&
      settings.ci.itr_test_impact_analysis_use_allocation_tracing
    Datadog.logger.warn(
      "Intelligent test runner: Single threaded coverage mode is incompatible with allocation tracing. " \
      "Allocation tracing will be disabled. It means that test impact analysis will not be able to detect " \
      "instantiations of objects in your code, which is important for ActiveRecord models. " \
      "Please add your app/model folder to the list of tracked files or disable single threaded coverage mode."
    )

    settings.ci.itr_test_impact_analysis_use_allocation_tracing = false
  end

  if RUBY_VERSION.start_with?("3.2.") && RUBY_VERSION < "3.2.3" &&
      settings.ci.itr_test_impact_analysis_use_allocation_tracing
    Datadog.logger.warn(
      "Intelligent test runner: Allocation tracing is not supported in Ruby versions 3.2.0, 3.2.1 and 3.2.2 and will be forcibly " \
      "disabled. This is due to a VM bug that can lead to crashes (https://bugs.ruby-lang.org/issues/19482). " \
      "Please update your Ruby version or add your app/model folder to the list of tracked files." \
      "Set env variable DD_CIVISIBILITY_ITR_TEST_IMPACT_ANALYSIS_USE_ALLOCATION_TRACING to 0 to disable this warning."
    )
    settings.ci.itr_test_impact_analysis_use_allocation_tracing = false
  end

  TestOptimisation::Component.new(
    api: test_visibility_api,
    dd_env: settings.env,
    config_tags: custom_configuration(settings),
    coverage_writer: build_coverage_writer(settings, test_visibility_api),
    enabled: settings.ci.enabled && settings.ci.itr_enabled,
    bundle_location: settings.ci.itr_code_coverage_excluded_bundle_path,
    use_single_threaded_coverage: settings.ci.itr_code_coverage_use_single_threaded_mode,
    use_allocation_tracing: settings.ci.itr_test_impact_analysis_use_allocation_tracing
  )
end

#build_test_visibility_api(settings) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/datadog/ci/configuration/components.rb', line 160

def build_test_visibility_api(settings)
  if settings.ci.agentless_mode_enabled
    check_dd_site(settings)

    Datadog.logger.debug("CI visibility configured to use agentless transport")

    api = Transport::Api::Builder.build_agentless_api(settings)
    if api.nil?
      Datadog.logger.error do
        "DATADOG CONFIGURATION - CI VISIBILITY - ATTENTION - " \
        "Agentless mode was enabled but DD_API_KEY is not set: CI visibility is disabled. " \
        "Please make sure to set valid api key in DD_API_KEY environment variable"
      end

      # Tests are running without CI visibility enabled
      settings.ci.enabled = false
    end
  else
    Datadog.logger.debug("CI visibility configured to use agent transport via EVP proxy")

    api = Transport::Api::Builder.build_evp_proxy_api(settings)
    if api.nil?
      Datadog.logger.debug(
        "Old agent version detected, no evp_proxy support. Forcing test level visibility mode"
      )

      # only legacy APM protocol is supported, so no test suite level visibility
      settings.ci.force_test_level_visibility = true

      # ITR is not supported with APM protocol
      settings.ci.itr_enabled = false
    end
  end

  api
end

#build_tracing_transport(settings, api) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/datadog/ci/configuration/components.rb', line 197

def build_tracing_transport(settings, api)
  # NullTransport ignores traces
  return TestVisibility::NullTransport.new if settings.ci.discard_traces
  # nil means that default legacy APM transport will be used (only for very old Datadog Agent versions)
  return nil if api.nil?

  TestVisibility::Transport.new(
    api: api,
    serializers_factory: serializers_factory(settings),
    dd_env: settings.env
  )
end

#build_unique_tests_client(settings, api) ⇒ Object 



238
239
240
241
242
243
244
 
# File 'lib/datadog/ci/configuration/components.rb', line 238

def build_unique_tests_client(settings, api)
  TestRetries::UniqueTestsClient.new(
    api: api,
    dd_env: settings.env,
    config_tags: custom_configuration(settings)
  )
end

#check_dd_site(settings) ⇒ Object 



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/datadog/ci/configuration/components.rb', line 260

def check_dd_site(settings)
  return if settings.site.nil?
  return if Ext::Settings::DD_SITE_ALLOWLIST.include?(settings.site)

  Datadog.logger.warn do
    "CI VISIBILITY CONFIGURATION " \
    "Agentless mode was enabled but DD_SITE is not set to one of the following: #{Ext::Settings::DD_SITE_ALLOWLIST.join(", ")}. " \
    "Please make sure to set valid site in DD_SITE environment variable"
  end
end

#configure_telemetry(settings) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/datadog/ci/configuration/components.rb', line 271

def configure_telemetry(settings)
  # in development environment Datadog's telemetry is disabled by default
  # for test visibility we want to enable it by default unless explicitly disabled
  # NOTE: before agentless mode is released, we only enable telemetry when running with Datadog Agent
  env_telemetry_enabled = ENV[Core::Telemetry::Ext::ENV_ENABLED]
  settings.telemetry.enabled = env_telemetry_enabled.nil? || Utils::Parsing.convert_to_bool(env_telemetry_enabled)

  return unless settings.telemetry.enabled

  settings.telemetry.agentless_enabled = true if settings.ci.agentless_mode_enabled
  settings.telemetry.shutdown_timeout_seconds = 60.0

  begin
    require "datadog/core/telemetry/http/adapters/net"

    # patch gem's telemetry transport layer to use Net::HTTP instead of WebMock's Net::HTTP
    Core::Telemetry::Http::Adapters::Net.include(CI::Transport::Adapters::TelemetryWebmockSafeAdapter)
  rescue => e
    Datadog.logger.warn("Failed to patch Datadog gem's telemetry layer: #{e}")
  end
end

#configure_time_providers(settings) ⇒ Object

When timecop is present:

  • Time.now is mocked and .now_without_mock_time is added on Time to get the current time without the mock.

  • Process.clock_gettime is mocked and .clock_gettime_without_mock is added on Process to get the monotonic time without the mock.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/datadog/ci/configuration/components.rb', line 296

def configure_time_providers(settings)
  return unless timecop?

  settings.time_now_provider = -> do
    Time.now_without_mock_time
  rescue NoMethodError
    # fallback to normal Time.now if Time.now_without_mock_time is not defined for any reason
    Time.now
  end

  if defined?(Process.clock_gettime_without_mock)
    settings.get_time_provider = ->(unit = :float_second) do
      ::Process.clock_gettime_without_mock(::Process::CLOCK_MONOTONIC, unit)
    rescue NoMethodError
      # fallback to normal Process.clock_gettime if Process.clock_gettime_without_mock is not defined for any reason
      Process.clock_gettime(::Process::CLOCK_MONOTONIC, unit)
    end
  end
end

#custom_configuration(settings) ⇒ Object

fetch custom tags provided by the user in DD_TAGS env var with prefix test.configuration.



248
249
250
 
# File 'lib/datadog/ci/configuration/components.rb', line 248

def custom_configuration(settings)
  @custom_configuration ||= Utils::TestRun.custom_configuration(settings.tags)
end

#initialize(settings) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/datadog/ci/configuration/components.rb', line 35

def initialize(settings)
  @test_optimisation = nil
  @test_visibility = TestVisibility::NullComponent.new
  @git_tree_upload_worker = DummyWorker.new
  @ci_remote = nil
  @test_retries = TestRetries::NullComponent.new

  # Activate CI mode if enabled
  if settings.ci.enabled
    activate_ci!(settings)
  end

  super
end

#serializers_factory(settings) ⇒ Object 



252
253
254
255
256
257
258
 
# File 'lib/datadog/ci/configuration/components.rb', line 252

def serializers_factory(settings)
  if settings.ci.force_test_level_visibility
    TestVisibility::Serializers::Factories::TestLevel
  else
    TestVisibility::Serializers::Factories::TestSuiteLevel
  end
end

#shutdown!(replacement = nil) ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/datadog/ci/configuration/components.rb', line 50

def shutdown!(replacement = nil)
  super

  @test_visibility&.shutdown!
  @test_optimisation&.shutdown!
  @git_tree_upload_worker&.stop
end

#timecop? ⇒ Boolean

Returns:

  • (Boolean) 


316
317
318
 
# File 'lib/datadog/ci/configuration/components.rb', line 316

def timecop?
  Gem.loaded_specs.key?("timecop") || !!defined?(Timecop)
end