datadog-ci 0.1.1 → 0.3.0

data/lib/datadog/ci/contrib/rspec/integration.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib"
-require "datadog/tracing/contrib/integration"
-
+require_relative "../integration"
 require_relative "configuration/settings"
 require_relative "patcher"
 
@@ -12,11 +10,11 @@ module Datadog
       module RSpec
         # Description of RSpec integration
         class Integration
-          include Datadog::Tracing::Contrib::Integration
+          include Datadog::CI::Contrib::Integration
 
           MINIMUM_VERSION = Gem::Version.new("3.0.0")
 
-          register_as :rspec, auto_patch: true
+          register_as :rspec
 
           def self.version
             Gem.loaded_specs["rspec-core"] \

data/lib/datadog/ci/contrib/settings.rb

@@ -0,0 +1,33 @@
+require "datadog/core/configuration/base"
+
+module Datadog
+  module CI
+    module Contrib
+      # Common settings for all integrations
+      # @public_api
+      class Settings
+        include Core::Configuration::Base
+
+        option :enabled, default: true
+        option :service_name
+        option :operation_name
+
+        def configure(options = {})
+          self.class.options.each do |name, _value|
+            self[name] = options[name] if options.key?(name)
+          end
+
+          yield(self) if block_given?
+        end
+
+        def [](name)
+          respond_to?(name) ? send(name) : get_option(name)
+        end
+
+        def []=(name, value)
+          respond_to?("#{name}=") ? send("#{name}=", value) : set_option(name, value)
+        end
+      end
+    end
+  end
+end

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

@@ -10,6 +10,10 @@ module Datadog
           # Appveyor: https://www.appveyor.com/
           # Environment variables docs: https://www.appveyor.com/docs/environment-variables/
           class Appveyor < Base
+            def self.handles?(env)
+              env.key?("APPVEYOR")
+            end
+
             def provider_name
               "appveyor"
             end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # AWS CodePipeline: https://aws.amazon.com/codepipeline/
+          # Environment variables docs: https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html
+          # AWS CodeBuild: https://aws.amazon.com/codebuild/
+          # Environment variable docs: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
+          class AwsCodePipeline < Base
+            def self.handles?(env)
+              !env["CODEBUILD_INITIATOR"].nil? && env["CODEBUILD_INITIATOR"].start_with?("codepipeline")
+            end
+
+            def provider_name
+              "awscodepipeline"
+            end
+
+            def pipeline_id
+              env["DD_PIPELINE_EXECUTION_ID"]
+            end
+
+            def ci_env_vars
+              {
+                "CODEBUILD_BUILD_ARN" => env["CODEBUILD_BUILD_ARN"],
+                "DD_PIPELINE_EXECUTION_ID" => env["DD_PIPELINE_EXECUTION_ID"],
+                "DD_ACTION_EXECUTION_ID" => env["DD_ACTION_EXECUTION_ID"]
+              }.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,10 @@ module Datadog
           # Azure Pipelines: https://azure.microsoft.com/en-us/products/devops/pipelines
           # Environment variables docs: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml
           class Azure < Base
+            def self.handles?(env)
+              env.key?("TF_BUILD")
+            end
+
             def provider_name
               "azurepipelines"
             end

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

@@ -12,6 +12,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

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/local_git.rb

@@ -97,6 +97,13 @@ module Datadog
 
               raise "Failed to run git command #{cmd}: #{out}" unless status.success?
 
+              # Sometimes Encoding.default_external is somehow set to US-ASCII which breaks
+              # commit messages with UTF-8 characters like emojis
+              # We force output's encoding to be UTF-8 in this case
+              # This is safe to do as UTF-8 is compatible with US-ASCII
+              if Encoding.default_external == Encoding::US_ASCII
+                out = out.force_encoding(Encoding::UTF_8)
+              end
               out.strip! # There's always a "\n" at the end of the command output
 
               return nil if out.empty?

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/settings.rb

@@ -6,6 +6,8 @@ module Datadog
       # Defines constants for test tags
       module Settings
         ENV_MODE_ENABLED = "DD_TRACE_CI_ENABLED"
+        ENV_AGENTLESS_MODE_ENABLED = "DD_CIVISIBILITY_AGENTLESS_ENABLED"
+        ENV_AGENTLESS_URL = "DD_CIVISIBILITY_AGENTLESS_URL"
       end
     end
   end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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"
+
+        CONTENT_TYPE_MESSAGEPACK = "application/msgpack"
+        CONTENT_ENCODING_GZIP = "gzip"
+      end
+    end
+  end
+end

data/lib/datadog/ci/{test.rb → recorder.rb}

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "datadog/tracing"
 require "datadog/tracing/contrib/analytics"
 
 require_relative "ext/app_types"
@@ -11,7 +12,7 @@ require "rbconfig"
 module Datadog
   module CI
     # Common behavior for CI tests
