Module: Datadog::CI::Contrib::RSpec::Example::InstanceMethods

Defined in:
lib/datadog/ci/contrib/rspec/example.rb

Instance Method Summary collapse

Instance Method Details

#datadog_fqn_test_id ⇒ Object 



125
126
127
128
129
130
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 125

def datadog_fqn_test_id
  @datadog_fqn_test_id ||= Utils::TestRun.datadog_test_id(
    datadog_test_name,
    datadog_test_suite_name
  )
end

#datadog_test_id ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 117

def datadog_test_id
  @datadog_test_id ||= Utils::TestRun.datadog_test_id(
    datadog_test_name,
    datadog_test_suite_name,
    datadog_test_parameters
  )
end

#datadog_test_name ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 132

def datadog_test_name
  return @datadog_test_name if defined?(@datadog_test_name)

  test_name = full_description.strip
  if metadata[:description].empty?
    # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
    test_name << " #{description}"
  end

  # remove example group description from test name to avoid duplication
  test_name = test_name.sub(datadog_test_suite_description, "").strip

  @datadog_test_name = test_name
end

#datadog_test_parameters ⇒ Object 



159
160
161
162
163
164
165
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 159

def datadog_test_parameters
  return @datadog_test_parameters if defined?(@datadog_test_parameters)

  @datadog_test_parameters = Utils::TestRun.test_parameters(
    metadata: {"scoped_id" => metadata[:scoped_id]}
  )
end

#datadog_test_suite_name ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 147

def datadog_test_suite_name
  return @datadog_test_suite_name if defined?(@datadog_test_suite_name)

  suite_name = "#{datadog_test_suite_description} at #{metadata[:example_group][:rerun_file_path]}"

  if ci_queue?
    suite_name = "#{suite_name} (ci-queue running example [#{datadog_test_name}])"
  end

  @datadog_test_suite_name = suite_name
end

#datadog_test_suite_source_file_path ⇒ Object 



171
172
173
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 171

def datadog_test_suite_source_file_path
  Git::LocalRepository.relative_to_root(metadata[:rerun_file_path])
end

#datadog_unskippable? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 167

def datadog_unskippable?
  !!metadata[CI::Ext::Test::ITR_UNSKIPPABLE_OPTION]
end

#finish(reporter) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 106

def finish(reporter)
  # By default finish test but do not report it to RSpec::Core::Reporter
  # it is going to be reported once after retries are done.
  #
  # We need to do this because RSpec breaks when we try to report the same example multiple times with different
  # results.
  return super unless @skip_reporting

  super(::RSpec::Core::NullReporter)
end

#run(*args) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
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
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
 
# File 'lib/datadog/ci/contrib/rspec/example.rb', line 21

def run(*args)
  return super unless datadog_configuration[:enabled]
  return super if ::RSpec.configuration.dry_run? && !datadog_configuration[:dry_run_enabled]

  test_suite_span = test_visibility_component.start_test_suite(datadog_test_suite_name) if ci_queue?

  # don't report test to RSpec::Core::Reporter until retries are done
  @skip_reporting = true

  # @type var tags : Hash[String, String]
  tags = {
    CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
    CI::Ext::Test::TAG_FRAMEWORK_VERSION => datadog_integration.version.to_s,
    CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(metadata[:file_path]),
    CI::Ext::Test::TAG_SOURCE_START => metadata[:line_number].to_s,
    CI::Ext::Test::TAG_PARAMETERS => datadog_test_parameters
  }

  end_line = Utils::SourceCode.last_line(@example_block)
  tags[CI::Ext::Test::TAG_SOURCE_END] = end_line.to_s if end_line

  test_retries_component.with_retries do
    test_visibility_component.trace_test(
      datadog_test_name,
      datadog_test_suite_name,
      tags: tags,
      service: datadog_configuration[:service_name]
    ) do |test_span|
      test_span&.itr_unskippable! if datadog_unskippable?

      metadata[:skip] = test_span&.datadog_skip_reason if test_span&.should_skip?

      # before each run remove any previous exception
      @exception = nil

      result = super

      # When test job is canceled and RSpec is quitting we don't want to report the last test
      # before RSpec context unwinds. This test might have some unrelated errors that we don't want to
      # see in Datadog.
      return result if ::RSpec.world.wants_to_quit

      case execution_result.status
      when :passed
        test_span&.passed!
      when :failed
        test_span&.failed!(exception: execution_result.exception)
        # if any of the retries passed or test is quarantined, we don't fail the test run
        @exception = nil if test_span&.should_ignore_failures?
      else
        # :pending or nil
        test_span&.skipped!(
          reason: execution_result.pending_message,
          exception: execution_result.pending_exception
        )
      end

      if datadog_configuration[:datadog_formatter_enabled]
        if test_span&.is_retry?
          metadata[Ext::METADATA_DD_RETRIES] ||= 0
          metadata[Ext::METADATA_DD_RETRY_RESULTS] ||= Hash.new(0)

          metadata[Ext::METADATA_DD_RETRIES] += 1
          metadata[Ext::METADATA_DD_RETRY_REASON] = test_span&.retry_reason
          metadata[Ext::METADATA_DD_RETRY_RESULTS][test_span&.status] += 1
        end

        metadata[Ext::METADATA_DD_QUARANTINED] = true if test_span&.quarantined?
        metadata[Ext::METADATA_DD_DISABLED] = true if test_span&.disabled?

        if test_span&.skipped_by_test_impact_analysis?
          metadata[Ext::METADATA_DD_SKIPPED_BY_ITR] = true
        end
      end
    end
  end

  # this is a special case for ci-queue, we need to finish the test suite span created for a single test
  test_suite_span&.finish

  # after retries are done, we can finally report the test to RSpec
  @skip_reporting = false
  finish(reporter)
end