datadog-ci 0.2.0 → 0.4.0

data/lib/datadog/ci/ext/environment/providers/base.rb

@@ -8,6 +8,10 @@ module Datadog
           class Base
             attr_reader :env
 
+            def self.handles?(_env)
+              false
+            end
+
             def initialize(env)
               @env = env
             end

data/lib/datadog/ci/ext/environment/providers/bitbucket.rb

@@ -10,6 +10,10 @@ module Datadog
           # Bitbucket Pipelines: https://bitbucket.org/product/features/pipelines
           # Environment variables docs: https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
           class Bitbucket < Base
+            def self.handles?(env)
+              env.key?("BITBUCKET_COMMIT")
+            end
+
             # overridden methods
             def provider_name
               "bitbucket"

data/lib/datadog/ci/ext/environment/providers/bitrise.rb

@@ -10,6 +10,10 @@ module Datadog
           # Bitrise: https://bitrise.io/
           # Environment variables docs: https://devcenter.bitrise.io/en/references/available-environment-variables.html
           class Bitrise < Base
+            def self.handles?(env)
+              env.key?("BITRISE_BUILD_SLUG")
+            end
+
             def provider_name
               "bitrise"
             end

data/lib/datadog/ci/ext/environment/providers/buddy.rb

@@ -10,6 +10,10 @@ module Datadog
           # Buddy: https://buddy.works/
           # Environment variables docs: https://buddy.works/docs/pipelines/environment-variables
           class Buddy < Base
+            def self.handles?(env)
+              env.key?("BUDDY")
+            end
+
             def provider_name
               "buddy"
             end

data/lib/datadog/ci/ext/environment/providers/buildkite.rb

@@ -12,6 +12,10 @@ module Datadog
           # Buildkite: https://buildkite.com/
           # Environment variables docs: https://buildkite.com/docs/pipelines/environment-variables
           class Buildkite < Base
+            def self.handles?(env)
+              env.key?("BUILDKITE")
+            end
+
             def provider_name
               "buildkite"
             end

data/lib/datadog/ci/ext/environment/providers/circleci.rb

@@ -12,6 +12,10 @@ module Datadog
           # Circle CI: https://circleci.com/
           # Environment variables docs: https://circleci.com/docs/variables/#built-in-environment-variables
           class Circleci < Base
+            def self.handles?(env)
+              env.key?("CIRCLECI")
+            end
+
             def provider_name
               "circleci"
             end

data/lib/datadog/ci/ext/environment/providers/codefresh.rb

@@ -12,6 +12,10 @@ module Datadog
           # Codefresh: https://codefresh.io/
           # Environment variables docs: https://codefresh.io/docs/docs/pipelines/variables/#export-variables-to-all-steps-with-cf_export
           class Codefresh < Base
+            def self.handles?(env)
+              env.key?("CF_BUILD_ID")
+            end
+
             def provider_name
               "codefresh"
             end

data/lib/datadog/ci/ext/environment/providers/github_actions.rb

@@ -3,6 +3,7 @@
 require "json"
 
 require_relative "base"
+require_relative "../../../utils/url"
 
 module Datadog
   module CI
@@ -12,6 +13,10 @@ module Datadog
           # Github Actions: https://github.com/features/actions
           # Environment variables docs: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
           class GithubActions < Base
+            def self.handles?(env)
+              env.key?("GITHUB_SHA")
+            end
+
             def provider_name
               "github"
             end
@@ -21,7 +26,7 @@ module Datadog
             end
 
             def job_url
-              "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}/commit/#{env["GITHUB_SHA"]}/checks"
+              "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}/commit/#{env["GITHUB_SHA"]}/checks"
             end
 
             def pipeline_id
@@ -37,7 +42,7 @@ module Datadog
             end
 
             def pipeline_url
-              res = "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}/actions/runs/#{env["GITHUB_RUN_ID"]}"
+              res = "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}/actions/runs/#{env["GITHUB_RUN_ID"]}"
               res = "#{res}/attempts/#{env["GITHUB_RUN_ATTEMPT"]}" if env["GITHUB_RUN_ATTEMPT"]
               res
             end
@@ -47,7 +52,7 @@ module Datadog
             end
 
             def git_repository_url
-              "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}.git"
+              "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}.git"
             end
 
             def git_commit_sha
@@ -62,12 +67,20 @@ module Datadog
 
             def ci_env_vars
               {
-                "GITHUB_SERVER_URL" => env["GITHUB_SERVER_URL"],
+                "GITHUB_SERVER_URL" => github_server_url,
                 "GITHUB_REPOSITORY" => env["GITHUB_REPOSITORY"],
                 "GITHUB_RUN_ID" => env["GITHUB_RUN_ID"],
                 "GITHUB_RUN_ATTEMPT" => env["GITHUB_RUN_ATTEMPT"]
               }.reject { |_, v| v.nil? }.to_json
             end
