DEBUG-3573 Split telemetry tests into multiple files (#4685)

Author: p-datadog

spec/datadog/core/telemetry/event/app_client_configuration_change_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/app_client_configuration_change'
+
+RSpec.describe Datadog::Core::Telemetry::Event::AppClientConfigurationChange do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:event_class) { described_class }
+  let(:event) { event_class.new(changes, origin) }
+  let(:changes) { { name => value } }
+  let(:origin) { double('origin') }
+  let(:name) { 'key' }
+  let(:value) { 'value' }
+
+  before do
+    allow_any_instance_of(Datadog::Core::Utils::Sequence).to receive(:next).and_return(id)
+  end
+
+  it 'has a list of client configurations' do
+    is_expected.to eq(
+      configuration: [{
+        name: name,
+        value: value,
+        origin: origin,
+        seq_id: id
+      }]
+    )
+  end
+
+  context 'with env_var state configuration' do
+    before do
+      Datadog.configure do |c|
+        c.appsec.sca_enabled = false
+      end
+    end
+
+    it 'includes sca enablement configuration' do
+      is_expected.to eq(
+        configuration:
+        [
+          { name: name, value: value, origin: origin, seq_id: id },
+          { name: 'appsec.sca_enabled', value: false, origin: 'code', seq_id: id }
+        ]
+      )
+    end
+  end
+
+  it 'all events to be the same' do
+    events =     [
+      event_class.new({ 'key' => 'value' }, 'origin'),
+      event_class.new({ 'key' => 'value' }, 'origin'),
+    ]
+
+    expect(events.uniq).to have(1).item
+  end
+
+  it 'all events to be different' do
+    events =     [
+      event_class.new({ 'key' => 'value' }, 'origin'),
+      event_class.new({ 'key' => 'value' }, 'origin2'),
+      event_class.new({ 'key' => 'value2' }, 'origin'),
+      event_class.new({ 'key2' => 'value' }, 'origin'),
+      event_class.new({}, 'origin'),
+    ]
+
+    expect(events.uniq).to eq(events)
+  end
+end

spec/datadog/core/telemetry/event/app_closing_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/app_closing'
+
+RSpec.describe Datadog::Core::Telemetry::Event::AppClosing do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:event_class) { described_class }
+  it_behaves_like 'telemetry event with no attributes'
+
+  it 'has no payload' do
+    is_expected.to eq({})
+  end
+end

spec/datadog/core/telemetry/event/app_dependencies_loaded_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/app_dependencies_loaded'
+
+RSpec.describe Datadog::Core::Telemetry::Event::AppDependenciesLoaded do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:event_class) { described_class }
+  it_behaves_like 'telemetry event with no attributes'
+
+  it 'all have name and Ruby gem version' do
+    is_expected.to match(dependencies: all(match(name: kind_of(String), version: kind_of(String))))
+  end
+
+  it 'has a known gem with expected version' do
+    is_expected.to match(
+      dependencies: include(name: 'datadog', version: Datadog::Core::Environment::Identity.gem_datadog_version)
+    )
+  end
+end

spec/datadog/core/telemetry/event/app_heartbeat_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/app_heartbeat'
+
+RSpec.describe Datadog::Core::Telemetry::Event::AppHeartbeat do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:event_class) { described_class }
+  it_behaves_like 'telemetry event with no attributes'
+
+  it 'has no payload' do
+    is_expected.to eq({})
+  end
+end

spec/datadog/core/telemetry/event/app_integrations_change_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/app_integrations_change'
+
+RSpec.describe Datadog::Core::Telemetry::Event::AppIntegrationsChange do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:event_class) { described_class }
+  it_behaves_like 'telemetry event with no attributes'
+
+  it 'all have name and compatibility' do
+    is_expected.to match(integrations: all(include(name: kind_of(String), compatible: boolean)))
+  end
+
+  context 'with an instrumented integration' do
+    context 'that applied' do
+      before do
+        Datadog.configure do |c|
+          c.tracing.instrument :http
+        end
+      end
+      it 'has a list of integrations' do
+        is_expected.to match(
+          integrations: include(
+            name: 'http',
+            version: RUBY_VERSION,
+            compatible: true,
+            enabled: true
+          )
+        )
+      end
+    end
+
+    context 'that failed to apply' do
+      before do
+        raise 'pg is loaded! This test requires integration that does not have its gem loaded' if Gem.loaded_specs['pg']
+
+        Datadog.configure do |c|
+          c.tracing.instrument :pg
+        end
+      end
+
+      it 'has a list of integrations' do
+        is_expected.to match(
+          integrations: include(
+            name: 'pg',
+            compatible: false,
+            enabled: false,
+            error: 'Available?: false, Loaded? false, Compatible? false, Patchable? false',
+          )
+        )
+      end
+    end
+  end
+end

