Class: Datadog::CI::Span

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

Overview

Represents a single part of a test run. Could be a session, suite, test, or any custom span.

Direct Known Subclasses

ConcurrentSpan, Test

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tracer_span) ⇒ Span

Returns a new instance of Span.



17
18
19
# File 'lib/datadog/ci/span.rb', line 17

def initialize(tracer_span)
  @tracer_span = tracer_span
end

Instance Attribute Details

#tracer_spanObject (readonly)

Returns the value of attribute tracer_span.



15
16
17
# File 'lib/datadog/ci/span.rb', line 15

def tracer_span
  @tracer_span
end

Instance Method Details

#clear_tag(key) ⇒ void

This method returns an undefined value.

Removes tag by key.

Parameters:

  • key (String)

    the key of the tag.



108
109
110
# File 'lib/datadog/ci/span.rb', line 108

def clear_tag(key)
  tracer_span.clear_tag(key)
end

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



74
75
76
77
78
# File 'lib/datadog/ci/span.rb', line 74

def failed!(exception: nil)
  tracer_span.status = 1
  tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::FAIL)
  tracer_span.set_error(exception) unless exception.nil?
end

#failed?bool

Checks whether span status is FAIL.

Returns:

  • (bool)

    true if span status is FAIL



55
56
57
# File 'lib/datadog/ci/span.rb', line 55

def failed?
  tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::FAIL
end

#finishvoid

This method returns an undefined value.

Finishes the span.



122
123
124
# File 'lib/datadog/ci/span.rb', line 122

def finish
  tracer_span.finish
end

#get_tag(key) ⇒ String

Gets tag value by key.

Parameters:

  • key (String)

    the key of the tag.

Returns:

  • (String)

    the value of the tag.



93
94
95
# File 'lib/datadog/ci/span.rb', line 93

def get_tag(key)
  tracer_span.get_tag(key)
end

#git_branchString

Returns the git branch name extracted from the environment.

Returns:

  • (String)

    the branch.



147
148
149
# File 'lib/datadog/ci/span.rb', line 147

def git_branch
  tracer_span.get_tag(Ext::Git::TAG_BRANCH)
end

#git_commit_shaString

Returns the latest commit SHA extracted from the environment.

Returns:

  • (String)

    the commit SHA of the last commit.



141
142
143
# File 'lib/datadog/ci/span.rb', line 141

def git_commit_sha
  tracer_span.get_tag(Ext::Git::TAG_COMMIT_SHA)
end

#git_repository_urlString

Returns the git repository URL extracted from the environment.

Returns:

  • (String)

    the repository URL.



135
136
137
# File 'lib/datadog/ci/span.rb', line 135

def git_repository_url
  tracer_span.get_tag(Ext::Git::TAG_REPOSITORY_URL)
end

#idInteger

Returns the ID of the span.

Returns:

  • (Integer)

    the ID of the span.



22
23
24
# File 'lib/datadog/ci/span.rb', line 22

def id
  tracer_span.id
end

#nameString

Returns the name of the span.

Returns:

  • (String)

    the name of the span.



27
28
29
# File 'lib/datadog/ci/span.rb', line 27

def name
  tracer_span.name
end

#os_architectureString

Returns the OS architecture extracted from the environment.

Returns:

  • (String)

    OS arch.



153
154
155
# File 'lib/datadog/ci/span.rb', line 153

def os_architecture
  tracer_span.get_tag(Ext::Test::TAG_OS_ARCHITECTURE)
end

#os_platformString

Returns the OS platform extracted from the environment.

Returns:

  • (String)

    OS platform.



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

def os_platform
  tracer_span.get_tag(Ext::Test::TAG_OS_PLATFORM)
end

#os_versionString

Returns the OS version extracted from the environment.

Returns:

  • (String)

    OS version.



165
166
167
# File 'lib/datadog/ci/span.rb', line 165

def os_version
  tracer_span.get_tag(Ext::Test::TAG_OS_VERSION)
end

#passed!void

This method returns an undefined value.

Sets the status of the span to "pass".



67
68
69
# File 'lib/datadog/ci/span.rb', line 67

def passed!
  tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::PASS)
end

#passed?bool