+
+            private
+
+            def github_server_url
+              return @github_server_url if defined?(@github_server_url)
+
+              @github_server_url ||= Utils::Url.filter_sensitive_info(env["GITHUB_SERVER_URL"])
+            end
           end
         end
       end

data/lib/datadog/ci/ext/environment/providers/gitlab.rb

@@ -10,6 +10,10 @@ module Datadog
           # Gitlab CI: https://docs.gitlab.com/ee/ci/
           # Environment variables docs: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
           class Gitlab < Base
+            def self.handles?(env)
+              env.key?("GITLAB_CI")
+            end
+
             def provider_name
               "gitlab"
             end

data/lib/datadog/ci/ext/environment/providers/jenkins.rb

@@ -13,6 +13,10 @@ module Datadog
           # Jenkins: https://www.jenkins.io/
           # Environment variables docs: https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables
           class Jenkins < Base
+            def self.handles?(env)
+              env.key?("JENKINS_URL")
+            end
+
             def provider_name
               "jenkins"
             end

data/lib/datadog/ci/ext/environment/providers/teamcity.rb

@@ -10,6 +10,10 @@ module Datadog
           # Teamcity: https://www.jetbrains.com/teamcity/
           # Environment variables docs: https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html
           class Teamcity < Base
+            def self.handles?(env)
+              env.key?("TEAMCITY_VERSION")
+            end
+
             def provider_name
               "teamcity"
             end

data/lib/datadog/ci/ext/environment/providers/travis.rb

@@ -10,6 +10,10 @@ module Datadog
           # Travis CI: https://www.travis-ci.com/
           # Environment variables docs: https://docs.travis-ci.com/user/environment-variables#default-environment-variables
           class Travis < Base
+            def self.handles?(env)
+              env.key?("TRAVIS")
+            end
+
             def provider_name
               "travisci"
             end

data/lib/datadog/ci/ext/environment/providers.rb

@@ -2,6 +2,7 @@
 
 require_relative "providers/base"
 require_relative "providers/appveyor"
+require_relative "providers/aws_code_pipeline"
 require_relative "providers/azure"
 require_relative "providers/bitbucket"
 require_relative "providers/bitrise"
@@ -24,23 +25,24 @@ module Datadog
       module Environment
         module Providers
           PROVIDERS = [
-            ["APPVEYOR", Providers::Appveyor],
-            ["TF_BUILD", Providers::Azure],
-            ["BITBUCKET_COMMIT", Providers::Bitbucket],
-            ["BITRISE_BUILD_SLUG", Providers::Bitrise],
-            ["BUDDY", Providers::Buddy],
-            ["BUILDKITE", Providers::Buildkite],
-            ["CIRCLECI", Providers::Circleci],
-            ["CF_BUILD_ID", Providers::Codefresh],
-            ["GITHUB_SHA", Providers::GithubActions],
-            ["GITLAB_CI", Providers::Gitlab],
-            ["JENKINS_URL", Providers::Jenkins],
-            ["TEAMCITY_VERSION", Providers::Teamcity],
-            ["TRAVIS", Providers::Travis]
+            Providers::Appveyor,
+            Providers::AwsCodePipeline,
+            Providers::Azure,
+            Providers::Bitbucket,
+            Providers::Bitrise,
+            Providers::Buddy,
+            Providers::Buildkite,
+            Providers::Circleci,
+            Providers::Codefresh,
+            Providers::GithubActions,
+            Providers::Gitlab,
+            Providers::Jenkins,
+            Providers::Teamcity,
+            Providers::Travis
           ]
 
           def self.for_environment(env)
-            _, provider_klass = PROVIDERS.find { |provider_env_var, _| env.key?(provider_env_var) }
+            provider_klass = PROVIDERS.find { |klass| klass.handles?(env) }
             provider_klass = Providers::Base if provider_klass.nil?
 
             provider_klass.new(env)

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

@@ -4,10 +4,15 @@ module Datadog
   module CI
     module Ext
       module Transport
+        DEFAULT_DD_SITE = "datadoghq.com"
+
         HEADER_DD_API_KEY = "DD-API-KEY"
         HEADER_CONTENT_TYPE = "Content-Type"
         HEADER_CONTENT_ENCODING = "Content-Encoding"
+        HEADER_EVP_SUBDOMAIN = "X-Datadog-EVP-Subdomain"
+        HEADER_CONTAINER_ID = "Datadog-Container-ID"
 
