Class: Datadog::CI::TestTracing::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/ci/test_tracing/context.rb

Overview

Manages current in-memory context for test visibility (such as active test session, suite, test, etc.). Its responsibility includes building domain models for test visibility as well. Internally it uses Datadog::Tracing module to create spans.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test_tracing_component:, runtime_tags_overrides: {}) ⇒ Context

Returns a new instance of Context.



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 33

def initialize(test_tracing_component:, runtime_tags_overrides: {})
  @test_tracing_component = test_tracing_component
  @runtime_tags_overrides = runtime_tags_overrides

  @fiber_local_context = Store::FiberLocal.new
  @process_context = Store::Process.new

  @mutex = Mutex.new

  @total_tests_count = 0
  @tests_skipped_by_tia_count = 0
end

Instance Attribute Details

#tests_skipped_by_tia_count ⇒ Object (readonly)

Returns the value of attribute tests_skipped_by_tia_count.



31
32
33
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 31

def tests_skipped_by_tia_count
  @tests_skipped_by_tia_count
end

#total_tests_count ⇒ Object (readonly)

Returns the value of attribute total_tests_count.



31
32
33
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 31

def total_tests_count
  @total_tests_count
end

Instance Method Details

#active_span ⇒ Object 



150
151
152
153
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 150

def active_span
  tracer_span = Datadog::Tracing.active_span
  Span.new(tracer_span) if tracer_span
end

#active_test ⇒ Object 



155
156
157
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 155

def active_test
  @fiber_local_context.active_test
end

#active_test_module ⇒ Object 



163
164
165
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 163

def active_test_module
  @process_context.active_test_module
end

#active_test_session ⇒ Object 



159
160
161
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 159

def active_test_session
  @process_context.active_test_session
end

#active_test_suite(test_suite_name) ⇒ Object 



167
168
169
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 167

def active_test_suite(test_suite_name)
  @process_context.active_test_suite(test_suite_name)
end

#deactivate_test ⇒ Object 



179
180
181
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 179

def deactivate_test
  @fiber_local_context.deactivate_test
end

#deactivate_test_module ⇒ Object 



187
188
189
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 187

def deactivate_test_module
  @process_context.deactivate_test_module!
end

#deactivate_test_session ⇒ Object 



183
184
185
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 183

def deactivate_test_session
  @process_context.deactivate_test_session!
end

#deactivate_test_suite(test_suite_name) ⇒ Object 



191
192
193
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 191

def deactivate_test_suite(test_suite_name)
  @process_context.deactivate_test_suite!(test_suite_name)
end

#incr_tests_skipped_by_tia_count ⇒ Object 



199
200
201
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 199

def incr_tests_skipped_by_tia_count
  @mutex.synchronize { @tests_skipped_by_tia_count += 1 }
end

#incr_total_tests_count ⇒ Object 



195
196
197
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 195

def incr_total_tests_count
  @mutex.synchronize { @total_tests_count += 1 }
end

#single_active_test_suite ⇒ Object 



171
172
173
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 171

def single_active_test_suite
  @process_context.fetch_single_test_suite
end

#start_test_module(test_module_name, service: nil, tags: {}) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 62

def start_test_module(test_module_name, service: nil, tags: {})
  @process_context.fetch_or_activate_test_module do
    set_inherited_globals(tags)
    set_session_context(tags)

    tracer_span = start_datadog_tracer_span(
      test_module_name, build_tracing_span_options(service, Ext::AppTypes::TYPE_TEST_MODULE)
    )
    set_module_context(tags, tracer_span)

    test_module = build_test_module(tracer_span, tags)

    Telemetry.event_created(test_module)

    test_module
  end
end

#start_test_session(service: nil, tags: {}) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 46

def start_test_session(service: nil, tags: {})
  @process_context.fetch_or_activate_test_session do
    tracer_span = start_datadog_tracer_span(
      "test.session", build_tracing_span_options(service, Ext::AppTypes::TYPE_TEST_SESSION)
    )
    set_session_context(tags, tracer_span)

    test_session = build_test_session(tracer_span, tags)

    Telemetry.test_session_started(test_session)
    Telemetry.event_created(test_session)

    test_session
  end
end

#start_test_suite(test_suite_name, service: nil, tags: {}) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 80

def start_test_suite(test_suite_name, service: nil, tags: {})
  @process_context.fetch_or_activate_test_suite(test_suite_name) do
    set_inherited_globals(tags)
    set_session_context(tags)
    set_module_context(tags)

    tracer_span = start_datadog_tracer_span(
      test_suite_name, build_tracing_span_options(service, Ext::AppTypes::TYPE_TEST_SUITE)
    )
    set_suite_context(tags, test_suite: tracer_span)

    test_suite = build_test_suite(tracer_span, tags)

    Telemetry.event_created(test_suite)

    test_suite
  end
end

#stop_all_test_suites ⇒ Object 



175
176
177
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 175

def stop_all_test_suites
  @process_context.stop_all_test_suites
end

#trace(span_name, type: "span", tags: {}, &block) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 132

def trace(span_name, type: "span", tags: {}, &block)
  span_options = build_tracing_span_options(
    nil, # service name is completely optional for custom spans
    type,
    {resource: span_name}
  )

  if block
    start_datadog_tracer_span(span_name, span_options) do |tracer_span|
      block.call(build_span(tracer_span, tags))
    end
  else
    tracer_span = start_datadog_tracer_span(span_name, span_options)

    build_span(tracer_span, tags)
  end
end

#trace_test(test_name, test_suite, service: nil, tags: {}, &block) ⇒ Object 



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
 
# File 'lib/datadog/ci/test_tracing/context.rb', line 99

def trace_test(test_name, test_suite, service: nil, tags: {}, &block)
  set_inherited_globals(tags)
  set_session_context(tags)
  set_module_context(tags)
  set_suite_context(tags, test_suite: test_suite)

  tags[Ext::Test::TAG_NAME] = test_name
  tags[Ext::Test::TAG_TYPE] ||= Ext::Test::Type::TEST

  span_options = build_tracing_span_options(
    service,
    Ext::AppTypes::TYPE_TEST,
    # :resource is needed for the agent APM protocol to work correctly (for older agent versions)
    # :continue_from is required to start a new trace for each test
    {resource: test_name, continue_from: Datadog::Tracing::TraceDigest.new}
  )

  if block
    start_datadog_tracer_span(test_name, span_options) do |tracer_span|
      test = build_test(tracer_span, tags)

      @fiber_local_context.activate_test(test) do
        block.call(test)
      end
    end
  else
    tracer_span = start_datadog_tracer_span(test_name, span_options)
    test = build_test(tracer_span, tags)
    @fiber_local_context.activate_test(test)
    test
  end
end