-    module Test
+    module Recorder
       # Creates a new span for a CI test
       def self.trace(span_name, options = {})
         span_options = {
@@ -19,13 +20,13 @@ module Datadog
         }.merge(options[:span_options] || {})
 
         if block_given?
-          Tracing.trace(span_name, **span_options) do |span, trace|
+          ::Datadog::Tracing.trace(span_name, **span_options) do |span, trace|
             set_tags!(trace, span, options)
             yield(span, trace)
           end
         else
-          span = Tracing.trace(span_name, **span_options)
-          trace = Tracing.active_trace
+          span = ::Datadog::Tracing.trace(span_name, **span_options)
+          trace = ::Datadog::Tracing.active_trace
           set_tags!(trace, span, options)
           span
         end
@@ -37,7 +38,7 @@ module Datadog
 
         # Set default tags
         trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
-        Datadog::Tracing::Contrib::Analytics.set_measured(span)
+        ::Datadog::Tracing::Contrib::Analytics.set_measured(span)
         span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_TEST)
 
         # Set environment tags

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/metadata/ext"
+require "datadog/tracing/flush"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Flush
+        # Common behavior for CI flushing
+        module Tagging
+          # Decorate a trace with CI tags
+          def get_trace(trace_op)
+            trace = trace_op.flush!
+
+            # Origin tag is required on every span
+            trace.spans.each do |span|
+              span.set_tag(
+                Tracing::Metadata::Ext::Distributed::TAG_ORIGIN,
+                trace.origin
+              )
+            end
+
+            trace
+          end
+        end
+
+        # Consumes only completed traces (where all spans have finished)
+        class Finished < Tracing::Flush::Finished
+          prepend Tagging
+        end
+
+        # Performs partial trace flushing to avoid large traces residing in memory for too long
+        class Partial < Tracing::Flush::Partial
+          prepend Tagging
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        class Base
+          MINIMUM_TIMESTAMP_NANO = 946684800000000000
+          MINIMUM_DURATION_NANO = 0
+          MAXIMUM_DURATION_NANO = 9223372036854775807
+
+          attr_reader :trace, :span
+
+          def initialize(trace, span)
+            @trace = trace
+            @span = span
+          end
+
+          def to_msgpack(packer = nil)
+            packer ||= MessagePack::Packer.new
+
+            packer.write_map_header(3)
+
+            write_field(packer, "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
+
+          # validates according to citestcycle json schema
+          def valid?
+            required_fields_present? && valid_start_time? && valid_duration?
+          end
+
+          def content_fields
+            []
+          end
+
+          def content_map_size
+            0
+          end
+
+          def runtime_id
+            @trace.runtime_id
+          end
+
+          def trace_id
+            @trace.id
+          end
+
+          def span_id
+            @span.id
+          end
+
+          def parent_id
+            @span.parent_id
+          end
+
+          def type
+          end
+
+          def version
+            1
+          end
+
+          def span_type
+            @span.type
+          end
+
+          def name
+            @span.name
+          end
+
+          def resource
+            @span.resource
+          end
+
+          def service
+            @span.service
+          end
+
+          def start
+            @start ||= time_nano(@span.start_time)
+          end
+
+          def duration
+            @duration ||= duration_nano(@span.duration)
+          end
+
+          def meta
+            @span.meta
+          end
+
+          def metrics
+            @span.metrics
+          end
+
+          def error
+            @span.status
+          end
+
+          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
+
+          private
+
+          def valid_start_time?
+            !start.nil? && start >= MINIMUM_TIMESTAMP_NANO
+          end
+
+          def valid_duration?
+            !duration.nil? && duration >= MINIMUM_DURATION_NANO && duration <= MAXIMUM_DURATION_NANO
+          end
+
+          def required_fields_present?
+            required_fields.all? { |field| !send(field).nil? }
+          end
+
+          def required_fields
+            []
+          end
+
+          def write_field(packer, field_name, method = nil)
+            method ||= field_name
+
+            packer.write(field_name)
+            packer.write(send(method))
+          end
+
+          # in nanoseconds since Epoch
+          def time_nano(time)
+            time.to_i * 1000000000 + time.nsec
+          end
+
+          # in nanoseconds
+          def duration_nano(duration)
+            (duration * 1e9).to_i
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../test_v1"
+require_relative "../span"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Serializers
+        module Factories
+          # This factory takes care of creating citestcycle serializers when test-level visibility is enabled
+          # NOTE: citestcycle is a protocol Datadog uses to submit test execution tracing information to CI visibility
+          # backend
+          module TestLevel
+            module_function
+
+            def serializer(trace, span)
+              case span.type
+              when Datadog::CI::Ext::AppTypes::TYPE_TEST
+                Serializers::TestV1.new(trace, span)
+              else
+                Serializers::Span.new(trace, span)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end