datadog-ci 0.4.1 → 0.5.1

data/sig/datadog/ci/test_visibility/recorder.rbs

@@ -0,0 +1,85 @@
+module Datadog
+  module CI
+    module TestVisibility
+      class Recorder
+        @test_suite_level_visibility_enabled: bool
+        @enabled: bool
+
+        @environment_tags: Hash[String, String]
+        @local_context: Datadog::CI::TestVisibility::Context::Local
+        @global_context: Datadog::CI::TestVisibility::Context::Global
+
+        @null_span: Datadog::CI::NullSpan
+
+        attr_reader environment_tags: Hash[String, String]
+        attr_reader test_suite_level_visibility_enabled: bool
+        attr_reader enabled: bool
+
+        def initialize: (?enabled: bool, ?test_suite_level_visibility_enabled: bool) -> void
+
+        def trace_test: (String span_name, String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
+
+        def trace: (String span_type, String span_name, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
+
+        def start_test_session: (?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+        def start_test_module: (String test_module_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+        def start_test_suite: (String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+        def active_test_session: () -> Datadog::CI::TestSession?
+
+        def active_test_module: () -> Datadog::CI::TestModule?
+
+        def active_test_suite: (String test_suite_name) -> Datadog::CI::TestSuite?
+
+        def active_test: () -> Datadog::CI::Test?
+
+        def active_span: () -> Datadog::CI::Span?
+
+        def deactivate_test: (Datadog::CI::Test test) -> void
+
+        def deactivate_test_session: () -> void
+
+        def deactivate_test_module: () -> void
+
+        def deactivate_test_suite: (String test_suite_name) -> void
+
+        def create_datadog_span: (String span_name, ?span_options: Hash[untyped, untyped], ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
+
+        def set_trace_origin: (Datadog::Tracing::TraceOperation trace) -> untyped
+
+        private
+
+        def build_test: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::Test
+
+        def build_test_session: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::TestSession
+
+        def build_test_module: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::TestModule
+
+        def build_test_suite: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::TestSuite
+
+        def build_span: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::Span
+
+        def build_span_options: (String? service_name, String span_type, ?Hash[Symbol, untyped] other_options) -> Hash[Symbol, untyped]
+
+        def set_initial_tags: (Datadog::CI::Span ci_span, Hash[untyped, untyped] tags) -> void
+
+        # the type (Datadog::CI::TestSession | Datadog::Tracing::SpanOperation) screams of wrong/mising abstraction
+        def set_session_context: (Hash[untyped, untyped] tags, ?Datadog::CI::TestSession | Datadog::Tracing::SpanOperation? test_session) -> void
+
+        def set_suite_context: (Hash[untyped, untyped] tags, ?span: Datadog::Tracing::SpanOperation, ?name: String) -> void
+
+        def set_module_context: (Hash[untyped, untyped] tags, ?Datadog::CI::TestModule | Datadog::Tracing::SpanOperation? test_module) -> void
+
+        def null_span: () -> Datadog::CI::Span
+
+        def skip_tracing: (?untyped block) -> untyped
+
+        def start_datadog_tracer_span: (String span_name, Hash[untyped, untyped] span_options) ?{ (untyped) -> untyped } -> untyped
+
+        def set_inherited_globals: (Hash[untyped, untyped] tags) -> void
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/serializers/base.rbs

@@ -7,18 +7,28 @@ module Datadog
           MINIMUM_DURATION_NANO: 0
           MAXIMUM_DURATION_NANO: 9223372036854775807
 
+          CONTENT_FIELDS: Array[String | Hash[String, String]]
+          REQUIRED_FIELDS: Array[String]
+
           @content_fields_count: Integer
           @start: Integer
           @duration: Integer
+          @meta: Hash[untyped, untyped]
+          @errors: Hash[String, Set[String]]
+          @validated: bool
 
           attr_reader trace: Datadog::Tracing::TraceSegment
           attr_reader span: Datadog::Tracing::Span
+          attr_reader meta: Hash[untyped, untyped]
 
           def initialize: (Datadog::Tracing::TraceSegment trace, Datadog::Tracing::Span span) -> void
 
           def to_msgpack: (?untyped? packer) -> untyped
 
           def valid?: () -> bool
+          def validate!: () -> void
+          def validation_errors: () -> Hash[String, Set[String]]
+
           def content_fields: () -> ::Array[String | Hash[String, String]]
           def content_map_size: () -> Integer
 
@@ -30,6 +40,12 @@ module Datadog
 
           def parent_id: () -> String
 
+          def test_session_id: () -> Integer?
+
+          def test_module_id: () -> Integer?
+
+          def test_suite_id: () -> Integer?
+
           def type: () -> nil
 
           def version: () -> 1
@@ -46,8 +62,6 @@ module Datadog
 
           def duration: () -> Integer
 
-          def meta: () -> Hash[String, untyped]
-
           def metrics: () -> Hash[String, untyped]
 
           def error: () -> Integer
@@ -56,15 +70,22 @@ module Datadog
 
           private
 
-          def valid_start_time?: () -> bool
-          def valid_duration?: () -> bool
-          def required_fields_present?: () -> bool
+          def validate_start_time!: () -> void
+          def validate_duration!: () -> void
+          def validate_required_fields!: () -> void
+          def validate_required!: (String field) -> void
+          def validate_greater_than_or_equal!: (String field, Integer value) -> void
+          def validate_less_than_or_equal!: (String field, Integer value) -> void
+          def add_error: (String field, String message) -> void
+
           def required_fields: () -> Array[String]
 
           def write_field: (untyped packer, String field_name, ?String? method) -> untyped
           def time_nano: (Time time) -> Integer
           def duration_nano: (Float duration) -> Integer
 
+          def to_integer: (String? value) -> Integer?
+
           def content_fields_count: () -> Integer
         end
       end

data/sig/datadog/ci/test_visibility/serializers/factories/test_suite_level.rbs

@@ -0,0 +1,13 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        module Factories
+          module TestSuiteLevel
+            def self?.serializer: (Datadog::Tracing::TraceSegment trace, Datadog::Tracing::Span span) -> Datadog::CI::TestVisibility::Serializers::Base
+          end
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/serializers/test_module.rbs

@@ -0,0 +1,26 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestModule < Base
+          CONTENT_FIELDS: Array[String | Hash[String, String]]
+          CONTENT_MAP_SIZE: Integer
+          REQUIRED_FIELDS: Array[String]
+
+          def content_fields: () -> Array[String | Hash[String, String]]
+          def content_map_size: () -> Integer
+
+          def type: () -> ::String
+
+          def name: () -> ::String
+
+          def resource: () -> ::String
+
+          private
+
+          def required_fields: () -> Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/serializers/test_session.rbs

@@ -0,0 +1,26 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestSession < Base
+          CONTENT_FIELDS: Array[String | Hash[String, String]]
+          CONTENT_MAP_SIZE: Integer
+          REQUIRED_FIELDS: Array[String]
+
+          def content_fields: () -> Array[String | Hash[String, String]]
+          def content_map_size: () -> Integer
+
+          def type: () -> ::String
+
+          def name: () -> ::String
+
+          def resource: () -> ::String
+
+          private
+
+          def required_fields: () -> Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/serializers/test_suite.rbs

@@ -0,0 +1,26 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestSuite < Base
+          CONTENT_FIELDS: Array[String | Hash[String, String]]
+          CONTENT_MAP_SIZE: Integer
+          REQUIRED_FIELDS: Array[String]
+
+          def content_fields: () -> Array[String | Hash[String, String]]
+          def content_map_size: () -> Integer
+
+          def type: () -> ::String
+
+          def name: () -> ::String
+
+          def resource: () -> ::String
+
+          private
+
+          def required_fields: () -> Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/serializers/test_v1.rbs

@@ -11,7 +11,7 @@ module Datadog
           def content_fields: () -> Array[String | Hash[String, String]]
           def content_map_size: () -> Integer
 
-          def type: () -> "test"
+          def type: () -> ::String
 
           def name: () -> ::String
 

data/sig/datadog/ci/test_visibility/serializers/test_v2.rbs

@@ -0,0 +1,25 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class TestV2 < TestV1
+          CONTENT_FIELDS: ::Array[String | ::Hash[::String, String]]
+
+          CONTENT_MAP_SIZE: Integer
+
+          REQUIRED_FIELDS: ::Array[String]
+
+          def content_fields: () -> ::Array[String | ::Hash[::String, String]]
+
+          def content_map_size: () -> Integer
+
+          def version: () -> 2
+
+          private
+
+          def required_fields: () -> Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/transport.rbs

@@ -4,19 +4,19 @@ module Datadog
       class Transport
         DEFAULT_MAX_PAYLOAD_SIZE: Integer
 
-        attr_reader serializers_factory: singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestLevel)
+        attr_reader serializers_factory: singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestLevel) | singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestSuiteLevel)
         attr_reader dd_env: String?
         attr_reader api: Datadog::CI::Transport::Api::Base
         attr_reader max_payload_size: Integer
 
         @dd_env: String?
-        @serializers_factory: singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestLevel)
+        @serializers_factory: singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestLevel) | singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestSuiteLevel)
         @max_payload_size: Integer
 
         def initialize: (
           api: Datadog::CI::Transport::Api::Base,
           ?dd_env: ::String?,
-          ?serializers_factory: singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestLevel),
+          ?serializers_factory: singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestLevel) | singleton(Datadog::CI::TestVisibility::Serializers::Factories::TestSuiteLevel),
           ?max_payload_size: Integer
         ) -> void
 

