tests(integration): separate snapshot tests into own module (#2209)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: Kyle-Verhoog

tests/integration/test_integration.py

@@ -9,21 +9,14 @@
 import ddtrace
 from ddtrace import Tracer
 from ddtrace import tracer
-from ddtrace.constants import MANUAL_DROP_KEY
-from ddtrace.constants import MANUAL_KEEP_KEY
 from ddtrace.internal import agent
 from ddtrace.internal.runtime import container
 from ddtrace.internal.writer import AgentWriter
-from ddtrace.sampler import DatadogSampler
-from ddtrace.sampler import RateSampler
-from ddtrace.sampler import SamplingRule
 from ddtrace.vendor import six
 from tests import AnyFloat
 from tests import AnyInt
 from tests import AnyStr
-from tests import TracerTestCase
 from tests import override_global_config
-from tests import snapshot
 
 
 AGENT_VERSION = os.environ.get("AGENT_VERSION")
@@ -400,116 +393,6 @@ def test_span_tags():
  log.error.assert_not_called()
 
 
-@pytest.mark.skipif(AGENT_VERSION != "testagent", reason="Tests only compatible with a testagent")
-class TestTraces(TracerTestCase):
- """
- These snapshot tests ensure that trace payloads are being sent as expected.
- """
-
- @snapshot(include_tracer=True)
- def test_single_trace_single_span(self, tracer):
- s = tracer.trace("operation", service="my-svc")
- s.set_tag("k", "v")
- # numeric tag
- s.set_tag("num", 1234)
- s.set_metric("float_metric", 12.34)
- s.set_metric("int_metric", 4321)
- s.finish()
- tracer.shutdown()
-
- @snapshot(include_tracer=True)
- def test_multiple_traces(self, tracer):
- with tracer.trace("operation1", service="my-svc") as s:
- s.set_tag("k", "v")
- s.set_tag("num", 1234)
- s.set_metric("float_metric", 12.34)
- s.set_metric("int_metric", 4321)
- tracer.trace("child").finish()
-
- with tracer.trace("operation2", service="my-svc") as s:
- s.set_tag("k", "v")
- s.set_tag("num", 1234)
- s.set_metric("float_metric", 12.34)
- s.set_metric("int_metric", 4321)
- tracer.trace("child").finish()
- tracer.shutdown()
-
- @snapshot(include_tracer=True)
- def test_filters(self, tracer):
- class FilterMutate(object):
- def __init__(self, key, value):
- self.key = key
- self.value = value
-
- def process_trace(self, trace):
- for s in trace:
- s.set_tag(self.key, self.value)
- return trace
-
- tracer.configure(
- settings={
- "FILTERS": [FilterMutate("boop", "beep")],
- },
- writer=tracer.writer,
- )
-
- with tracer.trace("root"):
- with tracer.trace("child"):
- pass
- tracer.shutdown()
-
- @snapshot(include_tracer=True)
- def test_sampling(self, tracer):
- with tracer.trace("trace1"):
- with tracer.trace("child"):
- pass
-
- sampler = DatadogSampler(default_sample_rate=1.0)
- tracer.configure(sampler=sampler, writer=tracer.writer)
- with tracer.trace("trace2"):
- with tracer.trace("child"):
- pass
-
- sampler = DatadogSampler(default_sample_rate=0.000001)
- tracer.configure(sampler=sampler, writer=tracer.writer)
- with tracer.trace("trace3"):
- with tracer.trace("child"):
- pass
-
- sampler = DatadogSampler(default_sample_rate=1, rules=[SamplingRule(1.0)])
- tracer.configure(sampler=sampler, writer=tracer.writer)
- with tracer.trace("trace4"):
- with tracer.trace("child"):
- pass
-
- sampler = DatadogSampler(default_sample_rate=1, rules=[SamplingRule(0)])
- tracer.configure(sampler=sampler, writer=tracer.writer)
- with tracer.trace("trace5"):
- with tracer.trace("child"):
- pass
-
- sampler = DatadogSampler(default_sample_rate=1)
- tracer.configure(sampler=sampler, writer=tracer.writer)
- with tracer.trace("trace6"):
- with tracer.trace("child") as span:
- span.set_tag(MANUAL_DROP_KEY)
-
- sampler = DatadogSampler(default_sample_rate=1)
- tracer.configure(sampler=sampler, writer=tracer.writer)
- with tracer.trace("trace7"):
- with tracer.trace("child") as span:
- span.set_tag(MANUAL_KEEP_KEY)
-
- sampler = RateSampler(0.0000000001)
- tracer.configure(sampler=sampler, writer=tracer.writer)
- # This trace should not appear in the snapshot
- with tracer.trace("trace8"):
- with tracer.trace("child"):
- pass
-
- tracer.shutdown()
-
-
 @pytest.mark.skipif(AGENT_VERSION == "testagent", reason="Test agent doesn't support empty trace payloads.")
 def test_flush_log(caplog):
  caplog.set_level(logging.INFO)

tests/integration/test_integration_snapshots.py

@@ -0,0 +1,120 @@
+import pytest
+
+from ddtrace.constants import MANUAL_DROP_KEY
+from ddtrace.constants import MANUAL_KEEP_KEY
+from ddtrace.sampler import DatadogSampler
+from ddtrace.sampler import RateSampler
+from ddtrace.sampler import SamplingRule
+from tests import snapshot
+
+from .test_integration import AGENT_VERSION
+
+
+pytestmark = pytest.mark.skipif(AGENT_VERSION != "testagent", reason="Tests only compatible with a testagent")
+
+
+@snapshot(include_tracer=True)
+def test_single_trace_single_span(tracer):
+ s = tracer.trace("operation", service="my-svc")
+ s.set_tag("k", "v")
+ # numeric tag
+ s.set_tag("num", 1234)
+ s.set_metric("float_metric", 12.34)
+ s.set_metric("int_metric", 4321)
+ s.finish()
+ tracer.shutdown()
+
+
+@snapshot(include_tracer=True)
+def test_multiple_traces(tracer):
+ with tracer.trace("operation1", service="my-svc") as s:
+ s.set_tag("k", "v")
+ s.set_tag("num", 1234)
+ s.set_metric("float_metric", 12.34)
+ s.set_metric("int_metric", 4321)
+ tracer.trace("child").finish()
+
+ with tracer.trace("operation2", service="my-svc") as s:
+ s.set_tag("k", "v")
+ s.set_tag("num", 1234)
+ s.set_metric("float_metric", 12.34)
+ s.set_metric("int_metric", 4321)
+ tracer.trace("child").finish()
+ tracer.shutdown()
+
+
+@snapshot(include_tracer=True)
+def test_filters(tracer):
+ class FilterMutate(object):
+ def __init__(self, key, value):
+ self.key = key
+ self.value = value
+
+ def process_trace(self, trace):
+ for s in trace:
+ s.set_tag(self.key, self.value)
+ return trace
+
+ tracer.configure(
+ settings={
+ "FILTERS": [FilterMutate("boop", "beep")],
+ },
+ writer=tracer.writer,
+ )
+
+ with tracer.trace("root"):
+ with tracer.trace("child"):
+ pass
+ tracer.shutdown()
+
+
+@snapshot(include_tracer=True)
+def test_sampling(tracer):
+ with tracer.trace("trace1"):
+ with tracer.trace("child"):
+ pass
+
+ sampler = DatadogSampler(default_sample_rate=1.0)
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ with tracer.trace("trace2"):
+ with tracer.trace("child"):
+ pass
+
+ sampler = DatadogSampler(default_sample_rate=0.000001)
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ with tracer.trace("trace3"):
+ with tracer.trace("child"):
+ pass
+
+ sampler = DatadogSampler(default_sample_rate=1, rules=[SamplingRule(1.0)])
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ with tracer.trace("trace4"):
+ with tracer.trace("child"):
+ pass
+
+ sampler = DatadogSampler(default_sample_rate=1, rules=[SamplingRule(0)])
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ with tracer.trace("trace5"):
+ with tracer.trace("child"):
+ pass
+
+ sampler = DatadogSampler(default_sample_rate=1)
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ with tracer.trace("trace6"):
+ with tracer.trace("child") as span:
+ span.set_tag(MANUAL_DROP_KEY)
+
+ sampler = DatadogSampler(default_sample_rate=1)
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ with tracer.trace("trace7"):
+ with tracer.trace("child") as span:
+ span.set_tag(MANUAL_KEEP_KEY)
+
+ sampler = RateSampler(0.0000000001)
+ tracer.configure(sampler=sampler, writer=tracer.writer)
+ # This trace should not appear in the snapshot
+ with tracer.trace("trace8"):
+ with tracer.trace("child"):
+ pass
+
+ tracer.shutdown()

tests/snapshots/tests.integration.test_integration.test_filters.snap renamed to tests/snapshots/tests.integration.test_integration_snapshots.test_filters.snap

@@ -5,21 +5,21 @@
  "span_id" 0
  "trace_id" 0
  "parent_id" nil
- "start" 1603750872873401000
- "duration" 140000
- "meta" {"runtime-id" "3069ce0f5ace427ab66cb89c9161a4ae"
+ "start" 1616457150171098000
+ "duration" 43000
+ "meta" {"runtime-id" "ddf562510b004d60bdfaa21911ab1e60"
  "boop" "beep"}
  "metrics" {"_dd.agent_psr" 1.0
  "_sampling_priority_v1" 1
- "_dd.tracer_kr" 1.0
- "system.pid" 42296}}
+ "system.pid" 39631
+ "_dd.tracer_kr" 1.0}}
  {"name" "child"
  "service" nil
  "resource" "child"
  "error" 0
  "span_id" 1
  "trace_id" 0
  "parent_id" 0
- "start" 1603750872873519000
- "duration" 9000
+ "start" 1616457150171130000
+ "duration" 7000
  "meta" {"boop" "beep"}}]]