+        EVP_PROXY_PATH_PREFIX = "/evp_proxy/v2/"
         TEST_VISIBILITY_INTAKE_HOST_PREFIX = "citestcycle-intake"
         TEST_VISIBILITY_INTAKE_PATH = "/api/v2/citestcycle"
 

data/lib/datadog/ci/recorder.rb

@@ -1,82 +1,118 @@
 # frozen_string_literal: true
 
 require "datadog/tracing"
-require "datadog/tracing/contrib/analytics"
+
+require "rbconfig"
 
 require_relative "ext/app_types"
 require_relative "ext/test"
 require_relative "ext/environment"
 
-require "rbconfig"
+require_relative "context/local"
+
+require_relative "span"
+require_relative "test"
 
 module Datadog
   module CI
     # Common behavior for CI tests
-    module Recorder
+    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 self.trace(span_name, options = {})
+      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
-        }.merge(options[:span_options] || {})
+        }
+
+        tags[Ext::Test::TAG_NAME] = test_name
 
-        if block_given?
-          ::Datadog::Tracing.trace(span_name, **span_options) do |span, trace|
-            set_tags!(trace, span, options)
-            yield(span, trace)
+        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
-          span = ::Datadog::Tracing.trace(span_name, **span_options)
-          trace = ::Datadog::Tracing.active_trace
-          set_tags!(trace, span, options)
-          span
+          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
 
-      # Adds tags to a CI test span.
-      def self.set_tags!(trace, span, tags = {})
-        tags ||= {}
-
-        # Set default tags
-        trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
-        ::Datadog::Tracing::Contrib::Analytics.set_measured(span)
-        span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_TEST)
+      def trace(span_type, span_name, tags: {}, &block)
+        span_options = {
+          resource: span_name,
+          span_type: span_type
+        }
 
-        # Set environment tags
-        @environment_tags ||= Ext::Environment.tags(ENV)
-        @environment_tags.each { |k, v| span.set_tag(k, v) }
+        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)
 
-        # Set contextual tags
-        span.set_tag(Ext::Test::TAG_FRAMEWORK, tags[:framework]) if tags[:framework]
-        span.set_tag(Ext::Test::TAG_FRAMEWORK_VERSION, tags[:framework_version]) if tags[:framework_version]
-        span.set_tag(Ext::Test::TAG_NAME, tags[:test_name]) if tags[:test_name]
-        span.set_tag(Ext::Test::TAG_SUITE, tags[:test_suite]) if tags[:test_suite]
-        span.set_tag(Ext::Test::TAG_TYPE, tags[:test_type]) if tags[:test_type]
+          build_span(tracer_span, tags)
+        end
+      end
 
-        set_environment_runtime_tags!(span)
+      def active_test
+        @local_context.active_test
+      end
 
-        span
+      def deactivate_test(test)
+        @local_context.deactivate_test!(test)
       end
 
-      def self.passed!(span)
-        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::PASS)
+      def active_span
+        tracer_span = Datadog::Tracing.active_span
+        Span.new(tracer_span) if tracer_span
       end
 
-      def self.failed!(span, exception = nil)
-        span.status = 1
-        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::FAIL)
-        span.set_error(exception) unless exception.nil?
+      private
+
+      # Sets trace's origin to ciapp-test
+      def set_trace_origin(trace)
+        trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
       end
 
-      def self.skipped!(span, exception = nil)
-        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::SKIP)
-        span.set_error(exception) unless exception.nil?
+      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
 
