datadog-ci 0.3.0 → 0.5.1

data/sig/datadog/ci/configuration/extensions.rbs

@@ -0,0 +1,9 @@
+module Datadog
+  module CI
+    module Configuration
+      module Extensions
+        def self.activate!: () -> untyped
+      end
+    end
+  end
+end

data/sig/datadog/ci/ext/app_types.rbs

@@ -2,7 +2,12 @@ module Datadog
   module CI
     module Ext
       module AppTypes
-        TYPE_TEST: String
+        TYPE_TEST: "test"
+        TYPE_TEST_SESSION: "test_session_end"
+        TYPE_TEST_MODULE: "test_module_end"
+        TYPE_TEST_SUITE: "test_suite_end"
+
+        CI_SPAN_TYPES: Array[String]
       end
     end
   end

data/sig/datadog/ci/ext/environment/extractor.rbs

@@ -18,8 +18,6 @@ module Datadog
           def normalize_git!: () -> void
 
           def expand_workspace!: () -> void
-
-          def filter_sensitive_info: (String? url) -> String?
         end
       end
     end

data/sig/datadog/ci/ext/environment/providers/github_actions.rbs

@@ -5,6 +5,7 @@ module Datadog
         module Providers
           class GithubActions < Extractor
             @ref: String
+            @github_server_url: String?
 
             def provider_name: () -> "github"
 
@@ -29,6 +30,10 @@ module Datadog
             def git_branch_or_tag: () -> String?
 
             def ci_env_vars: () -> String?
+
+            private
+
+            def github_server_url: () -> String?
           end
         end
       end

data/sig/datadog/ci/ext/settings.rbs

@@ -5,6 +5,9 @@ module Datadog
         ENV_MODE_ENABLED: String
         ENV_AGENTLESS_MODE_ENABLED: String
         ENV_AGENTLESS_URL: String
+        ENV_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED: String
+
+        DD_SITE_ALLOWLIST: Array[String]
       end
     end
   end

data/sig/datadog/ci/ext/test.rbs

@@ -18,9 +18,24 @@ module Datadog
 
         TAG_SUITE: String
 
+        TAG_MODULE: String
+
         TAG_TRAITS: String
 
         TAG_TYPE: String
+
+        TAG_COMMAND: String
+
+        TAG_TEST_SESSION_ID: String
+
+        TAG_TEST_MODULE_ID: String
+
+        TAG_TEST_SUITE_ID: String
+
+        SPECIAL_TAGS: Array[String]
+
+        INHERITABLE_TAGS: Array[String]
+
         TAG_OS_ARCHITECTURE: String
 
         TAG_OS_PLATFORM: String

data/sig/datadog/ci/null_span.rbs

@@ -0,0 +1,37 @@
+module Datadog
+  module CI
+    class NullSpan < Span
+      def initialize: () -> void
+
+      def id: () -> nil
+
+      def name: () -> nil
+
+      def service: () -> nil
+
+      def span_type: () -> nil
+
+      def passed!: () -> nil
+
+      def failed!: (?exception: untyped?) -> nil
+
+      def skipped!: (?exception: untyped?, ?reason: untyped?) -> nil
+
+      def get_tag: (untyped key) -> nil
+
+      def set_tag: (untyped key, untyped value) -> nil
+
+      def set_metric: (untyped key, untyped value) -> nil
+
+      def finish: () -> nil
+
+      def set_tags: (untyped tags) -> nil
+
+      def set_environment_runtime_tags: () -> nil
+
+      def set_default_tags: () -> nil
+
+      def to_s: () -> untyped
+    end
+  end
+end

data/sig/datadog/ci/span.rbs

