refactor: Remove TestAgent from the production code.

pvital · pvital · commit fde15c1ec6b1 · 2024-09-30T17:47:05.000+02:00
Remove the TestAgent and the if-blocks that check if running in a test
environment from the production code.

Signed-off-by: Paulo Vital &lt;paulo.vital@ibm.com&gt;
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -56,7 +56,6 @@ commands:
       - run:
           name: Run Tests With Coverage Report
           environment:
-            INSTANA_TEST: "true"
             CASSANDRA_TEST: "<<parameters.cassandra>>"
             COUCHBASE_TEST: "<<parameters.couchbase>>"
             GEVENT_STARLETTE_TEST: "<<parameters.gevent>>"
diff --git a/.tekton/run_unittests.sh b/.tekton/run_unittests.sh
@@ -52,7 +52,6 @@ esac
 
 echo -n "Configuration is '${TEST_CONFIGURATION}' on ${PYTHON_VERSION} "
 echo    "with dependencies in '${REQUIREMENTS}'"
-export INSTANA_TEST='true'
 ls -lah .
 if [[ -n "${COUCHBASE_TEST}" ]]; then
   echo "Install Couchbase Dependencies"
diff --git a/src/instana/agent/host.py b/src/instana/agent/host.py
@@ -104,9 +104,6 @@ def can_send(self):
         Are we in a state where we can send data?
         @return: Boolean
         """
-        if "INSTANA_TEST" in os.environ:
-            return True
-
         # Watch for pid change (fork)
         self.last_fork_check = datetime.now()
         current_pid = os.getpid()
diff --git a/src/instana/agent/test.py b/src/instana/agent/test.py
diff --git a/src/instana/collector/aws_fargate.py b/src/instana/collector/aws_fargate.py
@@ -19,7 +19,6 @@
 from instana.collector.helpers.runtime import RuntimeHelper
 from instana.collector.utils import format_span
 from instana.log import logger
-from instana.singletons import env_is_test
 from instana.util import DictionaryOfStan, validate_url
 
 
@@ -100,10 +99,6 @@ def get_ecs_metadata(self):
         Get the latest data from the ECS metadata container API and store on the class
         @return: Boolean
         """
-        if env_is_test is True:
-            # For test, we are using mock ECS metadata
-            return
-
         try:
             self.fetching_start_time = int(time())
             delta = self.fetching_start_time - self.last_ecmu_full_fetch
diff --git a/src/instana/collector/base.py b/src/instana/collector/base.py
@@ -8,14 +8,10 @@
 
 import queue  # pylint: disable=import-error
 import threading
-from os import environ
 
 from instana.log import logger
 from instana.util import DictionaryOfStan, every
 
-# TODO: Use mock.patch() or unittest.mock to mock the testing env
-env_is_test = "INSTANA_TEST" in environ
-
 
 class BaseCollector(object):
     """
@@ -31,16 +27,7 @@ def __init__(self, agent):
         self.THREAD_NAME = "Instana Collector"
 
         # The Queue where we store finished spans before they are sent
-        if env_is_test:
-            # Override span queue with a multiprocessing version
-            # The test suite runs background applications - some in background threads,
-            # others in background processes.  This multiprocessing queue allows us to collect
-            # up spans from all sources.
-            import multiprocessing
-
-            self.span_queue = multiprocessing.Queue()
-        else:
-            self.span_queue = queue.Queue()
+        self.span_queue = queue.Queue()
 
         # The Queue where we store finished profiles before they are sent
         self.profile_queue = queue.Queue()
@@ -163,8 +150,6 @@ def prepare_and_report_data(self):
         Prepare and report the data payload.
         @return: Boolean
         """
-        if env_is_test:
-            return True
         with self.background_report_lock:
             payload = self.prepare_payload()
             self.agent.report_data_payload(payload)
diff --git a/src/instana/fsm.py b/src/instana/fsm.py
@@ -67,10 +67,7 @@ def __init__(self, agent):
         self.timer = threading.Timer(1, self.fsm.lookup)
         self.timer.daemon = True
         self.timer.name = self.THREAD_NAME
-
-        # Only start the announce process when not in Test
-        if not "INSTANA_TEST" in os.environ:
-            self.timer.start()
+        self.timer.start()
 
     @staticmethod
     def print_state_change(e):
diff --git a/src/instana/recorder.py b/src/instana/recorder.py
@@ -41,13 +41,6 @@ def queued_spans(self) -> List[ReadableSpan]:
         span = None
         spans = []
 
-        import time
-
-        from .singletons import env_is_test
-
-        if env_is_test is True:
-            time.sleep(1)
-
         if self.agent.collector.span_queue.empty() is True:
             return spans
 
diff --git a/src/instana/singletons.py b/src/instana/singletons.py
@@ -15,7 +15,6 @@
 
 # Detect the environment where we are running ahead of time
 aws_env = os.environ.get("AWS_EXECUTION_ENV", "")