-      private_class_method def self.set_environment_runtime_tags!(span)
-        span.set_tag(Ext::Test::TAG_OS_ARCHITECTURE, ::RbConfig::CONFIG["host_cpu"])
-        span.set_tag(Ext::Test::TAG_OS_PLATFORM, ::RbConfig::CONFIG["host_os"])
-        span.set_tag(Ext::Test::TAG_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
-        span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
+      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

data/lib/datadog/ci/span.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "ext/test"
+
+module Datadog
+  module CI
+    # Represents a single part of a test run.
+    # Could be a session, suite, test, or any custom span.
+    #
+    # @public_api
+    class Span
+      attr_reader :tracer_span
+
+      def initialize(tracer_span)
+        @tracer_span = tracer_span
+      end
+
+      # @return [String] the name of the span.
+      def name
+        tracer_span.name
+      end
+
+      # @return [String] the type of the span (for example "test" or type that was provided to [Datadog::CI.trace]).
+      def span_type
+        tracer_span.type
+      end
+
+      # Sets the status of the span to "pass".
+      # @return [void]
+      def passed!
+        tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::PASS)
+      end
+
+      # Sets the status of the span to "fail".
+      # @param [Exception] exception the exception that caused the test to fail.
+      # @return [void]
+      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
+
+      # Sets the status of the span to "skip".
+      # @param [Exception] exception the exception that caused the test to fail.
+      # @param [String] reason the reason why the test was skipped.
+      # @return [void]
+      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
+
+      # Gets tag value by key.
+      # @param [String] key the key of the tag.
+      # @return [String] the value of the tag.
+      def get_tag(key)
+        tracer_span.get_tag(key)
+      end
+
+      # Sets tag value by key.
+      # @param [String] key the key of the tag.
+      # @param [String] value the value of the tag.
+      # @return [void]
+      def set_tag(key, value)
+        tracer_span.set_tag(key, value)
+      end
+
+      # Sets metric value by key.
+      # @param [String] key the key of the metric.
+      # @param [Numeric] value the value of the metric.
+      # @return [void]
+      def set_metric(key, value)
+        tracer_span.set_metric(key, value)
+      end
+
+      # Finishes the span.
+      # @return [void]
+      def finish
+        tracer_span.finish
+      end
+
+      # Sets multiple tags at once.
+      # @param [Hash[String, String]] tags the tags to set.
+      # @return [void]
+      def set_tags(tags)
+        tags.each do |key, value|
+          tracer_span.set_tag(key, value)
+        end
+      end
+
+      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_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
+        tracer_span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
+      end
+
+      def set_default_tags
+        tracer_span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_TEST)
+      end
+
+      def to_s
+        "#{self.class}(name:#{name},tracer_span:#{@tracer_span})"
+      end
+    end
+  end
+end

data/lib/datadog/ci/test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "span"
+
+module Datadog
+  module CI
+    # Represents a single part of a test run.
+    # Could be a session, suite, test, or any custom span.
+    #
+    # @public_api
+    class Test < Span
+      # @return [String] the name of the test.
+      def name
+        get_tag(Ext::Test::TAG_NAME)
+      end
+
+      # Finishes the current test.
+      # @return [void]
+      def finish
+        super
+
+        CI.deactivate_test(self)
+      end
+    end
+  end
+end

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

@@ -9,7 +9,6 @@ require "datadog/core/chunker"
 
 require_relative "serializers/factories/test_level"
 require_relative "../ext/transport"
-require_relative "../transport/http"
 
 module Datadog
   module CI
@@ -20,33 +19,20 @@ module Datadog
         DEFAULT_MAX_PAYLOAD_SIZE = 5 * 1024 * 1024
 
         attr_reader :serializers_factory,
-          :api_key,
+          :api,
           :max_payload_size,
-          :http,
-          :env
+          :dd_env
 
         def initialize(
-          api_key:,
-          url:,
-          env: nil,
+          api:,
+          dd_env: nil,
           serializers_factory: Datadog::CI::TestVisibility::Serializers::Factories::TestLevel,
           max_payload_size: DEFAULT_MAX_PAYLOAD_SIZE
         )
           @serializers_factory = serializers_factory
-          @api_key = api_key
           @max_payload_size = max_payload_size
-          @env = env
-
-          uri = URI.parse(url)
-
-          raise "Invalid agentless mode URL: #{url}" if uri.host.nil?
-
-          @http = Datadog::CI::Transport::HTTP.new(
-            host: uri.host,
-            port: uri.port,
-            ssl: uri.scheme == "https" || uri.port == 443,
-            compress: true
-          )
+          @dd_env = dd_env
+          @api = api
         end
 
         def send_traces(traces)
@@ -82,13 +68,9 @@ module Datadog
         private
 
         def send_payload(encoded_payload)
-          http.request(
+          api.request(
             path: Datadog::CI::Ext::Transport::TEST_VISIBILITY_INTAKE_PATH,
-            payload: encoded_payload,
-            headers: {
-              Ext::Transport::HEADER_DD_API_KEY => api_key,
-              Ext::Transport::HEADER_CONTENT_TYPE => Ext::Transport::CONTENT_TYPE_MESSAGEPACK
-            }
+            payload: encoded_payload
           )
         end
 
@@ -141,12 +123,12 @@ module Datadog
           packer.write_map_header(1)
 
           packer.write("*")
-          metadata_fields_count = env ? 4 : 3
+          metadata_fields_count = dd_env ? 4 : 3
           packer.write_map_header(metadata_fields_count)
 
-          if env
+          if dd_env
             packer.write("env")
-            packer.write(env)
+            packer.write(dd_env)
           end
 
           packer.write("runtime-id")