spec/datadog/core/telemetry/event/app_started_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/app_started'
+
+RSpec.describe Datadog::Core::Telemetry::Event::AppStarted do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:logger) do
+    stub_const('MyLogger', Class.new(::Logger)).new(nil)
+  end
+  let(:default_code_configuration) do
+    [
+      ['DD_AGENT_HOST', '1.2.3.4'],
+      ['DD_AGENT_TRANSPORT', 'TCP'],
+      ['DD_TRACE_SAMPLE_RATE', '0.5'],
+      ['DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED', true],
+      ['DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED', false],
+      ['DD_TRACE_PEER_SERVICE_MAPPING', 'foo:bar'],
+      ['dynamic_instrumentation.enabled', false],
+      ['logger.level', 0],
+      ['profiling.advanced.code_provenance_enabled', true],
+      ['profiling.advanced.endpoint.collection.enabled', true],
+      ['profiling.enabled', false],
+      ['runtime_metrics.enabled', false],
+      ['tracing.analytics.enabled', true],
+      ['tracing.propagation_style_extract', '["datadog", "tracecontext", "baggage"]'],
+      ['tracing.propagation_style_inject', '["datadog", "tracecontext", "baggage"]'],
+      ['tracing.enabled', true],
+      ['tracing.log_injection', true],
+      ['tracing.partial_flush.enabled', false],
+      ['tracing.partial_flush.min_spans_threshold', 500],
+      ['tracing.report_hostname', false],
+      ['tracing.sampling.rate_limit', 100],
+      ['tracing.auto_instrument.enabled', false],
+      ['tracing.writer_options.buffer_size', 123],
+      ['tracing.writer_options.flush_interval', 456],
+      ['tracing.opentelemetry.enabled', false],
+      ['logger.instance', 'MyLogger'],
+      ['appsec.enabled', false],
+      ['appsec.sca_enabled', false]
+    ].freeze
+  end
+  let(:expected_install_signature) do
+    { install_id: 'id', install_time: 'time', install_type: 'type' }
+  end
+  let(:expected_products) do
+    {
+      appsec: {
+        enabled: false,
+      },
+      dynamic_instrumentation: {
+        enabled: false,
+      },
+      profiler: hash_including(enabled: false),
+    }
+  end
+  let(:event_class) { described_class }
+  before do
+    allow_any_instance_of(Datadog::Core::Utils::Sequence).to receive(:next).and_return(id)
+
+    Datadog.configure do |c|
+      c.agent.host = '1.2.3.4'
+      c.tracing.sampling.default_rate = 0.5
+      c.tracing.contrib.global_default_service_name.enabled = true
+      c.tracing.contrib.peer_service_mapping = { foo: 'bar' }
+      c.tracing.writer_options = { buffer_size: 123, flush_interval: 456 }
+      c.logger.instance = logger
+      c.tracing.analytics.enabled = true
+      c.telemetry.install_id = 'id'
+      c.telemetry.install_type = 'type'
+      c.telemetry.install_time = 'time'
+      c.appsec.sca_enabled = false
+    end
+
+    # Reset global cache
+    Datadog::Core::Environment::Git.reset_for_tests
+  end
+  it_behaves_like 'telemetry event with no attributes'
+
+  # Helper to make configuration matching table easier to read
+  def contain_code_configuration(*array)
+    array.map { |name, value| { name: name, origin: 'code', seq_id: id, value: value } }
+  end
+
+  def contain_env_configuration(*array)
+    array.map { |name, value| { name: name, origin: 'env_var', seq_id: id, value: value } }
+  end
+
+  it do
+    is_expected.to match(
+      products: expected_products,
+      configuration: contain_code_configuration(
+        *default_code_configuration
+      ),
+      install_signature: expected_install_signature,
+    )
+  end
+
+  context 'with git/SCI environment variables set' do
+    with_env 'DD_GIT_REPOSITORY_URL' => 'https://github.com/datadog/hello',
+      'DD_GIT_COMMIT_SHA' => '1234hash'
+
+    before do
+      # Reset global cache so that we get our values back
+      Datadog::Core::Environment::Git.reset_for_tests
+    end
+
+    after do
+      # Do not use our values in other tests
+      Datadog::Core::Environment::Git.reset_for_tests
+    end
+
+    it 'reports git/SCI values to telemetry' do
+      is_expected.to match(
+        products: expected_products,
+        configuration: contain_env_configuration(
+          ['DD_GIT_REPOSITORY_URL', 'https://github.com/datadog/hello'],
+          ['DD_GIT_COMMIT_SHA', '1234hash'],
+        ) + contain_code_configuration(
+          *default_code_configuration
+        ),
+        install_signature: expected_install_signature,
+      )
+    end
+  end
+
+  context 'with nil configurations' do
+    before do
+      Datadog.configure do |c|
+        c.logger.instance = nil
+      end
+    end
+
+    it 'removes empty configurations from payload' do
+      is_expected.to_not match(
+        configuration: include(
+          { name: 'logger.instance', origin: anything, seq_id: anything, value: anything }
+        )
+      )
+    end
+  end
+end

spec/datadog/core/telemetry/event/distributions_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+require 'datadog/core/telemetry/event/distributions'
+require 'datadog/core/telemetry/metric'
+
+RSpec.describe Datadog::Core::Telemetry::Event::Distributions do
+  let(:id) { double('seq_id') }
+  let(:event) { event_class.new }
+
+  subject(:payload) { event.payload }
+
+  let(:event_class) { described_class }
+  let(:event) { event_class.new(namespace, metrics) }
+
+  let(:namespace) { 'general' }
+  let(:metric_name) { 'request_duration' }
+  let(:metric) do
+    Datadog::Core::Telemetry::Metric::Distribution.new(metric_name, tags: { status: '200' })
+  end
+  let(:metrics) { [metric] }
+
+  let(:expected_metric_series) { [metric.to_h] }
+
+  it do
+    is_expected.to eq(
+      {
+        namespace: namespace,
+        series: expected_metric_series
+      }
+    )
+  end
+end