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_recorder ⇒ Object (readonly)

Returns the value of attribute ci_recorder.



24
25
26
 
# File 'lib/datadog/ci/configuration/components.rb', line 24

def ci_recorder
  @ci_recorder
end

#itr ⇒ Object (readonly)

Returns the value of attribute itr.



24
25
26
 
# File 'lib/datadog/ci/configuration/components.rb', line 24

def itr
  @itr
end

Instance Method Details

#activate_ci!(settings) ⇒ Object 



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

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

  # Configure ddtrace library for CI visibility mode
  # Deactivate telemetry
  settings.telemetry.enabled = false

  # Deactivate remote configuration
  settings.remote.enabled = false

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

  # Activate underlying tracing test mode
  settings.tracing.test_mode.enabled = true

  # Choose user defined TraceFlush or default to CI TraceFlush
  settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Partial.new

  # 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.
  if 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
  end

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

  # transport creation
  writer_options = settings.ci.writer_options
  coverage_writer = nil
  test_visibility_api = build_test_visibility_api(settings)

  if test_visibility_api
    # setup writer for code coverage payloads
    coverage_writer = ITR::Coverage::Writer.new(
      transport: ITR::Coverage::Transport.new(api: test_visibility_api)
    )

    # configure tracing writer to send traces to CI visibility backend
    writer_options[:transport] = TestVisibility::Transport.new(
      api: test_visibility_api,
      serializers_factory: serializers_factory(settings),
      dd_env: settings.env
    )
    writer_options[:shutdown_timeout] = 60
    writer_options[:buffer_size] = 10_000

    settings.tracing.test_mode.async = true
  else
    # 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

  settings.tracing.test_mode.writer_options = writer_options

  custom_configuration_tags = Utils::TestRun.custom_configuration(settings.tags)

  remote_settings_api = Transport::RemoteSettingsApi.new(
    api: test_visibility_api,
    dd_env: settings.env,
    config_tags: custom_configuration_tags
  )

  itr = ITR::Runner.new(
    api: test_visibility_api,
    dd_env: settings.env,
    config_tags: custom_configuration_tags,
    coverage_writer: coverage_writer,
    enabled: settings.ci.enabled && settings.ci.itr_enabled,
    bundle_location: settings.ci.itr_code_coverage_excluded_bundle_path
  )

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

  # CI visibility recorder global instance
  @ci_recorder = TestVisibility::Recorder.new(
    test_suite_level_visibility_enabled: !settings.ci.force_test_level_visibility,
    itr: itr,
    remote_settings_api: remote_settings_api,
    git_tree_upload_worker: git_tree_upload_worker
  )

  @itr = itr
end

#build_test_visibility_api(settings) ⇒ Object 



155
156
157
158
159
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
 
# File 'lib/datadog/ci/configuration/components.rb', line 155

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"
      )
    end
  end

  api
end

#check_dd_site(settings) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/datadog/ci/configuration/components.rb', line 195

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

#initialize(settings) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/datadog/ci/configuration/components.rb', line 26

def initialize(settings)
  # Activate CI mode if enabled
  if settings.ci.enabled
    activate_ci!(settings)
  else
    @itr = nil
    @ci_recorder = TestVisibility::NullRecorder.new
  end

  super
end

#serializers_factory(settings) ⇒ Object 



187
188
189
190
191
192
193
 
# File 'lib/datadog/ci/configuration/components.rb', line 187

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 



38
39
40
41
42
43
 
# File 'lib/datadog/ci/configuration/components.rb', line 38

def shutdown!(replacement = nil)
  super

  @ci_recorder&.shutdown!
  @itr&.shutdown!
end

#timecop? ⇒ Boolean

Returns:

  • (Boolean) 


206
207
208
 
# File 'lib/datadog/ci/configuration/components.rb', line 206

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