data/sig/datadog/ci/utils/test_run.rbs

@@ -0,0 +1,11 @@
+module Datadog
+  module CI
+    module Utils
+      module TestRun
+        self.@command: String
+
+        def self.command: () -> String
+      end
+    end
+  end
+end

data/sig/datadog/ci.rbs

@@ -1,19 +1,35 @@
 module Datadog
   module CI
-    def self.trace_test: (String span_name, ?service_name: String?, ?operation_name: String, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Test test) -> untyped } -> untyped
+    def self.trace_test: (String test_name, String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span test) -> untyped } -> untyped
 
-    def self.start_test: (String span_name, ?service_name: String?, ?operation_name: String, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Test
+    def self.start_test: (String test_name, String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+    def self.start_test_session: (?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+    def self.start_test_module: (String test_module_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+    def self.start_test_suite: (String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
 
     def self.trace: (String span_type, String span_name, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
 
+    def self.active_test_session: () -> Datadog::CI::TestSession?
+
+    def self.active_test_module: () -> Datadog::CI::TestModule?
+
     def self.active_test: () -> Datadog::CI::Test?
 
     def self.active_span: (String span_type) -> Datadog::CI::Span?
 
     def self.deactivate_test: (Datadog::CI::Test test) -> void
 
+    def self.deactivate_test_session: () -> void
+
+    def self.deactivate_test_module: () -> void
+
+    def self.deactivate_test_suite: (String test_suite_name) -> void
+
     def self.components: () -> Datadog::CI::Configuration::Components
 
-    def self.recorder: () -> Datadog::CI::Recorder
+    def self.recorder: () -> Datadog::CI::TestVisibility::Recorder
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -42,9 +42,10 @@ files:
 - NOTICE
 - README.md
 - lib/datadog/ci.rb
+- lib/datadog/ci/concurrent_span.rb
 - lib/datadog/ci/configuration/components.rb
+- lib/datadog/ci/configuration/extensions.rb
 - lib/datadog/ci/configuration/settings.rb
-- lib/datadog/ci/context/local.rb
 - lib/datadog/ci/contrib/cucumber/configuration/settings.rb
 - lib/datadog/ci/contrib/cucumber/ext.rb
 - lib/datadog/ci/contrib/cucumber/formatter.rb
@@ -88,15 +89,25 @@ files:
 - lib/datadog/ci/ext/settings.rb
 - lib/datadog/ci/ext/test.rb
 - lib/datadog/ci/ext/transport.rb
-- lib/datadog/ci/extensions.rb
-- lib/datadog/ci/recorder.rb
+- lib/datadog/ci/null_span.rb
 - lib/datadog/ci/span.rb
 - lib/datadog/ci/test.rb
+- lib/datadog/ci/test_module.rb
+- lib/datadog/ci/test_session.rb
+- lib/datadog/ci/test_suite.rb
+- lib/datadog/ci/test_visibility/context/global.rb
+- lib/datadog/ci/test_visibility/context/local.rb
 - lib/datadog/ci/test_visibility/flush.rb
+- lib/datadog/ci/test_visibility/recorder.rb
 - lib/datadog/ci/test_visibility/serializers/base.rb
 - lib/datadog/ci/test_visibility/serializers/factories/test_level.rb
+- lib/datadog/ci/test_visibility/serializers/factories/test_suite_level.rb
 - lib/datadog/ci/test_visibility/serializers/span.rb
+- lib/datadog/ci/test_visibility/serializers/test_module.rb
+- lib/datadog/ci/test_visibility/serializers/test_session.rb
+- lib/datadog/ci/test_visibility/serializers/test_suite.rb
 - lib/datadog/ci/test_visibility/serializers/test_v1.rb
+- lib/datadog/ci/test_visibility/serializers/test_v2.rb
 - lib/datadog/ci/test_visibility/transport.rb
 - lib/datadog/ci/transport/api/base.rb
 - lib/datadog/ci/transport/api/builder.rb
@@ -105,12 +116,14 @@ files:
 - lib/datadog/ci/transport/gzip.rb
 - lib/datadog/ci/transport/http.rb
 - lib/datadog/ci/utils/git.rb
+- lib/datadog/ci/utils/test_run.rb
 - lib/datadog/ci/utils/url.rb
 - lib/datadog/ci/version.rb
 - sig/datadog/ci.rbs
+- sig/datadog/ci/concurrent_span.rbs
 - sig/datadog/ci/configuration/components.rbs
+- sig/datadog/ci/configuration/extensions.rbs
 - sig/datadog/ci/configuration/settings.rbs
-- sig/datadog/ci/context/local.rbs
 - sig/datadog/ci/contrib/cucumber/configuration/settings.rbs
 - sig/datadog/ci/contrib/cucumber/ext.rbs
 - sig/datadog/ci/contrib/cucumber/formatter.rbs
@@ -154,15 +167,25 @@ files:
 - sig/datadog/ci/ext/settings.rbs
 - sig/datadog/ci/ext/test.rbs
 - sig/datadog/ci/ext/transport.rbs
-- sig/datadog/ci/extensions.rbs
-- sig/datadog/ci/recorder.rbs
+- sig/datadog/ci/null_span.rbs
 - sig/datadog/ci/span.rbs
 - sig/datadog/ci/test.rbs
+- sig/datadog/ci/test_module.rbs
+- sig/datadog/ci/test_session.rbs
+- sig/datadog/ci/test_suite.rbs
+- sig/datadog/ci/test_visibility/context/global.rbs
+- sig/datadog/ci/test_visibility/context/local.rbs
 - sig/datadog/ci/test_visibility/flush.rbs
+- sig/datadog/ci/test_visibility/recorder.rbs
 - sig/datadog/ci/test_visibility/serializers/base.rbs
 - sig/datadog/ci/test_visibility/serializers/factories/test_level.rbs
+- sig/datadog/ci/test_visibility/serializers/factories/test_suite_level.rbs
 - sig/datadog/ci/test_visibility/serializers/span.rbs
+- sig/datadog/ci/test_visibility/serializers/test_module.rbs
+- sig/datadog/ci/test_visibility/serializers/test_session.rbs
+- sig/datadog/ci/test_visibility/serializers/test_suite.rbs
 - sig/datadog/ci/test_visibility/serializers/test_v1.rbs
+- sig/datadog/ci/test_visibility/serializers/test_v2.rbs
 - sig/datadog/ci/test_visibility/transport.rbs
 - sig/datadog/ci/transport/api/base.rbs
 - sig/datadog/ci/transport/api/builder.rbs
@@ -171,6 +194,7 @@ files:
 - sig/datadog/ci/transport/gzip.rbs
 - sig/datadog/ci/transport/http.rbs
 - sig/datadog/ci/utils/git.rbs
+- sig/datadog/ci/utils/test_run.rbs
 - sig/datadog/ci/utils/url.rbs
 - sig/datadog/ci/version.rbs
 homepage: https://github.com/DataDog/datadog-ci-rb

data/lib/datadog/ci/context/local.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Datadog
-  module CI
-    module Context
-      class Local
-        def initialize
-          @key = :datadog_ci_active_test
-
-          self.active_test = nil
-        end
-
-        def activate_test!(test)
-          raise "Nested tests are not supported. Currently active test: #{active_test}" unless active_test.nil?
-
-          if block_given?
-            begin
-              self.active_test = test
-              yield
-            ensure
-              self.active_test = nil
-            end
-          else
-            self.active_test = test
-          end
-        end
-
-        def deactivate_test!(test)
-          return if active_test.nil?
-
-          if active_test == test
-            self.active_test = nil
-          else
-            raise "Trying to deactivate test #{test}, but currently active test is #{active_test}"
-          end
-        end
-
-        def active_test
-          Thread.current[@key]
-        end
-
-        private
-
-        def active_test=(test)
-          Thread.current[@key] = test
-        end
-      end
-    end
-  end
-end

data/lib/datadog/ci/extensions.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "datadog/core/configuration/settings"
-require "datadog/core/configuration/components"
-
-require_relative "configuration/settings"
-require_relative "configuration/components"
-
-module Datadog
-  module CI
-    # Extends Datadog tracing with CI features
-    module Extensions
-      def self.activate!
-        Core::Configuration::Settings.extend(CI::Configuration::Settings)
-        Core::Configuration::Components.prepend(CI::Configuration::Components)
-      end
-    end
-  end
-end

data/lib/datadog/ci/recorder.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require "datadog/tracing"
-
-require "rbconfig"
-
-require_relative "ext/app_types"
-require_relative "ext/test"
-require_relative "ext/environment"
-
-require_relative "context/local"
-
-require_relative "span"
-require_relative "test"
-
-module Datadog
-  module CI
-    # Common behavior for CI tests
-    class Recorder
-      attr_reader :environment_tags
-
-      def initialize
-        @environment_tags = Ext::Environment.tags(ENV).freeze
-        @local_context = Context::Local.new
-      end
-
-      # Creates a new span for a CI test
-      def trace_test(test_name, service_name: nil, operation_name: "test", tags: {}, &block)
-        span_options = {
-          resource: test_name,
-          service: service_name,
-          span_type: Ext::AppTypes::TYPE_TEST
-        }
-
-        tags[Ext::Test::TAG_NAME] = test_name
-
-        if block
-          Datadog::Tracing.trace(operation_name, **span_options) do |tracer_span, trace|
-            set_trace_origin(trace)
-
-            test = build_test(tracer_span, tags)
-
-            @local_context.activate_test!(test) do
-              block.call(test)
-            end
-          end
-        else
-          tracer_span = Datadog::Tracing.trace(operation_name, **span_options)
-          trace = Datadog::Tracing.active_trace
-
-          set_trace_origin(trace)
-
-          test = build_test(tracer_span, tags)
-          @local_context.activate_test!(test)
-          test
-        end
-      end
-
-      def trace(span_type, span_name, tags: {}, &block)
-        span_options = {
-          resource: span_name,
-          span_type: span_type
-        }
-
-        if block
-          Datadog::Tracing.trace(span_name, **span_options) do |tracer_span, trace|
-            block.call(build_span(tracer_span, tags))
-          end
-        else
-          tracer_span = Datadog::Tracing.trace(span_name, **span_options)
-
-          build_span(tracer_span, tags)
-        end
-      end
-
-      def active_test
-        @local_context.active_test
-      end
-
-      def deactivate_test(test)
-        @local_context.deactivate_test!(test)
-      end
-
-      def active_span
-        tracer_span = Datadog::Tracing.active_span
-        Span.new(tracer_span) if tracer_span
-      end
-
-      private
-
-      # Sets trace's origin to ciapp-test
-      def set_trace_origin(trace)
-        trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
-      end
-
-      def build_test(tracer_span, tags)
-        test = Test.new(tracer_span)
-
-        test.set_default_tags
-        test.set_environment_runtime_tags
-
-        test.set_tags(tags)
-        test.set_tags(environment_tags)
-
-        test
-      end
-
-      def build_span(tracer_span, tags)
-        span = Span.new(tracer_span)
-
-        span.set_default_tags
-        span.set_environment_runtime_tags
-        span.set_tags(tags)
-
-        span
-      end
-    end
-  end
-end