Class: Datadog::CI::TestVisibility::Serializers::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/ci/test_visibility/serializers/base.rb

Direct Known Subclasses

Span, TestModule, TestSession, TestSuite, TestV1

Constant Summary collapse

MINIMUM_TIMESTAMP_NANO = 
946684800000000000
MINIMUM_DURATION_NANO = 
0
MAXIMUM_DURATION_NANO = 
9223372036854775807
CONTENT_FIELDS = 
[
  "name", "resource", "service",
  "error", "start", "duration",
  "meta", "metrics",
  "type" => "span_type"
].freeze
REQUIRED_FIELDS = 
[
  "error",
  "name",
  "resource",
  "start",
  "duration"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(trace, span) ⇒ Base

Returns a new instance of Base.



33
34
35
36
37
38
39
40
41
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 33

def initialize(trace, span)
  @trace = trace
  @span = span

  @meta = @span.meta.reject { |key, _| Ext::Test::TRANSIENT_TAGS.include?(key) }

  @errors = {}
  @validated = false
end

Instance Attribute Details

#meta ⇒ Object (readonly)

Returns the value of attribute meta.



31
32
33
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 31

def meta
  @meta
end

#span ⇒ Object (readonly)

Returns the value of attribute span.



31
32
33
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 31

def span
  @span
end

#trace ⇒ Object (readonly)

Returns the value of attribute trace.



31
32
33
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 31

def trace
  @trace
end

Class Method Details

.calculate_content_map_size(fields_list) ⇒ Object 



162
163
164
165
166
167
168
169
170
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 162

def self.calculate_content_map_size(fields_list)
  fields_list.reduce(0) do |size, field|
    if field.is_a?(Hash)
      size + field.size
    else
      size + 1
    end
  end
end

Instance Method Details

#content_fields ⇒ Object 



86
87
88
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 86

def content_fields
  []
end

#content_map_size ⇒ Object 



90
91
92
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 90

def content_map_size
  0
end

#duration ⇒ Object 



150
151
152
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 150

def duration
  @duration ||= duration_nano(@span.duration)
end

#error ⇒ Object 



158
159
160
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 158

def error
  @span.status
end

#event_type ⇒ Object 



130
131
132
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 130

def event_type
  "span"
end

#metrics ⇒ Object 



154
155
156
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 154

def metrics
  @span.metrics
end

#name ⇒ Object 



134
135
136
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 134

def name
  @span.name
end

#parent_id ⇒ Object 



106
107
108
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 106

def parent_id
  @span.parent_id
end

#resource ⇒ Object 



138
139
140
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 138

def resource
  @span.resource
end

#runtime_id ⇒ Object 



94
95
96
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 94

def runtime_id
  @trace.runtime_id
end

#service ⇒ Object 



142
143
144
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 142

def service
  @span.service
end

#span_id ⇒ Object 



102
103
104
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 102

def span_id
  @span.id
end

#span_type ⇒ Object 



126
127
128
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 126

def span_type
  @span.type
end

#start ⇒ Object 



146
147
148
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 146

def start
  @start ||= time_nano(@span.start_time)
end

#test_module_id ⇒ Object 



114
115
116
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 114

def test_module_id
  to_integer(@span.get_tag(Ext::Test::TAG_TEST_MODULE_ID))
end

#test_session_id ⇒ Object 



110
111
112
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 110

def test_session_id
  to_integer(@span.get_tag(Ext::Test::TAG_TEST_SESSION_ID))
end

#test_suite_id ⇒ Object 



118
119
120
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 118

def test_suite_id
  to_integer(@span.get_tag(Ext::Test::TAG_TEST_SUITE_ID))
end

#to_msgpack(packer = nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 43

def to_msgpack(packer = nil)
  packer ||= MessagePack::Packer.new

  packer.write_map_header(3)

  write_field(packer, "type", "event_type")
  write_field(packer, "version")

  packer.write("content")
  packer.write_map_header(content_map_size)

  content_fields.each do |field|
    if field.is_a?(Hash)
      field.each do |field_name, method|
        write_field(packer, field_name, method)
      end
    else
      write_field(packer, field)
    end
  end
end

#trace_id ⇒ Object 



98
99
100
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 98

def trace_id
  @trace.id
end

#valid? ⇒ Boolean

validates according to citestcycle json schema

Returns:

  • (Boolean) 


66
67
68
69
70
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 66

def valid?
  validate! unless @validated

  @errors.empty?
end

#validate! ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 72

def validate!
  @errors.clear

  validate_required_fields!
  validate_start_time!
  validate_duration!

  @validated = true
end

#validation_errors ⇒ Object 



82
83
84
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 82

def validation_errors
  @errors
end

#version ⇒ Object 



122
123
124
 
# File 'lib/datadog/ci/test_visibility/serializers/base.rb', line 122

def version
  1
end