-env_is_test = "INSTANA_TEST" in os.environ
 env_is_aws_fargate = aws_env == "AWS_ECS_FARGATE"
 env_is_aws_eks_fargate = (
     os.environ.get("INSTANA_TRACER_ENVIRONMENT") == "AWS_EKS_FARGATE"
@@ -29,15 +28,7 @@
     (k_service, k_configuration, k_revision, instana_endpoint_url)
 )
 
-if env_is_test:
-    from .agent.test import TestAgent
-    from .recorder import StanRecorder
-
-    agent = TestAgent()
-    span_recorder = StanRecorder(agent)
-    profiler = Profiler(agent)
-
-elif env_is_aws_lambda:
+if env_is_aws_lambda:
     from .agent.aws_lambda import AWSLambdaAgent
     from .recorder import StanRecorder
 
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -3,8 +3,6 @@
 
 import os
 
-os.environ["INSTANA_TEST"] = "true"
-
 if os.environ.get('GEVENT_STARLETTE_TEST'):
     from gevent import monkey
     monkey.patch_all()
diff --git a/tests/agent/test_host.py b/tests/agent/test_host.py
@@ -71,13 +71,7 @@ def test_is_timed_out():
     assert agent.is_timed_out()
 
 
-def test_can_send_test_env():
-    agent = HostAgent()
-    with patch.dict("os.environ", {"INSTANA_TEST": "sample-data"}):
-        if "INSTANA_TEST" in os.environ:
-            assert agent.can_send()
-
-
+@pytest.mark.original
 def test_can_send():
     agent = HostAgent()
     agent._boot_pid = 12345
@@ -92,6 +86,7 @@ def test_can_send():
             assert agent.can_send() is True
 
 
+@pytest.mark.original
 def test_can_send_default():
     agent = HostAgent()
     with patch.dict("os.environ", {}, clear=True):
@@ -121,6 +116,7 @@ def test_set_from():
     assert agent.announce_data.pid == 1234
 
 
+@pytest.mark.original
 def test_get_from_structure():
     agent = HostAgent()
     agent.announce_data = AnnounceData(pid=1234, agentUuid="value")
diff --git a/tests/apps/grpc_server/stan_server.py b/tests/apps/grpc_server/stan_server.py
@@ -92,7 +92,6 @@ def start_server(self):
 
 if __name__ == "__main__":
     print ("Booting foreground GRPC application...")
-    # os.environ["INSTANA_TEST"] = "true"
 
     if sys.version_info >= (3, 5, 3):
         StanServicer().start_server()
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -4,6 +4,7 @@
 import importlib.util
 import os
 import sys
+from typing import Any, Dict
 
 import pytest
 from opentelemetry.context.context import Context
@@ -12,18 +13,13 @@
 if importlib.util.find_spec("celery"):
     pytest_plugins = ("celery.contrib.pytest",)
 
