datadog-ci 0.4.1 → 0.5.1

data/lib/datadog/ci/test_visibility/serializers/base.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "set"
+
+require_relative "../../ext/test"
+
 module Datadog
   module CI
     module TestVisibility
@@ -9,11 +13,31 @@ module Datadog
           MINIMUM_DURATION_NANO = 0
           MAXIMUM_DURATION_NANO = 9223372036854775807
 
-          attr_reader :trace, :span
+          CONTENT_FIELDS = [
+            "name", "resource", "service",
+            "error", "start", "duration",
+            "meta", "metrics",
+            "type" => "span_type"
+          ].freeze
+
+          REQUIRED_FIELDS = [
+            "error",
+            "name",
+            "resource",
+            "start",
+            "duration"
+          ].freeze
+
+          attr_reader :trace, :span, :meta
 
           def initialize(trace, span)
             @trace = trace
             @span = span
+
+            @meta = @span.meta.reject { |key, _| Ext::Test::SPECIAL_TAGS.include?(key) }
+
+            @errors = {}
+            @validated = false
           end
 
           def to_msgpack(packer = nil)
@@ -40,7 +64,23 @@ module Datadog
 
           # validates according to citestcycle json schema
           def valid?
-            required_fields_present? && valid_start_time? && valid_duration?
+            validate! unless @validated
+
+            @errors.empty?
+          end
+
+          def validate!
+            @errors.clear
+
+            validate_required_fields!
+            validate_start_time!
+            validate_duration!
+
+            @validated = true
+          end
+
+          def validation_errors
+            @errors
           end
 
           def content_fields
@@ -67,6 +107,18 @@ module Datadog
             @span.parent_id
           end
 
+          def test_session_id
+            to_integer(@span.get_tag(Ext::Test::TAG_TEST_SESSION_ID))
+          end
+
+          def test_module_id
+            to_integer(@span.get_tag(Ext::Test::TAG_TEST_MODULE_ID))
+          end
+
+          def test_suite_id
+            to_integer(@span.get_tag(Ext::Test::TAG_TEST_SUITE_ID))
+          end
+
           def type
           end
 
@@ -98,10 +150,6 @@ module Datadog
             @duration ||= duration_nano(@span.duration)
           end
 
-          def meta
-            @span.meta
-          end
-
           def metrics
             @span.metrics
           end
@@ -122,16 +170,48 @@ module Datadog
 
           private
 
-          def valid_start_time?
-            !start.nil? && start >= MINIMUM_TIMESTAMP_NANO
+          def validate_start_time!
+            validate_required!("start")
+            validate_greater_than_or_equal!("start", MINIMUM_TIMESTAMP_NANO)
+          end
+
+          def validate_duration!
+            validate_required!("duration")
+            validate_greater_than_or_equal!("duration", MINIMUM_DURATION_NANO)
+            validate_less_than_or_equal!("duration", MAXIMUM_DURATION_NANO)
+          end
+
+          def validate_required_fields!
+            required_fields.each do |field|
+              validate_required!(field)
+            end
           end
 
-          def valid_duration?
-            !duration.nil? && duration >= MINIMUM_DURATION_NANO && duration <= MAXIMUM_DURATION_NANO
+          def validate_required!(field)
+            if send(field).nil?
+              add_error(field, "is required")
+            end
           end
 
-          def required_fields_present?
-            required_fields.all? { |field| !send(field).nil? }
+          def validate_greater_than_or_equal!(field, value)
+            return if send(field).nil?
+
+            if send(field) < value
+              add_error(field, "must be greater than or equal to #{value}")
+            end
+          end
+
+          def validate_less_than_or_equal!(field, value)
+            return if send(field).nil?
+
+            if send(field) > value
+              add_error(field, "must be less than or equal to #{value}")
+            end
+          end
+
+          def add_error(field, message)
+            @errors[field] ||= Set.new
+            @errors[field] << message
           end
 
           def required_fields
@@ -154,6 +234,14 @@ module Datadog
           def duration_nano(duration)
             (duration * 1e9).to_i
           end
+
+          def to_s
+            "#{self.class.name}(id:#{span_id},name:#{name})"
+          end
+
+          def to_integer(value)
+            value.to_i if value
+          end
         end
       end
     end

data/lib/datadog/ci/test_visibility/serializers/factories/test_suite_level.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "../test_v2"
+require_relative "../test_session"
+require_relative "../test_module"
+require_relative "../test_suite"
+require_relative "../span"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        module Factories
+          # This factory takes care of creating citestcycle serializers when test-suite-level visibility is enabled
+          module TestSuiteLevel
+            module_function
+
+            def serializer(trace, span)
+              case span.type
+              when Datadog::CI::Ext::AppTypes::TYPE_TEST
+                Serializers::TestV2.new(trace, span)
+              when Datadog::CI::Ext::AppTypes::TYPE_TEST_SESSION
+                Serializers::TestSession.new(trace, span)
+              when Datadog::CI::Ext::AppTypes::TYPE_TEST_MODULE
+                Serializers::TestModule.new(trace, span)
+              when Datadog::CI::Ext::AppTypes::TYPE_TEST_SUITE
+                Serializers::TestSuite.new(trace, span)
+              else
+                Serializers::Span.new(trace, span)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/serializers/span.rb

