Class: Datadog::CI::Test

Inherits:
Span
  • Object
show all
Defined in:
lib/datadog/ci/test.rb

Overview

Represents a single part of a test run.

Instance Attribute Summary

Attributes inherited from Span

#tracer_span

Instance Method Summary collapse

Methods inherited from Span

#clear_tag, #failed?, #get_tag, #git_branch, #git_commit_sha, #git_repository_url, #id, #initialize, #os_architecture, #os_platform, #os_version, #passed?, #runtime_name, #runtime_version, #service, #set_default_tags, #set_environment_runtime_tags, #set_metric, #set_tag, #set_tags, #skipped?, #to_s, #trace_id, #type, #undefined?

Constructor Details

This class inherits a constructor from Datadog::CI::Span

Instance Method Details

#failed!(exception: nil) ⇒ void

This method returns an undefined value.

Sets the status of the span to “fail”.

Parameters:

  • exception (Exception) (defaults to: nil) —

    the exception that caused the test to fail.



106
107
108
109
110
 
# File 'lib/datadog/ci/test.rb', line 106

def failed!(exception: nil)
  super

  record_test_result(Ext::Test::Status::FAIL)
end

#finish ⇒ void

This method returns an undefined value.

Finishes the current test.



22
23
24
25
26
 
# File 'lib/datadog/ci/test.rb', line 22

def finish
  test_visibility.deactivate_test

  super
end

#itr_unskippable! ⇒ void

This method returns an undefined value.

Marks this test as unskippable by the intelligent test runner. This must be done before the test execution starts.

Examples of tests that should be unskippable:

  • tests that read files from disk

  • tests that make network requests

  • tests that call external processes

  • tests that use forking or threading



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/datadog/ci/test.rb', line 83

def itr_unskippable!
  TestOptimisation::Telemetry.itr_unskippable
  set_tag(Ext::Test::TAG_ITR_UNSKIPPABLE, "true")

  if skipped_by_itr?
    clear_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR)

    TestOptimisation::Telemetry.itr_forced_run
    set_tag(Ext::Test::TAG_ITR_FORCED_RUN, "true")
  end
end

#name ⇒ String

Returns the name of the test.

Returns:

  • (String) —

    the name of the test.



16
17
18
 
# File 'lib/datadog/ci/test.rb', line 16

def name
  get_tag(Ext::Test::TAG_NAME)
end

#parameters ⇒ String?

Gets the parameters for this test (e.g. Cucumber example or RSpec specs) as a serialized JSON.

Returns:

  • (String) —

    the serialized JSON of the parameters

  • (nil) —

    if this test does not have parameters



138
139
140
 
# File 'lib/datadog/ci/test.rb', line 138

def parameters
  get_tag(Ext::Test::TAG_PARAMETERS)
end

#passed! ⇒ void

This method returns an undefined value.

Sets the status of the span to “pass”.



97
98
99
100
101
 
# File 'lib/datadog/ci/test.rb', line 97

def passed!
  super

  record_test_result(Ext::Test::Status::PASS)
end

#set_parameters(arguments, metadata = {}) ⇒ void

This method returns an undefined value.

Sets the parameters for this test (e.g. Cucumber example or RSpec specs). Parameters are needed to compute test fingerprint to distinguish between different tests having same names.

Parameters:

  • arguments (Hash) —

    the arguments that test accepts as key-value hash

  • metadata (Hash) (defaults to: {}) —

    optional metadata



128
129
130
131
132
 
# File 'lib/datadog/ci/test.rb', line 128

def set_parameters(arguments, metadata = {})
  return if arguments.nil?

  set_tag(Ext::Test::TAG_PARAMETERS, Utils::TestRun.test_parameters(arguments: arguments, metadata: metadata))
end

#skipped!(exception: nil, reason: nil) ⇒ void

This method returns an undefined value.

Sets the status of the span to “skip”.

Parameters:

  • exception (Exception) (defaults to: nil) —

    the exception that caused the test to fail.

  • reason (String) (defaults to: nil) —

    the reason why the test was skipped.



116
117
118
119
120
 
# File 'lib/datadog/ci/test.rb', line 116

def skipped!(exception: nil, reason: nil)
  super

  record_test_result(Ext::Test::Status::SKIP)
end

#skipped_by_itr? ⇒ Boolean

Returns “true” if the test is skipped by the intelligent test runner.

Returns:

  • (Boolean) —

    true if the test is skipped by the intelligent test runner, false otherwise.



69
70
71
 
# File 'lib/datadog/ci/test.rb', line 69

def skipped_by_itr?
  get_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR) == "true"
end

#source_file ⇒ String?

Source file path of the test relative to git repository root.

Returns:

  • (String) —

    the source file path of the test

  • (nil) —

    if the source file path is not found



63
64
65
 
# File 'lib/datadog/ci/test.rb', line 63

def source_file
  get_tag(Ext::Test::TAG_SOURCE_FILE)
end

#test_module_id ⇒ String

Span id of the running test module this test belongs to.

Returns:

  • (String) —

    the span id of the test module.



50
51
52
 
# File 'lib/datadog/ci/test.rb', line 50

def test_module_id
  get_tag(Ext::Test::TAG_TEST_MODULE_ID)
end

#test_session_id ⇒ String

Span id of the running test session this test belongs to.

Returns:

  • (String) —

    the span id of the test session.



56
57
58
 
# File 'lib/datadog/ci/test.rb', line 56

def test_session_id
  get_tag(Ext::Test::TAG_TEST_SESSION_ID)
end

#test_suite ⇒ Datadog::CI::TestSuite?

Running test suite that this test is part of (if any).

Returns:



31
32
33
34
 
# File 'lib/datadog/ci/test.rb', line 31

def test_suite
  suite_name = test_suite_name
  CI.active_test_suite(suite_name) if suite_name
end

#test_suite_id ⇒ String

Span id of the running test suite this test belongs to.

Returns:

  • (String) —

    the span id of the test suite.



38
39
40
 
# File 'lib/datadog/ci/test.rb', line 38

def test_suite_id
  get_tag(Ext::Test::TAG_TEST_SUITE_ID)
end

#test_suite_name ⇒ String

Name of the running test suite this test belongs to.

Returns:

  • (String) —

    the name of the test suite.



44
45
46
 
# File 'lib/datadog/ci/test.rb', line 44

def test_suite_name
  get_tag(Ext::Test::TAG_SUITE)
end