tests/snapshots/tests.integration.test_integration.test_multiple_traces.snap renamed to tests/snapshots/tests.integration.test_integration_snapshots.test_multiple_traces.snap

@@ -5,50 +5,50 @@
  "span_id" 0
  "trace_id" 0
  "parent_id" nil
- "start" 1603750872929188000
- "duration" 334000
- "meta" {"runtime-id" "3069ce0f5ace427ab66cb89c9161a4ae"
+ "start" 1616457150152653000
+ "duration" 54000
+ "meta" {"runtime-id" "ddf562510b004d60bdfaa21911ab1e60"
  "k" "v"}
  "metrics" {"_dd.agent_psr" 1.0
  "_sampling_priority_v1" 1
+ "system.pid" 39631
+ "int_metric" 4321
  "_dd.tracer_kr" 1.0
- "system.pid" 42296
- "num" 1234
  "float_metric" 12.34
- "int_metric" 4321}}
+ "num" 1234}}
  {"name" "child"
  "service" "my-svc"
  "resource" "child"
  "error" 0
  "span_id" 1
  "trace_id" 0
  "parent_id" 0
- "start" 1603750872929503000
- "duration" 10000}]
+ "start" 1616457150152696000
+ "duration" 7000}]
  [{"name" "operation2"
  "service" "my-svc"
  "resource" "operation2"
  "error" 0
  "span_id" 0
  "trace_id" 1
  "parent_id" nil
- "start" 1603750872929712000
- "duration" 36000
- "meta" {"runtime-id" "3069ce0f5ace427ab66cb89c9161a4ae"
+ "start" 1616457150152832000
+ "duration" 46000
+ "meta" {"runtime-id" "ddf562510b004d60bdfaa21911ab1e60"
  "k" "v"}
  "metrics" {"_dd.agent_psr" 1.0
  "_sampling_priority_v1" 1
+ "system.pid" 39631
+ "int_metric" 4321
  "_dd.tracer_kr" 1.0
- "system.pid" 42296
- "num" 1234
  "float_metric" 12.34
- "int_metric" 4321}}
+ "num" 1234}}
  {"name" "child"
  "service" "my-svc"
  "resource" "child"
  "error" 0
  "span_id" 1
  "trace_id" 1
  "parent_id" 0
- "start" 1603750872929740000
- "duration" 4000}]]
+ "start" 1616457150152868000
+ "duration" 6000}]]