@@ -0,0 +1,39 @@
+module Datadog
+  module CI
+    class Span
+      @tracer_span: Datadog::Tracing::SpanOperation
+
+      attr_reader tracer_span: Datadog::Tracing::SpanOperation
+
+      def initialize: (Datadog::Tracing::SpanOperation tracer_span) -> void
+
+      def id: () -> Integer
+
+      def name: () -> String
+
+      def service: () -> String
+
+      def passed!: () -> void
+
+      def failed!: (?exception: untyped?) -> void
+
+      def skipped!: (?exception: untyped?, ?reason: String?) -> void
+
+      def get_tag: (String key) -> untyped?
+
+      def set_tag: (String key, untyped? value) -> void
+
+      def set_metric: (String key, untyped value) -> void
+
+      def set_tags: (Hash[untyped, untyped] tags) -> void
+
+      def finish: () -> void
+
+      def span_type: () -> String
+
+      def set_environment_runtime_tags: () -> void
+
+      def set_default_tags: () -> void
+    end
+  end
+end

data/sig/datadog/ci/test.rbs

@@ -0,0 +1,7 @@
+module Datadog
+  module CI
+    class Test < Span
+      def finish: () -> void
+    end
+  end
+end

data/sig/datadog/ci/test_module.rbs

@@ -0,0 +1,6 @@
+module Datadog
+  module CI
+    class TestModule < ConcurrentSpan
+    end
+  end
+end

data/sig/datadog/ci/test_session.rbs

@@ -0,0 +1,9 @@
+module Datadog
+  module CI
+    class TestSession < ConcurrentSpan
+      @inheritable_tags: Hash[untyped, untyped]
+
+      def inheritable_tags: () -> Hash[untyped, untyped]
+    end
+  end
+end

data/sig/datadog/ci/test_suite.rbs

@@ -0,0 +1,6 @@
+module Datadog
+  module CI
+    class TestSuite < ConcurrentSpan
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/context/global.rbs

@@ -0,0 +1,39 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        class Global
+          @mutex: Thread::Mutex
+
+          @test_session: Datadog::CI::TestSession?
+          @test_module: Datadog::CI::TestModule?
+          @test_suites: Hash[String, Datadog::CI::TestSuite]
+
+          def initialize: () -> void
+
+          def fetch_or_activate_test_suite: (String test_suite_name) {() -> Datadog::CI::TestSuite} -> Datadog::CI::TestSuite
+
+          def fetch_or_activate_test_module: () {() -> Datadog::CI::TestModule} -> Datadog::CI::TestModule
+
+          def fetch_or_activate_test_session: () {() -> Datadog::CI::TestSession} -> Datadog::CI::TestSession
+
+          def active_test_session: () -> Datadog::CI::TestSession?
+
+          def active_test_suite: (String test_suite_name) -> Datadog::CI::TestSuite?
+
+          def service: () -> String?
+
+          def inheritable_session_tags: () -> Hash[untyped, untyped]
+
+          def active_test_module: () -> Datadog::CI::TestModule?
+
+          def deactivate_test_session!: () -> void
+
+          def deactivate_test_module!: () -> void
+
+          def deactivate_test_suite!: (String test_suite_name) -> void
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/context/local.rbs

@@ -0,0 +1,23 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        class Local
+          @key: Symbol
+
+          def initialize: () -> void
+
+          def activate_test!: (Datadog::CI::Test test) ?{ () -> untyped } -> void
+
+          def deactivate_test!: (Datadog::CI::Test test) -> void
+
+          def active_test: () -> Datadog::CI::Test?
+
+          private
+
+          def active_test=: (Datadog::CI::Test? test) -> untyped
+        end
+      end
+    end
+  end
+end

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/utils/url.rbs

@@ -0,0 +1,9 @@
+module Datadog
+  module CI
+    module Utils
+      module Url
+        def self.filter_sensitive_info: (String? url) -> String?
+      end
+    end
+  end
+end

data/sig/datadog/ci.rbs

@@ -1,7 +1,35 @@
 module Datadog
   module CI
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-    class Error < StandardError
-    end
+    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 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::TestVisibility::Recorder
   end
 end