-# Set our testing flags
-os.environ["INSTANA_TEST"] = "true"
-
-# TODO: remove all "noqa: E402" from instana package imports and move the
-# block of env variables setting to below the imports after finishing the
-# migration of instrumentation codes.
-from instana.agent.test import TestAgent  # noqa: E402
-from instana.recorder import StanRecorder  # noqa: E402
-from instana.span.base_span import BaseSpan  # noqa: E402
-from instana.span.span import InstanaSpan  # noqa: E402
-from instana.span_context import SpanContext  # noqa: E402
-from instana.tracer import InstanaTracerProvider  # noqa: E402
+from instana.agent.host import HostAgent
+from instana.collector.base import BaseCollector
+from instana.recorder import StanRecorder
+from instana.span.base_span import BaseSpan
+from instana.span.span import InstanaSpan
+from instana.span_context import SpanContext
+from instana.tracer import InstanaTracerProvider
 
 # Ignoring tests during OpenTelemetry migration.
 collect_ignore_glob = [
@@ -129,14 +125,14 @@ def span_id() -> int:
 
 @pytest.fixture
 def span_processor() -> StanRecorder:
-    rec = StanRecorder(TestAgent())
+    rec = StanRecorder(HostAgent())
     rec.THREAD_NAME = "InstanaSpan Recorder Test"
     return rec
 
 
 @pytest.fixture
 def tracer_provider(span_processor: StanRecorder) -> InstanaTracerProvider:
-    return InstanaTracerProvider(span_processor=span_processor, exporter=TestAgent())
+    return InstanaTracerProvider(span_processor=span_processor, exporter=HostAgent())
 
 
 @pytest.fixture
@@ -162,3 +158,56 @@ def base_span(span: InstanaSpan) -> BaseSpan:
 @pytest.fixture
 def context(span: InstanaSpan) -> Context:
     return set_span_in_context(span)
+
+
+def always_true(_: object) -> bool:
+    return True
+
+
+# Mocking HostAgent.can_send()
+@pytest.fixture(autouse=True)
+def can_send(monkeypatch, request) -> None:
+    """Return always True for HostAgent.can_send()"""
+    if "original" in request.keywords:
+        # If using the `@pytest.mark.original` marker before the test function,
+        # uses the original HostAgent.can_send()
+        monkeypatch.setattr(HostAgent, "can_send", HostAgent.can_send)
+    else:
+        monkeypatch.setattr(HostAgent, "can_send", always_true)
+
+
+# Mocking HostAgent.get_from_structure()
+@pytest.fixture(autouse=True)
+def get_from_structure(monkeypatch, request) -> None:
+    """
+    Retrieves the From data that is reported alongside monitoring data.
+    @return: dict()
+    """
+
+    def _get_from_structure(_: object) -> Dict[str, Any]:
+        return {"e": os.getpid(), "h": "fake"}
+
+    if "original" in request.keywords:
+        # If using the `@pytest.mark.original` marker before the test function,
+        # uses the original HostAgent.get_from_structure()
+        monkeypatch.setattr(
+            HostAgent, "get_from_structure", HostAgent.get_from_structure
+        )
+    else:
+        monkeypatch.setattr(HostAgent, "get_from_structure", _get_from_structure)
+
+
+# Mocking BaseCollector.prepare_and_report_data()
+@pytest.fixture(autouse=True)
+def prepare_and_report_data(monkeypatch, request):
+    """Return always True for BaseCollector.prepare_and_report_data()"""
+    if "original" in request.keywords:
+        # If using the `@pytest.mark.original` marker before the test function,
+        # uses the original BaseCollector.prepare_and_report_data()
+        monkeypatch.setattr(
+            BaseCollector,
+            "prepare_and_report_data",
+            BaseCollector.prepare_and_report_data,
+        )
+    else:
+        monkeypatch.setattr(BaseCollector, "prepare_and_report_data", always_true)
diff --git a/tests/platforms/conftest.py b/tests/platforms/conftest.py
@@ -0,0 +1,18 @@
+import pytest
+
+from instana.collector.aws_fargate import AWSFargateCollector
+
+# Mocking AWSFargateCollector.get_ecs_metadata()
+@pytest.fixture(autouse=True)
+def get_ecs_metadata(monkeypatch, request) -> None:
+    """Return always True for AWSFargateCollector.get_ecs_metadata()"""
+
+    def _always_true(_: object) -> bool:
+        return True
+
+    if "original" in request.keywords:
+        # If using the `@pytest.mark.original` marker before the test function,
+        # uses the original AWSFargateCollector.get_ecs_metadata()
+        monkeypatch.setattr(AWSFargateCollector, "get_ecs_metadata", AWSFargateCollector.get_ecs_metadata)
+    else:
+        monkeypatch.setattr(AWSFargateCollector, "get_ecs_metadata", _always_true)
diff --git a/tests/test_tracer.py b/tests/test_tracer.py
@@ -1,22 +1,19 @@
 # (c) Copyright IBM Corp. 2024
 
 import pytest
-
 from opentelemetry.trace.span import _SPAN_ID_MAX_VALUE
 
-from instana.agent.test import TestAgent
+from instana.agent.host import HostAgent
 from instana.recorder import StanRecorder
 from instana.sampling import InstanaSampler
 from instana.span.span import (
+    INVALID_SPAN,
+    INVALID_SPAN_ID,
     InstanaSpan,
     get_current_span,
-    INVALID_SPAN_ID,
-    INVALID_SPAN,
 )
 from instana.span_context import SpanContext
 from instana.tracer import InstanaTracer, InstanaTracerProvider
-from opentelemetry.context.context import Context
-from opentelemetry.trace.span import _SPAN_ID_MAX_VALUE, INVALID_SPAN_ID
 
 
 def test_tracer_defaults(tracer_provider: InstanaTracerProvider) -> None:
@@ -29,7 +26,7 @@ def test_tracer_defaults(tracer_provider: InstanaTracerProvider) -> None:
 
     assert isinstance(tracer._sampler, InstanaSampler)
     assert isinstance(tracer.span_processor, StanRecorder)
-    assert isinstance(tracer.exporter, TestAgent)
+    assert isinstance(tracer.exporter, HostAgent)
     assert len(tracer._propagators) == 3
 
 
diff --git a/tests/test_tracer_provider.py b/tests/test_tracer_provider.py
@@ -2,8 +2,8 @@
 
 from pytest import LogCaptureFixture
 
+from instana.agent.base import BaseAgent
 from instana.agent.host import HostAgent
-from instana.agent.test import TestAgent
 from instana.propagators.binary_propagator import BinaryPropagator
 from instana.propagators.format import Format
 from instana.propagators.http_propagator import HTTPPropagator
@@ -49,5 +49,5 @@ def test_tracer_provider_add_span_processor(span_processor: StanRecorder) -> Non
 
     provider.add_span_processor(span_processor)
     assert isinstance(provider._span_processor, StanRecorder)
-    assert isinstance(provider._span_processor.agent, TestAgent)
+    assert isinstance(provider._span_processor.agent, BaseAgent)
     assert provider._span_processor.THREAD_NAME == "InstanaSpan Recorder Test"