Checks whether span status is PASS.

Returns:

  • (bool)

    true if span status is PASS



49
50
51
# File 'lib/datadog/ci/span.rb', line 49

def passed?
  tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::PASS
end

#runtime_nameString

Returns the runtime name extracted from the environment.

Returns:

  • (String)

    runtime name.



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

def runtime_name
  tracer_span.get_tag(Ext::Test::TAG_RUNTIME_NAME)
end

#runtime_versionString

Returns the runtime version extracted from the environment.

Returns:

  • (String)

    runtime version.



177
178
179
# File 'lib/datadog/ci/span.rb', line 177

def runtime_version
  tracer_span.get_tag(Ext::Test::TAG_RUNTIME_VERSION)
end

#serviceString

Returns the service name of the span.

Returns:

  • (String)

    the service name of the span.



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

def service
  tracer_span.service
end

#set_default_tagsObject



190
191
192
# File 'lib/datadog/ci/span.rb', line 190

def set_default_tags
  tracer_span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::Test::SPAN_KIND_TEST)
end

#set_environment_runtime_tagsObject



181
182
183
184
185
186
187
188
# File 'lib/datadog/ci/span.rb', line 181

def set_environment_runtime_tags
  tracer_span.set_tag(Ext::Test::TAG_OS_ARCHITECTURE, ::RbConfig::CONFIG["host_cpu"])
  tracer_span.set_tag(Ext::Test::TAG_OS_PLATFORM, ::RbConfig::CONFIG["host_os"])
  tracer_span.set_tag(Ext::Test::TAG_OS_VERSION, Core::Environment::Platform.kernel_release)
  tracer_span.set_tag(Ext::Test::TAG_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
  tracer_span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
  tracer_span.set_tag(Ext::Test::TAG_COMMAND, Utils::TestRun.command)
end

#set_metric(key, value) ⇒ void

This method returns an undefined value.

Sets metric value by key.

Parameters:

  • key (String)

    the key of the metric.

  • value (Numeric)

    the value of the metric.



116
117
118
# File 'lib/datadog/ci/span.rb', line 116

def set_metric(key, value)
  tracer_span.set_metric(key, value)
end

#set_tag(key, value) ⇒ void

This method returns an undefined value.

Sets tag value by key.

Parameters:

  • key (String)

    the key of the tag.

  • value (String)

    the value of the tag.



101
102
103
# File 'lib/datadog/ci/span.rb', line 101

def set_tag(key, value)
  tracer_span.set_tag(key, value)
end

#set_tags(tags) ⇒ void

This method returns an undefined value.

Sets multiple tags at once.

Parameters:

  • tags (Hash[String, String])

    the tags to set.



129
130
131
# File 'lib/datadog/ci/span.rb', line 129

def set_tags(tags)
  tracer_span.set_tags(tags)
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.



84
85
86
87
88
# File 'lib/datadog/ci/span.rb', line 84

def skipped!(exception: nil, reason: nil)
  tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::SKIP)
  tracer_span.set_error(exception) unless exception.nil?
  tracer_span.set_tag(Ext::Test::TAG_SKIP_REASON, reason) unless reason.nil?
end

#skipped?bool

Checks whether span status is SKIP.

Returns:

  • (bool)

    true if span status is SKIP



61
62
63
# File 'lib/datadog/ci/span.rb', line 61

def skipped?
  tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::SKIP
end

#to_sObject



194
195
196
# File 'lib/datadog/ci/span.rb', line 194

def to_s
  "#{self.class}(name:#{name},tracer_span:#{@tracer_span})"
end

#typeString

Returns the type of the span (for example "test" or type that was provided to [Datadog::CI.trace]).

Returns:

  • (String)

    the type of the span (for example "test" or type that was provided to [Datadog::CI.trace]).



37
38
39
# File 'lib/datadog/ci/span.rb', line 37

def type
  tracer_span.type
end

#undefined?bool

Checks whether span status is not set yet.

Returns:

  • (bool)

    true if span does not have status



43
44
45
# File 'lib/datadog/ci/span.rb', line 43

def undefined?
  tracer_span.get_tag(Ext::Test::TAG_STATUS).nil?
end