@@ -7,25 +7,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class Span < Base
-          CONTENT_FIELDS = [
-            "trace_id", "span_id", "parent_id",
-            "name", "resource", "service",
-            "error", "start", "duration",
-            "meta", "metrics",
-            "type" => "span_type"
-          ].freeze
+          CONTENT_FIELDS = (["trace_id", "span_id", "parent_id"] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = [
-            "trace_id",
-            "span_id",
-            "error",
-            "name",
-            "resource",
-            "start",
-            "duration"
-          ].freeze
+          REQUIRED_FIELDS = (["trace_id", "span_id"] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS

data/lib/datadog/ci/test_visibility/serializers/test_module.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestModule < Base
+          CONTENT_FIELDS = (["test_session_id", "test_module_id"] + Base::CONTENT_FIELDS).freeze
+
+          CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
+
+          REQUIRED_FIELDS = (["test_session_id", "test_module_id"] + Base::REQUIRED_FIELDS).freeze
+
+          def content_fields
+            CONTENT_FIELDS
+          end
+
+          def content_map_size
+            CONTENT_MAP_SIZE
+          end
+
+          def type
+            Ext::AppTypes::TYPE_TEST_MODULE
+          end
+
+          def name
+            "#{@span.get_tag(Ext::Test::TAG_FRAMEWORK)}.test_module"
+          end
+
+          def resource
+            "#{@span.get_tag(Ext::Test::TAG_FRAMEWORK)}.test_module.#{@span.get_tag(Ext::Test::TAG_MODULE)}"
+          end
+
+          private
+
+          def required_fields
+            REQUIRED_FIELDS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/serializers/test_session.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestSession < Base
+          CONTENT_FIELDS = (["test_session_id"] + Base::CONTENT_FIELDS).freeze
+
+          CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
+
+          REQUIRED_FIELDS = (["test_session_id"] + Base::REQUIRED_FIELDS).freeze
+
+          def content_fields
+            CONTENT_FIELDS
+          end
+
+          def content_map_size
+            CONTENT_MAP_SIZE
+          end
+
+          def type
+            Ext::AppTypes::TYPE_TEST_SESSION
+          end
+
+          def name
+            "#{@span.get_tag(Ext::Test::TAG_FRAMEWORK)}.test_session"
+          end
+
+          def resource
+            "#{@span.get_tag(Ext::Test::TAG_FRAMEWORK)}.test_session.#{@span.get_tag(Ext::Test::TAG_COMMAND)}"
+          end
+
+          private
+
+          def required_fields
+            REQUIRED_FIELDS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/serializers/test_suite.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestSuite < Base
+          CONTENT_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + Base::CONTENT_FIELDS).freeze
+
+          CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
+
+          REQUIRED_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + Base::REQUIRED_FIELDS).freeze
+
+          def content_fields
+            CONTENT_FIELDS
+          end
+
+          def content_map_size
+            CONTENT_MAP_SIZE
+          end
+
+          def type
+            Ext::AppTypes::TYPE_TEST_SUITE
+          end
+
+          def name
+            "#{@span.get_tag(Ext::Test::TAG_FRAMEWORK)}.test_suite"
+          end
+
+          def resource
+            "#{@span.get_tag(Ext::Test::TAG_FRAMEWORK)}.test_suite.#{@span.get_tag(Ext::Test::TAG_SUITE)}"
+          end
+
+          private
+
+          def required_fields
+            REQUIRED_FIELDS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/serializers/test_v1.rb

@@ -8,25 +8,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class TestV1 < Base
-          CONTENT_FIELDS = [
-            "trace_id", "span_id",
-            "name", "resource", "service",
-            "error", "start", "duration",
-            "meta", "metrics",
-            "type" => "span_type"
-          ].freeze
+          CONTENT_FIELDS = (["trace_id", "span_id"] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = [
-            "trace_id",
-            "span_id",
-            "error",
-            "name",
-            "resource",
-            "start",
-            "duration"
-          ].freeze
+          REQUIRED_FIELDS = (["trace_id", "span_id"] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS
@@ -37,7 +23,7 @@ module Datadog
           end
 
           def type
-            "test"
+            Ext::AppTypes::TYPE_TEST
           end
 
           def name

data/lib/datadog/ci/test_visibility/serializers/test_v2.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "test_v1"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestV2 < TestV1
+          CONTENT_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::CONTENT_FIELDS).freeze
+
+          CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
+
+          REQUIRED_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::REQUIRED_FIELDS).freeze
+
+          def content_fields
+            CONTENT_FIELDS
+          end
+
+          def content_map_size
+            CONTENT_MAP_SIZE
+          end
+
+          def version
+            2
+          end
+
+          private
+
+          def required_fields
+            REQUIRED_FIELDS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/transport.rb

@@ -81,7 +81,7 @@ module Datadog
             if spans.respond_to?(:filter_map)
               spans.filter_map { |span| encode_span(trace, span) }
             else
-              trace.spans.map { |span| encode_span(trace, span) }.reject(&:nil?)
+              spans.map { |span| encode_span(trace, span) }.reject(&:nil?)
             end
           end
         end
@@ -94,15 +94,15 @@ module Datadog
 
             if encoded.size > max_payload_size
               # This single event is too large, we can't flush it
-              Datadog.logger.debug { "Dropping test event. Payload too large: '#{span.inspect}'" }
-              Datadog.logger.debug { encoded }
+              Datadog.logger.warn("Dropping test event. Payload too large: '#{span.inspect}'")
+              Datadog.logger.warn(encoded)
 
               return nil
             end
 
             encoded
           else
-            Datadog.logger.debug { "Invalid span skipped: #{span}" }
+            Datadog.logger.warn("Invalid event skipped: #{serializer} Errors: #{serializer.validation_errors}")
             nil
           end
         end

data/lib/datadog/ci/utils/test_run.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Utils
+      module TestRun
+        def self.command
+          return @command if defined?(@command)
+
+          @command = "#{$0} #{ARGV.join(" ")}"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/version.rb

@@ -4,7 +4,7 @@ module Datadog
   module CI
     module VERSION
       MAJOR = "0"
-      MINOR = "4"
+      MINOR = "5"
       PATCH = "1"
       PRE = nil
       BUILD = nil